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

Interface SecurityGroupInterface

public interface SecurityGroupInterface

Method Summary

Modifier and Type	Method	Description
String	createSecurityGroup(String userId, SecurityGroupProperties properties)	Create a new security group.
void	deleteSecurityGroup(String userId, String securityGroupGUID)	Delete a specific security group.
List<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<ElementStub>	getElementsGovernedBySecurityGroup(String userId, String securityGroupGUID, int startFrom, int pageSize)	Return the elements that are governed by the supplied security group.
SecurityGroupElement	getSecurityGroupByGUID(String userId, String securityGroupGUID)	Retrieve the userIdentity metadata element with the supplied unique identifier.
List<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, SecurityGroupProperties properties)	Update an existing security group.

Method Detail

createSecurityGroup

String createSecurityGroup(String userId,
                           SecurityGroupProperties properties)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           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:

InvalidParameterException - typeName, documentIdentifier or userId is null; documentIdentifier is not unique; typeName is not valid

PropertyServerException - problem accessing the metadata service

UserNotAuthorizedException - security access problem

updateSecurityGroup

void updateSecurityGroup(String userId,
                         String securityGroupGUID,
                         boolean isMergeUpdate,
                         SecurityGroupProperties properties)
                  throws InvalidParameterException,
                         UserNotAuthorizedException,
                         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:

InvalidParameterException - guid, documentIdentifier or userId is null; documentIdentifier is not unique; guid is not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

deleteSecurityGroup

void deleteSecurityGroup(String userId,
                         String securityGroupGUID)
                  throws InvalidParameterException,
                         UserNotAuthorizedException,
                         PropertyServerException

Delete a specific security group.

Parameters:

userId - calling user

securityGroupGUID - unique identifier of the definition to remove

Throws:

InvalidParameterException - guid is null or not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getSecurityGroupsForDistinguishedName

List<SecurityGroupElement> getSecurityGroupsForDistinguishedName(String userId,
                                                                 String distinguishedName,
                                                                 int startFrom,
                                                                 int pageSize)
                                                          throws InvalidParameterException,
                                                                 UserNotAuthorizedException,
                                                                 PropertyServerException

Return the list of security groups associated with a unique distinguishedName. In an ideal world, the 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:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the caller is not authorized to issue the request

PropertyServerException - the metadata service has problems

getElementsGovernedBySecurityGroup

List<ElementStub> getElementsGovernedBySecurityGroup(String userId,
                                                     String securityGroupGUID,
                                                     int startFrom,
                                                     int pageSize)
                                              throws InvalidParameterException,
                                                     UserNotAuthorizedException,
                                                     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:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the caller is not authorized to issue the request

PropertyServerException - the metadata service has problems

findSecurityGroups

List<SecurityGroupElement> findSecurityGroups(String userId,
                                              String searchString,
                                              int startFrom,
                                              int pageSize)
                                       throws InvalidParameterException,
                                              UserNotAuthorizedException,
                                              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:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the caller is not authorized to issue the request

PropertyServerException - the metadata service has problems

getSecurityGroupByGUID

SecurityGroupElement getSecurityGroupByGUID(String userId,
                                            String securityGroupGUID)
                                     throws InvalidParameterException,
                                            UserNotAuthorizedException,
                                            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:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)