oracle.maf.api.authentication

Class AuthenticationHandler

Object

oracle.maf.api.authentication.AuthenticationHandler

public abstract class AuthenticationHandler
extends Object

Base class that signifies a user-specified login feature.

Constructor Summary

Constructors

Constructor and Description
AuthenticationHandler()

Method Summary

Modifier and Type	Method and Description
abstract void	failed(AuthenticationPlatform authPlatform, AuthenticationException problem) The login failed callback is invoked when the user fails the authentication process in the AuthenticationPlatform login method.
abstract void	moreInformationRequested(AuthenticationPlatform authPlatform, java.util.Map<String,String> loginProperties, java.util.Map<String,String> additionalProperties) When the login process needs additional information like knowledge-based authentication (KBA): during the authentication process the user will be asked to answer at least one "secret" question.
abstract void	success(AuthenticationPlatform authPlatform, long actualAuthMode) The login success callback is invoked when the user passes the authentication process in the AuthenticationPlatform login method.

Methods inherited from class Object

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

Constructor Detail

AuthenticationHandler

public AuthenticationHandler()

Method Detail

moreInformationRequested

public abstract void moreInformationRequested(AuthenticationPlatform authPlatform,
                                              java.util.Map<String,String> loginProperties,
                                              java.util.Map<String,String> additionalProperties)
                                       throws UnsupportedOperationException

When the login process needs additional information like

knowledge-based authentication (KBA): during the authentication process the user will be asked to answer at least one "secret" question. In order to implement this the authentication platform will utilize the moreInformationRequested callback to obtain the appropriate responses.

two-way SSL: during the authentication process the user will be asked to select which client certificates should be used for the given SSL communication. In this case the moreInformationRequest will be invoked for the login feature to provide this additional information.

When the additional properties are collected during the login flow the login feature should invoke the login method that takes both the initial collected values (properties) and additional values (properties).

Parameters:

authPlatform - authentication platform used in the login process

loginProperties - populated login properties

additionalProperties - additional properties needed

Throws:

UnsupportedOperationException

success

public abstract void success(AuthenticationPlatform authPlatform,
                             long actualAuthMode)

The login success callback is invoked when the user passes the authentication process in the AuthenticationPlatform login method.

Parameters:

authPlatform - - authentication platform used in the authentication.

actualAuthMode - - the mode (local, remote, ...) that was used to authenticate.

failed

public abstract void failed(AuthenticationPlatform authPlatform,
                            AuthenticationException problem)

The login failed callback is invoked when the user fails the authentication process in the AuthenticationPlatform login method.

Parameters:

authPlatform - - authentication platform used in the authentication.

problem - - all problems are surfaced as an exception