Package org.odpi.openmetadata.accessservices.assetmanager.client.exchange

Class GovernanceExchangeClient

java.lang.Object

org.odpi.openmetadata.accessservices.assetmanager.client.AssetManagerBaseClient

org.odpi.openmetadata.accessservices.assetmanager.client.exchange.ExchangeClientBase

org.odpi.openmetadata.accessservices.assetmanager.client.exchange.GovernanceExchangeClient

All Implemented Interfaces:

GovernanceExchangeInterface

public class GovernanceExchangeClient
extends ExchangeClientBase
implements GovernanceExchangeInterface

GovernanceExchangeClient is the client for managing governance policies and rules.

Field Summary

Fields inherited from class org.odpi.openmetadata.accessservices.assetmanager.client.AssetManagerBaseClient

invalidParameterHandler, nullRequestBody, restClient, serverName, serverPlatformURLRoot, urlTemplatePrefix

Constructor Summary

Constructors

Constructor	Description
GovernanceExchangeClient(String serverName, String serverPlatformURLRoot)	Create a new client with no authentication embedded in the HTTP request.
GovernanceExchangeClient(String serverName, String serverPlatformURLRoot, String userId, String password)	Create a new client that passes userId and password in each HTTP request.
GovernanceExchangeClient(String serverName, String serverPlatformURLRoot, String userId, String password, AuditLog auditLog)	Create a new client that passes userId and password in each HTTP request.
GovernanceExchangeClient(String serverName, String serverPlatformURLRoot, AssetManagerRESTClient restClient, int maxPageSize, AuditLog auditLog)	Create a new client that is going to be used in an OMAG Server.
GovernanceExchangeClient(String serverName, String serverPlatformURLRoot, AuditLog auditLog)	Create a new client with no authentication embedded in the HTTP request.

Method Summary

Modifier and Type	Method	Description
void	clearGovernanceDelegation(String userId, String assetManagerGUID, String assetManagerName, String definitionGUID, String delegatedToDefinitionGUID)	Remove the link between a governance definition and a governance definition that is delegated to (ie provides an implementation of).
String	createGovernanceDefinition(String userId, String assetManagerGUID, String assetManagerName, String typeName, ExternalIdentifierProperties externalIdentifierProperties, GovernanceDefinitionProperties definitionProperties)	Create a new definition.
void	deleteGovernanceDefinition(String userId, String assetManagerGUID, String assetManagerName, String definitionGUID)	Delete a specific governance definition.
List<GovernanceActionProcessElement>	findGovernanceActionProcesses(String userId, String searchString, int startFrom, int pageSize)	Retrieve the list of governance action process metadata elements that contain the search string.
List<GovernanceActionTypeElement>	findGovernanceActionTypes(String userId, String searchString, int startFrom, int pageSize)	Retrieve the list of governance action type metadata elements that contain the search string.
List<GovernanceActionElement>	getActiveGovernanceActions(String userId, int startFrom, int pageSize)	Retrieve the governance actions that are still in process.
GovernanceActionTypeElement	getFirstActionType(String userId, String processGUID)	Return the governance action type that is the first step in a governance action process.
GovernanceActionElement	getGovernanceAction(String userId, String governanceActionGUID)	Request the status of an executing governance action request.
GovernanceActionProcessElement	getGovernanceActionProcessByGUID(String userId, String processGUID)	Retrieve the governance action process metadata element with the supplied unique identifier.
List<GovernanceActionProcessElement>	getGovernanceActionProcessesByName(String userId, String name, int startFrom, int pageSize)	Retrieve the list of governance action process metadata elements with a matching qualified or display name.
List<GovernanceActionElement>	getGovernanceActions(String userId, int startFrom, int pageSize)	Retrieve the governance actions known to the server.
GovernanceActionTypeElement	getGovernanceActionTypeByGUID(String userId, String actionTypeGUID)	Retrieve the governance action type metadata element with the supplied unique identifier.
List<GovernanceActionTypeElement>	getGovernanceActionTypesByName(String userId, String name, int startFrom, int pageSize)	Retrieve the list of governance action type metadata elements with a matching qualified or display name.
GovernanceDefinitionElement	getGovernanceDefinitionByDocId(String userId, String assetManagerGUID, String assetManagerName, String documentIdentifier)	Retrieve the governance definition by its assigned unique document identifier.
GovernanceDefinitionElement	getGovernanceDefinitionByGUID(String userId, String assetManagerGUID, String assetManagerName, String definitionGUID)	Retrieve the governance definition by the unique identifier assigned by this service when it was created.
List<NextGovernanceActionTypeElement>	getNextGovernanceActionTypes(String userId, String actionTypeGUID, int startFrom, int pageSize)	Return the lust of next action type defined for the governance action process.
void	linkDefinitions(String userId, String assetManagerGUID, String assetManagerName, String definitionOneGUID, String definitionTwoGUID, String description)	Link two related definitions together.
void	setupGovernanceDelegation(String userId, String assetManagerGUID, String assetManagerName, String definitionGUID, String delegatedToDefinitionGUID, String rationale)	Create a link to show that a governance definition supports the requirements of one of the governance drivers.
void	unlinkDefinitions(String userId, String assetManagerGUID, String assetManagerName, String definitionOneGUID, String definitionTwoGUID)	Remove the link between two definitions.
void	updateGovernanceDefinition(String userId, String assetManagerGUID, String assetManagerName, String definitionGUID, boolean isMergeUpdate, GovernanceDefinitionProperties definitionProperties)	Update an existing definition.

Methods inherited from class org.odpi.openmetadata.accessservices.assetmanager.client.AssetManagerBaseClient

clearRelationship, clearRelationship, createFeedbackFromTemplateWithParent, createFeedbackWithParent, createReferenceable, createReferenceableFromTemplate, createReferenceableFromTemplate, createReferenceableFromTemplateWithParent, createReferenceableFromTemplateWithParent, createReferenceableWithParent, getAssetManagerIdentifiersRequestBody, getClassifiedElements, getCorrelationProperties, getCorrelationProperties, getCorrelationProperties, getEffectiveTimeQueryRequestBody, getGlossaryTermRelationshipRequestBody, getNameRequestBody, getNameRequestBody, getQualifiedNameRequestBody, getRelatedElements, getRelationshipRequestBody, getSearchStringRequestBody, getUpdateRequestBody, handleMissingScope, removeReferenceable, removeReferenceableClassification, setReferenceableClassification, setupRelationship, setupRelationship, updateFeedback, updateReferenceable

Methods inherited from class java.lang.Object

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

Constructor Details

GovernanceExchangeClient

public GovernanceExchangeClient(String serverName,
 String serverPlatformURLRoot,
 AuditLog auditLog)
                         throws InvalidParameterException

Create a new client with no authentication embedded in the HTTP request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST services

auditLog - logging destination

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

GovernanceExchangeClient

public GovernanceExchangeClient(String serverName,
 String serverPlatformURLRoot)
                         throws InvalidParameterException

Create a new client with no authentication embedded in the HTTP request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST services

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

GovernanceExchangeClient

public GovernanceExchangeClient(String serverName,
 String serverPlatformURLRoot,
 String userId,
 String password,
 AuditLog auditLog)
                         throws InvalidParameterException

Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST services

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

auditLog - logging destination

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

GovernanceExchangeClient

public GovernanceExchangeClient(String serverName,
 String serverPlatformURLRoot,
 AssetManagerRESTClient restClient,
 int maxPageSize,
 AuditLog auditLog)
                         throws InvalidParameterException

Create a new client that is going to be used in an OMAG Server.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST services

restClient - client that issues the REST API calls

maxPageSize - maximum number of results supported by this server

auditLog - logging destination

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

GovernanceExchangeClient

public GovernanceExchangeClient(String serverName,
 String serverPlatformURLRoot,
 String userId,
 String password)
                         throws InvalidParameterException

Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST services

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

Method Details

createGovernanceDefinition

public String createGovernanceDefinition(String userId,
 String assetManagerGUID,
 String assetManagerName,
 String typeName,
 ExternalIdentifierProperties externalIdentifierProperties,
 GovernanceDefinitionProperties definitionProperties)
                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a new definition.

Specified by:

createGovernanceDefinition in interface GovernanceExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

externalIdentifierProperties - optional properties used to define an external identifier

typeName - type of definition

definitionProperties - 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 property server

UserNotAuthorizedException - security access problem

updateGovernanceDefinition

public void updateGovernanceDefinition(String userId,
 String assetManagerGUID,
 String assetManagerName,
 String definitionGUID,
 boolean isMergeUpdate,
 GovernanceDefinitionProperties definitionProperties)
                                throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update an existing definition.

Specified by:

updateGovernanceDefinition in interface GovernanceExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

definitionGUID - unique identifier of the definition to update

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

definitionProperties - 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

deleteGovernanceDefinition

public void deleteGovernanceDefinition(String userId,
 String assetManagerGUID,
 String assetManagerName,
 String definitionGUID)
                                throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Delete a specific governance definition.

Specified by:

deleteGovernanceDefinition in interface GovernanceExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

definitionGUID - unique identifier of the definition to remove

Throws:

InvalidParameterException - guid is null or not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

linkDefinitions

public void linkDefinitions(String userId,
 String assetManagerGUID,
 String assetManagerName,
 String definitionOneGUID,
 String definitionTwoGUID,
 String description)
                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Link two related definitions together. If the link already exists the description is updated.

Specified by:

linkDefinitions in interface GovernanceExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

definitionOneGUID - unique identifier of the first definition

definitionTwoGUID - unique identifier of the second definition

description - description of their relationship

Throws:

InvalidParameterException - one of the guids is null or not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

unlinkDefinitions

public void unlinkDefinitions(String userId,
 String assetManagerGUID,
 String assetManagerName,
 String definitionOneGUID,
 String definitionTwoGUID)
                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the link between two definitions.

Specified by:

unlinkDefinitions in interface GovernanceExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

definitionOneGUID - unique identifier of the first definition

definitionTwoGUID - unique identifier of the second definition

Throws:

InvalidParameterException - one of the guids is null or not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

setupGovernanceDelegation

public void setupGovernanceDelegation(String userId,
 String assetManagerGUID,
 String assetManagerName,
 String definitionGUID,
 String delegatedToDefinitionGUID,
 String rationale)
                               throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a link to show that a governance definition supports the requirements of one of the governance drivers. If the link already exists the rationale is updated.

Specified by:

setupGovernanceDelegation in interface GovernanceExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

definitionGUID - unique identifier of the governance definition

delegatedToDefinitionGUID - unique identifier of the governance definition that is delegated to

rationale - description of how the delegation supports the definition

Throws:

InvalidParameterException - one of the guids is null or not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

clearGovernanceDelegation

public void clearGovernanceDelegation(String userId,
 String assetManagerGUID,
 String assetManagerName,
 String definitionGUID,
 String delegatedToDefinitionGUID)
                               throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the link between a governance definition and a governance definition that is delegated to (ie provides an implementation of).

Specified by:

clearGovernanceDelegation in interface GovernanceExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

definitionGUID - unique identifier of the governance definition

delegatedToDefinitionGUID - unique identifier of the governance definition that is delegated to

Throws:

InvalidParameterException - one of the guids is null or not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getGovernanceDefinitionByGUID

public GovernanceDefinitionElement getGovernanceDefinitionByGUID(String userId,
 String assetManagerGUID,
 String assetManagerName,
 String definitionGUID)
                                                          throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the governance definition by the unique identifier assigned by this service when it was created.

Specified by:

getGovernanceDefinitionByGUID in interface GovernanceExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

definitionGUID - identifier of the governance definition to retrieve

Returns:

properties of the matching definition

Throws:

InvalidParameterException - documentIdentifier or userId is null; guid is not recognized

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getGovernanceDefinitionByDocId

public GovernanceDefinitionElement getGovernanceDefinitionByDocId(String userId,
 String assetManagerGUID,
 String assetManagerName,
 String documentIdentifier)
                                                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the governance definition by its assigned unique document identifier.

Specified by:

getGovernanceDefinitionByDocId in interface GovernanceExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

documentIdentifier - identifier to search for

Returns:

properties of the matching definition

Throws:

InvalidParameterException - documentIdentifier or userId is null; documentIdentifier is not recognized

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

findGovernanceActionProcesses

public List<GovernanceActionProcessElement> findGovernanceActionProcesses(String userId,
 String searchString,
 int startFrom,
 int pageSize)
                                                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of governance action process metadata elements that contain the search string. The search string is treated as a regular expression.

Specified by:

findGovernanceActionProcesses in interface GovernanceExchangeInterface

Parameters:

userId - calling user

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)

getGovernanceActionProcessesByName

public List<GovernanceActionProcessElement> getGovernanceActionProcessesByName(String userId,
 String name,
 int startFrom,
 int pageSize)
                                                                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of governance action process metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Specified by:

getGovernanceActionProcessesByName in interface GovernanceExchangeInterface

Parameters:

userId - calling user

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)

getGovernanceActionProcessByGUID

public GovernanceActionProcessElement getGovernanceActionProcessByGUID(String userId,
 String processGUID)
                                                                throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the governance action process metadata element with the supplied unique identifier.

Specified by:

getGovernanceActionProcessByGUID in interface GovernanceExchangeInterface

Parameters:

userId - calling user

processGUID - unique identifier of the requested metadata element

Returns:

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

findGovernanceActionTypes

public List<GovernanceActionTypeElement> findGovernanceActionTypes(String userId,
 String searchString,
 int startFrom,
 int pageSize)
                                                            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of governance action type metadata elements that contain the search string. The search string is treated as a regular expression.

Specified by:

findGovernanceActionTypes in interface GovernanceExchangeInterface

Parameters:

userId - calling user

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)

getGovernanceActionTypesByName

public List<GovernanceActionTypeElement> getGovernanceActionTypesByName(String userId,
 String name,
 int startFrom,
 int pageSize)
                                                                 throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of governance action type metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Specified by:

getGovernanceActionTypesByName in interface GovernanceExchangeInterface

Parameters:

userId - calling user

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)

getGovernanceActionTypeByGUID

public GovernanceActionTypeElement getGovernanceActionTypeByGUID(String userId,
 String actionTypeGUID)
                                                          throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the governance action type metadata element with the supplied unique identifier.

Specified by:

getGovernanceActionTypeByGUID in interface GovernanceExchangeInterface

Parameters:

userId - calling user

actionTypeGUID - unique identifier of the governance action type

Returns:

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

getFirstActionType

public GovernanceActionTypeElement getFirstActionType(String userId,
 String processGUID)
                                               throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the governance action type that is the first step in a governance action process.

Specified by:

getFirstActionType in interface GovernanceExchangeInterface

Parameters:

userId - calling user

processGUID - unique identifier of the governance action process

Returns:

properties of the governance action type

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)

getNextGovernanceActionTypes

public List<NextGovernanceActionTypeElement> getNextGovernanceActionTypes(String userId,
 String actionTypeGUID,
 int startFrom,
 int pageSize)
                                                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the lust of next action type defined for the governance action process.

Specified by:

getNextGovernanceActionTypes in interface GovernanceExchangeInterface

Parameters:

userId - calling user

actionTypeGUID - unique identifier of the current governance action type

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

return the list of relationships and attached governance action types.

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)

getGovernanceAction

public GovernanceActionElement getGovernanceAction(String userId,
 String governanceActionGUID)
                                            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Request the status of an executing governance action request.

Specified by:

getGovernanceAction in interface GovernanceExchangeInterface

Parameters:

userId - identifier of calling user

governanceActionGUID - identifier of the governance action request.

Returns:

status enum

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - there was a problem detected by the metadata store.

getGovernanceActions

public List<GovernanceActionElement> getGovernanceActions(String userId,
 int startFrom,
 int pageSize)
                                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the governance actions known to the server.

Specified by:

getGovernanceActions in interface GovernanceExchangeInterface

Parameters:

userId - userId of caller

startFrom - starting from element

pageSize - maximum elements to return

Returns:

list of governance action elements

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - there was a problem detected by the metadata store.

getActiveGovernanceActions

public List<GovernanceActionElement> getActiveGovernanceActions(String userId,
 int startFrom,
 int pageSize)
                                                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the governance actions that are still in process.

Specified by:

getActiveGovernanceActions in interface GovernanceExchangeInterface

Parameters:

userId - userId of caller

startFrom - starting from element

pageSize - maximum elements to return

Returns:

list of governance action elements

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - there was a problem detected by the metadata store.