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

Class ExternalAssetManagerClient

java.lang.Object

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

All Implemented Interfaces:

org.odpi.openmetadata.accessservices.assetmanager.api.exchange.ExternalAssetManagerInterface

public class ExternalAssetManagerClient
extends Object
implements org.odpi.openmetadata.accessservices.assetmanager.api.exchange.ExternalAssetManagerInterface

ExternalAssetManagerClient is the client for setting up the SoftwareServerCapabilities that represent asset managers.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	addExternalIdentifier(String userId, String assetManagerGUID, String assetManagerName, String openMetadataElementGUID, String openMetadataElementTypeName, org.odpi.openmetadata.accessservices.assetmanager.properties.ExternalIdentifierProperties externalIdentifierProperties)	Add a new external identifier to an existing open metadata element.
void	confirmSynchronization(String userId, String assetManagerGUID, String assetManagerName, String openMetadataElementGUID, String openMetadataElementTypeName, String externalIdentifier)	Confirm that the values of a particular metadata element have been synchronized.
String	createExternalAssetManager(String userId, org.odpi.openmetadata.accessservices.assetmanager.properties.AssetManagerProperties assetManagerProperties)	Create information about the external asset manager.
List<org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementHeader>	getElementsForExternalIdentifier(String userId, String assetManagerGUID, String assetManagerName, String externalIdentifier, int startFrom, int pageSize)	Return the list of headers for open metadata elements that are associated with a particular external identifier.
String	getExternalAssetManagerGUID(String userId, String qualifiedName)	Retrieve the unique identifier of the external asset manager from its qualified name.
void	removeExternalIdentifier(String userId, String assetManagerGUID, String assetManagerName, String openMetadataElementGUID, String openMetadataElementTypeName, String externalIdentifier)	Remove an external identifier from an existing open metadata element.
void	updateExternalIdentifier(String userId, String assetManagerGUID, String assetManagerName, String openMetadataElementGUID, String openMetadataElementTypeName, org.odpi.openmetadata.accessservices.assetmanager.properties.ExternalIdentifierProperties externalIdentifierProperties)	Update the description of a specific external identifier.

Methods inherited from class java.lang.Object

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

Constructor Details

ExternalAssetManagerClient

public ExternalAssetManagerClient(String serverName,
 String serverPlatformURLRoot,
 org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)
                           throws org.odpi.openmetadata.frameworks.connectors.ffdc.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:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

ExternalAssetManagerClient

public ExternalAssetManagerClient(String serverName,
 String serverPlatformURLRoot)
                           throws org.odpi.openmetadata.frameworks.connectors.ffdc.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:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

ExternalAssetManagerClient

public ExternalAssetManagerClient(String serverName,
 String serverPlatformURLRoot,
 String userId,
 String password)
                           throws org.odpi.openmetadata.frameworks.connectors.ffdc.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:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

ExternalAssetManagerClient

public ExternalAssetManagerClient(String serverName,
 String serverPlatformURLRoot,
 String userId,
 String password,
 org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)
                           throws org.odpi.openmetadata.frameworks.connectors.ffdc.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:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

ExternalAssetManagerClient

public ExternalAssetManagerClient(String serverName,
 String serverPlatformURLRoot,
 AssetManagerRESTClient restClient,
 int maxPageSize,
 org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)
                           throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException

Create a new client that is to be used within 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 - pre-initialized REST client

maxPageSize - pre-initialized parameter limit

auditLog - logging destination

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem with the information about the remote OMAS

Method Details

createExternalAssetManager

public String createExternalAssetManager(String userId,
 org.odpi.openmetadata.accessservices.assetmanager.properties.AssetManagerProperties assetManagerProperties)
                                  throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Create information about the external asset manager. This is represented as a software server capability and all information that is specific to the external asset manager (such as the identifiers of the metadata elements it stores) will be linked to it.

Specified by:

createExternalAssetManager in interface org.odpi.openmetadata.accessservices.assetmanager.api.exchange.ExternalAssetManagerInterface

Parameters:

userId - calling user

assetManagerProperties - description of the integration daemon (specify qualified name at a minimum)

Returns:

unique identifier of the asset management's software server capability

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing the property server

getExternalAssetManagerGUID

public String getExternalAssetManagerGUID(String userId,
 String qualifiedName)
                                   throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Retrieve the unique identifier of the external asset manager from its qualified name. Typically, the qualified name comes from the integration connector configuration.

Specified by:

getExternalAssetManagerGUID in interface org.odpi.openmetadata.accessservices.assetmanager.api.exchange.ExternalAssetManagerInterface

Parameters:

userId - calling user

qualifiedName - unique name to use for the external asset

Returns:

unique identifier of the external asset manager's software server capability

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing the property server

addExternalIdentifier

public void addExternalIdentifier(String userId,
 String assetManagerGUID,
 String assetManagerName,
 String openMetadataElementGUID,
 String openMetadataElementTypeName,
 org.odpi.openmetadata.accessservices.assetmanager.properties.ExternalIdentifierProperties externalIdentifierProperties)
                           throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Add a new external identifier to an existing open metadata element.

Specified by:

addExternalIdentifier in interface org.odpi.openmetadata.accessservices.assetmanager.api.exchange.ExternalAssetManagerInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

openMetadataElementGUID - unique identifier (GUID) of the element in the open metadata ecosystem

openMetadataElementTypeName - type name for the open metadata element

externalIdentifierProperties - optional properties used to define an external identifier

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing the property server

updateExternalIdentifier

public void updateExternalIdentifier(String userId,
 String assetManagerGUID,
 String assetManagerName,
 String openMetadataElementGUID,
 String openMetadataElementTypeName,
 org.odpi.openmetadata.accessservices.assetmanager.properties.ExternalIdentifierProperties externalIdentifierProperties)
                              throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Update the description of a specific external identifier.

Specified by:

updateExternalIdentifier in interface org.odpi.openmetadata.accessservices.assetmanager.api.exchange.ExternalAssetManagerInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

openMetadataElementGUID - unique identifier (GUID) of the element in the open metadata ecosystem

openMetadataElementTypeName - type name for the open metadata element

externalIdentifierProperties - optional properties used to define an external identifier

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing the property server

removeExternalIdentifier

public void removeExternalIdentifier(String userId,
 String assetManagerGUID,
 String assetManagerName,
 String openMetadataElementGUID,
 String openMetadataElementTypeName,
 String externalIdentifier)
                              throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Remove an external identifier from an existing open metadata element. The open metadata element is not affected.

Specified by:

removeExternalIdentifier in interface org.odpi.openmetadata.accessservices.assetmanager.api.exchange.ExternalAssetManagerInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

openMetadataElementGUID - unique identifier (GUID) of the element in the open metadata ecosystem

openMetadataElementTypeName - type name for the open metadata element

externalIdentifier - unique identifier of this element in the third party asset manager

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing the property server

confirmSynchronization

public void confirmSynchronization(String userId,
 String assetManagerGUID,
 String assetManagerName,
 String openMetadataElementGUID,
 String openMetadataElementTypeName,
 String externalIdentifier)
                            throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Confirm that the values of a particular metadata element have been synchronized. This is important from an audit point of view, and to allow bidirectional updates of metadata using optimistic locking.

Specified by:

confirmSynchronization in interface org.odpi.openmetadata.accessservices.assetmanager.api.exchange.ExternalAssetManagerInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

openMetadataElementGUID - unique identifier (GUID) of this element in open metadata

openMetadataElementTypeName - type name for the open metadata element

externalIdentifier - unique identifier of this element in the external asset manager

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing the property server

getElementsForExternalIdentifier

public List<org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementHeader> getElementsForExternalIdentifier(String userId,
 String assetManagerGUID,
 String assetManagerName,
 String externalIdentifier,
 int startFrom,
 int pageSize)
                                                                                                                  throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Return the list of headers for open metadata elements that are associated with a particular external identifier.

Specified by:

getElementsForExternalIdentifier in interface org.odpi.openmetadata.accessservices.assetmanager.api.exchange.ExternalAssetManagerInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

externalIdentifier - unique identifier of this element in the external asset manager

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of element headers

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing the property server