|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This interface provides methods to manage user.
AMUser
objects can be obtained by using
AMStoreConnection
.
A handle to this object can be obtained by using the DN of the object.
AMStoreConnection amsc = new AMStoreConnection(ssotoken); if (amsc.doesEntryExist(uDN)) { AMUser user = amsc.getUser(uDN); }
Fields inherited from interface com.iplanet.am.sdk.AMObject |
ACTIVE, ACTIVE_VALUE, ASSIGNABLE_DYNAMIC_GROUP, DELETED, DELETED_VALUE, DYNAMIC_GROUP, FILTERED_ROLE, GROUP, GROUP_CONTAINER, GROUP_PROFILE, INACTIVE, INACTIVE_VALUE, MANAGED_ROLE, ORGANIZATION, ORGANIZATIONAL_UNIT, PEOPLE_CONTAINER, POLICY, RESOURCE, ROLE, ROLE_PROFILE, SERVICE, STATIC_GROUP, TEMPLATE, UNDETERMINED_OBJECT_TYPE, UNKNOWN_OBJECT_TYPE, USER |
Method Summary | |
void |
activate()
Activates the user. |
void |
assignAssignableDynamicGroup(AMAssignableDynamicGroup assignableDynamicGroup)
Assigns a assignable dynamic group to the user. |
void |
assignAssignableDynamicGroup(java.lang.String assignableDynamicGroupDN)
Assigns a assignable dynamic group to the user. |
void |
assignRole(AMRole role)
Assigns a role to the user. |
void |
assignRole(java.lang.String roleDN)
Assigns a role to the user. |
void |
assignServices(java.util.Set serviceNames)
Assigns services to the user. |
void |
assignStaticGroup(AMStaticGroup group)
Assigns a static group to the user. |
void |
assignStaticGroup(java.lang.String groupDN)
Assigns a static group to the user. |
void |
deactivate()
Deactivates the user. |
java.util.Set |
getAssignableDynamicGroupDNs()
Gets all the assignable dynamic groups the user is in. |
java.util.Set |
getAssignedServices()
Gets all service names that are assigned to the user. |
java.util.Set |
getFilteredRoleDNs()
Gets all the filtered roles the user is in. |
java.util.Set |
getRoleDNs()
Gets all the roles the user is in. |
java.util.Set |
getStaticGroupDNs()
Gets all the static groups the user is in. |
boolean |
isActivated()
Returns true if the user is activated. |
void |
removeAssignableDynamicGroup(AMAssignableDynamicGroup assignableDynamicGroup)
Removes a assignable dynamic group that is assigned to the user. |
void |
removeAssignableDynamicGroup(java.lang.String assignableDynamicGroupDN)
Removes a assignable dynamic group that is assigned to the user. |
void |
removeRole(AMRole role)
Removes a role that is assigned to the user. |
void |
removeRole(java.lang.String roleDN)
Removes a role that is assigned to the user. |
void |
removeStaticGroup(AMStaticGroup group)
Removes a static group that is assigned to the user. |
void |
removeStaticGroup(java.lang.String groupDN)
Removes a static group that is assigned to the user. |
java.lang.String |
rename(java.lang.String newName,
boolean deleteOldName)
Renames the user name (ie., naming attribute of user entry) in the data store. |
Method Detail |
public java.lang.String rename(java.lang.String newName, boolean deleteOldName) throws AMException, SSOException
Note: This operation directly commits the
the user name changes to the data store. However, it
does not save the modified/added attributes. For
saving them explicitly to the data store, use
store()
method to save the
attributes.
newName
- The new user namedeleteOldName
- if true deletes the old name,
otherwise retains the old name.DN
value for the userAMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the single sign on token is no longer valid.public java.util.Set getFilteredRoleDNs() throws AMException, SSOException
AMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the single sign on token is no longer valid.public java.util.Set getRoleDNs() throws AMException, SSOException
AMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the single sign on token is no longer valid.public void assignRole(AMRole role) throws AMException, SSOException
role
- The Role that the user is assigned to.AMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the single sign on token is no longer valid.public void assignRole(java.lang.String roleDN) throws AMException, SSOException
roleDN
- The role DN that the user is assigned to.AMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the single sign on token is no longer valid.public void removeRole(AMRole role) throws AMException, SSOException
role
- The Role that the user is assigned to.AMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the single sign on token is no longer valid.public void removeRole(java.lang.String roleDN) throws AMException, SSOException
roleDN
- The role DN that the user is assigned to.AMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the single sign on token is no longer valid.public java.util.Set getStaticGroupDNs() throws AMException, SSOException
AMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the single sign on token is no longer valid.public void assignStaticGroup(AMStaticGroup group) throws AMException, SSOException
group
- The static group that the user is assigned to.AMException
- if an error is encountered when trying to
access/retrieve data from the data store.SSOException
- if the single sign on token is no longer valid.public void assignStaticGroup(java.lang.String groupDN) throws AMException, SSOException
groupDN
- The static group DN that the user is assigned to.AMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the single sign on token is no longer valid.public void removeStaticGroup(AMStaticGroup group) throws AMException, SSOException
group
- The static group that the user is assigned to.AMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the single sign on token is no longer valid.public void removeStaticGroup(java.lang.String groupDN) throws AMException, SSOException
groupDN
- The static group DN that the user is assigned to.AMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the single sign on token is no longer valid.public java.util.Set getAssignableDynamicGroupDNs() throws AMException, SSOException
AMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the single sign on token is no longer valid.public void assignAssignableDynamicGroup(AMAssignableDynamicGroup assignableDynamicGroup) throws AMException, SSOException
assignableDynamicGroup
- The assignable dynamic group that the user
is assigned to.AMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the single sign on token is no longer valid.public void assignAssignableDynamicGroup(java.lang.String assignableDynamicGroupDN) throws AMException, SSOException
assignableDynamicGroupDN
- The assignable dynamic group DN that the
user is assigned to.AMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the single sign on token is no longer valid.public void removeAssignableDynamicGroup(AMAssignableDynamicGroup assignableDynamicGroup) throws AMException, SSOException
assignableDynamicGroup
- The assignable dynamic group that the user
is assigned to.AMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the single sign on token is no longer valid.public void removeAssignableDynamicGroup(java.lang.String assignableDynamicGroupDN) throws AMException, SSOException
assignableDynamicGroupDN
- The assignable dynamic group DN that
the user is assigned to.AMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the single sign on token is no longer valid.public void activate() throws AMException, SSOException
AMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the single sign on token is no longer valid.public void deactivate() throws AMException, SSOException
AMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the single sign on token is no longer valid.public boolean isActivated() throws AMException, SSOException
AMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the single sign on token is no longer valid.public java.util.Set getAssignedServices() throws AMException, SSOException
getAssignedServices
in interface AMObject
AMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the single sign on token is no longer valid.public void assignServices(java.util.Set serviceNames) throws AMException, SSOException
serviceNames
- Set of service namesAMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the single sign on token is no longer valid.AMObject.assignServices(java.util.Map)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |