Package org.odpi.openmetadata.accessservices.assetmanager.server

Class AssetManagerRESTServices

java.lang.Object

org.odpi.openmetadata.accessservices.assetmanager.server.AssetManagerRESTServices

public class AssetManagerRESTServices
extends Object

The AssetManagerRESTServices provides the server-side implementation of the services that are generic for all types of asset managers.

Constructor Summary

Constructors

Constructor	Description
AssetManagerRESTServices()	Default constructor

Method Summary

Modifier and Type	Method	Description
VoidResponse	addExternalIdentifier(String serverName, String userId, String openMetadataElementGUID, String openMetadataElementTypeName, MetadataCorrelationProperties requestBody)	Add the description of a specific external identifier.
VoidResponse	confirmSynchronization(String serverName, String userId, String openMetadataElementGUID, String openMetadataElementTypeName, MetadataCorrelationProperties requestBody)	Confirm that the values of a particular metadata element have been synchronized.
GUIDResponse	createExternalAssetManager(String serverName, String userId, AssetManagerProperties assetManagerProperties)	Create information about the external asset manager.
ElementHeadersResponse	getElementsForExternalIdentifier(String serverName, String userId, int startFrom, int pageSize, MetadataCorrelationProperties requestBody)	Retrieve the unique identifier of the external asset manager from its qualified name.
GUIDResponse	getExternalAssetManagerGUID(String serverName, String userId, String qualifiedName)	Retrieve the unique identifier of the external asset manager from its qualified name.
ConnectionResponse	getOutTopicConnection(String serverName, String userId, String callerId)	Return the client side connection object for the Asset Manager OMAS's out topic.
VoidResponse	removeExternalIdentifier(String serverName, String userId, String openMetadataElementGUID, String openMetadataElementTypeName, MetadataCorrelationProperties requestBody)	Remove an external identifier from an existing open metadata element.
VoidResponse	updateExternalIdentifier(String serverName, String userId, String openMetadataElementGUID, String openMetadataElementTypeName, MetadataCorrelationProperties requestBody)	Update the description of a specific external identifier.

Methods inherited from class java.lang.Object

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

Constructor Detail

AssetManagerRESTServices

public AssetManagerRESTServices()

Default constructor

Method Detail

getOutTopicConnection

public ConnectionResponse getOutTopicConnection(String serverName,
                                                String userId,
                                                String callerId)

Return the client side connection object for the Asset Manager OMAS's out topic.

Parameters:

serverName - name of the service to route the request to.

userId - identifier of calling user.

callerId - unique identifier of the caller

Returns:

connection object for the out topic or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem retrieving the discovery engine definition.

createExternalAssetManager

public GUIDResponse createExternalAssetManager(String serverName,
                                               String userId,
                                               AssetManagerProperties assetManagerProperties)

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.

Parameters:

serverName - name of the server to route the request to.

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 or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException user not authorized to issue this request PropertyServerException problem accessing the property server

getExternalAssetManagerGUID

public GUIDResponse getExternalAssetManagerGUID(String serverName,
                                                String userId,
                                                String qualifiedName)

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

Parameters:

serverName - name of the service to route the request to.

userId - calling user

qualifiedName - unique name to use for the external asset

Returns:

unique identifier of the external asset manager's software server capability or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException user not authorized to issue this request PropertyServerException problem accessing the property server

addExternalIdentifier

public VoidResponse addExternalIdentifier(String serverName,
                                          String userId,
                                          String openMetadataElementGUID,
                                          String openMetadataElementTypeName,
                                          MetadataCorrelationProperties requestBody)

Add the description of a specific external identifier.

Parameters:

serverName - name of the service to route the request to.

userId - calling user

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

openMetadataElementTypeName - type name of the element in the open metadata ecosystem (default referenceable)

requestBody - unique identifier of this element in the external asset manager plus additional mapping properties

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException user not authorized to issue this request PropertyServerException problem accessing the property server

updateExternalIdentifier

public VoidResponse updateExternalIdentifier(String serverName,
                                             String userId,
                                             String openMetadataElementGUID,
                                             String openMetadataElementTypeName,
                                             MetadataCorrelationProperties requestBody)

Update the description of a specific external identifier.

Parameters:

serverName - name of the service to route the request to.

userId - calling user

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

openMetadataElementTypeName - type name of the element in the open metadata ecosystem (default referenceable)

requestBody - unique identifier of this element in the external asset manager plus additional mapping properties

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException user not authorized to issue this request PropertyServerException problem accessing the property server

removeExternalIdentifier

public VoidResponse removeExternalIdentifier(String serverName,
                                             String userId,
                                             String openMetadataElementGUID,
                                             String openMetadataElementTypeName,
                                             MetadataCorrelationProperties requestBody)

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

Parameters:

serverName - name of the service to route the request to.

userId - calling user

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

openMetadataElementTypeName - type name of the element in the open metadata ecosystem (default referenceable)

requestBody - unique identifier of this element in the external asset manager plus additional mapping properties

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException user not authorized to issue this request PropertyServerException problem accessing the property server

confirmSynchronization

public VoidResponse confirmSynchronization(String serverName,
                                           String userId,
                                           String openMetadataElementGUID,
                                           String openMetadataElementTypeName,
                                           MetadataCorrelationProperties requestBody)

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.

Parameters:

serverName - name of the service to route the request to.

userId - calling user

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

openMetadataElementTypeName - type name for the open metadata element

requestBody - details of the external identifier and its scope

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException user not authorized to issue this request PropertyServerException problem accessing the property server

getElementsForExternalIdentifier

public ElementHeadersResponse getElementsForExternalIdentifier(String serverName,
                                                               String userId,
                                                               int startFrom,
                                                               int pageSize,
                                                               MetadataCorrelationProperties requestBody)

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

Parameters:

serverName - name of the service to route the request to.

userId - calling user

startFrom - paging start point

pageSize - maximum results that can be returned

requestBody - details of the external identifier

Returns:

list of linked elements, null if null or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException user not authorized to issue this request PropertyServerException problem accessing the property server