Package org.forgerock.openig.tools.authentication

Interface AuthenticationService

All Known Implementing Classes:

AuthenticatorAuthenticationService

public interface AuthenticationService

Asynchronous AM authentication service delivering SsoToken.

Method Summary

Modifier and Type	Method	Description
Promise<SsoToken,AuthenticationException>	authenticate(Context context, String username, SecretReference<GenericSecret> passwordRef)	Authenticates a subject (identified with the given username and passwordRef credentials), returning asynchronously an SSO token (if the authentication succeeded) or an AuthenticationException on failures (I/O, invalid credentials, ...).

Method Details

authenticate

Promise<SsoToken,AuthenticationException> authenticate(Context context,
 String username,
 SecretReference<GenericSecret> passwordRef)

Authenticates a subject (identified with the given username and passwordRef credentials), returning asynchronously an SSO token (if the authentication succeeded) or an AuthenticationException on failures (I/O, invalid credentials, ...).

Parameters:

context - Service context

username - subject's username

passwordRef - subject's credentials as a SecretReference

Returns:

a promise of an SsoToken