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

Packages that use Version

Package	Description
org.forgerock.api
org.forgerock.api.models
org.forgerock.http
org.forgerock.http.header
org.forgerock.http.routing
org.forgerock.http.swagger
org.forgerock.json.resource
org.forgerock.json.resource.http

Uses of Version in org.forgerock.api

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

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

Uses of Version in org.forgerock.api.models

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

Modifier and Type	Field and 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 and 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 and 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 and 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 and Description
Version	ContentApiVersionHeader.getProtocolVersion() Gets the protocol version of the content of the returned content.
Version	AcceptApiVersionHeader.getProtocolVersion() Gets the acceptable protocol version.
Version	ContentApiVersionHeader.getResourceVersion() Gets the resource version of the returned content.
Version	AcceptApiVersionHeader.getResourceVersion() Gets the acceptable resource version.

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

Modifier and Type	Method and 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 and 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 and 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 and 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 and 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 and 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 and Description
Version	Response.getResourceApiVersion() Gets the API version of the resource that the request was routed to.
Version	ResourceException.getResourceApiVersion()
Version	UpdateRequest.getResourceVersion()
Version	Request.getResourceVersion() Gets the requested API version of the resource.
Version	ReadRequest.getResourceVersion()
Version	QueryRequest.getResourceVersion()
Version	PatchRequest.getResourceVersion()
Version	DeleteRequest.getResourceVersion()
Version	CreateRequest.getResourceVersion()
Version	ActionRequest.getResourceVersion()

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

Modifier and Type	Method and 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.
void	Response.setResourceApiVersion(Version version) Sets the API version of the resource that the request was routed to.
void	ResourceException.setResourceApiVersion(Version version)
UpdateRequest	UpdateRequest.setResourceVersion(Version resourceVersion)
Request	Request.setResourceVersion(Version resourceVersion) Sets the requested API version of the resource.
ReadRequest	ReadRequest.setResourceVersion(Version resourceVersion)
QueryRequest	QueryRequest.setResourceVersion(Version resourceVersion)
PatchRequest	PatchRequest.setResourceVersion(Version resourceVersion)
DeleteRequest	DeleteRequest.setResourceVersion(Version resourceVersion)
CreateRequest	CreateRequest.setResourceVersion(Version resourceVersion)
ActionRequest	ActionRequest.setResourceVersion(Version resourceVersion)

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

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

Modifier and Type	Field and 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.