Package org.forgerock.caf.authentication.framework

Class AuthenticationFilter.AuthenticationModuleBuilder

java.lang.Object
org.forgerock.caf.authentication.framework.AuthenticationFilter.AuthenticationModuleBuilder
Enclosing class:
AuthenticationFilter
public static final class AuthenticationFilter.AuthenticationModuleBuilder extends Object

Builder class that configures AsyncServerAuthModules and ServerAuthModules.

Usage:


 configureModule(authModuleOne)
         .requestPolicy(authModuleOneRequestPolicy)
         .responsePolicy(authModuleOneResponsePolicy)
         .callbackHandler(authModuleOneHandler)
         .withSettings(authModuleOneSettings);
Since:
2.0.0

  • Constructor Details

    • AuthenticationModuleBuilder

      public AuthenticationModuleBuilder()

  • Method Details

    • configureModule

      public static AuthenticationFilter.AuthenticationModuleBuilder configureModule(AsyncServerAuthModule authModule)
      Creates a builder to configure the provided AsyncServerAuthModule instance.
      Parameters:
      authModule - The AsyncServerAuthModule instance.
      Returns:
      This auth module builder instance.

    • configureModule

      public static AuthenticationFilter.AuthenticationModuleBuilder configureModule(javax.security.auth.message.module.ServerAuthModule authModule)
      Creates a builder to configure the provided ServerAuthModule instance.
      Parameters:
      authModule - The ServerAuthModule instance.
      Returns:
      This auth module builder instance.

    • requestPolicy

      public AuthenticationFilter.AuthenticationModuleBuilder requestPolicy(javax.security.auth.message.MessagePolicy requestPolicy)
      Sets the request MessagePolicy that the auth module should use.
      Parameters:
      requestPolicy - The request MessagePolicy.
      Returns:
      This auth module builder instance.

    • responsePolicy

      public AuthenticationFilter.AuthenticationModuleBuilder responsePolicy(javax.security.auth.message.MessagePolicy responsePolicy)
      Sets the response MessagePolicy that the auth module should use.
      Parameters:
      responsePolicy - The response MessagePolicy.
      Returns:
      This auth module builder instance.

    • callbackHandler

      public AuthenticationFilter.AuthenticationModuleBuilder callbackHandler(CallbackHandler handler)
      Sets the CallbackHandler that the auth module should use.
      Parameters:
      handler - The CallbackHandler instance.
      Returns:
      This auth module builder instance.

    • withSettings

      public AuthenticationFilter.AuthenticationModuleBuilder withSettings(Map<String,Object> settings)
      Sets the settings that contain configuration information that the auth module will use to configure itself.
      Parameters:
      settings - The auth module settings.
      Returns:
      This auth module builder instance.