Package com.sun.identity.authentication.spi

Interface AMAuthCallBack

  • @SupportedAll
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 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.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int ACCOUNT_LOCKOUT
      The constant for the ACCOUNT LOCKOUT event type.
      static int PASSWORD_CHANGE
      The constant for the PASSWORD CHANGE event type.
      static String REALM_KEY
      The key for the value of the module's realm, for which the callback was triggered.
      static String TIME_KEY
      The key for the value of the callback notification time (i.e.
      static String USER_KEY
      The key for the value of the user's identity for which the callback was triggered.

    • Field Detail

      • TIME_KEY

        static final String TIME_KEY
        The key for the value of the callback notification time (i.e. when the event occured).
        See Also:
        Constant Field Values

      • REALM_KEY

        static final String REALM_KEY
        The key for the value of the module's realm, for which the callback was triggered.
        See Also:
        Constant Field Values

      • USER_KEY

        static final String USER_KEY
        The key for the value of the user's identity for which the callback was triggered.
        See Also:
        Constant Field Values

      • PASSWORD_CHANGE

        static final int PASSWORD_CHANGE
        The constant for the PASSWORD CHANGE event type.
        See Also:
        Constant Field Values

      • ACCOUNT_LOCKOUT

        static final int ACCOUNT_LOCKOUT
        The constant for the ACCOUNT LOCKOUT event type.
        See Also:
        Constant Field Values

    • 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.