Package org.forgerock.openig.tools.authentication

Class AuthenticatorAuthenticationService

java.lang.Object

org.forgerock.openig.tools.authentication.AuthenticatorAuthenticationService

All Implemented Interfaces:

AuthenticationService

public class AuthenticatorAuthenticationService
extends Object
implements AuthenticationService

Provides an implementation of the AuthenticationService using a Authenticator plugin.

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, ...).
static AuthenticationService	createAgentAuthenticationService(Handler amHandler, URI authenticateUri, AmVersion version)	Return an instance of an AuthenticationService for Agent authentication based on the AmVersion.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createAgentAuthenticationService

public static AuthenticationService createAgentAuthenticationService(Handler amHandler,
                                                                     URI authenticateUri,
                                                                     AmVersion version)

Return an instance of an AuthenticationService for Agent authentication based on the AmVersion.

Parameters:

amHandler - the Handler to use when making authentication requests.

authenticateUri - the URI to use when authenticating.

version - the AmVersion details.

Returns:

an instance of an AuthenticationService for Agent authentication based on the AmVersion.

authenticate

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

Description copied from interface: AuthenticationService

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, ...).

Specified by:

authenticate in interface AuthenticationService

Parameters:

context - Service context

username - subject's username

passwordRef - subject's credentials as a SecretReference

Returns:

a promise of an SsoToken