Package org.forgerock.openam.rest

This package contains classes for all the REST framework classes responsible for determining the location of request REST endpoints.

Interface Summary

Interface	Description
ResourceRouter	A Router which allows for CREST routes to be registered fluently.
RestRouteProvider	A provider interface that allows CREST routes to be registered on the root and realm REST Router.
Routers.VersionableResourceRoute	A route that is being registered fluently, which can be versioned.
Routers.VersionableServiceRoute
ServiceRouter	A Router which allows for CHF REST routes to be registered fluently.

Class Summary

Class	Description
AbstractRestRouteProvider	An abstract implementation of the RestRouteProvider that provides methods for adding resource (CREST) endpoints and service (CHF REST) endpoints on either the root router or realm router.
AuthenticationEnforcer	A Filter implementation which can be configured to enforce whether authentication is required to access the endpoint.
AuthnRequestUtils	Responsible for performing common operations based on the SSOToken stored in the request headers.
ContextFilter	A Filter implementation that injects the required OpenAM contexts into the context hierarchy.
DescriptorUtils	Utility methods for dealing with API Descriptors.
ElevatedConnectionFactoryWrapper	CREST connection factory wrapper that elevates in coming contexts with an admin user for the duration of the connection.
LocalSSOTokenSessionModule	A local implementation of a SSOToken Session module, that is designed to be deployed in an OpenAM deployment not remotely, i.e. protecting resources on another server which uses OpenAM for authentication.
OptionalSSOTokenSessionModule	An AuthModule that will validate a SSOToken if it's present, else will allow the request through anyway.
PassThroughFilter	A Filter implementation which enforces that no authentication is required to access the endpoint.
RealmAwareResource	Resource capable of determining a realm from a Context.
RealmContext	A CREST Context for holding realm information from the Request.
RealmContextFilter	Deprecated.
RealmRoutingFactory	Factory for providing realm routers for CHF and CREST.
RestConstants	Constants for use with creating CREST services.
RestEndpointServlet	Root Servlet for all REST endpoint requests, which are then passed onto the correct underlying servlet, either CREST for Resource endpoints or Restlet for Service endpoints.
RestGuiceModule	Guice module for bindings for the REST routers and route registration.
RestHttpRouteProvider	HTTP route provider for the REST (/json) endpoints.
RestUtils	A collection of ForgeRock-REST based utility functions.
Routers	Class containing methods for creating fluent route registration routers.
Routers.ResourceRoute	A route that is being registered fluently.
Routers.ServiceRoute
Routers.VersionedResourceRoute	A route that is being registered fluently, which requires versioning.
Routers.VersionedServiceRoute
ServerContextHelper	This class contains method that help with getting information out of ServerContexts objects.
SSOTokenFactory	Responsible for generating SSOTokens.
SubjectAwareResource	Resource capable of determining a subject from a Context.
VersionBehaviourConfigListener	A ServiceListener to listen for changes to the default version behaviour configuration and update a VersionedRouter.