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.

  • 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

    • 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<ZoneAccessType>> getZoneAccess()
      Return details of the actions that are permitted on particular Governance Zones.
      Returns:
      map of accesses

    • setZoneAccess

      public void setZoneAccess(Map<String,List<ZoneAccessType>> 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