com.iplanet.am.sdk
Interface AMUser

All Superinterfaces:

AMConstants, AMObject

Deprecated. As of Sun Java System Access Manager 7.1.

public interface AMUser
extends AMObject

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); }
 

Field Summary

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

Fields inherited from interface com.iplanet.am.sdk.AMConstants

ADD_MEMBER, ADMIN_GROUPS_ENABLED_ATTR, ADMIN_ROLE_ATTR, ADMINISTRATION_SERVICE, CACHE_ENABLED_DISABLED_KEY, CACHE_MAX_SIZE_KEY, COMPLIANCE_SPECIAL_FILTER_ATTR, COMPLIANCE_USER_DELETION_ATTR, CONTAINER_DEFAULT_TEMPLATE_ROLE, CONTAINER_SUPPORTED_TYPES_ATTRIBUTE, DCT_ATTRIBUTE_LIST_ATTR, DCT_ENABLED_ATTR, DOMAIN_ADMINISTRATORS, DOMAIN_HELP_DESK_ADMINISTRATORS, EMAIL_ATTRIBUTE, FILTER_ATTR_NAME, INET_ADMIN_OBJECT_CLASS, INET_DOMAIN_STATUS_ATTR, INET_DOMAIN_STATUS_ATTRIBUTE, INVALID_USERID_CHARACTERS, OTHER_COSATTR_TYPE, POLICY_COSATTR_TYPE, POLICY_SUFFIX, PRE_POST_PROCESSING_MODULES_ATTR, REMOVE_ATTRIBUTE, REMOVE_MEMBER, REQUIRED_SERVICES_ATTR, ROLE_MANAGED_CONTAINER_DN_ATTRIBUTE, SCOPE_BASE, SCOPE_ONE, SCOPE_SUB, SERVICE_STATUS_ATTRIBUTE, STATIC_GROUP_DN_ATTRIBUTE, SUBSCRIBABLE_ATTRIBUTE, UNIQUE_ATTRIBUTE_LIST_ATTRIBUTE, UNIQUE_MEMBER_ATTRIBUTE, USER_CREATE_NOTIFICATION_LIST, USER_DELETE_NOTIFICATION_LIST, USER_ENCRYPTED_PASSWORD_ATTRIBUTE, USER_ENTRY_PROCESSING_IMPL, USER_MODIFY_NOTIFICATION_LIST, USER_PASSWORD_ATTRIBUTE, USER_SEARCH_RETURN_ATTR, USERID_PASSWORD_VALIDATION_CLASS

Method Summary

void	activate() Deprecated. Activates the user.
void	assignAssignableDynamicGroup(AMAssignableDynamicGroup assignableDynamicGroup) Deprecated. Assigns a assignable dynamic group to the user.
void	assignAssignableDynamicGroup(String assignableDynamicGroupDN) Deprecated. Assigns a assignable dynamic group to the user.
void	assignRole(AMRole role) Deprecated. Assigns a role to the user.
void	assignRole(String roleDN) Deprecated. Assigns a role to the user.
void	assignServices(Set serviceNames) Deprecated. Assigns services to the user.
void	assignStaticGroup(AMStaticGroup group) Deprecated. Assigns a static group to the user.
void	assignStaticGroup(String groupDN) Deprecated. Assigns a static group to the user.
void	deactivate() Deprecated. Deactivates the user.
Set	getAllRoleDNs() Deprecated. Gets all the static and filtered roles the user is in.
Set	getAssignableDynamicGroupDNs() Deprecated. Gets all the assignable dynamic groups the user is in.
Set	getAssignedServices() Deprecated. Gets all service names that are assigned to the user.
Set	getFilteredRoleDNs() Deprecated. Gets all the filtered roles the user is in.
Set	getRoleDNs() Deprecated. Gets all the static roles the user is in.
Set	getStaticGroupDNs() Deprecated. Gets all the static groups the user is in.
boolean	isActivated() Deprecated. Returns true if the user is activated.
void	removeAssignableDynamicGroup(AMAssignableDynamicGroup assignableDynamicGroup) Deprecated. Removes a assignable dynamic group that is assigned to the user.
void	removeAssignableDynamicGroup(String assignableDynamicGroupDN) Deprecated. Removes a assignable dynamic group that is assigned to the user.
void	removeRole(AMRole role) Deprecated. Removes a role that is assigned to the user.
void	removeRole(String roleDN) Deprecated. Removes a role that is assigned to the user.
void	removeStaticGroup(AMStaticGroup group) Deprecated. Removes a static group that is assigned to the user.
void	removeStaticGroup(String groupDN) Deprecated. Removes a static group that is assigned to the user.
String	rename(String newName, boolean deleteOldName) Deprecated. Renames the user name (ie., naming attribute of user entry) in the data store.

Methods inherited from interface com.iplanet.am.sdk.AMObject

addEventListener, assignPolicies, assignServices, createPolicyTemplate, createPolicyTemplate, createTemplate, createTemplate, delete, delete, getAttribute, getAttributeByteArray, getAttributes, getAttributes, getAttributesByteArray, getAttributesByteArray, getAttributesFromDataStore, getAttributesFromDataStore, getDN, getOrganizationDN, getParentDN, getPolicy, getPolicyTemplate, getServiceAttributes, getServiceStatus, getStringAttribute, getTemplate, isExists, modifyService, purge, removeAttributes, removeEventListener, search, setAttributeByteArray, setAttributes, setAttributesByteArray, setServiceStatus, setStringAttribute, store, store, unassignPolicies, unassignServices

Method Detail

rename

String rename(String newName,
              boolean deleteOldName)
              throws AMException,
                     SSOException

Deprecated.

Renames the user name (ie., naming attribute of user entry) in the data store.

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.

Parameters:

newName - The new user name

deleteOldName - if true deletes the old name, otherwise retains the old name.

Returns:

the new DN value for the user

Throws:

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.

getFilteredRoleDNs

Set getFilteredRoleDNs()
                       throws AMException,
                              SSOException

Deprecated.

Gets all the filtered roles the user is in.

Returns:

The Set of filtered role DN's the user is in.

Throws:

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.

getRoleDNs

Set getRoleDNs()
               throws AMException,
                      SSOException

Deprecated.

Gets all the static roles the user is in.

Returns:

The Set of static role DN's the user is in.

Throws:

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.

getAllRoleDNs

Set getAllRoleDNs()
                  throws AMException,
                         SSOException

Deprecated.

Gets all the static and filtered roles the user is in.

Returns:

The Set of static and filtered role DN's the user is in.

Throws:

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.

assignRole

void assignRole(AMRole role)
                throws AMException,
                       SSOException

Deprecated.

Assigns a role to the user.

Parameters:

role - The Role that the user is assigned to.

Throws:

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.

assignRole

void assignRole(String roleDN)
                throws AMException,
                       SSOException

Deprecated.

Assigns a role to the user.

Parameters:

roleDN - The role DN that the user is assigned to.

Throws:

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.

removeRole

void removeRole(AMRole role)
                throws AMException,
                       SSOException

Deprecated.

Removes a role that is assigned to the user.

Parameters:

role - The Role that the user is assigned to.

Throws:

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.

removeRole

void removeRole(String roleDN)
                throws AMException,
                       SSOException

Deprecated.

Removes a role that is assigned to the user.

Parameters:

roleDN - The role DN that the user is assigned to.

Throws:

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.

getStaticGroupDNs

Set getStaticGroupDNs()
                      throws AMException,
                             SSOException

Deprecated.

Gets all the static groups the user is in.

Returns:

The Set of static group DN's the user is in.

Throws:

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.

assignStaticGroup

void assignStaticGroup(AMStaticGroup group)
                       throws AMException,
                              SSOException

Deprecated.

Assigns a static group to the user.

Parameters:

group - The static group that the user is assigned to.

Throws:

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.

assignStaticGroup

void assignStaticGroup(String groupDN)
                       throws AMException,
                              SSOException

Deprecated.

Assigns a static group to the user.

Parameters:

groupDN - The static group DN that the user is assigned to.

Throws:

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.

removeStaticGroup

void removeStaticGroup(AMStaticGroup group)
                       throws AMException,
                              SSOException

Deprecated.

Removes a static group that is assigned to the user.

Parameters:

group - The static group that the user is assigned to.

Throws:

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.

removeStaticGroup

void removeStaticGroup(String groupDN)
                       throws AMException,
                              SSOException

Deprecated.

Removes a static group that is assigned to the user.

Parameters:

groupDN - The static group DN that the user is assigned to.

Throws:

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.

getAssignableDynamicGroupDNs

Set getAssignableDynamicGroupDNs()
                                 throws AMException,
                                        SSOException

Deprecated.

Gets all the assignable dynamic groups the user is in.

Returns:

The Set of assignable dynamic group DN's the user is in.

Throws:

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.

assignAssignableDynamicGroup

void assignAssignableDynamicGroup(AMAssignableDynamicGroup assignableDynamicGroup)
                                  throws AMException,
                                         SSOException

Deprecated.

Assigns a assignable dynamic group to the user.

Parameters:

assignableDynamicGroup - The assignable dynamic group that the user is assigned to.

Throws:

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.

assignAssignableDynamicGroup

void assignAssignableDynamicGroup(String assignableDynamicGroupDN)
                                  throws AMException,
                                         SSOException

Deprecated.

Assigns a assignable dynamic group to the user.

Parameters:

assignableDynamicGroupDN - The assignable dynamic group DN that the user is assigned to.

Throws:

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.

removeAssignableDynamicGroup

void removeAssignableDynamicGroup(AMAssignableDynamicGroup assignableDynamicGroup)
                                  throws AMException,
                                         SSOException

Deprecated.

Removes a assignable dynamic group that is assigned to the user.

Parameters:

assignableDynamicGroup - The assignable dynamic group that the user is assigned to.

Throws:

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.

removeAssignableDynamicGroup

void removeAssignableDynamicGroup(String assignableDynamicGroupDN)
                                  throws AMException,
                                         SSOException

Deprecated.

Removes a assignable dynamic group that is assigned to the user.

Parameters:

assignableDynamicGroupDN - The assignable dynamic group DN that the user is assigned to.

Throws:

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.

activate

void activate()
              throws AMException,
                     SSOException

Deprecated.

Activates the user.

Throws:

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.

deactivate

void deactivate()
                throws AMException,
                       SSOException

Deprecated.

Deactivates the user.

Throws:

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.

isActivated

boolean isActivated()
                    throws AMException,
                           SSOException

Deprecated.

Returns true if the user is activated.

Returns:

true if the user is activated.

Throws:

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.

getAssignedServices

Set getAssignedServices()
                        throws AMException,
                               SSOException

Deprecated.

Gets all service names that are assigned to the user.

Specified by:

getAssignedServices in interface AMObject

Returns:

The Set of service names that are assigned to the user.

Throws:

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.

assignServices

void assignServices(Set serviceNames)
                    throws AMException,
                           SSOException

Deprecated.

Assigns services to the user.

Parameters:

serviceNames - Set of service names

Throws:

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.

See Also:

AMObject.assignServices(java.util.Map)