com.ca.identitymanager.provisioning.managedobject
Interface Account

All Superinterfaces:

AttributeCollection, ManagedObject, java.util.Map, ModifiableObject, NamedObject, java.io.Serializable

public interface Account
extends ManagedObject

Defines an eTrust Admin provisioning account to Identity Manager.

A provisioning account represents the identity of a user in a particular endpoint type (such as Active Directory or LDAP). The AccountType object indicates the endpoint type that the account is associated with.

A provisioning account is associated with a particular User object.

If an attempt is made to delete a user with one or more eTrust Admin accounts, the system attempts to delete all of the accounts before deleting the user. If any of the accounts fail to delete, the user is not deleted.

Note: This object requires an instance of eTrust Admin Directory. This object also requires an IAMSession has already been established.

Since:

Identity Manager 12

See Also:

ProvisioningPolicy, ProvisioningRole

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

static java.lang.String	ATTRIBUTE_DELIMETER
static java.lang.String	PROPERTY_ACCOUNT_TEMPLATES
static java.lang.String	PROPERTY_CONTAINER Attribute identifier for the account object's container.
static java.lang.String	PROPERTY_CONTAINER_HANDLE Attribute identifier for the account object's container handle.
static java.lang.String	PROPERTY_ENDPOINT Attribute identifier for the account object's endpoint.
static java.lang.String	PROPERTY_ENDPOINT_DESCRIPTION Attribute identifier for the endpoint's description.
static java.lang.String	PROPERTY_ENDPOINT_HANDLE Attribute identifier for the account object's endpoint handle.
static java.lang.String	PROPERTY_ENDPOINT_TYPE Attribute identifier for the account object's endpoint type.
static java.lang.String	PROPERTY_EXCEPTION_ACCOUNT
static java.lang.String	PROPERTY_EXCEPTION_ACCOUNT_JIAM
static java.lang.String	PROPERTY_FRIENDLY_NAME Attribute identifier for the account object's name.
static java.lang.String	PROPERTY_LOCKED
static java.lang.String	PROPERTY_LOCKED_STATE Attribute identifier for the account object's locked state.
static java.lang.String	PROPERTY_PASSWORD Attribute identifier for the account object's password.
static java.lang.String	PROPERTY_SOURCE Attribute identifier for the account object's source
static java.lang.String	PROPERTY_SUSPENDED_STATE Attribute identifier for the account object's suspended state.
static java.lang.String	PROPERTY_USER_FRIENDLY_NAME Attribute identifier for the account object's user.

Method Summary

java.util.Vector	assign(java.lang.String opId, User targetUser) Associate an account from one user to another
java.util.Vector	delete(java.lang.String operationId) Delete an account
java.util.Vector	getAccountReasons(User user, java.util.Hashtable userRoles) Returns the reasons which caused this eTrust Admin provisioning Account to be created.
AccountType	getAccountType() Retrieves the type of this account.
java.lang.String	getDefaultAccountTemplateAttributeValue(java.lang.String attributeName)
java.lang.String	getEndpointAttributeValue(java.lang.String attributeName)
java.lang.String	getEndPointName() Retrieves the name of the endpoint on which this eTrust Admin provisioning Account resieds.
IAMHandle	getIAMHandle() Retuns the JIAM Handle of the eTrust Admin provisioning Account.
AccountReturnType	getLockedState() Retrieves the account's locked state.
java.lang.String	getPassword() Retuns a string containing the password that has been assinged to the eTrust Admin provisioning Account.
void	getSecondaryAttributes(IAMSession jiamSession) Retrieves the "secondary attributes" associated with this eTrust Admin provisioning account.
AccountReturnType	getSuspendedState() Retrieves the eTrust Admin provisioning Account's suspended state.
User	getUser() Retrieves the user associated with the account.
java.lang.String	getUserAccountName() Retrieves the name of this eTrust Admin provisioning account.
boolean	isEqualTo(Account accIn) This method compares the specified account, accIn, to the this account and returns true if the two are equal and false if they are not.
AccountReturnType	isExceptionAccount() Returns true if this account is an "exception account" that should be excluded from being deleted when the user is synchronized with his roles.
boolean	isLockedModified() Indicates whether or not the Locked attribute for this eTrust Admin provisioning Account has been modified.
boolean	isPasswordModified() Indicates whether or not the the password for this eTrust Admin provisioning Account has been modified.
boolean	isSuspendedModified() Indicates whether or not the the suspended attribute for this eTrust Admin provisioning Account has been modified.
void	relocate(Container container) Relocate an account to another container
void	setExceptionAccount(boolean exceptionAccount) Set if this is an exception account
void	setLockedState(boolean locked) Sets the account's locked state.
void	setPassword(java.lang.String password) Specifies the password to be set for the eTrust Admin provisioning Account.
void	setSuspendedState(boolean suspended) Sets the account's suspended state.
void	unassign() Deprecated. in Im r12
java.util.Vector	unassign(java.lang.String opId) Disassociates an account from this user.
boolean	validateNewPassword(java.lang.String password, PasswordCondition cond, User user) Determines if a given string is aceptable as a new password for this account.

Methods inherited from interface com.netegrity.llsdk6.imsapi.managedobject.ManagedObject

directAddAttributeValue, directRemoveAttributeValue, equals, fixUniqueNames, getImsDirectory, getImsEnvironment, getObjectType, getOrg, getOrg, getProvider, hashCode, move, persisted

Methods inherited from interface com.netegrity.llsdk6.imsapi.abstractinterface.NamedObject

getFriendlyName, getUniqueName, toString

Methods inherited from interface com.netegrity.llsdk6.imsapi.abstractinterface.AttributeCollection

addAttributes, addValueToAttribute, containsAttribute, doesAttributeHaveMultipleValues, enumerateAttributes, getAttribute, getAttributeMultiValue, getAttributePermission, getAttributes, getExtendedAttribute, getLastCommittedAttribute, getLastCommittedAttributeMultiValue, getLastCommittedValue, getOriginalAttribute, getOriginalAttributeMultiValue, getOriginalValue, getValue, hasAttributeChanged, isAttributeUncommitted, isUncommitted, makeCurrentValueOriginal, removeAttributes, setAttribute, setAttributeMultiValue, setAttributes, setValue, updateAttributeSet

Methods inherited from interface com.netegrity.llsdk6.imsapi.abstractinterface.ModifiableObject

modifyObject, modifyObject

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Field Detail

ATTRIBUTE_DELIMETER

static final java.lang.String ATTRIBUTE_DELIMETER

See Also:

Constant Field Values

PROPERTY_FRIENDLY_NAME

static final java.lang.String PROPERTY_FRIENDLY_NAME

Attribute identifier for the account object's name.

See Also:

Constant Field Values

PROPERTY_ENDPOINT_DESCRIPTION

static final java.lang.String PROPERTY_ENDPOINT_DESCRIPTION

Attribute identifier for the endpoint's description.

See Also:

Constant Field Values

PROPERTY_ENDPOINT_TYPE

static final java.lang.String PROPERTY_ENDPOINT_TYPE

Attribute identifier for the account object's endpoint type.

See Also:

Constant Field Values

PROPERTY_ENDPOINT

static final java.lang.String PROPERTY_ENDPOINT

Attribute identifier for the account object's endpoint.

See Also:

Constant Field Values

PROPERTY_ENDPOINT_HANDLE

static final java.lang.String PROPERTY_ENDPOINT_HANDLE

Attribute identifier for the account object's endpoint handle.

See Also:

Constant Field Values

PROPERTY_CONTAINER

static final java.lang.String PROPERTY_CONTAINER

Attribute identifier for the account object's container.

See Also:

Constant Field Values

PROPERTY_CONTAINER_HANDLE

static final java.lang.String PROPERTY_CONTAINER_HANDLE

Attribute identifier for the account object's container handle.

See Also:

Constant Field Values

PROPERTY_PASSWORD

static final java.lang.String PROPERTY_PASSWORD

Attribute identifier for the account object's password.

See Also:

Constant Field Values

PROPERTY_SUSPENDED_STATE

static final java.lang.String PROPERTY_SUSPENDED_STATE

Attribute identifier for the account object's suspended state.

See Also:

Constant Field Values

PROPERTY_LOCKED_STATE

static final java.lang.String PROPERTY_LOCKED_STATE

Attribute identifier for the account object's locked state.

See Also:

Constant Field Values

PROPERTY_SOURCE

static final java.lang.String PROPERTY_SOURCE

Attribute identifier for the account object's source

See Also:

Constant Field Values

PROPERTY_USER_FRIENDLY_NAME

static final java.lang.String PROPERTY_USER_FRIENDLY_NAME

Attribute identifier for the account object's user.

See Also:

Constant Field Values

PROPERTY_EXCEPTION_ACCOUNT

static final java.lang.String PROPERTY_EXCEPTION_ACCOUNT

See Also:

Constant Field Values

PROPERTY_ACCOUNT_TEMPLATES

static final java.lang.String PROPERTY_ACCOUNT_TEMPLATES

See Also:

Constant Field Values

PROPERTY_EXCEPTION_ACCOUNT_JIAM

static final java.lang.String PROPERTY_EXCEPTION_ACCOUNT_JIAM

See Also:

Constant Field Values

PROPERTY_LOCKED

static final java.lang.String PROPERTY_LOCKED

See Also:

Constant Field Values

Method Detail

isExceptionAccount

AccountReturnType isExceptionAccount()
                                     throws SmApiException

Returns true if this account is an "exception account" that should be excluded from being deleted when the user is synchronized with his roles.

Returns:

Throws:

SmApiException

setExceptionAccount

void setExceptionAccount(boolean exceptionAccount)
                         throws SmApiException

Set if this is an exception account

Parameters:

exceptionAccount -

Throws:

SmApiException

getSecondaryAttributes

void getSecondaryAttributes(IAMSession jiamSession)
                            throws SmApiException

Retrieves the "secondary attributes" associated with this eTrust Admin provisioning account.

The "secondary attributes" of an account are those attribues that require accessing the endpoint on which the account exists to be retreived. This operation may require some time to complete, as accessing the account endpoint is an opoeration that may be constrainted by network topology. It should be noted that it is not necessary to retrieve the account secondary attributes in order to modify them. For example, it is not necessary to retrieve the "suspended" state of an account in order to make a request to "resume" that account.

Throws:

JIAMOperationException - This exception indicates that there was a error encounted while tring to access the account secondary attributes, andthat this error was reported from the JIAM API layer.

SmApiException

Since:

Identity Manager 8.1 SP1

getUser

User getUser()
             throws SmApiException

Retrieves the user associated with the account.

Returns:

User associated with the account. On failure, null

Throws:

SmApiException

getUserAccountName

java.lang.String getUserAccountName()
                                    throws SmApiException

Retrieves the name of this eTrust Admin provisioning account.

Returns:

The name of the account.

Throws:

SmApiException

getAccountType

AccountType getAccountType()
                           throws SmApiException

Retrieves the type of this account. The account type reflects the endpoint type associated with the account.

Returns:

An object that indicates the account type.

Throws:

SmApiException

getEndPointName

java.lang.String getEndPointName()
                                 throws SmApiException

Retrieves the name of the endpoint on which this eTrust Admin provisioning Account resieds.

Returns:

A string containd the name of the endpoint on which the account resides.

Throws:

SmApiException

isSuspendedModified

boolean isSuspendedModified()
                            throws SmApiException

Indicates whether or not the the suspended attribute for this eTrust Admin provisioning Account has been modified. The suspended attributes is the suspended state of the account.

Returns:

true - The suspended state, of the account has been modified false - The suspended state, of the account has not been modified

Throws:

SmApiException

Since:

Identity Manager 8.1 SP1

setSuspendedState

void setSuspendedState(boolean suspended)
                       throws SmApiException

Sets the account's suspended state.

This method allows the "suspended" state of the eTrust Admin provisioning Account to be set to boolean "true" or "false". This method is used to indicate that the suspend state for the account is to be modified to the specific state. The suspend state can be set regardless of its current state, as returned by getSuspendedState(). If setting the Suspended state of the account will not change the current Suspended state, then no net action will be taken (this account will not be modified.

Throws:

SmApiException

Since:

Identity Manager 8.1 SP1

getSuspendedState

AccountReturnType getSuspendedState()
                                    throws SmApiException

Retrieves the eTrust Admin provisioning Account's suspended state.

Returns:

AccountReturnType:

AccountReturnType.TRUE

The account IS suspended.

AccountReturnType.FALSE

The account is NOT suspended.

AccountReturnType.UNKNOWN

The suspended state is not known; no Secondary Access Attributes have been retrieved for

this account.

AccountReturnType.UNAVAILABLE

The attempt to retrieve the suspended state of this account failed. This represents a condition

where the endpoint associated with this account could not be accessed.

Throws:

SmApiException

Since:

Identity Manager 8.1 SP1

getLockedState

AccountReturnType getLockedState()
                                 throws SmApiException

Retrieves the account's locked state.

Returns:

AccountReturnType:

AccountReturnType.TRUE

The account IS locked.

AccountReturnType.FALSE

The account is NOT locked.

AccountReturnType.UNKNOWN

The locked state is not known; no Secondary Access Attributes have been retrieved for

this account.

AccountReturnType.UNAVAILABLE

The attempt to retrieve the locked state of this account failed. This represents a condition

where the endpoint associated with this account could not be accessed.

Throws:

SmApiException

Since:

Identity Manager 8.1 SP1

setLockedState

void setLockedState(boolean locked)
                    throws SmApiException

Sets the account's locked state.

This method allows the "locked" state of the eTrust Admin provisioning Account to be set to boolean "true" or "false". This method is used to indicate that the locked state for the account is to be modified to the specific state. The locked state can be set regardless of its current state, as returned by getLockedState(). If setting the Locked state of the account will not change the current Locked state, then no net action will be taken (this account will not be modified.

Throws:

SmApiException

Since:

Identity Manager 8.1 SP1

isLockedModified

boolean isLockedModified()
                         throws SmApiException

Indicates whether or not the Locked attribute for this eTrust Admin provisioning Account has been modified. The Locked attributes is the locked state of the account.

Returns:

true - The locked state of the account has been modified false - The locked state of the account has not been modified

Throws:

SmApiException

Since:

Identity Manager 8.1 SP1

isPasswordModified

boolean isPasswordModified()
                           throws SmApiException

Indicates whether or not the the password for this eTrust Admin provisioning Account has been modified.

Returns:

true - The password of the account has been modified false - The password of the account has not been modified

Throws:

SmApiException

Since:

Identity Manager 8.1 SP1

getPassword

java.lang.String getPassword()
                             throws SmApiException

Retuns a string containing the password that has been assinged to the eTrust Admin provisioning Account. If no password has been specified for the account, during the current task session, then a blank string will be returned. This method does not return the password which has been stored on the endpoint, it only returns the password which has been speicified by the setPassword method during the current task session.

Returns:

A string containing the password which has been specified for the account, during the current task session, with the setPassword method.

Throws:

SmApiException

Since:

Identity Manager 8.1 SP1

setPassword

void setPassword(java.lang.String password)
                 throws SmApiException

Specifies the password to be set for the eTrust Admin provisioning Account.

Parameters:

password - a string containing the password to be associated with the account.

Throws:

SmApiException

Since:

Identity Manager 8.1 SP1

validateNewPassword

boolean validateNewPassword(java.lang.String password,
                            PasswordCondition cond,
                            User user)

Determines if a given string is aceptable as a new password for this account.

Parameters:

password - The proposed password that is to be validated

cond - A PasswordCondition object that is populated with information on why a proposed password could not be validated.

Returns:

true if the password is validated, or false otherwise. If false, Identity Manager provides the reasons in the output parameter cond.

getAccountReasons

java.util.Vector getAccountReasons(User user,
                                   java.util.Hashtable userRoles)
                                   throws SmApiException

Returns the reasons which caused this eTrust Admin provisioning Account to be created. If the reasons have not been initialize, either on construction of this account or by an explicit call the method initReasons(), then an empty vector will be returned. The "reasons" is a list of eTrust Admin Roles and the contained eTrust Admin Policies from which the account was provisioned. The Roles are those that have been assigned to the User with which the account is associated.

Returns:

Vector of AccountReason objects

Throws:

SmApiException

Since:

Identity Manager 8.1 SP1

unassign

void unassign()
              throws SmApiException

Deprecated. in Im r12

Disassociates an account from this user. This will not delete the actual account on the end point system.

Throws:

SmApiException

unassign

java.util.Vector unassign(java.lang.String opId)
                          throws SmApiException

Disassociates an account from this user. If the user is other than [default user] the account will be associated to [default user], otherwise it will just get removed from the user. This will not delete the actual account on the end point system.

Parameters:

operationID - Operation ID to be used for the JIAM commit operation. Ideally this should be derived from the IM eventID using ProvisioningDefinitionImpl.getIMOperationId() .

Returns:

JIAM Operation return message from admin server in case of a success.

Throws:

SmApiException

Since:

Identity Manager r12

assign

java.util.Vector assign(java.lang.String opId,
                        User targetUser)
                        throws SmApiException

Associate an account from one user to another

Parameters:

opId - Operation ID to be used for the JIAM commit operation. Ideally this should be derived from the IM eventID using ProvisioningDefinitionImpl.getIMOperationId() .

Returns:

JIAM Operation return message from admin server in case of a success.

Throws:

SmApiException

Since:

Identity Manager r12

getIAMHandle

IAMHandle getIAMHandle()

Retuns the JIAM Handle of the eTrust Admin provisioning Account.

Returns:

The JIAM Handle of the account.

Since:

Identity Manager 8.1 SP1

isEqualTo

boolean isEqualTo(Account accIn)
                  throws SmApiException

This method compares the specified account, accIn, to the this account and returns true if the two are equal and false if they are not. To accounts are considered to be equal if the account names and endpoint names are the same.

Parameters:

accIn - an account which is being compared to this account.

Returns:

true if the specified account, accIn, is equal to this account false if the specified account, accIn, is not equal to this account

Throws:

SmApiException

Since:

Identity Manager 8.1 SP1

delete

java.util.Vector delete(java.lang.String operationId)
                        throws SmApiException

Delete an account

Parameters:

operationId - - Operation Id to use for the JIAM session.

Returns:

- operation message from the provisioning server.

Throws:

SmApiException

getEndpointAttributeValue

java.lang.String getEndpointAttributeValue(java.lang.String attributeName)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

getDefaultAccountTemplateAttributeValue

java.lang.String getDefaultAccountTemplateAttributeValue(java.lang.String attributeName)

relocate

void relocate(Container container)
              throws SmApiException

Relocate an account to another container

Parameters:

container - - The destination container to relocate to

Throws:

SmApiException