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

Class StewardshipExchangeClient

java.lang.Object

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

org.odpi.openmetadata.accessservices.assetmanager.client.StewardshipExchangeClient

All Implemented Interfaces:

StewardshipExchangeInterface

public class StewardshipExchangeClient
extends ExchangeClientBase
implements StewardshipExchangeInterface

StewardshipExchangeClient is the client for todos and tasks.

Constructor Summary

Constructors

Constructor	Description
StewardshipExchangeClient(String serverName, String serverPlatformURLRoot)	Create a new client with no authentication embedded in the HTTP request.
StewardshipExchangeClient(String serverName, String serverPlatformURLRoot, String userId, String password)	Create a new client that passes userId and password in each HTTP request.
StewardshipExchangeClient(String serverName, String serverPlatformURLRoot, String userId, String password, AuditLog auditLog)	Create a new client that passes userId and password in each HTTP request.
StewardshipExchangeClient(String serverName, String serverPlatformURLRoot, AssetManagerRESTClient restClient, int maxPageSize, AuditLog auditLog)	Create a new client that is going to be used in an OMAG Server.
StewardshipExchangeClient(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	addIncompleteClassification(String userId, String assetManagerGUID, String assetManagerName, String elementGUID, String elementExternalIdentifier, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)	Classify the element with the Incomplete classification to indicate that it has more details to come.
void	addMementoClassification(String userId, String assetManagerGUID, String assetManagerName, String elementGUID, String elementExternalIdentifier, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)	Classify the element with the Memento classification to indicate that it has been logically deleted for by lineage requests.
void	clearIncompleteClassification(String userId, String assetManagerGUID, String assetManagerName, String elementGUID, String elementExternalIdentifier, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)	Remove the Incomplete designation from the element.
void	clearMementoClassification(String userId, String assetManagerGUID, String assetManagerName, String elementGUID, String elementExternalIdentifier, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)	Remove the memento designation from the element.

Methods inherited from class java.lang.Object

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

Constructor Detail

StewardshipExchangeClient

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

StewardshipExchangeClient

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

StewardshipExchangeClient

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

StewardshipExchangeClient

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

StewardshipExchangeClient

public StewardshipExchangeClient(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

addMementoClassification

public void addMementoClassification(String userId,
                                     String assetManagerGUID,
                                     String assetManagerName,
                                     String elementGUID,
                                     String elementExternalIdentifier,
                                     Date effectiveTime,
                                     boolean forLineage,
                                     boolean forDuplicateProcessing)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException

Classify the element with the Memento classification to indicate that it has been logically deleted for by lineage requests.

Specified by:

addMementoClassification in interface StewardshipExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

elementGUID - unique identifier of the metadata element to update

elementExternalIdentifier - unique identifier of the element in the external asset manager

effectiveTime - optional date for effective time of the query. Null means any effective time

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

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)

clearMementoClassification

public void clearMementoClassification(String userId,
                                       String assetManagerGUID,
                                       String assetManagerName,
                                       String elementGUID,
                                       String elementExternalIdentifier,
                                       Date effectiveTime,
                                       boolean forLineage,
                                       boolean forDuplicateProcessing)
                                throws InvalidParameterException,
                                       UserNotAuthorizedException,
                                       PropertyServerException

Remove the memento designation from the element.

Specified by:

clearMementoClassification in interface StewardshipExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

elementGUID - unique identifier of the metadata element to update

elementExternalIdentifier - unique identifier of the element in the external asset manager

effectiveTime - optional date for effective time of the query. Null means any effective time

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

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)

addIncompleteClassification

public void addIncompleteClassification(String userId,
                                        String assetManagerGUID,
                                        String assetManagerName,
                                        String elementGUID,
                                        String elementExternalIdentifier,
                                        Date effectiveTime,
                                        boolean forLineage,
                                        boolean forDuplicateProcessing)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException

Classify the element with the Incomplete classification to indicate that it has more details to come.

Specified by:

addIncompleteClassification in interface StewardshipExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

elementGUID - unique identifier of the metadata element to update

elementExternalIdentifier - unique identifier of the element in the external asset manager

effectiveTime - optional date for effective time of the query. Null means any effective time

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

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)

clearIncompleteClassification

public void clearIncompleteClassification(String userId,
                                          String assetManagerGUID,
                                          String assetManagerName,
                                          String elementGUID,
                                          String elementExternalIdentifier,
                                          Date effectiveTime,
                                          boolean forLineage,
                                          boolean forDuplicateProcessing)
                                   throws InvalidParameterException,
                                          UserNotAuthorizedException,
                                          PropertyServerException

Remove the Incomplete designation from the element.

Specified by:

clearIncompleteClassification in interface StewardshipExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

elementGUID - unique identifier of the metadata element to update

elementExternalIdentifier - unique identifier of the element in the external asset manager

effectiveTime - optional date for effective time of the query. Null means any effective time

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

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)