Uses of Interface
org.forgerock.http.Filter

Packages that use Filter

Package	Description
org.forgerock.caf.authentication.framework	This package defines the authentication framework classes for the authentication of messages via authentication contexts and modules.
org.forgerock.http.filter	Core Filter implementations.
org.forgerock.http.filter.cors	Support for CORS.
org.forgerock.http.handler	Core Handler implementations.
org.forgerock.http.oauth2	This package provides APIs for OAuth 2.0 services implementations.
org.forgerock.http.routing	Provides routing functionality for HTTP requests.
org.forgerock.json.resource	Classes and interfaces for core types including connections, request handlers, resources, and their exceptions.
org.forgerock.oauth.clients.oauth2	OAuth 2.0 ForgeRock Client Implementation.

Uses of Filter in org.forgerock.caf.authentication.framework

Classes in org.forgerock.caf.authentication.framework that implement Filter

Modifier and Type	Class	Description
final class	AuthenticationFilter	A HTTP Filter that will protect all downstream filters or handlers.

Uses of Filter in org.forgerock.http.filter

Classes in org.forgerock.http.filter that implement Filter

Modifier and Type	Class	Description
final class	CsrfFilter	A generic filter for preventing cross-site request forgery (CSRF) attacks when using cookie-based authentication.
final class	OptionsFilter	Filter which handles OPTION HTTP requests to CREST resources.
class	TransactionIdInboundFilter	This filter is responsible to create the TransactionIdContext 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 a Filter which encapsulates the provided filters into a single Filter.
static Filter	Filters.chainOf(Filter... filters)	Creates a Filter which encapsulates the provided filters into a single Filter.
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.newAsyncSessionFilter(AsyncSessionManager sessionManager)	Creates a session Filter that will use the provided AsyncSessionManager to manage the users session.
static Filter	Filters.newBearerTokenAuthFilter(SecretReference<GenericSecret> tokenReference)	Creates an authentication Filter that puts a Bearer Authorization header in the request.
static Filter	Filters.newBearerTokenAuthFilterWithoutRetry(SecretReference<GenericSecret> tokenReference)	Creates an authentication Filter that puts a Bearer Authorization header in the request.
static Filter	Filters.newDefaultCsrfFilter(String cookieName)	Creates a filter that protects against cross-site request forgery (CSRF) attacks when using cookies for authentication.
static Filter	Filters.newHttpBasicAuthenticationFilter(String username, SecretReference<GenericSecret> password)	Deprecated, for removal: This API element is subject to removal in a future version. use Filters.newHttpBasicAuthenticationFilter(CredentialPair) instead
static Filter	Filters.newHttpBasicAuthenticationFilter(String username, SecretReference<GenericSecret> password, Charset charset)	Deprecated, for removal: This API element is subject to removal in a future version. use Filters.newHttpBasicAuthenticationFilter(CredentialPair, Charset) instead
static Filter	Filters.newHttpBasicAuthenticationFilter(CredentialPair<GenericSecret> credentialPair)	Creates an authentication Filter that puts a Basic Authorization header in the request.
static Filter	Filters.newHttpBasicAuthenticationFilter(CredentialPair<GenericSecret> credentialPair, Charset charset)	Creates an authentication Filter that puts a Basic Authorization header in the request.
static Filter	Filters.newOptionsFilter(String... allowedMethods)	Creates a Filter which handles HTTP OPTIONS method requests.
static Filter	Filters.newSessionFilter(SessionManager sessionManager)	Deprecated.
static Filter	Filters.newUrlEncodedHttpBasicAuthFilter(String username, SecretReference<GenericSecret> password)	Deprecated, for removal: This API element is subject to removal in a future version. use Filters.newUrlEncodedHttpBasicAuthFilter(CredentialPair) instead
static Filter	Filters.newUrlEncodedHttpBasicAuthFilter(CredentialPair<GenericSecret> credentialPair)	Creates an authentication Filter that put a Basic Authorization header in the request.
static Filter	Filters.requestCopyFilter()	Creates a Filter which creates a defensive copy of the Request - on which the chain of execution will be based on.

Methods in org.forgerock.http.filter with parameters of type Filter

Modifier and Type	Method	Description
static Filter	Filters.chainOf(Filter... filters)	Creates a Filter which encapsulates the provided filters into a single Filter.
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 a Filter which encapsulates the provided filters into a single Filter.

Uses of Filter in org.forgerock.http.filter.cors

Classes in org.forgerock.http.filter.cors that implement Filter

Modifier and Type	Class	Description
class	CorsFilter	This filters implements the resource processing of the CORS protocol.

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 a Handler 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 a Handler which wraps the provided filters around the provided target handler.

Uses of Filter in org.forgerock.http.oauth2

Classes in org.forgerock.http.oauth2 that implement Filter

Modifier and Type	Class	Description
class	ClientSecretBasicAuthenticationFilter	Deprecated. since 26.2.
class	ClientSecretPostAuthenticationFilter	A Filter implementation to add the credentials to request body for authenticating as per the OAuth 2.0 Authorization Framework specification.
class	EncryptedPrivateKeyJwtClientAuthenticationFilter	A Filter implementation to add the client credentials to request as signed then encrypted private key jwt as per the OpenID Connect Client Authentication specification.
class	PrivateKeyJwtClientAuthenticationFilter	A Filter implementation for adding the client credentials to request as signed private key jwt as per the OpenID Connect Client Authentication specification.
class	ResourceServerFilter	Validates a Request that contains an OAuth 2.0 access token.

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 a ApiVersionRouterContext 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 a Filter which MUST be placed, in the route, before any API Version routing takes place.

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 a ApiVersionRouterContext which contains the default routing behaviour when the Accept-API-Version header is set on the request.

Uses of Filter in org.forgerock.oauth.clients.oauth2

Methods in org.forgerock.oauth.clients.oauth2 that return Filter

Modifier and Type	Method	Description
Filter	OAuth2ClientConfiguration.getAuthenticationFilter()	Gets the filter that will update the request with authentication information on the request sent to the OAuth provider.

Methods in org.forgerock.oauth.clients.oauth2 with parameters of type Filter

Modifier and Type	Method	Description
T	OAuth2ClientConfiguration.Builder.withClientAuthenticationFilter(Filter filter)	Sets the client authentication filter capable of sending authentication information to the OAuth provider.