java.lang.Object
org.odpi.openmetadata.frameworks.connectors.properties.users.SecurityAccessControl

public class SecurityAccessControl extends Object
SecurityAccessControl describes the permissions to be granted to the security list. It is typically associated with a resource that needs access control protection.
  • Constructor Details

    • SecurityAccessControl

      public SecurityAccessControl()
      Default constructor
    • SecurityAccessControl

      public SecurityAccessControl(SecurityAccessControl template)
      Copy constructor
  • Method Details

    • getDisplayName

      public String getDisplayName()
      Return the name of the security access control.
      Returns:
      string name
    • setDisplayName

      public void setDisplayName(String displayName)
      Set up the name of the security access control.
      Parameters:
      displayName - string name
    • getControlTypeName

      public String getControlTypeName()
      Return the type name of security access control. By convention, this is the open metadata type name used to represent this control in the open metadata repositories. EG GovernanceZone
      Returns:
      string
    • setControlTypeName

      public void setControlTypeName(String controlTypeName)
      Set up the type name of security access control. By convention, this is the open metadata type name used to represent this control in the open metadata repositories. EG GovernanceZone
      Parameters:
      controlTypeName - string
    • getMappingProperties

      public Map<String,String> getMappingProperties()
      Return the properties used to map the resource to the security control.
      Returns:
      property map
    • setMappingProperties

      public void setMappingProperties(Map<String,String> mappingProperties)
      Set up the properties used to map the resource to the security control.
      Parameters:
      mappingProperties - property map
    • getDescription

      public String getDescription()
      Return the description of the security access control.
      Returns:
      string
    • setDescription

      public void setDescription(String description)
      Set up the description of the security access control.
      Parameters:
      description - string
    • getAssociatedSecurityList

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

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

      public List<String> getSecurityLabels()
      Return the list of security labels attached to the element.
      Returns:
      list of label strings
    • setSecurityLabels

      public void setSecurityLabels(List<String> securityLabels)
      Set up the list of security labels for the element.
      Parameters:
      securityLabels - list of label strings
    • getSecurityProperties

      public Map<String,Object> getSecurityProperties()
      Return the security properties associated with the element. These are name-value pairs.
      Returns:
      map of properties
    • setSecurityProperties

      public void setSecurityProperties(Map<String,Object> securityProperties)
      Set up the security properties associated with the element. These are name-value pairs.
      Parameters:
      securityProperties - map of properties
    • 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
    • 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