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

Packages that use Version

Package	Description
org.forgerock.api	ForgeRock API Descriptor models, builders, and utilities.
org.forgerock.api.models	ForgeRock API Descriptor models.
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.json.resource	Classes and interfaces for core types including connections, request handlers, resources, and their exceptions.
org.forgerock.selfservice.stages.reset	This package contains a common reset password stage implementation.
org.forgerock.selfservice.stages.user	This package contains a common user related stage implementation.

Uses of Version in org.forgerock.api

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

Modifier and Type	Method	Description
ApiDescription	CrestApiProducer.withVersion(ApiDescription api, Version version)

Constructors in org.forgerock.api with parameters of type Version

Constructor	Description
DuplicateDescriptionException(Version version)	Construct a new exception for the given version with an unknown path.
DuplicateDescriptionException(Version version, String path)	Construct a new exception for the given path and version.
DuplicateDescriptionException(Version version, String path, Throwable cause)	Construct a new exception for the given path and version.

Uses of Version in org.forgerock.api.models

Fields in org.forgerock.api.models declared as Version

Modifier and Type	Field	Description
static Version	VersionedPath.UNVERSIONED	Version 0.0 represents null/empty, for when resource versions are not required by an API (e.g., OpenIDM).

Methods in org.forgerock.api.models that return types with arguments of type Version

Modifier and Type	Method	Description
protected Map<Version,Resource>	VersionedPath.getPaths()	Gets a Map of versions to Resources.
Set<Version>	VersionedPath.getVersions()	Returns all resource-versions on this path.

Methods in org.forgerock.api.models with parameters of type Version

Modifier and Type	Method	Description
Resource	VersionedPath.get(Version version)	Gets the Resource for a given version.
VersionedPath.Builder	VersionedPath.Builder.put(Version version, Resource resource)	Adds a resource-version.

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.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.selfservice.stages.reset

Methods in org.forgerock.selfservice.stages.reset that return Version

Modifier and Type	Method	Description
Version	ResetStageConfig.getResourceVersion()	Gets the Resource Version to use for the identity service.

Methods in org.forgerock.selfservice.stages.reset with parameters of type Version

Modifier and Type	Method	Description
ResetStageConfig	ResetStageConfig.setResourceVersion(Version resourceVersion)	Sets the Resource Version to use for the identity service.

Uses of Version in org.forgerock.selfservice.stages.user

Methods in org.forgerock.selfservice.stages.user that return Version

Modifier and Type	Method	Description
Version	UserQueryConfig.getResourceVersion()	Gets the resource version fields to be used when looking up the user.

Methods in org.forgerock.selfservice.stages.user with parameters of type Version

Modifier and Type	Method	Description
UserQueryConfig	UserQueryConfig.setResourceVersion(Version resourceVersion)	Sets the resource version fields to be used when looking up the user.