com.iplanet.am.sdk
Interface AMUser

All Superinterfaces:

AMConstants, AMObject

public interface AMUser

extends AMObject

The User interface provides methods to manage user

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

ASSIGNABLE_DYNAMIC_GROUP, DYNAMIC_GROUP, FILTERED_ROLE, GROUP, GROUP_CONTAINER, GROUP_PROFILE, MANAGED_ROLE, ORGANIZATION, ORGANIZATIONAL_UNIT, PEOPLE_CONTAINER, POLICY, ROLE, ROLE_PROFILE, SERVICE, STATIC_GROUP, TEMPLATE, UNKNOWN_OBJECT_TYPE, USER

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

SCOPE_BASE, SCOPE_ONE, SCOPE_SUB, SUBSCRIBABLE_ATTRIBUTE, UNIQUE_MEMBER_ATTRIBUTE

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	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.
void	unassignServices(java.util.Set serviceNames) Unassigns services from the user.

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

addEventListener, assignPolicies, createPolicyTemplate, createPolicyTemplate, createTemplate, createTemplate, delete, delete, getAttribute, getAttributeByteArray, getAttributes, getAttributes, getAttributesByteArray, getAttributesByteArray, getDN, getOrganizationDN, getParentDN, getPolicy, getPolicyTemplate, getServiceAttributes, getStringAttribute, getTemplate, isExists, removeAttributes, removeEventListener, search, setAttributes, setStringAttribute, store, unassignPolicies

Method Detail

getRoleDNs

public java.util.Set getRoleDNs()
                         throws AMException,
                                SSOException

Gets all the roles the user is in.

Returns:

The Set of 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 sign on is no longer valid

assignRole

public void assignRole(AMRole role)
                throws AMException,
                       SSOException

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 sign on is no longer valid

assignRole

public void assignRole(java.lang.String roleDN)
                throws AMException,
                       SSOException

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 sign on is no longer valid

removeRole

public void removeRole(AMRole role)
                throws AMException,
                       SSOException

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 sign on is no longer valid

removeRole

public void removeRole(java.lang.String roleDN)
                throws AMException,
                       SSOException

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 sign on is no longer valid

getStaticGroupDNs

public java.util.Set getStaticGroupDNs()
                                throws AMException,
                                       SSOException

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 sign on is no longer valid

assignStaticGroup

public void assignStaticGroup(AMStaticGroup group)
                       throws AMException,
                              SSOException

Assigns a static group to the user.

Parameters:

group - The AMStaticGroup 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 sign on is no longer valid

assignStaticGroup

public void assignStaticGroup(java.lang.String groupDN)
                       throws AMException,
                              SSOException

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 sign on is no longer valid

removeStaticGroup

public void removeStaticGroup(AMStaticGroup group)
                       throws AMException,
                              SSOException

Removes a static group that is assigned to the user.

Parameters:

group - The AMStaticGroup 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 sign on is no longer valid

removeStaticGroup

public void removeStaticGroup(java.lang.String groupDN)
                       throws AMException,
                              SSOException

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 sign on is no longer valid

getAssignableDynamicGroupDNs

public java.util.Set getAssignableDynamicGroupDNs()
                                           throws AMException,
                                                  SSOException

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 sign on is no longer valid

assignAssignableDynamicGroup

public void assignAssignableDynamicGroup(AMAssignableDynamicGroup assignableDynamicGroup)
                                  throws AMException,
                                         SSOException

Assigns a assignable dynamic group to the user.

Parameters:

assignableDynamicGroup - The AssignableDynamicGroup 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 sign on is no longer valid

assignAssignableDynamicGroup

public void assignAssignableDynamicGroup(java.lang.String assignableDynamicGroupDN)
                                  throws AMException,
                                         SSOException

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 sign on is no longer valid

removeAssignableDynamicGroup

public void removeAssignableDynamicGroup(AMAssignableDynamicGroup assignableDynamicGroup)
                                  throws AMException,
                                         SSOException

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

Parameters:

assignableDynamicGroup - The AssignableDynamicGroup 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 sign on is no longer valid

removeAssignableDynamicGroup

public void removeAssignableDynamicGroup(java.lang.String assignableDynamicGroupDN)
                                  throws AMException,
                                         SSOException

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 sign on is no longer valid

activate

public void activate()
              throws AMException,
                     SSOException

Activates the user.

Throws:

AMException - if an error is encountered when trying to access/retrieve data from the data store

SSOException - if the sign on is no longer valid

deactivate

public void deactivate()
                throws AMException,
                       SSOException

Deactivates the user.

Throws:

AMException - if an error is encountered when trying to access/retrieve data from the data store

SSOException - if the sign on is no longer valid

isActivated

public boolean isActivated()
                    throws AMException,
                           SSOException

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 sign on is no longer valid

getAssignedServices

public java.util.Set getAssignedServices()
                                  throws AMException,
                                         SSOException

Gets all service names that are assigned to the user.

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 sign on is no longer valid

assignServices

public void assignServices(java.util.Set serviceNames)
                    throws AMException,
                           SSOException

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 sign on is no longer valid

unassignServices

public void unassignServices(java.util.Set serviceNames)
                      throws AMException,
                             SSOException

Unassigns services from 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 sign on is no longer valid