Skip navigation links


oracle.iam.identity.usermgmt.vo
Class User

java.lang.Object
  extended by oracle.iam.identity.usermgmt.vo.User

All Implemented Interfaces:
java.io.Serializable, Identity
Direct Known Subclasses:
User

public class User
extends java.lang.Object
implements Identity

The User class is a value object class to hold the GUID, attribute name-value pair and direct reports of user.

See Also:
Serialized Form

Constructor Summary
User(java.lang.String entityId)
          Constructs a user identity object with GUID entityId.
User(java.lang.String entityId, java.util.HashMap attrs)
          Constructs a user identity object with GUID entityId and a map of attribute name-value pair.

 

Method Summary
 java.util.Date getAccountLockedDate()
          Provides the date on which the user account was locked.
 java.lang.String getAccountStatus()
          Provides the status if the user account.
 java.lang.Object getAttribute(java.lang.String attr)
          Get the value of the specified organization attribute name.
 java.util.Set getAttributeNames()
          Provides a set of all the user attribute names.
 java.util.HashMap getAttributes()
          Provides a map of all attribute-value pair of user.
 java.util.Date getAutomaticallyDeleteDate()
          Provides the date on which the user account will get deleted automatically.
 java.lang.String getChangePasswordAtNextLogin()
          Gets whether the user should be asked to change the password at next login.
 java.lang.String getCommonName()
          Provides the common name specified for the user.
 java.lang.String getCountry()
          Gets the user country.
 java.util.Date getCreationDate()
          Gets the date on which the user was created.
 java.util.Date getDeprovisionedDate()
          Provides the date on which the user was de-provisioned of resources.
 java.util.Date getDeprovisioningDate()
          Provides the date set for the user on which its resources would be de-provisioned.
 java.lang.String getDescription()
          Gets the description set for the user.
 java.lang.String getDisplayName()
          Provides a display name specified for the user.
 java.lang.String getEmail()
          Provides the email set to the user.
 java.lang.String getEmployeeNumber()
          Gets the employee number of the user created within the LDAP system.
 java.lang.String getEmployeeType()
          Gets the type of employee the user is created as.
 java.util.Date getEndDate()
          Provides the date set for the user on which the account ceases to be in effect.
 java.lang.String getEntityId()
          Provides GUID of the user.
 java.lang.String getFirstName()
          Provides the first name specified for the user.
 java.lang.String getGenerationQualifier()
          Gets the generation qualifier of the user created within the LDAP system.
 java.lang.String getId()
          Provides the user unique identifier.
 java.lang.String getLastName()
          Provides the last name specified for the user.
 java.util.Locale getLocale()
          Gets the Locale set for the user.
 java.lang.String getLogin()
          Provides the login information of the user.
 java.lang.String getLoginAttemptsCounter()
          Gets the number of login attempts made by the user.
 java.lang.String getManagerKey()
          Gets the entity id of the user's manager.
 java.lang.String getManuallyLocked()
          Gets if the user account is manually locked.
 java.lang.String getMiddleName()
          Provides the middle name specified for the user.
 java.lang.String getOrganizationKey()
          Provides the Key of the organization the user is a member of.
 java.lang.String getPasswordCantChange()
          Gets if the user password can be changed.
 java.lang.String getPasswordExpired()
          Gets if the user password has expired.
 java.util.Date getPasswordExpireDate()
          Gets the date on which the user password will expire.
 java.lang.String getPasswordGenerated()
          Gets whether the user password is auto-generated.
 java.util.Date getPasswordMinimumAge()
          Gets the minimum age set for the user password.
 java.lang.String getPasswordMustChange()
          Gets if the user password must be changed.
 java.lang.String getPasswordNeverExpires()
          Gets if the user password can expire.
 java.lang.String getPasswordResetAttemptsCounter()
          Gets the number of attempts the user has made to reset the password.
 java.util.Date getPasswordWarnDate()
          Gets the date on which the user should be warned about password due for expiration.
 java.lang.String getPasswordWarned()
          Gets if the user has been warned about password due for expiration.
 java.lang.String getPolicyUpdateEnabled()
          Provides the flag value which tells if the access policies needs to be applied to the user.
 java.util.Date getProvisionedDate()
          Provides the date on which the user was provisioned with resources.
 java.util.Date getProvisioningDate()
          Provides the date set for the user on which it would be provisioned with resources.
 java.util.Date getStartDate()
          Provides the date set for the user on which the account will get into effect.
 java.lang.String getStatus()
          Provides the current status of the user.
 java.util.TimeZone getTimezone()
          Gets the TimeZone set for the user.
 java.lang.String getUserDisabled()
          Gets whether the user is disabled.
 java.lang.String getUserType()
          Provides the 'Xellerate Type' of the user.
 void setAccountStatus(java.lang.String accountStatus)
          Sets the status if the user account.
 void setAttribute(java.lang.String attr, java.lang.Object val)
          Adds the attribute attr and it's value val.
 void setCommonName(java.lang.String commonName)
          Sets the common name of the user.
 void setCountry(java.lang.String country)
          Sets the user country.
 void setDeprovisionedDate(java.util.Date deprovisionedDate)
          Sets the date on which the user is de-provisioned of resources.
 void setDeprovisioningDate(java.util.Date deprovisioningDate)
          Sets the date for the user on which its resources would be de-provisioned.
 void setDescription(java.lang.String description)
          Sets the description for the user.
 void setDisplayName(java.lang.String displayName)
          Sets the display name of the user.
 void setEmail(java.lang.String email)
          Sets the email of the user.
 void setEmployeeNumber(java.lang.String employeeNumber)
          Sets the employee number to be set for the user in the LDAP system.
 void setEmployeeType(java.lang.String employeeType)
          Sets the type of employee the user is to be created as.
 void setEndDate(java.util.Date endDate)
          Sets the date set for the user on which the account ceases to be in effect.
 void setFirstName(java.lang.String firstName)
          Sets the first name of the user.
 void setGenerationQualifier(java.lang.String genQualifier)
          Sets the generation qualifier of the user in the LDAP system.
 void setLastName(java.lang.String lastName)
          Sets the last name of the user.
 void setLocale(java.util.Locale locale)
          Sets the Locale for the user.
 void setLogin(java.lang.String login)
          Sets the user login.
 void setManagerKey(java.lang.String managerKey)
          Sets the entity id of the user to be set as the manager.
 void setMiddleName(java.lang.String middleName)
          Sets the middle name of the user.
 void setOrganizationKey(java.lang.String orgKey)
          Sets the Key of the organization the user is a member of.
 void setPasswordWarned(java.lang.String passwordWarned)
          Sets if the user has been warned about password due for expiration.
 void setPolicyUpdateEnabled(java.lang.String policyUpdateEnabled)
          Sets the flag value which tells if the access policies needs to be applied to the user.
 void setProvisionedDate(java.util.Date provisionedDate)
          Sets the date on which the user is provisioned with resources.
 void setProvisioningDate(java.util.Date provisioningDate)
          Sets the date for the user on which it would be provisioned with resources.
 void setStartDate(java.util.Date startDate)
          Sets the date for the user on which the account will get into effect.
 void setStatus(java.lang.String status)
          Sets the current user status.
 void setTimezone(java.util.TimeZone timezone)
          Sets the TimeZone for the user.
 void setUserDisabled(java.lang.String userDisabled)
          Sets whether the user is disabled.
 void setUserType(java.lang.String userType)
          Sets the 'Xellerate Type' of the user.
 java.lang.String toString()
          Provides the string representation of User value object.

 

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Constructor Detail

User

public User(java.lang.String entityId)
Constructs a user identity object with GUID entityId.
Parameters:
entityId - The GUID of the user.

User

public User(java.lang.String entityId,
            java.util.HashMap attrs)
Constructs a user identity object with GUID entityId and a map of attribute name-value pair.
Parameters:
entityId - The GUID of the user.
attrs - The Map of attribute name-value pair.

Method Detail

setAttribute

public void setAttribute(java.lang.String attr,
                         java.lang.Object val)
Adds the attribute attr and it's value val.
Specified by:
setAttribute in interface Identity
Parameters:
attr - The attribute to be added.
val - The value of the attribute.

getAttribute

public java.lang.Object getAttribute(java.lang.String attr)
Get the value of the specified organization attribute name.
Specified by:
getAttribute in interface Identity
Parameters:
attr - The attribute whose value is to be returned.
Returns:
the value of the attribute. null if the attribute is not present.

getEntityId

public java.lang.String getEntityId()
Provides GUID of the user.
Specified by:
getEntityId in interface Identity
Returns:
GUID of the user.

getAttributes

public java.util.HashMap getAttributes()
Provides a map of all attribute-value pair of user.
Specified by:
getAttributes in interface Identity
Returns:
A map of all attribute-value pair of this user.

getAttributeNames

public java.util.Set getAttributeNames()
Provides a set of all the user attribute names.
Specified by:
getAttributeNames in interface Identity
Returns:
A set of all the user attribute names.

getId

public java.lang.String getId()
Provides the user unique identifier. This is a read-only value.
Returns:
unique identifier of the user

getLogin

public java.lang.String getLogin()
Provides the login information of the user.
Returns:
login value of the user

setLogin

public void setLogin(java.lang.String login)
Sets the user login. Null is not a supported value for user login
Parameters:
login - The login to be set for the user

getOrganizationKey

public java.lang.String getOrganizationKey()
Provides the Key of the organization the user is a member of.
Returns:
the Key of the organization the user is a member of

setOrganizationKey

public void setOrganizationKey(java.lang.String orgKey)
Sets the Key of the organization the user is a member of.
Parameters:
orgKey - the Key of the organization the user is a member of

getFirstName

public java.lang.String getFirstName()
Provides the first name specified for the user.
Returns:
the first name specified for the user

setFirstName

public void setFirstName(java.lang.String firstName)
Sets the first name of the user.
Parameters:
firstName - first name to be specified for the user

getLastName

public java.lang.String getLastName()
Provides the last name specified for the user.
Returns:
the last name specified for the user

setLastName

public void setLastName(java.lang.String lastName)
Sets the last name of the user.
Parameters:
lastName - the last name to be specified for the user

getMiddleName

public java.lang.String getMiddleName()
Provides the middle name specified for the user.
Returns:
; the middle name specified for the user

setMiddleName

public void setMiddleName(java.lang.String middleName)
Sets the middle name of the user.
Parameters:
middleName - the middle name to be specified for the user

getDisplayName

public java.lang.String getDisplayName()
Provides a display name specified for the user.
Returns:
the display name specified for the user

setDisplayName

public void setDisplayName(java.lang.String displayName)
Sets the display name of the user.
Parameters:
displayName - the diaplay name to be specified for the user

getCommonName

public java.lang.String getCommonName()
Provides the common name specified for the user.
Returns:
the common name specified for the user

setCommonName

public void setCommonName(java.lang.String commonName)
Sets the common name of the user.
Parameters:
commonName - the common name to be specified for the user

getStartDate

public java.util.Date getStartDate()
Provides the date set for the user on which the account will get into effect.
Returns:
start date of the user

setStartDate

public void setStartDate(java.util.Date startDate)
Sets the date for the user on which the account will get into effect.
Parameters:
startDate - the date to be set as the start date

getEndDate

public java.util.Date getEndDate()
Provides the date set for the user on which the account ceases to be in effect.
Returns:
end date of the user

setEndDate

public void setEndDate(java.util.Date endDate)
Sets the date set for the user on which the account ceases to be in effect.
Parameters:
endDate - the date to be set as the end date

getProvisioningDate

public java.util.Date getProvisioningDate()
Provides the date set for the user on which it would be provisioned with resources.
Returns:
the provisioning date set for the user

setProvisioningDate

public void setProvisioningDate(java.util.Date provisioningDate)
Sets the date for the user on which it would be provisioned with resources.
Parameters:
provisioningDate - the provisioning date for the user

getDeprovisioningDate

public java.util.Date getDeprovisioningDate()
Provides the date set for the user on which its resources would be de-provisioned.
Returns:
the de-provisioning date set for the user

setDeprovisioningDate

public void setDeprovisioningDate(java.util.Date deprovisioningDate)
Sets the date for the user on which its resources would be de-provisioned.
Parameters:
deprovisioningDate - the de-provisioning date for the user

getProvisionedDate

public java.util.Date getProvisionedDate()
Provides the date on which the user was provisioned with resources.
Returns:
the provisioned date for the user

setProvisionedDate

public void setProvisionedDate(java.util.Date provisionedDate)
Sets the date on which the user is provisioned with resources.
Parameters:
provisionedDate - the provisioned date for the user

getDeprovisionedDate

public java.util.Date getDeprovisionedDate()
Provides the date on which the user was de-provisioned of resources.
Returns:
the de-provisioned date for the user

setDeprovisionedDate

public void setDeprovisionedDate(java.util.Date deprovisionedDate)
Sets the date on which the user is de-provisioned of resources.
Parameters:
deprovisionedDate - the de-provisioned date for the user

getPolicyUpdateEnabled

public java.lang.String getPolicyUpdateEnabled()
Provides the flag value which tells if the access policies needs to be applied to the user.
Returns:
the policy update flag

setPolicyUpdateEnabled

public void setPolicyUpdateEnabled(java.lang.String policyUpdateEnabled)
Sets the flag value which tells if the access policies needs to be applied to the user.
Parameters:
policyUpdateEnabled - the policy update flag to be enabled/disabled

getStatus

public java.lang.String getStatus()
Provides the current status of the user.
Returns:
the user status

setStatus

public void setStatus(java.lang.String status)
Sets the current user status. Possible Values: "Active", "Disabled", "Deleted", "Disabled Until Start Date"
Parameters:
status - user status to be set

getAccountStatus

public java.lang.String getAccountStatus()
Provides the status if the user account. 1 = Locked, 0 = Unlocked.
Returns:
user value set for attribute usr_locked

setAccountStatus

public void setAccountStatus(java.lang.String accountStatus)
Sets the status if the user account. 1 = Locked, 0 = Unlocked.
Parameters:
accountStatus - to set for usr_locked

getUserDisabled

public java.lang.String getUserDisabled()
Gets whether the user is disabled. 1 = Disabled, 0 = Not disabled
Returns:
value of user disabled status

setUserDisabled

public void setUserDisabled(java.lang.String userDisabled)
Sets whether the user is disabled. 1 = Disabled, 0 = Not disabled
Parameters:
userDisabled - user disabled flag to set

getEmail

public java.lang.String getEmail()
Provides the email set to the user.
Returns:
user Email

setEmail

public void setEmail(java.lang.String email)
Sets the email of the user.
Parameters:
email - user Email

getAutomaticallyDeleteDate

public java.util.Date getAutomaticallyDeleteDate()
Provides the date on which the user account will get deleted automatically.
Returns:
account automatic deletion date

getAccountLockedDate

public java.util.Date getAccountLockedDate()
Provides the date on which the user account was locked.
Returns:
user account locked date

getUserType

public java.lang.String getUserType()
Provides the 'Xellerate Type' of the user. Possible values: "End-User", "End-User Administrator"
Returns:

setUserType

public void setUserType(java.lang.String userType)
Sets the 'Xellerate Type' of the user. Possible values: "End-User", "End-User Administrator"
Parameters:
userType -

getPasswordCantChange

public java.lang.String getPasswordCantChange()
Gets if the user password can be changed. This is a read-only value.
Returns:

getPasswordMustChange

public java.lang.String getPasswordMustChange()
Gets if the user password must be changed. This is a read-only value.
Returns:

getPasswordNeverExpires

public java.lang.String getPasswordNeverExpires()
Gets if the user password can expire. This is a read-only value.
Returns:

getCreationDate

public java.util.Date getCreationDate()
Gets the date on which the user was created.
Returns:
user creation date

getEmployeeType

public java.lang.String getEmployeeType()
Gets the type of employee the user is created as.
Returns:
the user employee type

setEmployeeType

public void setEmployeeType(java.lang.String employeeType)
Sets the type of employee the user is to be created as.
Parameters:
employeeType -

getPasswordExpireDate

public java.util.Date getPasswordExpireDate()
Gets the date on which the user password will expire.
Returns:
the user password expiration date

getPasswordWarnDate

public java.util.Date getPasswordWarnDate()
Gets the date on which the user should be warned about password due for expiration.
Returns:

getManagerKey

public java.lang.String getManagerKey()
Gets the entity id of the user's manager.
Returns:
manager entity id

setManagerKey

public void setManagerKey(java.lang.String managerKey)
Sets the entity id of the user to be set as the manager.
Parameters:
managerKey -

getPasswordWarned

public java.lang.String getPasswordWarned()
Gets if the user has been warned about password due for expiration.
Returns:

setPasswordWarned

public void setPasswordWarned(java.lang.String passwordWarned)
Sets if the user has been warned about password due for expiration.
Parameters:
passwordWarned -

getPasswordExpired

public java.lang.String getPasswordExpired()
Gets if the user password has expired. This is a read-only value.
Returns:

getLoginAttemptsCounter

public java.lang.String getLoginAttemptsCounter()
Gets the number of login attempts made by the user. This is a read-only value.
Returns:

getPasswordResetAttemptsCounter

public java.lang.String getPasswordResetAttemptsCounter()
Gets the number of attempts the user has made to reset the password. This is a read-only value.
Returns:

getChangePasswordAtNextLogin

public java.lang.String getChangePasswordAtNextLogin()
Gets whether the user should be asked to change the password at next login. This is a read-only value.
Returns:

getPasswordMinimumAge

public java.util.Date getPasswordMinimumAge()
Gets the minimum age set for the user password.
Returns:

getTimezone

public java.util.TimeZone getTimezone()
Gets the TimeZone set for the user.
Returns:

setTimezone

public void setTimezone(java.util.TimeZone timezone)
Sets the TimeZone for the user.
Parameters:
timezone -

getLocale

public java.util.Locale getLocale()
Gets the Locale set for the user.
Returns:

setLocale

public void setLocale(java.util.Locale locale)
Sets the Locale for the user.
Parameters:
locale -

getManuallyLocked

public java.lang.String getManuallyLocked()
Gets if the user account is manually locked. This is a read-only value. 1 = Yes, 0 = No
Returns:

getCountry

public java.lang.String getCountry()
Gets the user country.
Returns:

setCountry

public void setCountry(java.lang.String country)
Sets the user country.
Parameters:
country -

getDescription

public java.lang.String getDescription()
Gets the description set for the user.
Returns:

setDescription

public void setDescription(java.lang.String description)
Sets the description for the user.
Parameters:
description -

getEmployeeNumber

public java.lang.String getEmployeeNumber()
Gets the employee number of the user created within the LDAP system.
Returns:
user LDAP system employee number

setEmployeeNumber

public void setEmployeeNumber(java.lang.String employeeNumber)
Sets the employee number to be set for the user in the LDAP system.
Parameters:
employeeNumber -

getGenerationQualifier

public java.lang.String getGenerationQualifier()
Gets the generation qualifier of the user created within the LDAP system.
Returns:
generation qualifier of the user

setGenerationQualifier

public void setGenerationQualifier(java.lang.String genQualifier)
Sets the generation qualifier of the user in the LDAP system.
Parameters:
genQualifier - generation qualifier to be set

getPasswordGenerated

public java.lang.String getPasswordGenerated()
Gets whether the user password is auto-generated. This is a read-only value.
Returns:

toString

public java.lang.String toString()
Provides the string representation of User value object.
Specified by:
toString in interface Identity
Overrides:
toString in class java.lang.Object
Returns:
A string representation of User value object.

Skip navigation links


Copyright © 2011, Oracle and/or its affiliates. All rights reserved.