Uses of Class
org.forgerock.services.routing.RouteMatcher
Packages that use RouteMatcher
Package
Description
Provides routing functionality for HTTP requests.
Classes and interfaces for core types including connections, request
handlers, resources, and their exceptions.
This package provides a simple framework for implementing routers.
-
Uses of RouteMatcher in org.forgerock.http.routing
Methods in org.forgerock.http.routing that return RouteMatcherModifier and TypeMethodDescriptionstatic RouteMatcher<Request>
RouteMatchers.requestResourceApiVersionMatcher
(Version version) Creates aRouteMatcher
instance that matches the request resource API version with the provided version.static RouteMatcher<Request>
RouteMatchers.requestUriMatcher
(RoutingMode mode, String template) Creates aRouteMatcher
instance that matchesRequest
s with the provided mode and template.static RouteMatcher<Version>
RouteMatchers.resourceApiVersionMatcher
(Version version) Creates aRouteMatcher
instance that matches the request resource API version with the provided version.static RouteMatcher<Request>
RouteMatchers.selfApiMatcher()
A matcher to check if the request is for all versions of the API descriptor of the current path.static RouteMatcher<List<String>>
RouteMatchers.uriMatcher
(RoutingMode mode, String template) Creates aRouteMatcher
instance that matchesResourcePath
s with the provided mode and template.protected RouteMatcher<Request>
Router.uriMatcher
(RoutingMode mode, String pattern) Methods in org.forgerock.http.routing that return types with arguments of type RouteMatcherModifier and TypeMethodDescriptionprotected Pair<RouteMatcher<Request>,
Handler> Router.getSelfApiHandler()
-
Uses of RouteMatcher in org.forgerock.json.resource
Methods in org.forgerock.json.resource that return RouteMatcherModifier and TypeMethodDescriptionRouter.addRoute
(RoutingMode mode, Router.UriTemplate uriTemplate, RequestHandler handler) Adds a new route to this router for the provided request handler.Router.addRoute
(Version version, CollectionResourceProvider provider) Adds a new route to this router for the provided collection resource provider.Router.addRoute
(Version version, RequestHandler handler) Adds a new route to this router for the provided request handler.Router.addRoute
(Version version, SingletonResourceProvider provider) Adds a new route to this router for the provided singleton resource provider.Router.addRoute
(Router.UriTemplate uriTemplate, CollectionResourceProvider provider) Adds a new route to this router for the provided collection resource provider.Router.addRoute
(Router.UriTemplate uriTemplate, SingletonResourceProvider provider) Adds a new route to this router for the provided singleton resource provider.static RouteMatcher<Request>
RouteMatchers.requestResourceApiVersionMatcher
(Version version) Creates aRouteMatcher
instance that matches the request resource API version with the provided version.static RouteMatcher<Request>
RouteMatchers.requestUriMatcher
(RoutingMode mode, String template) Creates aRouteMatcher
instance that matchesRequest
s with the provided mode and template.protected RouteMatcher<Request>
Router.uriMatcher
(RoutingMode mode, String pattern) Methods in org.forgerock.json.resource that return types with arguments of type RouteMatcherModifier and TypeMethodDescriptionprotected Pair<RouteMatcher<Request>,
RequestHandler> Router.getSelfApiHandler()
-
Uses of RouteMatcher in org.forgerock.services.routing
Subclasses of RouteMatcher in org.forgerock.services.routingModifier and TypeClassDescriptionclass
A route matcher that delegates to a provided route matcher.Fields in org.forgerock.services.routing declared as RouteMatcherModifier and TypeFieldDescriptionprotected final RouteMatcher<R>
AbstractRouter.thisRouterUriMatcher
Matches the current route.Methods in org.forgerock.services.routing that return RouteMatcherModifier and TypeMethodDescriptionprotected abstract RouteMatcher<R>
AbstractRouter.uriMatcher
(RoutingMode mode, String pattern) Create a URI matcher suitable for the request type<R>
.Methods in org.forgerock.services.routing that return types with arguments of type RouteMatcherModifier and TypeMethodDescriptionprotected final Map<RouteMatcher<R>,
H> AbstractRouter.getRoutes()
Gets all registered routes on this router.protected abstract Pair<RouteMatcher<R>,
H> AbstractRouter.getSelfApiHandler()
Return aDescribable
handler that returns thisAbstractRouter
's internal api description from theDescribable.handleApiRequest(Context, Object)
method.Methods in org.forgerock.services.routing with parameters of type RouteMatcherModifier and TypeMethodDescriptionfinal T
AbstractRouter.addRoute
(RouteMatcher<R> matcher, H handler) Adds a new route to this router for the provided handler.final boolean
AbstractRouter.removeRoute
(RouteMatcher<R>... routes) Removes one or more routes from this router.Constructors in org.forgerock.services.routing with parameters of type RouteMatcherModifierConstructorDescriptionDelegatingRouteMatcher
(RouteMatcher<R> delegate) Create a new route matcher, delegating to the provided delegate.