Uses of Class
org.forgerock.http.routing.Version

Packages that use Version

Package	Description
org.forgerock.http	Models and manages elements of the Hypertext Transfer Protocol.
org.forgerock.http.header	Processes HTTP message header fields.
org.forgerock.http.routing	Provides routing functionality for HTTP requests.
org.forgerock.http.swagger	Classes to support OpenAPI API Descriptions using Swagger.
org.forgerock.json.resource	Classes and interfaces for core types including connections, request handlers, resources, and their exceptions.
org.forgerock.json.resource.http	JSON resource Commons HTTP Framework integration.
org.forgerock.openig.tools	Common tools used in policy service.

Uses of Version in org.forgerock.http

Methods in org.forgerock.http with parameters of type Version

Modifier and Type	Method	Description
D	ApiProducer.withVersion(D descriptor, Version version)	Mutate the provided descriptor to add the specified version.

Uses of Version in org.forgerock.http.header

Methods in org.forgerock.http.header that return Version

Modifier and Type	Method	Description
Version	AcceptApiVersionHeader.getProtocolVersion()	Gets the acceptable protocol version.
Version	ContentApiVersionHeader.getProtocolVersion()	Gets the protocol version of the content of the returned content.
Version	AcceptApiVersionHeader.getResourceVersion()	Gets the acceptable resource version.
Version	ContentApiVersionHeader.getResourceVersion()	Gets the resource version of the returned content.

Methods in org.forgerock.http.header with parameters of type Version

Modifier and Type	Method	Description
AcceptApiVersionHeader	AcceptApiVersionHeader.withDefaultProtocolVersion(Version version)	Will set the accepted protocol version, if not provided in the Accept-API-Version header.
AcceptApiVersionHeader	AcceptApiVersionHeader.withDefaultResourceVersion(Version version)	Will set the accepted resource version, if not provided in the Accept-API-Version header.

Constructors in org.forgerock.http.header with parameters of type Version

Constructor	Description
AcceptApiVersionHeader(Version protocol, Version resource)	Constructs a new header, initialized with the specified protocol and resource versions.
ContentApiVersionHeader(Version protocolVersion, Version resourceVersion)	Constructs a new header, initialized with the specified protocol and resource versions.

Uses of Version in org.forgerock.http.routing

Methods in org.forgerock.http.routing that return Version

Modifier and Type	Method	Description
Version	ApiVersionRouterContext.getProtocolVersion()	Gets the protocol API version of the framework used to handle the request.
Version	ApiVersionRouterContext.getResourceVersion()	Gets the API version of the resource that the request was routed to.
static Version	Version.version(int major)	Creates a new version using the provided version information and a minor.
static Version	Version.version(int major, int minor)	Creates a new version using the provided version information.
static Version	Version.version(String s)	Parses the string argument as a version.

Methods in org.forgerock.http.routing that return types with arguments of type Version

Modifier and Type	Method	Description
static RouteMatcher<Version>	RouteMatchers.resourceApiVersionMatcher(Version version)	Creates a RouteMatcher instance that matches the request resource API version with the provided version.

Methods in org.forgerock.http.routing with parameters of type Version

Modifier and Type	Method	Description
int	Version.compareTo(Version that)
boolean	Version.isCompatibleWith(Version that)	Returns false if: the MAJOR version numbers are not the same.
static RouteMatcher<Request>	RouteMatchers.requestResourceApiVersionMatcher(Version version)	Creates a RouteMatcher instance that matches the request resource API version with the provided version.
static RouteMatcher<Version>	RouteMatchers.resourceApiVersionMatcher(Version version)	Creates a RouteMatcher instance that matches the request resource API version with the provided version.
void	ApiVersionRouterContext.setProtocolVersion(Version protocolVersion)	Sets the protocol API version of the framework used to handle the request.

Uses of Version in org.forgerock.http.swagger

Methods in org.forgerock.http.swagger with parameters of type Version

Modifier and Type	Method	Description
io.swagger.models.Swagger	SwaggerApiProducer.withVersion(io.swagger.models.Swagger descriptor, Version version)

Uses of Version in org.forgerock.json.resource

Methods in org.forgerock.json.resource that return Version

Modifier and Type	Method	Description
Version	ResourceException.getResourceApiVersion()
Version	Response.getResourceApiVersion()	Gets the API version of the resource that the request was routed to.
Version	ActionRequest.getResourceVersion()
Version	CreateRequest.getResourceVersion()
Version	DeleteRequest.getResourceVersion()
Version	PatchRequest.getResourceVersion()
Version	QueryRequest.getResourceVersion()
Version	ReadRequest.getResourceVersion()
Version	Request.getResourceVersion()	Gets the requested API version of the resource.
Version	UpdateRequest.getResourceVersion()
Version	ResourceApiVersionSpecificationFilter.ResourcePathAndVersion.getVersion()	Get the Version corresponding to the resourcePath.

Methods in org.forgerock.json.resource that return types with arguments of type Version

Modifier and Type	Method	Description
Optional<Version>	ResourceApiVersionSpecificationFilter.ResourcePathAndVersionSpecification.matchVersion(Request request)
Optional<Version>	ResourceApiVersionSpecificationFilter.VersionSpecification.matchVersion(Request request)	Test the request to try to find a match based on version configuration.

Methods in org.forgerock.json.resource with parameters of type Version

Modifier and Type	Method	Description
RouteMatcher<Request>	Router.addRoute(Version version, CollectionResourceProvider provider)	Adds a new route to this router for the provided collection resource provider.
RouteMatcher<Request>	Router.addRoute(Version version, RequestHandler handler)	Adds a new route to this router for the provided request handler.
RouteMatcher<Request>	Router.addRoute(Version version, SingletonResourceProvider provider)	Adds a new route to this router for the provided singleton resource provider.
static RouteMatcher<Request>	RouteMatchers.requestResourceApiVersionMatcher(Version version)	Creates a RouteMatcher instance that matches the request resource API version with the provided version.
ResourceApiVersionSpecificationFilter.ResourcePathAndVersionSpecification	ResourceApiVersionSpecificationFilter.ResourcePathAndVersionSpecification.setDefaultVersion(Version defaultVersion)	Set a default Version to use if no matching resource path found for request.
void	ResourceException.setResourceApiVersion(Version version)
void	Response.setResourceApiVersion(Version version)	Sets the API version of the resource that the request was routed to.
ActionRequest	ActionRequest.setResourceVersion(Version resourceVersion)
CreateRequest	CreateRequest.setResourceVersion(Version resourceVersion)
DeleteRequest	DeleteRequest.setResourceVersion(Version resourceVersion)
PatchRequest	PatchRequest.setResourceVersion(Version resourceVersion)
QueryRequest	QueryRequest.setResourceVersion(Version resourceVersion)
ReadRequest	ReadRequest.setResourceVersion(Version resourceVersion)
Request	Request.setResourceVersion(Version resourceVersion)	Sets the requested API version of the resource.
UpdateRequest	UpdateRequest.setResourceVersion(Version resourceVersion)

Constructors in org.forgerock.json.resource with parameters of type Version

Constructor	Description
ResourcePathAndVersion(ResourcePath resourcePath, Version version)	Construct a ResourceApiVersionSpecificationFilter.ResourcePathAndVersion.

Uses of Version in org.forgerock.json.resource.http

Fields in org.forgerock.json.resource.http declared as Version

Modifier and Type	Field	Description
static Version	HttpUtils.DEFAULT_PROTOCOL_VERSION	The default version of the named protocol.
static Version	HttpUtils.PROTOCOL_VERSION_1	Protocol Version 1.
static Version	HttpUtils.PROTOCOL_VERSION_2	Protocol Version 2 - supports upsert on PUT.
static Version	HttpUtils.PROTOCOL_VERSION_2_1	Protocol Version 2.1 - supports defacto standard for create requests when the ID of the created resource is to be allocated by the server, which are represented as a POST to the collection endpoint without an _action query parameter.
static Version	HttpUtils.PROTOCOL_VERSION_2_2	Protocol Version 2.2 - supports _countOnly parameter on query requests to indicate that only a count of the resources matching the supplied query filter on the resource collection are returned.

Uses of Version in org.forgerock.openig.tools

Constructors in org.forgerock.openig.tools with parameters of type Version

Constructor	Description
ApiVersionProtocolHeaderFilter(Version protocolVersion)	Creates a new ApiVersionProtocolHeaderFilter.