Package org.odpi.openmetadata.integrationservices.organization.connector

Class OrganizationIntegratorContext

java.lang.Object

org.odpi.openmetadata.frameworks.integration.context.IntegrationContext

org.odpi.openmetadata.integrationservices.organization.connector.OrganizationIntegratorContext

public class OrganizationIntegratorContext
extends IntegrationContext

OrganizationIntegratorContext provides a wrapper around the Community Profile OMAS client. It provides the simplified interface to open metadata needed by the OrganizationIntegratorConnector.

Field Summary

Fields inherited from class org.odpi.openmetadata.frameworks.integration.context.IntegrationContext

connectorName, externalSourceGUID, externalSourceIsHome, externalSourceName, fileClassifier, integrationConnectorGUID, integrationReportWriter, maxPageSize, openIntegrationClient, openMetadataStoreClient, permittedSynchronization, userId

Constructor Summary

Constructors

Constructor

Description

OrganizationIntegratorContext(String connectorId, String connectorName, String connectorUserId, String serverName, OpenIntegrationClient openIntegrationClient, OpenMetadataClient openMetadataStoreClient, OrganizationManagement organizationManagement, SecurityGroupManagement securityGroupManagement, UserIdentityManagement userIdentityManagement, CommunityProfileEventClient eventClient, boolean generateIntegrationReport, PermittedSynchronization permittedSynchronization, String integrationConnectorGUID, String externalSourceGUID, String externalSourceName, int maxPageSize, AuditLog auditLog)

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

Method Summary

Modifier and Type	Method	Description
String	addContactMethod(String actorProfileGUID, ContactMethodProperties properties)	Add a new contact method to the profile.
void	addIdentityToProfile(String userIdentityGUID, String profileGUID, ProfileIdentityProperties properties)	Link a user identity to a profile.
String	createActorProfile(ActorProfileProperties properties, ContributionRecord contributionRecord)	Create a definition of a actor profile.
String	createPersonRole(PersonRoleProperties properties)	Create a definition of a person role.
String	createSecurityGroup(SecurityGroupProperties properties)	Create a new security group.
String	createUserIdentity(UserIdentityProperties newIdentity)	Create a UserIdentity.
String	createUserIdentityForProfile(String profileGUID, UserIdentityProperties newIdentity)	Create a UserIdentity that is for the sole use of a specific actor profile.
void	deleteActorProfile(String actorProfileGUID)	Remove the definition of an actor profile.
void	deleteContactMethod(String contactMethodGUID)	Remove an obsolete contact method from the profile.
void	deletePersonRole(String personRoleGUID)	Remove the definition of a person role.
void	deleteSecurityGroup(String securityGroupGUID)	Delete a specific security group.
void	deleteUserIdentity(String userIdentityGUID)	Remove a user identity object.
List<ActorProfileElement>	findActorProfiles(String searchString, int startFrom, int pageSize)	Retrieve the list of matching profiles for the search string.
List<PersonRoleElement>	findPersonRoles(String searchString, int startFrom, int pageSize)	Retrieve the list of matching roles for the search string.
List<SecurityGroupElement>	findSecurityGroups(String searchString, int startFrom, int pageSize)	Return the list of security groups that match the search string - this can be a regular expression.
List<UserIdentityElement>	findUserIdentities(String searchString, int startFrom, int pageSize)	Retrieve the list of user identity metadata elements that contain the search string.
ActorProfileElement	getActorProfileByGUID(String actorProfileGUID)	Return information about a specific actor profile.
ActorProfileElement	getActorProfileByUserId(String actorProfileUserId)	Return information about a specific actor profile.
List<ActorProfileElement>	getActorProfiles(int startFrom, int pageSize)	Return information about all actor profiles.
List<ActorProfileElement>	getActorProfilesByLocation(String locationGUID, int startFrom, int pageSize)	Return information about actor profiles associated with a location.
List<ActorProfileElement>	getActorProfilesByName(String name, int startFrom, int pageSize)	Return information about matching named actor profiles.
List<PersonRoleAppointee>	getAppointees(String personRoleGUID, Date effectiveTime, int startFrom, int pageSize)	Return the list of people appointed to a particular role.
List<ElementStub>	getElementsGovernedBySecurityGroup(String securityGroupGUID, int startFrom, int pageSize)	Return the elements that are governed by the supplied security group.
String	getExternalSourceName()	Return the qualified name of the external source that is supplied in the configuration document.
List<PersonRoleElement>	getLeadershipRolesForTeam(String teamGUID, int startFrom, int pageSize)	Return information about the leadership person roles linked to a team.
List<PersonRoleElement>	getMembershipRolesForTeam(String teamGUID, int startFrom, int pageSize)	Return information about the membership person roles linked to a team.
PersonRoleElement	getPersonRoleByGUID(String personRoleGUID)	Return information about a specific person role.
List<PersonRoleElement>	getPersonRolesByName(String name, int startFrom, int pageSize)	Return information about a named person role.
List<SecurityGroupElement>	getSecurityGroupsForDistinguishedName(String distinguishedName, int startFrom, int pageSize)	Return the list of security groups associated with a unique distinguishedName.
List<UserIdentityElement>	getUserIdentitiesByName(String name, int startFrom, int pageSize)	Retrieve the list of user identity metadata elements with a matching qualified name.
UserIdentityElement	getUserIdentityByGUID(String userIdentityGUID)	Retrieve the userIdentity metadata element with the supplied unique identifier.
void	linkPersonRoleToProfile(String personRoleGUID, String personProfileGUID, AppointmentProperties properties)	Link a person role to a person profile to show that that person is performing the role.
void	linkTeamPlayer(String teamRoleGUID, String teamProfileGUID, String position, boolean leadershipPosition)	Link a team leader person role or team member person role to a team profile.
void	linkTeamsInHierarchy(String superTeamProfileGUID, String subTeamProfileGUID, boolean delegationEscalationAuthority, Date effectiveFrom, Date effectiveTo)	Link two related team/organization actor profiles together as part of a hierarchy.
void	registerListener(CommunityProfileEventListener listener)	Register a listener object that will be passed each of the events published by the Community Profile OMAS.
void	removeIdentityFromProfile(String userIdentityGUID, String profileGUID)	Unlink a user identity from a profile.
void	unlinkPersonRoleFromProfile(String appointmentGUID)	Remove the link between a person role and a person profile.
void	unlinkTeamPlayer(String teamRoleGUID, String teamProfileGUID, boolean leadershipPosition)	Remove the link between a person role and a team profile.
void	unlinkTeamsInHierarchy(String superTeamProfileGUID, String subTeamProfileGUID)	Remove the link between two actor profiles in the actor profile hierarchy.
void	updateActorProfile(String actorProfileGUID, boolean isMergeUpdate, ActorProfileProperties properties, ContributionRecord contributionRecord)	Update the definition of an actor profile.
void	updateAppointment(String appointmentGUID, boolean isMergeUpdate, AppointmentProperties properties)	Update the properties for the appointment of a person to a role.
void	updatePersonRole(String personRoleGUID, boolean isMergeUpdate, PersonRoleProperties properties)	Update the definition of a person role.
void	updateProfileIdentity(String userIdentityGUID, String profileGUID, boolean isMergeUpdate, ProfileIdentityProperties properties)	Update the properties of the relationship between a user identity and profile.
void	updateSecurityGroup(String securityGroupGUID, boolean isMergeUpdate, SecurityGroupProperties properties)	Update an existing security group.
void	updateUserIdentity(String userIdentityGUID, boolean isMergeUpdate, UserIdentityProperties properties)	Update a UserIdentity.

Methods inherited from class org.odpi.openmetadata.frameworks.integration.context.IntegrationContext

disconnect, getAnchorGUID, getCatalogTargets, getConnectedAssetContext, getExternalSourceIsHome, getFileClassifier, getIntegrationGovernanceContext, getMaxPageSize, getMetadataSourceQualifiedName, getPermittedSynchronization, isRefreshInProgress, isTypeOf, isTypeOf, publishReport, registerDirectoryListener, registerDirectoryTreeListener, registerFileListener, reportAnchorGUID, reportAnchorGUID, reportElementCreation, reportElementDelete, reportElementUpdate, reportParentGUID, setActiveReportPublishing, setExternalSourceIsHome, setMetadataSourceQualifiedName, startRecording, unregisterDirectoryListener, unregisterDirectoryTreeListener, unregisterFileListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OrganizationIntegratorContext

public OrganizationIntegratorContext(String connectorId,
 String connectorName,
 String connectorUserId,
 String serverName,
 OpenIntegrationClient openIntegrationClient,
 OpenMetadataClient openMetadataStoreClient,
 OrganizationManagement organizationManagement,
 SecurityGroupManagement securityGroupManagement,
 UserIdentityManagement userIdentityManagement,
 CommunityProfileEventClient eventClient,
 boolean generateIntegrationReport,
 PermittedSynchronization permittedSynchronization,
 String integrationConnectorGUID,
 String externalSourceGUID,
 String externalSourceName,
 int maxPageSize,
 AuditLog auditLog)

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

Parameters:

connectorId - unique identifier of the connector (used to configure the event listener)

connectorName - name of connector from config

connectorUserId - userId for the connector

serverName - name of the integration daemon

openIntegrationClient - client for calling the metadata server

openMetadataStoreClient - client for calling the metadata server

organizationManagement - client for exchange requests

securityGroupManagement - client for exchange requests

userIdentityManagement - client for exchange requests

eventClient - client for registered listeners

generateIntegrationReport - should the connector generate an integration reports?

permittedSynchronization - the direction of integration permitted by the integration connector

integrationConnectorGUID - unique identifier for the integration connector if it is started via an integration group (otherwise it is null).

externalSourceGUID - unique identifier of the software server capability for the asset manager

externalSourceName - unique name of the software server capability for the asset manager

maxPageSize - max number of elements that can be returned on a query

auditLog - logging destination

Method Details

getExternalSourceName

public String getExternalSourceName()

Return the qualified name of the external source that is supplied in the configuration document.

Returns:

string name

registerListener

public void registerListener(CommunityProfileEventListener listener)
                      throws InvalidParameterException,
ConnectionCheckedException,
ConnectorCheckedException,
PropertyServerException,
UserNotAuthorizedException

Register a listener object that will be passed each of the events published by the Community Profile 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.

createActorProfile

public String createActorProfile(ActorProfileProperties properties,
 ContributionRecord contributionRecord)
                          throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a definition of a actor profile. This could be for the whole organization, a team, a person or a system.

Parameters:

properties - properties for a actor profile

contributionRecord - optional properties for the contribution record

Returns:

unique identifier of actor profile

Throws:

InvalidParameterException - qualifiedName or userId is null; qualifiedName is not unique

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

updateActorProfile

public void updateActorProfile(String actorProfileGUID,
 boolean isMergeUpdate,
 ActorProfileProperties properties,
 ContributionRecord contributionRecord)
                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the definition of an actor profile.

Parameters:

actorProfileGUID - unique identifier of actor profile

isMergeUpdate - are unspecified properties unchanged (true) or replaced with null?

properties - properties to change

contributionRecord - optional properties for the contribution record

Throws:

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

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

deleteActorProfile

public void deleteActorProfile(String actorProfileGUID)
                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the definition of an actor profile.

Parameters:

actorProfileGUID - unique identifier of actor profile

Throws:

InvalidParameterException - guid or userId is null; guid is not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

addContactMethod

public String addContactMethod(String actorProfileGUID,
 ContactMethodProperties properties)
                        throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Add a new contact method to the profile.

Parameters:

actorProfileGUID - identifier of the profile to update.

properties - properties of contact method.

Returns:

unique identifier (guid) for the new contact method.

Throws:

InvalidParameterException - the userId is null or invalid. Another property 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.

deleteContactMethod

public void deleteContactMethod(String contactMethodGUID)
                         throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Remove an obsolete contact method from the profile.

Parameters:

contactMethodGUID - unique identifier (guid) for the obsolete contact method.

Throws:

InvalidParameterException - the userId is null or invalid. Another property 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.

linkTeamsInHierarchy

public void linkTeamsInHierarchy(String superTeamProfileGUID,
 String subTeamProfileGUID,
 boolean delegationEscalationAuthority,
 Date effectiveFrom,
 Date effectiveTo)
                          throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Link two related team/organization actor profiles together as part of a hierarchy. A team/organization actor profile can only have one parent but many child actor profiles.

Parameters:

superTeamProfileGUID - unique identifier of the parent team profile

subTeamProfileGUID - unique identifier of the child team profile

delegationEscalationAuthority - can workflows delegate/escalate through this link?

effectiveFrom - start date for the team relationship

effectiveTo - end date for the team relationship

Throws:

InvalidParameterException - one of the guids is null or not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

unlinkTeamsInHierarchy

public void unlinkTeamsInHierarchy(String superTeamProfileGUID,
 String subTeamProfileGUID)
                            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the link between two actor profiles in the actor profile hierarchy.

Parameters:

superTeamProfileGUID - unique identifier of the parent actor profile

subTeamProfileGUID - unique identifier of the child actor profile

Throws:

InvalidParameterException - one of the guids is null or not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getActorProfileByGUID

public ActorProfileElement getActorProfileByGUID(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(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

getActorProfilesByName

public List<ActorProfileElement> getActorProfilesByName(String name,
 int startFrom,
 int pageSize)
                                                 throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return information about matching named actor profiles.

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

Throws:

InvalidParameterException - name or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getActorProfilesByLocation

public List<ActorProfileElement> getActorProfilesByLocation(String locationGUID,
 int startFrom,
 int pageSize)
                                                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return information about actor profiles associated with a location.

Parameters:

locationGUID - unique identifier or the location

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 - locationGUID or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getActorProfiles

public List<ActorProfileElement> getActorProfiles(int startFrom,
 int pageSize)
                                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return information about all actor profiles.

Parameters:

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

findActorProfiles

public List<ActorProfileElement> findActorProfiles(String searchString,
 int startFrom,
 int pageSize)
                                            throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Retrieve the list of matching profiles 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.

createPersonRole

public String createPersonRole(PersonRoleProperties properties)
                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a definition of a person role.

Parameters:

properties - properties for a person role

Returns:

unique identifier of person role

Throws:

InvalidParameterException - qualifiedName or userId is null; qualifiedName is not unique

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

updatePersonRole

public void updatePersonRole(String personRoleGUID,
 boolean isMergeUpdate,
 PersonRoleProperties properties)
                      throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the definition of a person role.

Parameters:

personRoleGUID - unique identifier of person role

isMergeUpdate - are unspecified properties unchanged (true) or replaced with null?

properties - properties to change

Throws:

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

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

deletePersonRole

public void deletePersonRole(String personRoleGUID)
                      throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the definition of a person role.

Parameters:

personRoleGUID - unique identifier of person role

Throws:

InvalidParameterException - guid or userId is null; guid is not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

linkPersonRoleToProfile

public void linkPersonRoleToProfile(String personRoleGUID,
 String personProfileGUID,
 AppointmentProperties properties)
                             throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Link a person role to a person profile to show that that person is performing the role.

Parameters:

personRoleGUID - unique identifier of the person role

personProfileGUID - unique identifier of the person profile

properties - optional properties for the appointment

Throws:

InvalidParameterException - one of the guids is null or not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getAppointees

public List<PersonRoleAppointee> getAppointees(String personRoleGUID,
 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

updateAppointment

public void updateAppointment(String appointmentGUID,
 boolean isMergeUpdate,
 AppointmentProperties properties)
                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the properties for the appointment of a person to a role.

Parameters:

appointmentGUID - unique identifier of the appointment relationship

isMergeUpdate - are unspecified properties unchanged (true) or replaced with null?

properties - properties to change

Throws:

InvalidParameterException - one of the guids is null or not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

unlinkPersonRoleFromProfile

public void unlinkPersonRoleFromProfile(String appointmentGUID)
                                 throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the link between a person role and a person profile.

Parameters:

appointmentGUID - unique identifier of the appointment relationship

Throws:

InvalidParameterException - one of the guids is null or not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

linkTeamPlayer

public void linkTeamPlayer(String teamRoleGUID,
 String teamProfileGUID,
 String position,
 boolean leadershipPosition)
                    throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Link a team leader person role or team member person role to a team profile.

Parameters:

teamRoleGUID - unique identifier of the person role

teamProfileGUID - unique identifier of the team profile

position - position name of the role in the team

leadershipPosition - is this a leadership position

Throws:

InvalidParameterException - one of the guids is null or not known; the person role is not a team member or team leader

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

unlinkTeamPlayer

public void unlinkTeamPlayer(String teamRoleGUID,
 String teamProfileGUID,
 boolean leadershipPosition)
                      throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the link between a person role and a team profile.

Parameters:

teamRoleGUID - unique identifier of the person role

teamProfileGUID - unique identifier of the team profile

leadershipPosition - is this a leadership position

Throws:

InvalidParameterException - one of the guids is null or not known; the person role is not a team member or team leader

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getPersonRoleByGUID

public PersonRoleElement getPersonRoleByGUID(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

getPersonRolesByName

public List<PersonRoleElement> getPersonRolesByName(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

getLeadershipRolesForTeam

public List<PersonRoleElement> getLeadershipRolesForTeam(String teamGUID,
 int startFrom,
 int pageSize)
                                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return information about the leadership person roles linked to a team.

Parameters:

teamGUID - unique identifier for the Team 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

getMembershipRolesForTeam

public List<PersonRoleElement> getMembershipRolesForTeam(String teamGUID,
 int startFrom,
 int pageSize)
                                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return information about the membership person roles linked to a team.

Parameters:

teamGUID - unique identifier for the Team 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

findPersonRoles

public List<PersonRoleElement> findPersonRoles(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.

createSecurityGroup

public 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(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(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 List<SecurityGroupElement> getSecurityGroupsForDistinguishedName(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 List<ElementStub> getElementsGovernedBySecurityGroup(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 List<SecurityGroupElement> findSecurityGroups(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 String createUserIdentity(UserIdentityProperties newIdentity)
                          throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Create a UserIdentity. This is not connected to a profile.

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.

createUserIdentityForProfile

public String createUserIdentityForProfile(String profileGUID,
 UserIdentityProperties newIdentity)
                                    throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Create a UserIdentity that is for the sole use of a specific actor profile.

Parameters:

profileGUID - unique identifier of the profile

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(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(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.

addIdentityToProfile

public void addIdentityToProfile(String userIdentityGUID,
 String profileGUID,
 ProfileIdentityProperties properties)
                          throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Link a user identity to a profile. This will fail if the user identity is already connected to a profile.

Parameters:

profileGUID - the profile to add the identity to.

userIdentityGUID - additional userId for the profile.

properties - the properties that describe how the owner of the profile uses the user identity

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.

updateProfileIdentity

public void updateProfileIdentity(String userIdentityGUID,
 String profileGUID,
 boolean isMergeUpdate,
 ProfileIdentityProperties properties)
                           throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Update the properties of the relationship between a user identity and profile.

Parameters:

userIdentityGUID - additional userId for the profile

profileGUID - the profile to add the identity to

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

properties - the properties that describe how the owner of the profile uses the user identity

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.

removeIdentityFromProfile

public void removeIdentityFromProfile(String userIdentityGUID,
 String profileGUID)
                               throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Unlink a user identity from a profile.

Parameters:

userIdentityGUID - unique identifier of the UserIdentity

profileGUID - profile to remove it from.

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 List<UserIdentityElement> findUserIdentities(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 List<UserIdentityElement> getUserIdentitiesByName(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(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)