Package oracle.iam.identity.usermgmt.vo

Class User

java.lang.Object
oracle.iam.identity.usermgmt.vo.User
All Implemented Interfaces:
Serializable, Identity
Direct Known Subclasses:
User
public class User extends Object implements Identity
The User class is a value object class to hold the Identifier, attribute name-value pair and direct reports of user.
Author:
abhimanyu seth
See Also:

  • Constructor Details

    • User

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

    • User

      public User(String entityId, HashMap<String,Object> attrs)
      Constructs a user identity object with specified unique Identifier 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 Details

    • setAttribute

      public void setAttribute(String attr, 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 Object getAttribute(String attr)
      Get the value of the specified user 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 String getEntityId()
      Provides GUID of the user.
      Specified by:
      getEntityId in interface Identity
      Returns:
      GUID of the user.

    • getAttributes

      public HashMap<String,Object> 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 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 String getId()
      Provides the user unique identifier. This is a read-only value.
      Returns:
      unique identifier of the user

    • getLogin

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

    • setLogin

      public void setLogin(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 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(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 String getFirstName()
      Provides the first name specified for the user.
      Returns:
      the first name specified for the user

    • setFirstName

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

    • getLastName

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

    • setLastName

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

    • getMiddleName

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

    • setMiddleName

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

    • getDisplayName

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

    • setDisplayName

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

    • getCommonName

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

    • setCommonName

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

    • getStartDate

      public 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(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 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(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 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(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 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(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 Date getProvisionedDate()
      Provides the date on which the user was provisioned with resources.
      Returns:
      the provisioned date for the user

    • setProvisionedDate

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

    • getDeprovisionedDate

      public 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(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 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(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 String getStatus()
      Provides the current status of the user.
      Returns:
      the user status

    • setStatus

      public void setStatus(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 String getAccountStatus()
      Provides the status of the user account. 1/null =unlocked 0 = locked due to invalid login attempt 1 = Admin lock 2 = locked due to invalid password reset attempt
      Returns:
      user value set for Lock attribute

    • setAccountStatus

      public void setAccountStatus(String accountStatus)
      Sets the status of the user account.
      Parameters:
      accountStatus - to set for Lock attribute

    • getUserDisabled

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

    • setUserDisabled

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

    • getEmail

      public String getEmail()
      Provides the email set for the user.
      Returns:
      user Email

    • setEmail

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

    • getAutomaticallyDeleteDate

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

    • getAccountLockedDate

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

    • getUserType

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

    • setUserType

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

    • getPasswordCantChange

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

    • getPasswordMustChange

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

    • getPasswordNeverExpires

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

    • getCreationDate

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

    • getEmployeeType

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

    • setEmployeeType

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

    • getPasswordExpireDate

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

    • getPasswordWarnDate

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

    • getManagerKey

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

    • setManagerKey

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

    • setManagerKey

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

    • getPasswordWarned

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

    • setPasswordWarned

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

    • getPasswordExpired

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

    • getLoginAttemptsCounter

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

    • getPasswordResetAttemptsCounter

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

    • getChangePasswordAtNextLogin

      public 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 Date getPasswordMinimumAge()
      Deprecated TO get password min age date, get applicable password policy of the user Get min age in days from the policy and add that to password creation date
      Returns:

    • getPasswordCreationDate

      public Date getPasswordCreationDate()
      Gets the password ccreation date for the user.
      Returns:

    • getTimezone

      @Deprecated public TimeZone getTimezone()
      Deprecated.
      Gets the TimeZone set for the user.
      Returns:

    • setTimezone

      @Deprecated public void setTimezone(TimeZone timezone)
      Deprecated.
      Sets the TimeZone for the user.
      Parameters:
      timezone -

    • getLocale

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

    • setLocale

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

    • getManuallyLocked

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

    • getCountry

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

    • setCountry

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

    • setDepartmentNumber

      public void setDepartmentNumber(String departmentNumber)
      Sets the user departmentNumber.
      Parameters:
      departmentNumber -

    • getDepartmentNumber

      public String getDepartmentNumber()
      Gets the user departmentNumber.
      Returns:

    • getDescription

      @Deprecated public String getDescription()
      Deprecated.
      Gets the description set for the user.
      Returns:

    • setDescription

      @Deprecated public void setDescription(String description)
      Deprecated.
      Sets the description for the user.
      Parameters:
      description -

    • getEmployeeNumber

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

    • setEmployeeNumber

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

    • getGenerationQualifier

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

    • setGenerationQualifier

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

    • getPasswordGenerated

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

    • setMobile

      public void setMobile(String mobile)
      * Sets the user MobileNumber. * @param MobileNumber

    • getMobile

      public String getMobile()
      * Gets the user MobileNumber. * @return

    • toString

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