Package | Description |
---|---|
org.forgerock.http |
Models and manages elements of the Hypertext Transfer Protocol.
|
org.forgerock.http.filter |
Core
Filter implementations. |
org.forgerock.http.handler |
Core
Handler implementations. |
org.forgerock.http.routing |
Provides routing functionality for HTTP requests.
|
org.forgerock.json.resource.http |
JSON resource Commons HTTP Framework integration.
|
org.forgerock.openig.audit.decoration |
[ Deprecated ] Contains the audit decorator and related filter/handler interceptors.
|
org.forgerock.openig.audit.monitor |
[ Deprecated ] Contains a simple monitoring endpoint that returns monitoring
statistics of audited components.
|
org.forgerock.openig.decoration.baseuri |
Contains a decorator which overrides the existing request URI, making requests relative to
a new base URI.
|
org.forgerock.openig.decoration.capture |
Capture decoration classes that prints filters and handlers input and output messages..
|
org.forgerock.openig.decoration.helper |
Contains an abstract decorator dedicated to Filter and Handler.
|
org.forgerock.openig.decoration.timer |
Contains a decorator that log started and elapsed messages when
entering/exiting a Filter or a Handler.
|
org.forgerock.openig.doc |
Samples for those following along with the product documentation.
|
org.forgerock.openig.filter |
Filters the requests and/or responses of HTTP.
|
org.forgerock.openig.filter.oauth2 |
This package contains the OAuth2 Token validation filter that acts as an OAuth 2 Resource Server.
|
org.forgerock.openig.filter.oauth2.challenge |
This package contains handlers implementations that return challenging responses in case of OAuth2 processing errors.
|
org.forgerock.openig.filter.oauth2.client |
OAuth 2.0 Client filter implementation.
|
org.forgerock.openig.filter.oauth2.resolver |
This package defines OpenAM specific logic needed to retrieve an
.AccessToken . |
org.forgerock.openig.handler |
Handles HTTP requests by generating responses.
|
org.forgerock.openig.handler.router |
Provides automated router capability that loads its configurations files (called routes) from a given directory.
|
org.forgerock.openig.handler.saml |
OpenIG SAML support.
|
org.forgerock.openig.heap |
Manages collections or "heaps" of associated objects, initialized from
declarative configuration artifacts.
|
org.forgerock.openig.http |
Integrates with the ForgeRock HTTP Framework.
|
org.forgerock.openig.openam |
OpenAM-specific integration classes.
|
org.forgerock.openig.script |
Scripting support.
|
org.forgerock.openig.uma |
This package contains the UMA (User Managed Access) components used to support the Uma Resource Server role.
|
Modifier and Type | Method and Description |
---|---|
Handler |
HttpApplication.start()
Gets the root
Handler that will handle all HTTP requests. |
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
Filter.filter(Context context,
Request request,
Handler next)
Filters the request and/or response of an exchange.
|
Constructor and Description |
---|
Client(Handler handler)
Creates a new
Client which will route HTTP requests to the
provided Handler using a RootContext allocated during
construction when none is provided. |
Client(Handler handler,
Context defaultContext)
|
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
TransactionIdOutboundFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
TransactionIdInboundFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
OptionsFilter.filter(Context context,
Request request,
Handler next)
Handles all OPTION requests to CREST resources, all other request methods are handled by the
Handler . |
Modifier and Type | Class and Description |
---|---|
class |
HttpClientHandler
An HTTP client for sending requests to remote servers.
|
Modifier and Type | Method and Description |
---|---|
static Handler |
Handlers.chainOf(Handler handler,
Filter... filters)
Creates a
Handler which wraps the provided filters
around the provided target handler. |
static Handler |
Handlers.chainOf(Handler handler,
List<Filter> filters)
Creates a
Handler which wraps the provided filters
around the provided target handler. |
Modifier and Type | Method and Description |
---|---|
static Handler |
Handlers.chainOf(Handler handler,
Filter... filters)
Creates a
Handler which wraps the provided filters
around the provided target handler. |
static Handler |
Handlers.chainOf(Handler handler,
List<Filter> filters)
Creates a
Handler which wraps the provided filters
around the provided target handler. |
Modifier and Type | Class and Description |
---|---|
class |
Router
A router which routes requests based on route matchers.
|
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
ResourceApiVersionRoutingFilter.filter(Context context,
Request request,
Handler next) |
Modifier and Type | Method and Description |
---|---|
static Handler |
CrestHttp.newHttpHandler(ConnectionFactory connectionFactory)
Creates a new JSON resource HTTP Handler with the provided connection
factory and no context factory.
|
static Handler |
CrestHttp.newHttpHandler(ConnectionFactory connectionFactory,
Context parentContext)
Creates a new JSON resource HTTP Handler with the provided connection
factory and a context factory which will always return the provided
request context.
|
static Handler |
CrestHttp.newHttpHandler(ConnectionFactory connectionFactory,
HttpContextFactory contextFactory)
Creates a new JSON resource HTTP Handler with the provided connection
factory and context factory.
|
static Handler |
CrestHttp.newHttpHandler(RequestHandler handler)
Creates a new JSON resource HTTP handler with the provided CREST request handler.
|
Modifier and Type | Method and Description |
---|---|
static ConnectionFactory |
CrestHttp.newConnectionFactory(Handler handler,
URI uri)
Creates a new
ConnectionFactory that map back and forth JSON resource objects to CHF objects. |
static RequestHandler |
CrestHttp.newRequestHandler(Handler handler,
URI uri)
Creates a new
RequestHandler that map back and forth JSON resource objects to CHF objects. |
Modifier and Type | Method and Description |
---|---|
protected Handler |
AuditDecorator.decorateHandler(Handler delegate,
JsonValue decoratorConfig,
Context context)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
protected Handler |
AuditDecorator.decorateHandler(Handler delegate,
JsonValue decoratorConfig,
Context context)
Deprecated.
|
Modifier and Type | Class and Description |
---|---|
class |
MonitorEndpointHandler
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
protected Handler |
BaseUriDecorator.decorateHandler(Handler delegate,
JsonValue decoratorConfig,
Context context) |
Modifier and Type | Method and Description |
---|---|
protected Handler |
BaseUriDecorator.decorateHandler(Handler delegate,
JsonValue decoratorConfig,
Context context) |
Modifier and Type | Method and Description |
---|---|
protected Handler |
CaptureDecorator.decorateHandler(Handler delegate,
JsonValue decoratorConfig,
Context context) |
Modifier and Type | Method and Description |
---|---|
protected Handler |
CaptureDecorator.decorateHandler(Handler delegate,
JsonValue decoratorConfig,
Context context) |
Modifier and Type | Method and Description |
---|---|
protected abstract Handler |
AbstractHandlerAndFilterDecorator.decorateHandler(Handler delegate,
JsonValue decoratorConfig,
Context context)
|
Modifier and Type | Method and Description |
---|---|
protected abstract Handler |
AbstractHandlerAndFilterDecorator.decorateHandler(Handler delegate,
JsonValue decoratorConfig,
Context context)
|
Modifier and Type | Method and Description |
---|---|
protected Handler |
TimerDecorator.decorateHandler(Handler delegate,
JsonValue decoratorConfig,
Context context) |
Modifier and Type | Method and Description |
---|---|
protected Handler |
TimerDecorator.decorateHandler(Handler delegate,
JsonValue decoratorConfig,
Context context) |
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
SampleFilter.filter(Context context,
Request request,
Handler next)
Set a header in the incoming request and in the outgoing response.
|
Modifier and Type | Class and Description |
---|---|
class |
Chain
A chain of zero or more filters and one handler.
|
Modifier and Type | Method and Description |
---|---|
SwitchFilter |
SwitchFilter.addRequestCase(Expression<Boolean> condition,
Handler handler)
Add a request switch case with a condition and the handler to execute if condition yields.
|
SwitchFilter |
SwitchFilter.addResponseCase(Expression<Boolean> condition,
Handler handler)
Add a response switch case with a condition and the handler to execute if condition yields.
|
Promise<Response,NeverThrowsException> |
ThrottlingFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
SwitchFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
StaticRequestFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
SqlAttributesFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
ScriptableFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
RuntimeExceptionFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
LocationHeaderFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
HttpBasicAuthFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
HttpAccessAuditFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
HeaderFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
FileAttributesFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
EntityExtractFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
CryptoHeaderFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
CookieFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
AssignmentFilter.filter(Context context,
Request request,
Handler next) |
Constructor and Description |
---|
Chain(Handler handler,
List<Filter> filters)
Builds a chain of filters that will finally dispatch to the given handler.
|
HttpBasicAuthFilter(Expression<String> username,
Expression<String> password,
Handler failureHandler)
Builds a
HttpBasicAuthFilter with required expressions and error handler. |
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
OAuth2ResourceServerFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
EnforcerFilter.filter(Context context,
Request request,
Handler next) |
Modifier and Type | Class and Description |
---|---|
class |
AuthenticateChallengeHandler
This handler build an authentication challenge to be returned in the
Response Authorization HTTP
header. |
class |
InsufficientScopeChallengeHandler
Builds an error
Response when the request is missing some required scope. |
class |
InvalidRequestChallengeHandler
Builds an error
Response when the request is invalid (missing param, malformed, ...). |
class |
InvalidTokenChallengeHandler
Builds an error
Response when the token extracted from the request is invalid (expired, revoked, ...). |
class |
NoAuthenticationChallengeHandler
Builds an error
Response when the request does not contains any OAuth 2.0 Bearer token. |
Modifier and Type | Method and Description |
---|---|
static Issuer |
Issuer.build(String name,
URI wellKnownUri,
List<String> supportedDomains,
Handler handler)
Builds a new Issuer based on the given well-known URI.
|
Promise<Response,NeverThrowsException> |
OAuth2ClientFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
DiscoveryFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
ClientRegistrationFilter.filter(Context context,
Request request,
Handler next) |
OAuth2ClientFilter |
OAuth2ClientFilter.setFailureHandler(Handler handler)
Sets the handler which will be invoked when authentication fails.
|
OAuth2ClientFilter |
OAuth2ClientFilter.setLoginHandler(Handler handler)
Sets the handler which will be invoked when the user needs to
authenticate.
|
Constructor and Description |
---|
ClientRegistration(String name,
JsonValue config,
Issuer issuer,
Handler registrationHandler)
Creates a Client Registration.
|
ClientRegistrationFilter(Handler registrationHandler,
JsonValue config,
Heap heap,
String suffix)
Creates a new dynamic registration filter.
|
OAuth2ClientFilter(TimeService time,
Heap heap,
JsonValue metadata,
String name,
Handler discoveryHandler,
Expression<String> clientEndpoint)
Constructs an
OAuth2ClientFilter . |
Constructor and Description |
---|
OpenAmAccessTokenResolver(Handler client,
OpenAmAccessToken.Builder builder,
String tokenInfoEndpoint)
Creates a new
OpenAmAccessTokenResolver configured to access the given /oauth2/tokeninfo
OpenAm endpoint. |
OpenAmAccessTokenResolver(Handler client,
TimeService time,
String tokenInfoEndpoint)
Creates a new
OpenAmAccessTokenResolver configured to access the given /oauth2/tokeninfo
OpenAm endpoint. |
Modifier and Type | Class and Description |
---|---|
class |
ClientHandler
Submits requests to remote servers.
|
class |
DesKeyGenHandler
Creates a static response with a generated DES key.
|
class |
DispatchHandler
Dispatches to one of a list of handlers.
|
class |
ScriptableHandler
A scriptable handler.
|
class |
SequenceHandler
Processes a request through a sequence of handlers.
|
class |
StaticResponseHandler
Creates a static HTTP response.
|
class |
WelcomeHandler
Creates a static response containing a simple HTML welcome page.
|
Modifier and Type | Field and Description |
---|---|
static Handler |
Handlers.NO_CONTENT
|
Modifier and Type | Method and Description |
---|---|
DispatchHandler |
DispatchHandler.addBinding(Expression<Boolean> condition,
Handler handler,
URI baseURI)
Binds an expression to the current handler to dispatch to.
|
SequenceHandler |
SequenceHandler.addBinding(Handler handler,
Expression<Boolean> postcondition)
Binds sequenced handlers with sequence processing postconditions.
|
DispatchHandler |
DispatchHandler.addUnconditionalBinding(Handler handler,
URI baseURI)
Adds an unconditional bindings to the handler.
|
Constructor and Description |
---|
ClientHandler(Handler delegate)
Creates a new client handler.
|
Modifier and Type | Class and Description |
---|---|
class |
RouterHandler
Auto-configured
DispatchHandler . |
Modifier and Type | Method and Description |
---|---|
void |
RouterHandler.setDefaultHandler(Handler handler)
Sets the handler which should be invoked when no routes match the
request.
|
Modifier and Type | Class and Description |
---|---|
class |
SamlFederationHandler
The SAML federation handler.
|
Modifier and Type | Method and Description |
---|---|
Handler |
HeapImpl.getHandler()
Returns the
Handler object referenced by the handler top-level attribute. |
Modifier and Type | Method and Description |
---|---|
Handler |
GatewayHttpApplication.start() |
Modifier and Type | Method and Description |
---|---|
static Response |
Responses.blockingCall(Handler handler,
Context context,
Request request)
Executes a blocking call with the given
handler , context and request , returning
the Response when fully available. |
EndpointRegistry.Registration |
EndpointRegistry.register(String name,
Handler handler)
Registers a new endpoint under the given
name . |
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
TokenTransformationFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
SsoTokenFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
PolicyEnforcementFilter.filter(Context context,
Request request,
Handler next) |
Constructor and Description |
---|
PolicyEnforcementFilter(URI baseUri,
Handler policiesHandler,
Duration cacheMaxExpiration)
Creates a new OpenAM enforcement filter.
|
TokenTransformationFilter(Handler handler,
URI endpoint,
Expression<String> idToken,
Expression<String> target)
Constructs a new TokenTransformationFilter transforming the OpenID Connect id_token from
idToken
into a SAML 2.0 Assertions structure (into target ). |
Modifier and Type | Method and Description |
---|---|
protected Promise<Response,NeverThrowsException> |
AbstractScriptableHeapObject.runScript(Bindings bindings,
Handler next,
Context context)
Runs the compiled script using the provided bindings and optional
forwarding handler.
|
void |
AbstractScriptableHeapObject.setClientHandler(Handler clientHandler)
Sets the HTTP client handler which should be made available to scripts.
|
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
UmaResourceServerFilter.filter(Context context,
Request request,
Handler next) |
Constructor and Description |
---|
UmaResourceServerFilter(UmaSharingService umaService,
Handler protectionApiHandler,
String realm)
Constructs a new UmaResourceServerFilter.
|
UmaSharingService(Handler protectionApiHandler,
List<org.forgerock.openig.uma.ShareTemplate> templates,
URI authorizationServer,
String clientId,
String clientSecret)
Constructs an UmaSharingService bound to the given
authorizationServer and dedicated to protect resource
sets described by the given templates . |
Copyright 2011-2015 ForgeRock AS.