Package org.odpi.openmetadata.frameworks.connectors.properties.users

Class UserAccount

java.lang.Object
org.odpi.openmetadata.frameworks.connectors.properties.users.UserAccount
Direct Known Subclasses:
OpenMetadataUserAccount
public class UserAccount extends Object
UserAccount described details of a user account for the open metadata ecosystem. This could be for a person or system. The fields are informed from the LDAP inetOrgPerson attributes (see RFC 2798). However, many organizations develop their own definitions of a user and so this object includes otherProperties to allow for extensions.

  • Constructor Details

    • UserAccount

      public UserAccount()
      Default constructor

    • UserAccount

      public UserAccount(UserAccount template)
      Copy constructor

  • Method Details

    • getUserName

      public String getUserName()
      Return the name of the user.
      Returns:
      string name

    • setUserName

      public void setUserName(String userName)
      Set up the name of the user.
      Parameters:
      userName - string name

    • getAccountType

      public UserAccountType getAccountType()
      Return whether this account for a person or automation.
      Returns:
      account type enum

    • setAccountType

      public void setAccountType(UserAccountType userAccountType)
      Set up whether this account for a person or automation.
      Parameters:
      userAccountType - enum

    • getEmployeeNumber

      public String getEmployeeNumber()
      Return the employee number (maybe called personnel number, or similar name).
      Returns:
      string

    • setEmployeeNumber

      public void setEmployeeNumber(String employeeNumber)
      Set up the employee number (maybe called personnel number, or similar name).
      Parameters:
      employeeNumber - string

    • getEmployeeType

      public String getEmployeeType()
      Return the type of employee (for example, are they full time, contractor etc). Each organization has their own definitions for these values.
      Returns:
      string

    • setEmployeeType

      public void setEmployeeType(String employeeType)
      Set up the type of employee contract (for example, are they full time, contractor etc). Each organization has their own definitions for these values.
      Parameters:
      employeeType - string

    • getDisplayName

      public String getDisplayName()
      Return the display name for this user (for example, the preferred name of a person).
      Returns:
      string

    • setDisplayName

      public void setDisplayName(String displayName)
      Set up the display name for this user (for example, the preferred name of a person).
      Parameters:
      displayName - string

    • getGivenName

      public String getGivenName()
      Return a person's given name.
      Returns:
      string

    • setGivenName

      public void setGivenName(String givenName)
      Set up a person's given name.
      Parameters:
      givenName - string

    • getSurname

      public String getSurname()
      Return a person's surname.
      Returns:
      string

    • setSurname

      public void setSurname(String surname)
      Set up a person's surname.
      Parameters:
      surname - string

    • getEmail

      public String getEmail()
      Return a person's contact email.
      Returns:
      string

    • setEmail

      public void setEmail(String email)
      Set up a person's contact email.
      Parameters:
      email - string

    • getManager

      public String getManager()
      Return a person's manager. Typically expressed as a distinguished name. This is typically the person who authorizes access for this person.
      Returns:
      string

    • setManager

      public void setManager(String manager)
      Set up a person's manager. Typically expressed as a distinguished name. This is typically the person who authorizes access for this person.
      Parameters:
      manager - string

    • getDistinguishedName

      public String getDistinguishedName()
      Return the distinguished name of the user.
      Returns:
      string name

    • setDistinguishedName

      public void setDistinguishedName(String distinguishedName)
      Set up the distinguished name of the user.
      Parameters:
      distinguishedName - string name

    • getSecurityRoles

      public List<String> getSecurityRoles()
      Return the list of security roles assigned to the user.
      Returns:
      list of names

    • setSecurityRoles

      public void setSecurityRoles(List<String> securityRoles)
      Set up the list of security roles assigned to the user.
      Parameters:
      securityRoles - list of names

    • getSecurityGroups

      public List<String> getSecurityGroups()
      Return the list of security roles assigned to the user.
      Returns:
      list of names

    • setSecurityGroups

      public void setSecurityGroups(List<String> securityGroups)
      Set upi the list of security groups that the user belongs to.
      Parameters:
      securityGroups - list of names

    • getZoneAccess

      public Map<String,List<AccessOperation>> getZoneAccess()
      Return details of the actions that are permitted on particular Governance Zones.
      Returns:
      map of accesses

    • setZoneAccess

      public void setZoneAccess(Map<String,List<AccessOperation>> zoneAccess)
      Set up details of the actions that are permitted on particular Governance Zones.
      Parameters:
      zoneAccess - map of accesses

    • getOtherProperties

      public Map<String,Object> getOtherProperties()
      Return any other properties that should be shared with security providers.
      Returns:
      property map

    • setOtherProperties

      public void setOtherProperties(Map<String,Object> otherProperties)
      Set up any other properties that should be shared with security providers.
      Parameters:
      otherProperties - property map

    • getUserAccountStatus

      public UserAccountStatus getUserAccountStatus()
      Return the status of the account.
      Returns:
      status enum

    • setUserAccountStatus

      public void setUserAccountStatus(UserAccountStatus userAccountStatus)
      Set up the status of the account.
      Parameters:
      userAccountStatus - status enum

    • getSecrets

      public Map<String,String> getSecrets()
      Return the secrets associated with the user account.
      Returns:
      a map of secret names to secret values

    • setSecrets

      public void setSecrets(Map<String,String> secrets)
      Set up the secrets associated with the user account.
      Parameters:
      secrets - a map of secret names to secret values

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class Object
      Returns:
      print out of variables in a JSON-style

    • equals

      public boolean equals(Object objectToCompare)
      Compare the values of the supplied object with those stored in the current object.
      Overrides:
      equals in class Object
      Parameters:
      objectToCompare - supplied object
      Returns:
      boolean result of comparison

    • hashCode

      public int hashCode()
      Hash of properties
      Overrides:
      hashCode in class Object
      Returns:
      int