Package org.odpi.openmetadata.accessservices.communityprofile.api

Interface SecurityGroupInterface

public interface SecurityGroupInterface

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    createSecurityGroup(String userId, org.odpi.openmetadata.frameworks.openmetadata.properties.security.SecurityGroupProperties properties)
    Create a new security group.
    void
    deleteSecurityGroup(String userId, String securityGroupGUID)
    Delete a specific security group.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.SecurityGroupElement>
    findSecurityGroups(String userId, String searchString, int startFrom, int pageSize)
    Return the list of security groups that match the search string - this can be a regular expression.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementStub>
    getElementsGovernedBySecurityGroup(String userId, String securityGroupGUID, int startFrom, int pageSize)
    Return the elements that are governed by the supplied security group.
    org.odpi.openmetadata.frameworks.openmetadata.metadataelements.SecurityGroupElement
    getSecurityGroupByGUID(String userId, String securityGroupGUID)
    Retrieve the userIdentity metadata element with the supplied unique identifier.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.SecurityGroupElement>
    getSecurityGroupsForDistinguishedName(String userId, String distinguishedName, int startFrom, int pageSize)
    Return the list of security groups associated with a unique distinguishedName.
    void
    updateSecurityGroup(String userId, String securityGroupGUID, boolean isMergeUpdate, org.odpi.openmetadata.frameworks.openmetadata.properties.security.SecurityGroupProperties properties)
    Update an existing security group.

  • Method Details

    • createSecurityGroup

      String createSecurityGroup(String userId, org.odpi.openmetadata.frameworks.openmetadata.properties.security.SecurityGroupProperties properties) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Create a new security group. The type of the definition is located in the properties.
      Parameters:
      userId - calling user
      properties - properties of the definition
      Returns:
      unique identifier of the definition
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - typeName, documentIdentifier or userId is null; documentIdentifier is not unique; typeName is not valid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem accessing the metadata service
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - security access problem

    • updateSecurityGroup

      void updateSecurityGroup(String userId, String securityGroupGUID, boolean isMergeUpdate, org.odpi.openmetadata.frameworks.openmetadata.properties.security.SecurityGroupProperties properties) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Update an existing security group.
      Parameters:
      userId - calling user
      securityGroupGUID - unique identifier of the definition to update
      isMergeUpdate - are unspecified properties unchanged (true) or removed?
      properties - properties to update
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - guid, documentIdentifier or userId is null; documentIdentifier is not unique; guid is not known
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - security access problem

    • deleteSecurityGroup

      void deleteSecurityGroup(String userId, String securityGroupGUID) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Delete a specific security group.
      Parameters:
      userId - calling user
      securityGroupGUID - unique identifier of the definition to remove
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - guid is null or not known
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - security access problem

    • getSecurityGroupsForDistinguishedName

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.SecurityGroupElement> getSecurityGroupsForDistinguishedName(String userId, String distinguishedName, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Return the list of security groups associated with a unique distinguishedName. In an ideal world, there should be only one.
      Parameters:
      userId - calling user
      distinguishedName - unique name of the security group
      startFrom - where to start from in the list of definitions
      pageSize - max number of results to return in one call
      Returns:
      list of security groups
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the caller is not authorized to issue the request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - the metadata service has problems

    • getElementsGovernedBySecurityGroup

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementStub> getElementsGovernedBySecurityGroup(String userId, String securityGroupGUID, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Return the elements that are governed by the supplied security group.
      Parameters:
      userId - calling user
      securityGroupGUID - unique name of the security group
      startFrom - where to start from in the list of definitions
      pageSize - max number of results to return in one call
      Returns:
      list of headers for the associated elements
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the caller is not authorized to issue the request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - the metadata service has problems

    • findSecurityGroups

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.SecurityGroupElement> findSecurityGroups(String userId, String searchString, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Return the list of security groups that match the search string - this can be a regular expression.
      Parameters:
      userId - calling user
      searchString - value to search for
      startFrom - where to start from in the list of definition results
      pageSize - max number of results to return in one call
      Returns:
      list of security groups
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the caller is not authorized to issue the request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - the metadata service has problems

    • getSecurityGroupByGUID

      org.odpi.openmetadata.frameworks.openmetadata.metadataelements.SecurityGroupElement getSecurityGroupByGUID(String userId, String securityGroupGUID) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Retrieve the userIdentity metadata element with the supplied unique identifier.
      Parameters:
      userId - calling user
      securityGroupGUID - unique identifier of the requested metadata element
      Returns:
      matching metadata element
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)