org.forgerock.caf.authentication.api

Interface AuthContextWithState

All Known Implementing Classes:

FallbackAuthContext

public interface AuthContextWithState

AsyncServerAuthContext implementations should implement this interface when the AsyncServerAuthContext has its own implementation of a AuthenticationState that it will be using to store and maintain state for a single request.

The MessageContext will use the createAuthenticationState() method on this interface to create a new instance of the AuthenticationState for each request message.

Since:

2.0.0

Method Summary

Modifier and Type	Method and Description
AuthenticationState	createAuthenticationState() Creates an instance of a specific type of AuthenticationState.

Method Detail

createAuthenticationState

AuthenticationState createAuthenticationState()

Creates an instance of a specific type of AuthenticationState.

Must return a new AuthenticationState instance for each invocation.

Returns:

A new AuthenticationState instance.