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
AsyncServerAuthModule
s andServerAuthModule
s.Usage:
configureModule(authModuleOne) .requestPolicy(authModuleOneRequestPolicy) .responsePolicy(authModuleOneResponsePolicy) .callbackHandler(authModuleOneHandler) .withSettings(authModuleOneSettings);
- Since:
- 2.0.0
-
-
Constructor Summary
Constructors Constructor Description AuthenticationModuleBuilder()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AuthenticationFilter.AuthenticationModuleBuilder
callbackHandler(CallbackHandler handler)
Sets theCallbackHandler
that the auth module should use.static AuthenticationFilter.AuthenticationModuleBuilder
configureModule(javax.security.auth.message.module.ServerAuthModule authModule)
Creates a builder to configure the providedServerAuthModule
instance.static AuthenticationFilter.AuthenticationModuleBuilder
configureModule(AsyncServerAuthModule authModule)
Creates a builder to configure the providedAsyncServerAuthModule
instance.AuthenticationFilter.AuthenticationModuleBuilder
requestPolicy(javax.security.auth.message.MessagePolicy requestPolicy)
Sets the requestMessagePolicy
that the auth module should use.AuthenticationFilter.AuthenticationModuleBuilder
responsePolicy(javax.security.auth.message.MessagePolicy responsePolicy)
Sets the responseMessagePolicy
that the auth module should use.AuthenticationFilter.AuthenticationModuleBuilder
withSettings(Map<String,Object> settings)
Sets the settings that contain configuration information that the auth module will use to configure itself.
-
-
-
Method Detail
-
configureModule
public static AuthenticationFilter.AuthenticationModuleBuilder configureModule(AsyncServerAuthModule authModule)
Creates a builder to configure the providedAsyncServerAuthModule
instance.- Parameters:
authModule
- TheAsyncServerAuthModule
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 providedServerAuthModule
instance.- Parameters:
authModule
- TheServerAuthModule
instance.- Returns:
- This auth module builder instance.
-
requestPolicy
public AuthenticationFilter.AuthenticationModuleBuilder requestPolicy(javax.security.auth.message.MessagePolicy requestPolicy)
Sets the requestMessagePolicy
that the auth module should use.- Parameters:
requestPolicy
- The requestMessagePolicy
.- Returns:
- This auth module builder instance.
-
responsePolicy
public AuthenticationFilter.AuthenticationModuleBuilder responsePolicy(javax.security.auth.message.MessagePolicy responsePolicy)
Sets the responseMessagePolicy
that the auth module should use.- Parameters:
responsePolicy
- The responseMessagePolicy
.- Returns:
- This auth module builder instance.
-
callbackHandler
public AuthenticationFilter.AuthenticationModuleBuilder callbackHandler(CallbackHandler handler)
Sets theCallbackHandler
that the auth module should use.- Parameters:
handler
- TheCallbackHandler
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.
-
-