org.odpi.openmetadata.accessservices.assetmanager.client

Class GovernanceExchangeClient

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

Modifier and Type	Method and Description
void	addElementToSubjectArea(String userId, String assetManagerGUID, String assetManagerName, String glossaryCategoryGUID, String glossaryCategoryExternalIdentifier, String subjectAreaName, String methodName) Classify the element to asset that the definitions it represents are part of a subject area definition.
void	removeElementFromSubjectArea(String userId, String assetManagerGUID, String assetManagerName, String openMetadataGUID, String externalElementIdentifier, String methodName) Remove the subject area designation from the identified element.

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

addElementToSubjectArea

public void addElementToSubjectArea(String userId,
                                    String assetManagerGUID,
                                    String assetManagerName,
                                    String glossaryCategoryGUID,
                                    String glossaryCategoryExternalIdentifier,
                                    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

glossaryCategoryGUID - unique identifier of the metadata element to update

glossaryCategoryExternalIdentifier - 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 openMetadataGUID,
                                         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

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