|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | 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, realmName);
Constructor Summary | |
AMIdentityRepository(SSOToken ssotoken,
java.lang.String realmName)
Constructor for the AMIdentityRepository object. |
Method Summary | |
int |
addEventListener(com.sun.identity.idm.IdEventListener listener)
Adds a listener, which should receive notifications for all changes that occurred in this organization. |
static void |
clearCache()
Clears the cache. |
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)
Deprecated. As of release AM 7.1, replaced by deleteIdentities(Set identities) |
void |
deleteIdentities(java.util.Set identities)
Deletes identities. |
java.util.Set |
getAllowedIdOperations(IdType type)
Returns the set of Operations for a given IdType ,
IdOperations that can be performed on an Identity. |
AMIdentity |
getRealmIdentity()
Returns a handle of the Identity object representing this realm for services related operations only. |
java.util.Set |
getSupportedIdTypes()
Returns the set of supported object types IdType
for 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. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public AMIdentityRepository(SSOToken ssotoken, java.lang.String realmName) throws IdRepoException, SSOException
AMIdentityRepository
object. If a null
is passed for the organization identifier realmName
, then
the "root" realm is assumed.
ssotoken
- Single sign on token of the userrealmName
- Name of the realm (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 realm 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 identity
IdOperation
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
AMIdentity
object can be used to assign and unassign services containing
dynamic attributes to this realm.
type
- Type of identity being searched for.pattern
- Pattern 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 realm
IdRepoException
- 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
IdType.AGENT
IdType.USER
IdType.REALM
IdType.REALM
identities,
a map of sunIdentityRepositoryService
attributes need to
be passed. Also, AMIdentity object representing this realm can be
used for services related operations only. This AMIdentity
object can be used to assign and unassign services containing
dynamic attributes to this realm
type
- IdType
of object to be created.idName
- Name of object. If the type is IdType.REALM
then enter a valid realm name.attrMap
- 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.
This method is only valid for:
IdType.AGENT
IdType.REALM
IdType.REALM
identities,
a map of sunIdentityRepositoryService
attributes need to
be passed. Also, AMIdentity object representing this realm can be
used for services related operations only. This AMIdentity
object can be used to assign and unassign services containing
dynamic attributes to this realm
type
- Type of object to be createdidentityNamesAndAttrs
- Names of the identities and their
IdRepoException
- 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
deleteIdentities(Set identities)
IdType.AGENT
IdType.REALM
type
- Type of Identity to be deleted.identities
- Set of AMIdentity objects to be deleted
IdRepoException
- if there are repository related error conditions.
SSOException
- if user's single sign on token is invalid.public void deleteIdentities(java.util.Set identities) throws IdRepoException, SSOException
IdType.AGENT
IdType.REALM
identities
- Set of AMIDentity objects to be deleted
IdRepoException
- if there are repository related error conditions.
SSOException
- if user's single sign on token is invalid.public int addEventListener(com.sun.identity.idm.IdEventListener listener)
listener
- The callback which implements
AMEventListener
.
public void removeEventListener(int identifier)
identifier
- Integer identifying the listener.public static void clearCache()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |