|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 :
The event type and related information are passed through the method call
authEventCallback
. The event parameters are stored in a hashmap.
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 | |
static int |
ACCOUNT_LOCKOUT
The constant for the event type ACCOUNT LOCKOUT. |
static int |
PASSWORD_CHANGE
The constant for the event type PASSWORD CHANGE. |
static java.lang.String |
REALM_KEY
The key for the value of the module's realm, for which the callback was triggered. |
static java.lang.String |
TIME_KEY
The key for the value of the callback notification time (i.e. |
static java.lang.String |
USER_KEY
The key for the value of the user's identity for which the callback was triggered. |
Method Summary | |
void |
authEventCallback(int eventType,
java.util.Map eventParams)
Receives the event notifications when the user status changes during the authentication process. |
Field Detail |
public static final java.lang.String TIME_KEY
public static final java.lang.String REALM_KEY
public static final java.lang.String USER_KEY
public static final int PASSWORD_CHANGE
public static final int ACCOUNT_LOCKOUT
Method Detail |
public void authEventCallback(int eventType, java.util.Map eventParams) throws AMAuthCallBackException
eventType
- the type of event for which this method is being calledeventParams
- a map of different parameters meaningful for this
event.
a
- AMAuthCallBackException
can be thrown back
if necessary (currently not supported). It will be ignored by
authentication processing classes.
AMAuthCallBackException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |