com.sun.identity.authentication.spi

Interface AMAuthCallBack

public interface AMAuthCallBack

The AMAuthCallBack interface should be implemented by external business logic code, in order to receive callbacks from the authentication framework when one of the following events happens :

• account lockout
• password change (via LDAP module)

The event type and related information are passed through the method call AMAuthCallBack.authEventCallback(int, java.util.Map). The event parameters are stored in a hash map. See information about public static fields for more details.

A plug-in class, which implements this interface, can retrieve the event parameters using the get() function of the Map interface : eventParams.get(TIME_KEY); eventParams.get(USER_KEY); etc.

Method Summary

Modifier and Type	Method and Description
void	authEventCallback(int eventType, Map eventParams) Receives the event notifications when the user status changes during the authentication process.

Method Detail

authEventCallback

void authEventCallback(int eventType,
                       Map eventParams)
                throws AMAuthCallBackException

Receives the event notifications when the user status changes during the authentication process. It includes the type of event and other information pertinent to this event.

Parameters:

eventType - the type of event for which this method is being called

eventParams - a map of different parameters meaningful for this event.

Throws:

AMAuthCallBackException - can be thrown back if necessary (currently not supported). It will be ignored by authentication processing classes.