Package org.forgerock.http

Interface Filter

All Known Implementing Classes:
AbstractConditionAdviceFilter, AllowOnlyFilter, AmSessionIdleTimeoutFilter, ApiVersionProtocolHeaderFilter, AssignmentFilter, CapturedUserPasswordFilter, CdSsoConditionAdviceFilter, CertificateThumbprintFilter, CircuitBreakerFilter, ClientRegistrationFilter, ClientSecretBasicAuthenticationFilter, ClientSecretPostAuthenticationFilter, ConditionalFilter, ConditionEnforcementFilter, CookieFilter, CorsFilter, CrossDomainSingleSignOnFilter, CsrfFilter, DataPreservationFilter, DateHeaderFilter, DiscoveryFilter, EncryptedPrivateKeyJwtClientAuthenticationFilter, EntityExtractFilter, FapiInteractionIdFilter, FileAttributesFilter, ForwardedRequestFilter, FragmentFilter, GrantSwapJwtAssertionOAuth2ClientFilter, HeaderFilter, HeadlessAuthenticationFilter, HttpAccessAuditFilter, HttpBasicAuthFilter, InsertSsoTokenHeaderFilter, InvalidCallerTokenDetectionFilter, JwtBuilderFilter, JwtValidationFilter, LocationHeaderFilter, LogAttachedExceptionFilter, MdcRouteIdFilter, MetricsFilter, NullResponseFilter, OAuth2ClientFilter, OAuth2TokenExchangeFilter, OpenApiRequestFilter, OptionsFilter, PingOneProtectEvaluationFilter, PingOneProtectFeedbackFilter, PolicyEnforcementFilter, PrivateKeyJwtClientAuthenticationFilter, ResourceApiVersionRoutingFilter, ResourceApiVersionRoutingFilter, ResourceServerFilter, RetryFilter, ScriptableFilter, SessionInfoFilter, SetCookieUpdateFilter, SidebandApiFilter, SingleSignOnFilter, SplitCookieFilter, SqlAttributesFilter, StaticRequestFilter, SwitchFilter, ThrottlingFilter, TokenTransformationFilter, TransactionIdInboundFilter, TransactionIdOutboundFilter, UmaResourceServerFilter, UriPathRewriteFilter, UserProfileFilter
Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface public interface Filter
Filters the request and/or response of an HTTP exchange.

  • Method Details

    • filter

      Promise<Response,NeverThrowsException> filter(Context context, Request request, Handler next)
      Filters the request and/or response of an exchange. To pass the request to the next filter or handler in the chain, the filter calls next.handle(context, request).

      This method may elect not to pass the request to the next filter or handler, and instead handle the request itself. It can achieve this by merely avoiding a call to next.handle(context, request) and creating its own response object. The filter is also at liberty to replace a response with another of its own by intercepting the response returned by the next handler.

      Parameters:
      context - The request context.
      request - The request.
      next - The next filter or handler in the chain to handle the request.
      Returns:
      A Promise representing the response to be returned to the client.