Uses of Interface
org.forgerock.http.Filter
-
Packages that use Filter Package Description org.forgerock.http.filter CoreFilter
implementations.org.forgerock.http.handler CoreHandler
implementations.org.forgerock.http.routing Provides routing functionality for HTTP requests.org.forgerock.http.swagger Classes to support OpenAPI API Descriptions using Swagger.org.forgerock.json.resource Classes and interfaces for core types including connections, request handlers, resources, and their exceptions.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 time elapsed in a Filter or a Handler.org.forgerock.openig.filter Filters the requests and/or responses of HTTP.org.forgerock.openig.filter.finance Support for financial APIs (Open Banking, PSD2, Berlin Group, ...).org.forgerock.openig.filter.oauth2.client OAuth 2.0 Client filter implementation.org.forgerock.openig.filter.throttling This package contains the components used to implement a throttling rate support.org.forgerock.openig.handler.router Provides automated router capability that loads its configurations files (called routes) from a given directory.org.forgerock.openig.openam Integration classes specifically for ForgeRock Access Management.org.forgerock.openig.sql Provides SQL and JDBC support. -
-
Uses of Filter in org.forgerock.http.filter
Classes in org.forgerock.http.filter that implement Filter Modifier and Type Class Description class
OptionsFilter
Filter
which handles OPTION HTTP requests to CREST resources.class
TransactionIdInboundFilter
This filter is responsible to create theTransactionIdContext
in the context's chain.class
TransactionIdOutboundFilter
This filter aims to create a sub-transaction's id and inserts that value as a header of the request.Methods in org.forgerock.http.filter that return Filter Modifier and Type Method Description static Filter
Filters. chainOf(List<Filter> filters)
Creates aFilter
which encapsulates the provided filters into a singleFilter
.static Filter
Filters. chainOf(Filter... filters)
Creates aFilter
which encapsulates the provided filters into a singleFilter
.static Filter
Filters. conditionalFilter(Filter delegate, BiPredicate<Context,Request> condition)
Create a Filter decorator that only delegates to the decorated filter if the supplied predicate returns true.static Filter
Filters. newBearerTokenAuthFilter(SecretReference<GenericSecret> tokenReference)
Creates an authenticationFilter
that puts a Bearer Authorization header in the request.static Filter
Filters. newBearerTokenAuthFilterWithoutRetry(SecretReference<GenericSecret> tokenReference)
Creates an authenticationFilter
that puts a Bearer Authorization header in the request.static Filter
Filters. newHttpBasicAuthenticationFilter(String username, String password)
Deprecated.static Filter
Filters. newHttpBasicAuthenticationFilter(String username, String password, Charset charset)
Deprecated.static Filter
Filters. newHttpBasicAuthenticationFilter(String username, SecretReference<GenericSecret> password)
Creates an authenticationFilter
that put a Basic Authorization header in the request.static Filter
Filters. newHttpBasicAuthenticationFilter(String username, SecretReference<GenericSecret> password, Charset charset)
Creates an authenticationFilter
that put a Basic Authorization header in the request.static Filter
Filters. newOptionsFilter(String... allowedMethods)
Creates aFilter
which handles HTTP OPTIONS method requests.static Filter
Filters. newSessionFilter(SessionManager sessionManager)
Creates a sessionFilter
that will use the providedSessionManager
to manage the users session.static Filter
Filters. newUrlEncodedHttpBasicAuthFilter(String username, SecretReference<GenericSecret> password)
Creates an authenticationFilter
that put a Basic Authorization header in the request.static Filter
Filters. requestCopyFilter()
Methods in org.forgerock.http.filter with parameters of type Filter Modifier and Type Method Description static Filter
Filters. chainOf(Filter... filters)
Creates aFilter
which encapsulates the provided filters into a singleFilter
.static Filter
Filters. conditionalFilter(Filter delegate, BiPredicate<Context,Request> condition)
Create a Filter decorator that only delegates to the decorated filter if the supplied predicate returns true.Method parameters in org.forgerock.http.filter with type arguments of type Filter Modifier and Type Method Description static Filter
Filters. chainOf(List<Filter> filters)
Creates aFilter
which encapsulates the provided filters into a singleFilter
. -
Uses of Filter in org.forgerock.http.handler
Methods in org.forgerock.http.handler with parameters of type Filter Modifier and Type Method Description static DescribableHandler
Handlers. chainOf(Handler handler, Filter... filters)
Creates aHandler
which wraps the provided filters around the provided target handler.static DescribableHandler
Handlers. filtered(Handler handler, Filter filter)
Creates a "filtered handler" instance.Method parameters in org.forgerock.http.handler with type arguments of type Filter Modifier and Type Method Description static DescribableHandler
Handlers. chainOf(Handler handler, List<Filter> filters)
Creates aHandler
which wraps the provided filters around the provided target handler. -
Uses of Filter in org.forgerock.http.routing
Classes in org.forgerock.http.routing that implement Filter Modifier and Type Class Description class
ResourceApiVersionRoutingFilter
API Version routing filter which creates aApiVersionRouterContext
which contains the default routing behaviour when the Accept-API-Version header is set on the request.Methods in org.forgerock.http.routing that return Filter Modifier and Type Method Description static Filter
RouteMatchers. resourceApiVersionContextFilter(ResourceApiVersionBehaviourManager behaviourManager)
Creates aFilter
which MUST be placed, in the route, before any API Version routing takes place. -
Uses of Filter in org.forgerock.http.swagger
Classes in org.forgerock.http.swagger that implement Filter Modifier and Type Class Description class
OpenApiRequestFilter
This filter looks for the query parameter {code _api} : if present then it returns the API description of the downstream handlers, otherwise the request is processed as expected. -
Uses of Filter in org.forgerock.json.resource
Classes in org.forgerock.json.resource that implement Filter Modifier and Type Class Description class
ResourceApiVersionRoutingFilter
API Version routing filter which creates aApiVersionRouterContext
which contains the default routing behaviour when the Accept-API-Version header is set on the request. -
Uses of Filter in org.forgerock.openig.decoration.baseuri
Methods in org.forgerock.openig.decoration.baseuri with parameters of type Filter Modifier and Type Method Description protected DecorationHandle
BaseUriDecorator. decorateFilter(Filter delegate, JsonValue decoratorConfig, Context context)
-
Uses of Filter in org.forgerock.openig.decoration.capture
Methods in org.forgerock.openig.decoration.capture with parameters of type Filter Modifier and Type Method Description protected DecorationHandle
CaptureDecorator. decorateFilter(Filter delegate, JsonValue decoratorConfig, Context context)
-
Uses of Filter in org.forgerock.openig.decoration.helper
Methods in org.forgerock.openig.decoration.helper with parameters of type Filter Modifier and Type Method Description protected abstract DecorationHandle
AbstractHandlerAndFilterDecorator. decorateFilter(Filter delegate, JsonValue decoratorConfig, Context context)
-
Uses of Filter in org.forgerock.openig.decoration.timer
Methods in org.forgerock.openig.decoration.timer with parameters of type Filter Modifier and Type Method Description protected DecorationHandle
TimerDecorator. decorateFilter(Filter delegate, JsonValue decoratorConfig, Context context)
-
Uses of Filter in org.forgerock.openig.filter
Classes in org.forgerock.openig.filter that implement Filter Modifier and Type Class Description class
AssignmentFilter
Conditionally assigns values to expressions before and after the request is handled.class
ConditionalFilter
This filter conditionally executes a delegate Filter given the result of a 'condition' function.class
ConditionEnforcementFilter
AnConditionEnforcementFilter
makes sure that the handledRequest
verifies a condition.class
CookieFilter
Suppresses, relays and manages cookies.class
CryptoHeaderFilter
Encrypts and decrypts header fields.class
DateHeaderFilter
This filter inserts a Date header into the response if it is not present.class
EntityExtractFilter
Extracts regular expression patterns from a message entity.class
FileAttributesFilter
Retrieves and exposes a record from a delimiter-separated file.class
HeaderFilter
Removes headers from and adds headers to a message.class
HttpAccessAuditFilter
This filter aims to send some access audit events to the AuditService managed as a CREST handler.class
HttpBasicAuthFilter
Performs authentication through the HTTP Basic authentication scheme.class
JwtBuilderFilter
The JwtBuilderFilter collects data from template and puts the name-value pairs into a JWT structure.class
LocationHeaderFilter
Rewrites Location headers on responses that generate a redirect that would take the user directly to the application being proxied rather than taking the user through the Identity Gateway.class
LogAttachedExceptionFilter
ALogAttachedExceptionFilter
prints attached exceptions to filtered responses.class
MdcRouteIdFilter
AMdcRouteIdFilter
aims to prepare the current thread with SLF4J MDC information about the current route.class
MetricsFilter
Collect request processing metrics.class
RetryFilter
ARetryFilter
is responsible for re-executing the incoming request should it fail with a runtime exception.class
RuntimeExceptionFilter
This filter aims to guarantee the caller that it will always get a Response to process, even if the next returns a promise completed with aRuntimeException
, or even if aRuntimeException
is thrown.class
ScriptableFilter
A scriptable filter.class
StaticRequestFilter
Creates a new request and send it down the next handler (effectively replacing the previous request).class
SwitchFilter
Conditionally diverts the request to another handler.Constructors in org.forgerock.openig.filter with parameters of type Filter Constructor Description ConditionalFilter(Filter delegate, boolean condition)
Constructs aConditionalFilter
.ConditionalFilter(Filter delegate, AsyncFunction<ContextAndRequest,Boolean,Exception> condition)
Constructs aConditionalFilter
. -
Uses of Filter in org.forgerock.openig.filter.finance
Classes in org.forgerock.openig.filter.finance that implement Filter Modifier and Type Class Description class
FapiInteractionIdFilter
AFapiInteractionIdFilter
is responsible to manage theFapiInteractionIdFilter.FAPI_INTERACTION_ID
header value. -
Uses of Filter in org.forgerock.openig.filter.oauth2.client
Classes in org.forgerock.openig.filter.oauth2.client that implement Filter Modifier and Type Class Description class
ClientRegistrationFilter
The client registration filter is the way to dynamically register an OpenID Connect Relying Party with the End-User's OpenID Provider.class
DiscoveryFilter
In order for an OpenID Connect Relying Party to utilize OpenID Connect services for an End-User, the RP needs to know where the OpenID Provider is.class
IdTokenValidationFilter
AnIdTokenValidationFilter
validates the givenidToken
according to the provided configuration.class
OAuth2ClientFilter
A filter which is responsible for authenticating the end-user using OAuth 2.0 delegated authorization. -
Uses of Filter in org.forgerock.openig.filter.throttling
Classes in org.forgerock.openig.filter.throttling that implement Filter Modifier and Type Class Description class
ThrottlingFilter
This filter applies a rate limitation to incoming requests : over the limit requests will be rejected with a 429 (Too Many Requests) response, others will pass through. -
Uses of Filter in org.forgerock.openig.handler.router
Classes in org.forgerock.openig.handler.router that implement Filter Modifier and Type Class Description class
NullResponseFilter
This class is used to filter null responses. -
Uses of Filter in org.forgerock.openig.openam
Classes in org.forgerock.openig.openam that implement Filter Modifier and Type Class Description class
AbstractConditionAdviceFilter
AbstractFilter
base class providing policy condition advice support.class
CapturedUserPasswordFilter
TheCapturedUserPasswordFilter
is responsible for retrieving the user password from AM and to decrypt it.class
CdSsoConditionAdviceFilter
This filter handles any condition advices returned from AM during a policy evaluation, which one will depend on the policy.class
CrossDomainSingleSignOnFilter
This filter verifies the presence of a JWT authentication token in the configured cookie name: If the JWT is present then its validity is checked and the request is forwarded to the next handler. If the JWT is not present, then the user-agent is redirected to Access Management via its OAuth2 authorization endpoint, to obtain user authentication.class
DeprecatedUserProfileFilter
Deprecated.Since 6.5.class
PolicyEnforcementFilter
This filter requests policy decisions from Access Management which evaluates the original URI based on the context and the policies configured, and according to the decisions, allows or denies the current request.class
SessionInfoFilter
This filter requests user session info from Access Management and stores it on the context for later use.class
SingleSignOnFilter
This filter verifies the presence of a SSOToken in the given cookie name.class
TokenTransformationFilter
ATokenTransformationFilter
is responsible for transforming a token issued by Access Management into a token of another type.class
UserProfileFilter
This filter requests user profile attributes from Access Management and stores them in the context for later use. -
Uses of Filter in org.forgerock.openig.sql
Classes in org.forgerock.openig.sql that implement Filter Modifier and Type Class Description class
SqlAttributesFilter
Executes a SQL query through a prepared statement and exposes its first result.
-