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

Class SecretsCollection

java.lang.Object
org.odpi.openmetadata.frameworks.connectors.properties.users.SecretsCollection
Direct Known Subclasses:
OpenMetadataSecretsCollection
public class SecretsCollection extends Object
SecretsCollection stores a collection or properties that are used to connect to a particular digital resource, or support a specific type of security service.

  • Constructor Details

    • SecretsCollection

      public SecretsCollection()
      Default constructor

    • SecretsCollection

      public SecretsCollection(SecretsCollection template)
      Default constructor

  • Method Details

    • getDisplayName

      public String getDisplayName()
      Return the display name for this collection.
      Returns:
      string

    • setDisplayName

      public void setDisplayName(String displayName)
      Set up the display name for this collection.
      Parameters:
      displayName - string

    • getDescription

      public String getDescription()
      Return the description for this collection.
      Returns:
      string

    • setDescription

      public void setDescription(String description)
      Set up the description for this collection.
      Parameters:
      description - string

    • getRefreshTimeInterval

      public long getRefreshTimeInterval()
      Return the length of time that secrets can be cached.
      Returns:
      long

    • setRefreshTimeInterval

      public void setRefreshTimeInterval(long getRefreshTimeInterval)
      Set up the length of time that secrets can be cached.
      Parameters:
      getRefreshTimeInterval - long

    • getUsers

      public Map<String,UserAccount> getUsers()
      Return the users stored in the secrets collection.
      Returns:
      map of userIds to user details

    • setUsers

      public void setUsers(Map<String,UserAccount> users)
      Set up the users stored in the secrets collection.
      Parameters:
      users - map of userIds to user details

    • getSecrets

      public Map<String,String> getSecrets()
      Return the list of secrets.
      Returns:
      map of secret values

    • setSecrets

      public void setSecrets(Map<String,String> secrets)
      Set up the in memory version of the secrets collection.
      Parameters:
      secrets - a map of secrets values

    • getTokenAPI

      public TokenAPI getTokenAPI()
      Return details of a token API associated with the secrets collection.
      Returns:
      token API definition

    • setTokenAPI

      public void setTokenAPI(TokenAPI tokenAPI)
      Set up the token API for this secrets collection.
      Parameters:
      tokenAPI - token API definition

    • getNamedLists

      public Map<String,NamedList> getNamedLists()
      Return the named lists in this collection. The named lists can represent organization units, security groups, and roles.
      Returns:
      map of named lists

    • setNamedLists

      public void setNamedLists(Map<String,NamedList> namedLists)
      Set up the named lists in this collection. The named lists can represent organization units, security groups, and roles.
      Parameters:
      namedLists - map of named lists

    • getSecurityAccessControls

      public Map<String,SecurityAccessControl> getSecurityAccessControls()
      Return the security access controls in this collection. The security access controls can represent organization units, security groups, and roles.
      Returns:
      map of security access controls

    • setSecurityAccessControls

      public void setSecurityAccessControls(Map<String,SecurityAccessControl> securityAccessControls)
      Set up the security access controls in this collection. The security access controls can represent organization units, security groups, and roles.
      Parameters:
      securityAccessControls - map of security access controls

    • 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