| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object | +--com.iplanet.am.sdk.AMCallBack
A Plugin Class that needs to be extended by external applications in-order to
 do some special pre/post-processing for creation/deletion and modification 
 operations for User, Organization, Roles and Groups. The implementation 
 classes/module(s) are pluggable and are configurable through the Organization
 attribute: iplanet-am-admin-console-pre-post-processing-modules 
 of the iPlanetAMAdminConsoleService service.
 
 
For call backs pertaining to Organizations and Organizational Units, the 
 parent organization's configuration
 (iPlanetAMAdminConsoleService Organization configuration) will
 be used to obtain the plugin modules.
 
The call backs will be made at the time of performing one of the corresponding User/Organization/Role/Group operations (create/modify/delete and attribute fetch) by the Sun Java System Access Manager SDK. Applications that need to perform special pre/post processing for one or more of the above operations, should extend the class and override the corresponding methods.
The API's for pre call back provide a mechanism to inspect the attributes being modified and also modify the values appropriately if required. Care should be taken while performing such modifications, so that it will not affect other plugins which are dependent on the same attributes.
Note:
| Method Summary | |
|  java.util.Map | getAttributes(SSOToken token,
              java.lang.String entryDN,
              java.util.Set attrNames)This method provides a mechanism for applications to obtain attributes external to the Access Manager data store. | 
|  void | postProcessAddUser(SSOToken token,
                   java.lang.String entryDN,
                   java.util.Set members,
                   int objectType)Method which gets invoked after users are added to a role/group. | 
|  void | postProcessCreate(SSOToken token,
                  java.lang.String entryDN,
                  java.util.Map attributes,
                  int objectType)Method which gets invoked after a entry create operation is performed. | 
|  void | postProcessDelete(SSOToken token,
                  java.lang.String entryDN,
                  java.util.Map attributes,
                  boolean softDelete,
                  int objectType)Method which gets invoked after a entry entry is deleted. | 
|  void | postProcessModify(SSOToken token,
                  java.lang.String entryDN,
                  java.util.Map oldAttributes,
                  java.util.Map newAttributes,
                  int objectType)Method which gets invoked after a entry is modified | 
|  void | postProcessRemoveUser(SSOToken token,
                      java.lang.String entryDN,
                      java.util.Set members,
                      int objectType)Method which gets invoked after users are removed from a role/group. | 
|  java.util.Set | preProcessAddUser(SSOToken token,
                  java.lang.String entryDN,
                  java.util.Set members,
                  int objectType)Method which gets called before users are added to a role/group. | 
|  java.util.Map | preProcessCreate(SSOToken token,
                 java.lang.String entryDN,
                 java.util.Map attributes,
                 int objectType)Method which gets invoked before a create operation is performed. | 
|  void | preProcessDelete(SSOToken token,
                 java.lang.String entryDN,
                 java.util.Map attributes,
                 boolean softDeleteEnabled,
                 int objectType)Method which gets invoked before an entry is deleted. | 
|  java.util.Map | preProcessModify(SSOToken token,
                 java.lang.String entryDN,
                 java.util.Map oldAttributes,
                 java.util.Map newAttributes,
                 int objectType)Method which gets invoked before a modify operation is performed. | 
|  java.util.Set | preProcessRemoveUser(SSOToken token,
                     java.lang.String entryDN,
                     java.util.Set members,
                     int objectType)Method which gets called before users are removed from a role/group. | 
| Methods inherited from class java.lang.Object | 
| equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Method Detail | 
public java.util.Map getAttributes(SSOToken token,
                                   java.lang.String entryDN,
                                   java.util.Set attrNames)
AMObject.getAttributes() methods are called. When multiple plugins 
 override this method, then attributes returned from each of them will be
 merged and returned. When the getAttribute() method that
 request specific attributes the call backs are made only for those
 attributes that are not found in the Access Manager's data store. If
 the getAttributes() which do not request any specific
 attributes is called, the call back will take place after obtaining all
 the attributes for the corresponding entry from the Access Manager's
 data store.      
 iplanet-am-admin-console-external-attribute-fetch-enabled 
 of the iPlanetAMAdminConsoleService service should be set to
 enabled          
 token - the SSOTokenentryDN - the DN of the entry being addedattrNames - names of attributes that need to retrieved. If null, all
 attributes should be returned.
public java.util.Map preProcessCreate(SSOToken token,
                                      java.lang.String entryDN,
                                      java.util.Map attributes,
                                      int objectType)
                               throws AMPreCallBackException
token - the SSOTokenentryDN - the DN of the entry being addedattributes - a map consisting of attribute names and a set of values
        for each of them. This map of attributes can be inspected,
        modified and sent back. Note, caution should be taken while
        performing modifications to avoid changing attributes that are
        used by Access Manager. If no modifications need to done, either
        the original map or null value can be returned.objectType - represents the type of entry on which
        the operation is being performed. Types could be:
        attributes or null. If this
         returned map is not null, then this map will be used while
         performing the operation.- Throws:
- AMPreCallBackException- if an 
         error that occurs during pre processing. The SDK will not proceed
         with the create operation, if any one of the implementation
         classes throws an exception. A user specific localized message
         should be sent as part of the exception message. The specific
         messages can be added to- amProfile.propertiesfile.
public java.util.Map preProcessModify(SSOToken token,
                                      java.lang.String entryDN,
                                      java.util.Map oldAttributes,
                                      java.util.Map newAttributes,
                                      int objectType)
                               throws AMPreCallBackException
token - the SSOTokenentryDN - the DN of the entry being modifiedoldAttributes - a map consisting of attribute names and a set of 
 values for each of them before modificationnewAttributes - a map consisting of attribute names and
 a set of values for each of them after modification. This map of 
 attributes can be inspected, modified and sent back. Note, caution should
 be taken while performing modifications to avoid changing attributes that
 are used by Access Manager. If no modifications need to done, either the
 original map or null value can be returned.objectType - represents the type of entry on which
 the operation is being performed. Types could be:
 newAttributes or null. If 
 this returned map is not null, then this map will be used while 
 performing the operation.AMPreCallBackException - if an 
 error occurs pre processing. The SDK will not proceed with
 the modify operation, if any one of the implementation classes throws an
 exception. A user specific localized message should be sent as
 part of the exception message. The specific messages can be added to
 amProfile.properties file.
public void preProcessDelete(SSOToken token,
                             java.lang.String entryDN,
                             java.util.Map attributes,
                             boolean softDeleteEnabled,
                             int objectType)
                      throws AMPreCallBackException
token - the SSOTokenentryDN - the DN of the entry being deletedattributes - a map consisting of attribute names and 
 a set of values for each of them.softDeleteEnabled - if true soft delete will be performed
 Otherwise hard delete will be performed.objectType - represents the type of entry on which
 the operation is being performed. Types could be:
 AMPreCallBackException - if an error occurs during entry delete
 pre-processing. The SDK will not proceed with the delete 
 operation, if any one of the implementation classes throws an
 exception. A user specific localized message should be sent as
 part of the exception message. The specific messages can be added to
 amProfile.properties file.
public void postProcessCreate(SSOToken token,
                              java.lang.String entryDN,
                              java.util.Map attributes,
                              int objectType)
                       throws AMPostCallBackException
token - the SSOTokenentryDN - the DN of the entry being addedattributes - a map consisting of attribute names and 
 a set of values for each of themobjectType - represents the type of entry on which
 the operation is being performed. Types could be:
 AMPostCallBackException - if an error occurs during post
 processing. A user specific localized message should be sent as part of
 the exception message. The specific messages can be added to
 amProfile.properties file.
public void postProcessModify(SSOToken token,
                              java.lang.String entryDN,
                              java.util.Map oldAttributes,
                              java.util.Map newAttributes,
                              int objectType)
                       throws AMPostCallBackException
token - the SSOTokenentryDN - the DN of the entry being modifiedoldAttributes - a map consisting of attribute names and
 a set of values for each of them before modificationnewAttributes - a map consisting of attribute names and
 a set of values for each of them after modificationobjectType - represents the type of entry on which
 the operation is being performed. Types could be:
 AMPostCallBackException - if an error occurs during post
 processing. A user specific localized message should be sent as part of
 the exception message. The specific messages can be added to
 amProfile.properties file.
public void postProcessDelete(SSOToken token,
                              java.lang.String entryDN,
                              java.util.Map attributes,
                              boolean softDelete,
                              int objectType)
                       throws AMPostCallBackException
token - the SSOTokenentryDN - the DN of the entry being deletedattributes - a map consisting of attribute names and 
 a set of values for each of themsoftDelete - If true, this implies that the object is just being
        marked for deletion, if false, then it implies that the object is
        being removed from the data store.objectType - represents the type of entry on which
 the operation is being performed. Types could be:
 AMPostCallBackException - if an 
 error occurs during post processing. A user specific localized 
 message should be sent as part of the exception message. The specific 
 messages can be added to amProfile.properties file.
public java.util.Set preProcessAddUser(SSOToken token,
                                       java.lang.String entryDN,
                                       java.util.Set members,
                                       int objectType)
                                throws AMPreCallBackException
token - the SSOTokenentryDN - the DN of the entry being addedmembers - a set consisting of user DN's. This set of members can be 
 inspected, modified (users can be added/removed) and sent back. If no 
 modifications need to done, either the original set or null value can be
 returned.objectType - represents the type of entry on which
 the operation is being performed. Types could be:
 members or null. If null
 value or empty set is returned, no users will be added. Hence, if no
 modification is being performed to the original set, it needs to be 
 back.- Throws:
- AMPreCallBackException- if an 
 error occurs during pre processing. The SDK will not proceed with
 the adding users to role/group operation, if any one of the 
 implementation classes throws an exception. A user specific localized 
 message should be sent as part of the exception message. The specific 
 messages can be added to- amProfile.propertiesfile.
public void postProcessAddUser(SSOToken token,
                               java.lang.String entryDN,
                               java.util.Set members,
                               int objectType)
                        throws AMPostCallBackException
token - the SSOTokenentryDN - the DN of the entry being addedmembers - a Set consisting of user DN's which represent the users 
 added to the role/group.objectType - represents the type of entry on which
 the operation is being performed. Types could be:
 AMPostCallBackException - if an 
 error occurs during post processing. A user specific localized 
 message should be sent as part of the exception message. The specific 
 messages can be added to amProfile.properties file.
public java.util.Set preProcessRemoveUser(SSOToken token,
                                          java.lang.String entryDN,
                                          java.util.Set members,
                                          int objectType)
                                   throws AMPreCallBackException
token - the SSOTokenentryDN - the DN of the entry being addedmembers - a set consisting of user DN's. This set of members can be 
 inspected, modified (users can be added/removed) and sent back. If no 
 modifications need to done, either the original set or null value can be
 returned.objectType - represents the type of entry on which
 the operation is being performed. Types could be:
 members or null. If null
 value or empty set is returned, no users will be removed. Hence, if no
 modification is being performed to the original set, it needs to be 
 back.- Throws:
- AMPreCallBackException- if an 
 error that occurs during pre processing. The SDK will not proceed with
 the removing users from role/group operation, if any one of the 
 implementation classes throws an exception. A user specific localized 
 message should be sent as part of the exception message. The specific 
 messages can be added to- amProfile.propertiesfile.
public void postProcessRemoveUser(SSOToken token,
                                  java.lang.String entryDN,
                                  java.util.Set members,
                                  int objectType)
                           throws AMPostCallBackException
token - the SSOTokenentryDN - the DN of the entry being addedmembers - a Set consisting of user DN's which represent the users 
 added to the role/group.objectType - represents the type of entry on which
 the operation is being performed. Types could be:
 AMPostCallBackException - if an 
 error occurs during post processing. A user specific localized
 message should be sent as part of the exception message. The specific
 messages can be added to amProfile.properties file.| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||