Package org.forgerock.json.resource
Interface ResourceApiVersionSpecificationFilter.VersionSpecification
-
- All Known Implementing Classes:
ResourceApiVersionSpecificationFilter.ResourcePathAndVersionSpecification
- Enclosing class:
- ResourceApiVersionSpecificationFilter
public static interface ResourceApiVersionSpecificationFilter.VersionSpecificationMechanism supporting specification of a version on the request. TheVersionSpecificationis expected to be configured with a means of determining the preferred version based on a request. It may also be configured to indicate if a warning should be raised when no version is supplied.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidhandleNoApiVersionSupplied(Context context, ResourcePath resourcePath)Support custom handling when no resource API version is supplied on the request.Optional<Version>matchVersion(Request request)Test the request to try to find a match based on version configuration.
-
-
-
Method Detail
-
matchVersion
Optional<Version> matchVersion(Request request)
Test the request to try to find a match based on version configuration. The matching version is returned if found.
-
handleNoApiVersionSupplied
void handleNoApiVersionSupplied(Context context, ResourcePath resourcePath)
Support custom handling when no resource API version is supplied on the request.- Parameters:
context- theContextresourcePath- the requestedResourcePath
-
-