GovernanceExchangeClient (Asset Manager OMAS Client 2.10 API)

java.lang.Object
- org.odpi.openmetadata.accessservices.assetmanager.client.ExchangeClientBase
- - org.odpi.openmetadata.accessservices.assetmanager.client.GovernanceExchangeClient

All Implemented Interfaces:

GovernanceExchangeInterface
```
public class GovernanceExchangeClient
extends ExchangeClientBase
implements GovernanceExchangeInterface
```
GovernanceExchangeClient is the client for managing governance policies and rules.

Constructor Summary

Constructors
Constructor and Description
`GovernanceExchangeClient(String serverName, String serverPlatformURLRoot)` Create a new client with no authentication embedded in the 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.
`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.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addElementToSubjectArea(String userId, String assetManagerGUID, String assetManagerName, String elementGUID, String elementExternalIdentifier, String subjectAreaName, String methodName)` Classify the element to asset that the definitions it represents are part of a subject area definition.
`void`	`addGovernanceDefinitionToElement(String userId, String assetManagerGUID, String assetManagerName, String definitionGUID, String elementGUID, String methodName)` Link a governance definition to an element using the GovernedBy relationship.
`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, String definitionExternalIdentifier, String definitionExternalIdentifierName, String definitionExternalIdentifierUsage, String definitionExternalIdentifierSource, KeyPattern definitionExternalIdentifierKeyPattern, Map<String,String> mappingProperties, GovernanceDefinitionProperties definitionProperties)` Create a new definition.
`void`	`deleteGovernanceDefinition(String userId, String assetManagerGUID, String assetManagerName, String definitionGUID)` Delete a specific governance definition.
`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.
`void`	`linkDefinitions(String userId, String assetManagerGUID, String assetManagerName, String definitionOneGUID, String definitionTwoGUID, String description)` Link two related definitions together.
`void`	`removeElementFromSubjectArea(String userId, String assetManagerGUID, String assetManagerName, String elementGUID, String externalElementIdentifier, String methodName)` Remove the subject area designation from the identified element.
`void`	`removeGovernanceDefinitionFromElement(String userId, String assetManagerGUID, String assetManagerName, String definitionGUID, String elementGUID, String methodName)` Remove the GovernedBy relationship between a governance definition and an element.
`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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- 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 servers
  
  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 servers
  
  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 servers
  
  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 servers
  
  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 servers
  
  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 Detail

createGovernanceDefinition

public String createGovernanceDefinition(String userId,
                                         String assetManagerGUID,
                                         String assetManagerName,
                                         String typeName,
                                         String definitionExternalIdentifier,
                                         String definitionExternalIdentifierName,
                                         String definitionExternalIdentifierUsage,
                                         String definitionExternalIdentifierSource,
                                         KeyPattern definitionExternalIdentifierKeyPattern,
                                         Map<String,String> mappingProperties,
                                         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; definitionExternalIdentifier - unique identifier of the definition in the external asset manager; definitionExternalIdentifierName - name of property for the external identifier in the external asset manager; definitionExternalIdentifierUsage - optional usage description for the external identifier when calling the external asset manager; definitionExternalIdentifierSource - component that issuing this request.; definitionExternalIdentifierKeyPattern - pattern for the external identifier within the external asset manager (default is LOCAL_KEY); mappingProperties - additional properties to help with the mapping of the elements in the external asset manager and open metadata; 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

addGovernanceDefinitionToElement

public void addGovernanceDefinitionToElement(String userId,
                                             String assetManagerGUID,
                                             String assetManagerName,
                                             String definitionGUID,
                                             String elementGUID,
                                             String methodName)
                                      throws InvalidParameterException,
                                             UserNotAuthorizedException,
                                             PropertyServerException

Link a governance definition to an element using the GovernedBy relationship.

Specified by:: addGovernanceDefinitionToElement 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 link; elementGUID - unique identifier of the metadata element to link; methodName - calling method
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)

removeGovernanceDefinitionFromElement

public void removeGovernanceDefinitionFromElement(String userId,
                                                  String assetManagerGUID,
                                                  String assetManagerName,
                                                  String definitionGUID,
                                                  String elementGUID,
                                                  String methodName)
                                           throws InvalidParameterException,
                                                  UserNotAuthorizedException,
                                                  PropertyServerException

Remove the GovernedBy relationship between a governance definition and an element.

Specified by:: removeGovernanceDefinitionFromElement 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 link; elementGUID - unique identifier of the metadata element to update; methodName - calling method
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)

addElementToSubjectArea

public void addElementToSubjectArea(String userId,
                                    String assetManagerGUID,
                                    String assetManagerName,
                                    String elementGUID,
                                    String elementExternalIdentifier,
                                    String subjectAreaName,
                                    String methodName)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException

Classify the element to asset that the definitions it represents are part of a subject area definition.

Specified by:: addElementToSubjectArea 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; elementGUID - unique identifier of the metadata element to update; elementExternalIdentifier - unique identifier of the glossary category in the external asset manager; subjectAreaName - qualified name of subject area; methodName - calling method
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)

removeElementFromSubjectArea

public void removeElementFromSubjectArea(String userId,
                                         String assetManagerGUID,
                                         String assetManagerName,
                                         String elementGUID,
                                         String externalElementIdentifier,
                                         String methodName)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         PropertyServerException

Remove the subject area designation from the identified element.

Specified by:: removeElementFromSubjectArea 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; elementGUID - unique identifier of the metadata element to update; externalElementIdentifier - unique identifier of the equivalent element in the external asset manager; methodName - calling method
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)

Class GovernanceExchangeClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GovernanceExchangeClient

GovernanceExchangeClient

GovernanceExchangeClient

GovernanceExchangeClient

GovernanceExchangeClient

Method Detail

createGovernanceDefinition

updateGovernanceDefinition

deleteGovernanceDefinition

linkDefinitions

unlinkDefinitions

setupGovernanceDelegation

clearGovernanceDelegation

getGovernanceDefinitionByGUID

getGovernanceDefinitionByDocId

addGovernanceDefinitionToElement

removeGovernanceDefinitionFromElement

addElementToSubjectArea

removeElementFromSubjectArea