com.ibm.itim.dataservices.model.pim
Class Credential

java.lang.Object
  com.ibm.itim.dataservices.model.DirectoryEntry
      com.ibm.itim.dataservices.model.DirectoryObject
          com.ibm.itim.dataservices.model.pim.Credential

All Implemented Interfaces:

CredentialComponent, ProtectedObject, com.ibm.itim.util.Sortable, com.ibm.itim.util.xml.objectstream.Importable, java.io.Serializable

public class Credential
extends DirectoryObject
implements CredentialComponent

This is a value Object class that holds the attribute information of a credential in the data model.

Since:

6.0

See Also:

CredentialSetting, Serialized Form

Nested Class Summary

static class	Credential.AccessMode Enumeration constants of credential access mode
static class	Credential.Status Enumeration constants of credential status

Field Summary

static java.lang.String	CRED_ATTR_ACCOUNT This is a constant for the account DN attribute name.
static java.lang.String	CRED_ATTR_IS_EXCLUSIVE This is a constant for the attribute name of credential access mode.
static java.lang.String	CRED_ATTR_MAX_CHECKOUT_TIME This is a constant for the attribute name of credential maximum checkout time
static java.lang.String	CRED_ATTR_PASSWORD_RESET This is a constant for password reset attribute name
static java.lang.String	CRED_ATTR_PASSWORD_VIEWABLE String constant for password viewable attribute name
static java.lang.String	CRED_ATTR_SEARCHOPTION This is a constant for the credential searcahability attribute name.
static java.lang.String	PROFILE_NAME This is the profile name for credential

Fields inherited from class com.ibm.itim.dataservices.model.DirectoryObject

ATTR_ACCESS_RIGHT, ATTR_LIFECYCLE_ENABLE, ATTR_URI, DESCRIPTION, NAME

Fields inherited from interface com.ibm.itim.dataservices.model.pim.CredentialComponent

CRED_ATTR_DESCRIPTION, CRED_ATTR_NAME, CRED_ATTR_PARENT, CRED_ATTR_PROFILE_NAME, CRED_USE_GLOBAL_SETTINGS

Fields inherited from interface com.ibm.itim.util.Sortable

ATTR_NAME

Constructor Summary

Credential()
This is a default constructor.

Credential(AttributeValues attrs)
This constructor creates an object with attribute information.

Credential(DirectoryObject dirObj)
This is a copy constructor.

Method Summary

boolean	equals(java.lang.Object obj) This API compares this credential with the passing object.
DistinguishedName	getAccountDN() This API returns the distinguished name of the associated account.
CredentialSetting	getCredentialSetting() This API returns the settings of the credential such as maximum checkout duration and so on.
static java.util.Collection<java.lang.String>	getCredentialSettingAttributes()
java.lang.String	getDescription() This API returns the credential description.
boolean	getUseGlobalSettings() This API returns the value for use global settings attribute.
int	hashCode() Returns a hash value that can be used in hash tables.
boolean	isPool() This API always returns false.
void	setCredentialSetting(CredentialSetting settings) This API changes the credential's settings.
void	setDescription(java.lang.String description) This API changes the description of the credential.
void	setName(java.lang.String name) This API changes the credential name
void	setUseGlobalSettings(boolean useGlobalSettings) This API sets/changes the value of use global settings attribute

Methods inherited from class com.ibm.itim.dataservices.model.DirectoryObject

addAttribute, addAttributeValues, getAccessRights, getAttribute, getAttributes, getAuthorizationOwners, getMapAttributeNames, getMappedAttributes, getName, getNameAttribute, getOldMappedAttributes, getProfileName, getRawAttributes, getSortValue, getTenantDN, isLifecycleDefined, removeAttribute, removeAttribute, setAccessRights, setAttribute, setAttributes, setAuthorizationOwners, setProfileName, setTenantDN, toString

Methods inherited from class com.ibm.itim.dataservices.model.DirectoryEntry

clearChange, clearChanges, getChanges, getDistinguishedName, getLastModified, getObjectClasses, getOldAttributes, setDistinguishedName

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ibm.itim.dataservices.model.pim.CredentialComponent

getDistinguishedName, getName

Field Detail

PROFILE_NAME

public static java.lang.String PROFILE_NAME

This is the profile name for credential

CRED_ATTR_SEARCHOPTION

public static java.lang.String CRED_ATTR_SEARCHOPTION

This is a constant for the credential searcahability attribute name.

CRED_ATTR_ACCOUNT

public static java.lang.String CRED_ATTR_ACCOUNT

This is a constant for the account DN attribute name.

CRED_ATTR_PASSWORD_RESET

public static java.lang.String CRED_ATTR_PASSWORD_RESET

This is a constant for password reset attribute name

CRED_ATTR_MAX_CHECKOUT_TIME

public static java.lang.String CRED_ATTR_MAX_CHECKOUT_TIME

This is a constant for the attribute name of credential maximum checkout time

CRED_ATTR_PASSWORD_VIEWABLE

public static java.lang.String CRED_ATTR_PASSWORD_VIEWABLE

String constant for password viewable attribute name

CRED_ATTR_IS_EXCLUSIVE

public static java.lang.String CRED_ATTR_IS_EXCLUSIVE

This is a constant for the attribute name of credential access mode. This attribute has three enumerated values:
AccessMode.EXCLUSIVE , AccessMode.NONEXCLUSIVE, AccessMode.NONSHARED

Constructor Detail

Credential

public Credential()

This is a default constructor. Use the setter methods to set each properties when constructing with this default. Warning: the purpose of this constructor is to enable the clients to create value objects in the data store. Do not use this constructor to create value objects that represent existing entities. Use the CredentialSearch object for that purpose.

Credential

public Credential(AttributeValues attrs)

This constructor creates an object with attribute information. Warning: the purpose of this constructor is to enable the clients to create value objects in the data store. Do not use this constructor to create value objects that represent existing entities. Use the CredentialSearch object for that purpose.

Parameters:

attrs - AttributeValues This parameter holds the attribute values of the credential.

Credential

public Credential(DirectoryObject dirObj)

This is a copy constructor.

Method Detail

setName

public void setName(java.lang.String name)

This API changes the credential name

Specified by:

setName in interface CredentialComponent

Parameters:

name - String This parameter specifies the credential name

getDescription

public java.lang.String getDescription()

This API returns the credential description.

setDescription

public void setDescription(java.lang.String description)

This API changes the description of the credential.

Parameters:

description - String This parameter specifies the description of the credential.

getUseGlobalSettings

public boolean getUseGlobalSettings()

This API returns the value for use global settings attribute.

Returns:

value of use global settings attribute

true indicates credential uses global settings

false indicates credential has its own setting

setUseGlobalSettings

public void setUseGlobalSettings(boolean useGlobalSettings)

This API sets/changes the value of use global settings attribute

Parameters:

useGlobalSettings
-

true to indicate use global settings

false to indicate do not use global setting

getAccountDN

public DistinguishedName getAccountDN()

This API returns the distinguished name of the associated account.

Returns:

DistinguishedName represents the distinguishedname of the account the credential is associated.
null if the credential does not have an associated account.

getCredentialSetting

public CredentialSetting getCredentialSetting()

This API returns the settings of the credential such as maximum checkout duration and so on. Refer to CredentialSetting value object.

Returns:

CredentialSetting This API returns the credential settings.

setCredentialSetting

public void setCredentialSetting(CredentialSetting settings)

This API changes the credential's settings.

Parameters:

settings - CredentialSetting This parameter specifies the credential's new settings.

equals

public boolean equals(java.lang.Object obj)

This API compares this credential with the passing object.

Overrides:

equals in class java.lang.Object

Returns:

This API returns true if they are equivalent; otherwise, it returns false

hashCode

public int hashCode()

Returns a hash value that can be used in hash tables.

Overrides:

hashCode in class java.lang.Object

Returns:

Hash value for the distinguished name.

isPool

public boolean isPool()

This API always returns false.

Specified by:

isPool in interface CredentialComponent

Returns:

true if this is a credential pool; false otherwise.

getCredentialSettingAttributes

public static java.util.Collection<java.lang.String> getCredentialSettingAttributes()