java.lang.Object
- org.odpi.openmetadata.integrationservices.security.connector.SecurityIntegratorContext

```
public class SecurityIntegratorContext
extends java.lang.Object
```
SecurityIntegratorContext provides a wrapper around the Security Manager OMAS client. It provides the simplified interface to open metadata needed by the SecurityIntegratorConnector.

Constructor Summary

Constructors
Constructor	Description
`SecurityIntegratorContext(SecurityManagerClient securityManagerClient, SecurityManagerEventClient eventClient, java.lang.String userId, java.lang.String securityManagerGUID, java.lang.String securityManagerName, java.lang.String connectorName, AuditLog auditLog)`	Create a new client to exchange data asset content with open metadata.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`createSecurityGroup(SecurityGroupProperties properties)`	Create a new security group.
`java.lang.String`	`createUserIdentity(UserIdentityProperties newIdentity)`	Create a UserIdentity.
`void`	`deleteSecurityGroup(java.lang.String securityGroupGUID)`	Delete a specific security group.
`void`	`deleteUserIdentity(java.lang.String userIdentityGUID)`	Remove a user identity object.
`java.util.List<ActorProfileElement>`	`findActorProfile(java.lang.String userId, java.lang.String searchString, int startFrom, int pageSize)`	Retrieve the list of matching profiles for the search string.
`java.util.List<PersonRoleElement>`	`findPersonRole(java.lang.String searchString, int startFrom, int pageSize)`	Retrieve the list of matching roles for the search string.
`java.util.List<SecurityGroupElement>`	`findSecurityGroups(java.lang.String searchString, int startFrom, int pageSize)`	Return the list of security groups that match the search string - this can be a regular expression.
`java.util.List<UserIdentityElement>`	`findUserIdentities(java.lang.String searchString, int startFrom, int pageSize)`	Retrieve the list of user identity metadata elements that contain the search string.
`ActorProfileElement`	`getActorProfileByGUID(java.lang.String actorProfileGUID)`	Return information about a specific actor profile.
`java.util.List<ActorProfileElement>`	`getActorProfileByName(java.lang.String name, int startFrom, int pageSize)`	Return information about a named actor profile.
`ActorProfileElement`	`getActorProfileByUserId(java.lang.String actorProfileUserId)`	Return information about a specific actor profile.
`java.util.List<PersonRoleAppointee>`	`getAppointees(java.lang.String personRoleGUID, java.util.Date effectiveTime, int startFrom, int pageSize)`	Return the list of people appointed to a particular role.
`java.util.List<ElementStub>`	`getElementsGovernedBySecurityGroup(java.lang.String securityGroupGUID, int startFrom, int pageSize)`	Return the elements that are governed by the supplied security group.
`PersonRoleElement`	`getPersonRoleByGUID(java.lang.String personRoleGUID)`	Return information about a specific person role.
`java.util.List<PersonRoleElement>`	`getPersonRoleByName(java.lang.String name, int startFrom, int pageSize)`	Return information about a named person role.
`java.util.List<SecurityGroupElement>`	`getSecurityGroupsForDistinguishedName(java.lang.String distinguishedName, int startFrom, int pageSize)`	Return the list of security groups associated with a unique distinguishedName.
`java.lang.String`	`getSecurityManagerName()`	Return the qualified name of the security manager that is supplied in the configuration document.
`java.util.List<UserIdentityElement>`	`getUserIdentitiesByName(java.lang.String name, int startFrom, int pageSize)`	Retrieve the list of user identity metadata elements with a matching qualified name.
`UserIdentityElement`	`getUserIdentityByGUID(java.lang.String userIdentityGUID)`	Retrieve the userIdentity metadata element with the supplied unique identifier.
`void`	`registerListener(SecurityManagerEventListener listener)`	Register a listener object that will be passed each of the events published by the Security Manager OMAS.
`void`	`updateSecurityGroup(java.lang.String securityGroupGUID, boolean isMergeUpdate, SecurityGroupProperties properties)`	Update an existing security group.
`void`	`updateUserIdentity(java.lang.String userIdentityGUID, boolean isMergeUpdate, UserIdentityProperties properties)`	Update a UserIdentity.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SecurityIntegratorContext

public SecurityIntegratorContext(SecurityManagerClient securityManagerClient,
                                 SecurityManagerEventClient eventClient,
                                 java.lang.String userId,
                                 java.lang.String securityManagerGUID,
                                 java.lang.String securityManagerName,
                                 java.lang.String connectorName,
                                 AuditLog auditLog)

Create a new client to exchange data asset content with open metadata.

Parameters:: securityManagerClient - client for exchange requests; eventClient - client for registered listeners; userId - integration daemon's userId; securityManagerGUID - unique identifier of the software server capability for the asset manager; securityManagerName - unique name of the software server capability for the asset manager; connectorName - name of the connector using this context; auditLog - logging destination

Method Detail

getSecurityManagerName
```
public java.lang.String getSecurityManagerName()
```
Return the qualified name of the security manager that is supplied in the configuration document.

Returns:

string name

registerListener
```
public void registerListener(SecurityManagerEventListener listener)
                      throws InvalidParameterException,
                             ConnectionCheckedException,
                             ConnectorCheckedException,
                             PropertyServerException,
                             UserNotAuthorizedException
```
Register a listener object that will be passed each of the events published by the Security Manager OMAS.

Parameters:

listener - listener object

Throws:

InvalidParameterException - one of the parameters is null or invalid.

ConnectionCheckedException - there are errors in the configuration of the connection which is preventing the creation of a connector.

ConnectorCheckedException - there are errors in the initialization of the connector.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

createSecurityGroup
```
public java.lang.String createSecurityGroup(SecurityGroupProperties properties)
                                     throws InvalidParameterException,
                                            UserNotAuthorizedException,
                                            PropertyServerException
```
Create a new security group. The type of the definition is located in the properties.

Parameters:

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

public void updateSecurityGroup(java.lang.String securityGroupGUID,
                                boolean isMergeUpdate,
                                SecurityGroupProperties properties)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException

Update an existing security group.

Parameters:: 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

public void deleteSecurityGroup(java.lang.String securityGroupGUID)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException

Delete a specific security group.

Parameters:: 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

public java.util.List<SecurityGroupElement> getSecurityGroupsForDistinguishedName(java.lang.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:: 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

public java.util.List<ElementStub> getElementsGovernedBySecurityGroup(java.lang.String securityGroupGUID,
                                                                      int startFrom,
                                                                      int pageSize)
                                                               throws InvalidParameterException,
                                                                      UserNotAuthorizedException,
                                                                      PropertyServerException

Return the elements that are governed by the supplied security group.

Parameters:: 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

public java.util.List<SecurityGroupElement> findSecurityGroups(java.lang.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:: 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

createUserIdentity
```
public java.lang.String createUserIdentity(UserIdentityProperties newIdentity)
                                    throws InvalidParameterException,
                                           PropertyServerException,
                                           UserNotAuthorizedException
```
Create a UserIdentity.

Parameters:

newIdentity - properties for the new userIdentity.

Returns:

unique identifier of the UserIdentity

Throws:

InvalidParameterException - one of the parameters is invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

updateUserIdentity
```
public void updateUserIdentity(java.lang.String userIdentityGUID,
                               boolean isMergeUpdate,
                               UserIdentityProperties properties)
                        throws InvalidParameterException,
                               PropertyServerException,
                               UserNotAuthorizedException
```
Update a UserIdentity.

Parameters:

userIdentityGUID - unique identifier of the UserIdentity

isMergeUpdate - should the supplied properties be overlaid on the existing properties (true) or replace them (false

properties - updated properties for the new userIdentity

Throws:

InvalidParameterException - one of the parameters is invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

deleteUserIdentity
```
public void deleteUserIdentity(java.lang.String userIdentityGUID)
                        throws InvalidParameterException,
                               PropertyServerException,
                               UserNotAuthorizedException
```
Remove a user identity object. This will fail if the profile would be left without an associated user identity.

Parameters:

userIdentityGUID - unique identifier of the UserIdentity

Throws:

InvalidParameterException - one of the parameters is invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

findUserIdentities

public java.util.List<UserIdentityElement> findUserIdentities(java.lang.String searchString,
                                                              int startFrom,
                                                              int pageSize)
                                                       throws InvalidParameterException,
                                                              UserNotAuthorizedException,
                                                              PropertyServerException

Retrieve the list of user identity metadata elements that contain the search string. The search string is treated as a regular expression.

Parameters:: searchString - string to find in the properties; startFrom - paging start point; pageSize - maximum results that can be returned
Returns:: list of matching metadata elements
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)

getUserIdentitiesByName

public java.util.List<UserIdentityElement> getUserIdentitiesByName(java.lang.String name,
                                                                   int startFrom,
                                                                   int pageSize)
                                                            throws InvalidParameterException,
                                                                   UserNotAuthorizedException,
                                                                   PropertyServerException

Retrieve the list of user identity metadata elements with a matching qualified name. There are no wildcards supported on this request.

Parameters:: name - name to search for; startFrom - paging start point; pageSize - maximum results that can be returned
Returns:: list of matching metadata elements
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)

getUserIdentityByGUID
```
public UserIdentityElement getUserIdentityByGUID(java.lang.String userIdentityGUID)
                                          throws InvalidParameterException,
                                                 UserNotAuthorizedException,
                                                 PropertyServerException
```
Retrieve the userIdentity metadata element with the supplied unique identifier.

Parameters:

userIdentityGUID - 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)

getActorProfileByGUID

public ActorProfileElement getActorProfileByGUID(java.lang.String actorProfileGUID)
                                          throws InvalidParameterException,
                                                 UserNotAuthorizedException,
                                                 PropertyServerException

Return information about a specific actor profile.

Parameters:: actorProfileGUID - unique identifier for the actor profile
Returns:: properties of the actor profile
Throws:: InvalidParameterException - actorProfileGUID or userId is null; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

getActorProfileByUserId

public ActorProfileElement getActorProfileByUserId(java.lang.String actorProfileUserId)
                                            throws InvalidParameterException,
                                                   UserNotAuthorizedException,
                                                   PropertyServerException

Return information about a specific actor profile.

Parameters:: actorProfileUserId - unique identifier for the actor profile
Returns:: properties of the actor profile
Throws:: InvalidParameterException - actorProfileUserId or userId is null; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

getActorProfileByName

public java.util.List<ActorProfileElement> getActorProfileByName(java.lang.String name,
                                                                 int startFrom,
                                                                 int pageSize)
                                                          throws InvalidParameterException,
                                                                 UserNotAuthorizedException,
                                                                 PropertyServerException

Return information about a named actor profile.

Parameters:: name - unique name for the actor profile; startFrom - index of the list to start from (0 for start); pageSize - maximum number of elements to return.
Returns:: list of matching actor profiles (hopefully only one)
Throws:: InvalidParameterException - name or userId is null; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

findActorProfile

public java.util.List<ActorProfileElement> findActorProfile(java.lang.String userId,
                                                            java.lang.String searchString,
                                                            int startFrom,
                                                            int pageSize)
                                                     throws InvalidParameterException,
                                                            PropertyServerException,
                                                            UserNotAuthorizedException

Retrieve the list of matching profiles for the search string.

Parameters:: userId - the name of the calling user.; searchString - RegEx string to search for; startFrom - index of the list to start from (0 for start); pageSize - maximum number of elements to return.
Returns:: list of matching actor profiles
Throws:: InvalidParameterException - guid invalid or the external references are not correctly specified, or are null.; PropertyServerException - the server is not available.; UserNotAuthorizedException - the calling user is not authorized to issue the call.

getAppointees

public java.util.List<PersonRoleAppointee> getAppointees(java.lang.String personRoleGUID,
                                                         java.util.Date effectiveTime,
                                                         int startFrom,
                                                         int pageSize)
                                                  throws InvalidParameterException,
                                                         UserNotAuthorizedException,
                                                         PropertyServerException

Return the list of people appointed to a particular role.

Parameters:: personRoleGUID - unique identifier of the person role; effectiveTime - time for appointments, null for full appointment history; startFrom - index of the list to start from (0 for start); pageSize - maximum number of elements to return
Returns:: list of appointees
Throws:: InvalidParameterException - one of the guids is null or not known; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

getPersonRoleByGUID

public PersonRoleElement getPersonRoleByGUID(java.lang.String personRoleGUID)
                                      throws InvalidParameterException,
                                             UserNotAuthorizedException,
                                             PropertyServerException

Return information about a specific person role.

Parameters:: personRoleGUID - unique identifier for the person role
Returns:: properties of the person role
Throws:: InvalidParameterException - personRoleGUID or userId is null; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

getPersonRoleByName

public java.util.List<PersonRoleElement> getPersonRoleByName(java.lang.String name,
                                                             int startFrom,
                                                             int pageSize)
                                                      throws InvalidParameterException,
                                                             UserNotAuthorizedException,
                                                             PropertyServerException

Return information about a named person role.

Parameters:: name - unique name for the actor profile; startFrom - index of the list to start from (0 for start); pageSize - maximum number of elements to return.
Returns:: list of matching actor profiles (hopefully only one)
Throws:: InvalidParameterException - name or userId is null; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

findPersonRole

public java.util.List<PersonRoleElement> findPersonRole(java.lang.String searchString,
                                                        int startFrom,
                                                        int pageSize)
                                                 throws InvalidParameterException,
                                                        PropertyServerException,
                                                        UserNotAuthorizedException

Retrieve the list of matching roles for the search string.

Parameters:: searchString - RegEx string to search for; startFrom - index of the list to start from (0 for start); pageSize - maximum number of elements to return.
Returns:: list of matching actor profiles
Throws:: InvalidParameterException - guid invalid or the external references are not correctly specified, or are null.; PropertyServerException - the server is not available.; UserNotAuthorizedException - the calling user is not authorized to issue the call.

Class SecurityIntegratorContext