| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object | +--com.sun.identity.idm.AMIdentityRepository
The class  AMIdentityRepository  represents an object
 to access the repositories in which user/role/group and other identity
 data is configured. This class provides access to methods which will
 search, create and delete identities. An instance of this class can be 
 obtained in the following manner:
 
          AMIdentityRepository = new AMIdentityRepository(ssoToken, orgName);
 
| Field Summary | |
| static Debug | debug | 
| static java.util.Map | listeners | 
| Constructor Summary | |
| AMIdentityRepository(SSOToken ssotoken,
                     java.lang.String orgName)Constructor for the AMIdentityRepositoryobject. | |
| Method Summary | |
|  int | addEventListener(IdEventListener listener)Adds a listener, which should receive notifications for all changes that occured in this organization. | 
|  java.util.Set | createIdentities(IdType type,
                 java.util.Map identityNamesAndAttrs)Creates multiple objects of the same type. | 
|  AMIdentity | createIdentity(IdType type,
               java.lang.String idName,
               java.util.Map attrMap)Creates a single object of a type. | 
|  void | deleteIdentities(IdType type,
                 java.util.Set identities)Deletes identities. | 
|  java.util.Set | getAllowedIdOperations(IdType type)Returns the set of Operations for a given IdType,IdOperationsthat can be performed on an Identity. | 
|  AMIdentity | getRealmIdentity()Returns a handle of the Identity object representing this realm for services related operations only. | 
|  IdSearchResults | getSpecialIdentities(IdType type)Return the special identities for this realm for a given type. | 
|  IdSearchResults | getSpecialIdentities(SSOToken token,
                     IdType type,
                     java.lang.String orgName) | 
|  java.util.Set | getSupportedIdTypes()Returns the set of supported object types IdTypefor this deployment. | 
|  void | removeEventListener(int identifier)Removes listener as the application is no longer interested in receiving notifications. | 
|  IdSearchResults | searchIdentities(IdType type,
                 java.lang.String pattern,
                 IdSearchControl ctrl)Searches for identities of certain types from each plugin and returns a combined result | 
|  IdSearchResults | searchIdentities(IdType type,
                 java.lang.String pattern,
                 java.util.Map avPairs,
                 boolean recursive,
                 int maxResults,
                 int maxTime,
                 java.util.Set returnAttributes,
                 boolean returnAllAttributes)Deprecated. This method is deprecated. Use searchIdentities(IdType type,String pattern,IdSearchControl 
 ctrl) | 
| Methods inherited from class java.lang.Object | 
| equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Field Detail | 
public static Debug debug
public static java.util.Map listeners
| Constructor Detail | 
public AMIdentityRepository(SSOToken ssotoken,
                            java.lang.String orgName)
                     throws IdRepoException,
                            SSOException
AMIdentityRepository object. If a null
 is passed for the organization identifier orgName, then
 the "root" organization is assumed.ssotoken - Single sign on token of the userorgName - Name of the organization (can be a Fully qualified DN)IdRepoException - if there are repository related error conditions.SSOException - if user's single sign on token is invalid.| Method Detail | 
public java.util.Set getSupportedIdTypes()
                                  throws IdRepoException,
                                         SSOException
IdType
 for this deployment. This is not organization specific. IdType  objects.IdRepoException - if there are repository related error conditions.SSOException - if user's single sign on token is invalid.
public java.util.Set getAllowedIdOperations(IdType type)
                                     throws IdRepoException,
                                            SSOException
IdType, 
 IdOperations that can be performed on an Identity.
 This varies for each organization (and each plugin?).type - Type of identityIdOperation objects.IdRepoException - if there are repository related error conditions.SSOException - if user's single sign on token is invalid.
public IdSearchResults getSpecialIdentities(IdType type)
                                     throws IdRepoException,
                                            SSOException
type - Type of the identityIdRepoException - if there is a datastore exceptionSSOException - if the user's single sign on token is not valid.
public IdSearchResults searchIdentities(IdType type,
                                        java.lang.String pattern,
                                        java.util.Map avPairs,
                                        boolean recursive,
                                        int maxResults,
                                        int maxTime,
                                        java.util.Set returnAttributes,
                                        boolean returnAllAttributes)
                                 throws IdRepoException,
                                        SSOException
searchIdentities(IdType type,String pattern,IdSearchControl 
 ctrl)
type - Type of identity being searched for.pattern - Search pattern, like "a*" or "*".avPairs - Map of attribute-values which can further help qualify 
        the search pattern.recursive - If true, then the search is performed on the 
        entire subtree (if applicable)maxResults - Maximum number of results to be returned. A -1 means
      no limit on the result set.maxTime - Maximum amount of time after which the search should
        return with partial results.returnAttributes - Set of attributes to be read when performing
        the search.returnAllAttributes - If true, then read all the attributes of the
        entries.AMIdentity objects.IdRepoException - if there are repository related error conditions.SSOException - if user's single sign on token is invalid.
public IdSearchResults searchIdentities(IdType type,
                                        java.lang.String pattern,
                                        IdSearchControl ctrl)
                                 throws IdRepoException,
                                        SSOException
type - Type of identity being searched for.pattern - Patter to be used when searching.ctrl - IdSearchControl which can be used to set up 
          various search controls on the search to be performed.IdRepoException - if there are repository related error conditions.SSOException - if user's single sign on token is invalid.IdSearchControl, 
IdSearchResults
public AMIdentity getRealmIdentity()
                            throws IdRepoException,
                                   SSOException
 AMIdentity
  object can be used to assign and unassign services containing
 dynamic attributes to this realmIdRepoException - if there are repository related error conditions.SSOException - if user's single sign on token is invalid.
public AMIdentity createIdentity(IdType type,
                                 java.lang.String idName,
                                 java.util.Map attrMap)
                          throws IdRepoException,
                                 SSOException
type - Type of object to be created.idName - Name of objectattrMap - Map of attribute-values to be set when creating the entry.IdRepoException - if there are repository related error conditions.SSOException - if user's single sign on token is invalid.
public java.util.Set createIdentities(IdType type,
                                      java.util.Map identityNamesAndAttrs)
                               throws IdRepoException,
                                      SSOException
IdRepo plugins that support creation of these
 objects.type - Type of object to be createdidentityNamesAndAttrs - Names of the identities and theirIdRepoException - if there are repository related error conditions.SSOException - if user's single sign on token is invalid.
public void deleteIdentities(IdType type,
                             java.util.Set identities)
                      throws IdRepoException,
                             SSOException
type - Type of Identity to be deleted.identities - Set of AMIDentity objects to be deletedIdRepoException - if there are repository related error conditions.SSOException - if user's single sign on token is invalid.public int addEventListener(IdEventListener listener)
listener - The callback which implements
        AMEventListener.public void removeEventListener(int identifier)
identifier - Integer identifying the listener.
public IdSearchResults getSpecialIdentities(SSOToken token,
                                            IdType type,
                                            java.lang.String orgName)
                                     throws IdRepoException,
                                            SSOException
| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||