org.odpi.openmetadata.accessservices.assetmanager.server

Class DataAssetExchangeRESTServices

java.lang.Object

org.odpi.openmetadata.accessservices.assetmanager.server.DataAssetExchangeRESTServices

public class DataAssetExchangeRESTServices
extends Object

DataAssetExchangeRESTServices is the server-side implementation of the Asset Manager OMAS's support for relational databases. It matches the DataAssetExchangeClient.

Constructor Summary

Constructors

Constructor and Description
DataAssetExchangeRESTServices() Default constructor

Method Summary

Modifier and Type	Method and Description
VoidResponse	clearDataAssetAsReferenceData(String serverName, String userId, String assetGUID, MetadataCorrelationProperties requestBody) Remove the reference data designation from the asset.
GUIDResponse	createDataAsset(String serverName, String userId, boolean assetManagerIsHome, DataAssetRequestBody requestBody) Create a new metadata element to represent the root of an asset.
GUIDResponse	createDataAssetFromTemplate(String serverName, String userId, boolean assetManagerIsHome, String templateGUID, TemplateRequestBody requestBody) Create a new metadata element to represent an asset using an existing metadata element as a template.
DataAssetElementsResponse	findDataAssets(String serverName, String userId, int startFrom, int pageSize, SearchStringRequestBody requestBody) Retrieve the list of asset metadata elements that contain the search string.
DataAssetElementResponse	getDataAssetByGUID(String serverName, String userId, String assetGUID, AssetManagerIdentifiersRequestBody requestBody) Retrieve the asset metadata element with the supplied unique identifier.
DataAssetElementsResponse	getDataAssetsByName(String serverName, String userId, int startFrom, int pageSize, NameRequestBody requestBody) Retrieve the list of asset metadata elements with a matching qualified or display name.
DataAssetElementsResponse	getDataAssetsForAssetManager(String serverName, String userId, int startFrom, int pageSize, AssetManagerIdentifiersRequestBody requestBody) Retrieve the list of assets created on behalf of the named asset manager.
VoidResponse	publishDataAsset(String serverName, String userId, String assetGUID, AssetManagerIdentifiersRequestBody requestBody) Update the zones for the asset so that it becomes visible to consumers.
VoidResponse	removeDataAsset(String serverName, String userId, String assetGUID, MetadataCorrelationProperties requestBody) Remove the metadata element representing an asset.
DataAssetElementsResponse	scanDataAssets(String serverName, String userId, int startFrom, int pageSize, AssetManagerIdentifiersRequestBody requestBody) Step through the assets visible to this caller.
VoidResponse	setDataAssetAsReferenceData(String serverName, String userId, String assetGUID, MetadataCorrelationProperties requestBody) Classify the asset to indicate that it can be used as reference data.
VoidResponse	updateDataAsset(String serverName, String userId, String assetGUID, boolean isMergeUpdate, DataAssetRequestBody requestBody) Update the metadata element representing an asset.
VoidResponse	withdrawDataAsset(String serverName, String userId, String assetGUID, AssetManagerIdentifiersRequestBody requestBody) Update the zones for the asset so that it is no longer visible to consumers.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataAssetExchangeRESTServices

public DataAssetExchangeRESTServices()

Default constructor

Method Detail

createDataAsset

public GUIDResponse createDataAsset(String serverName,
                                    String userId,
                                    boolean assetManagerIsHome,
                                    DataAssetRequestBody requestBody)

Create a new metadata element to represent the root of an asset.

Parameters:

serverName - name of the server to route the request to

userId - calling user

assetManagerIsHome - ensure that only the asset manager can update this asset

requestBody - properties to store

Returns:

unique identifier of the new metadata element or 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)

createDataAssetFromTemplate

public GUIDResponse createDataAssetFromTemplate(String serverName,
                                                String userId,
                                                boolean assetManagerIsHome,
                                                String templateGUID,
                                                TemplateRequestBody requestBody)

Create a new metadata element to represent an asset using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new asset.

Parameters:

serverName - name of the server to route the request to

userId - calling user

assetManagerIsHome - ensure that only the asset manager can update this asset

templateGUID - unique identifier of the metadata element to copy

requestBody - properties that override the template and correlate to external identifiers

Returns:

unique identifier of the new metadata element or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

updateDataAsset

public VoidResponse updateDataAsset(String serverName,
                                    String userId,
                                    String assetGUID,
                                    boolean isMergeUpdate,
                                    DataAssetRequestBody requestBody)

Update the metadata element representing an asset.

Parameters:

serverName - name of the server to route the request to

userId - calling user

assetGUID - unique identifier of the metadata element to update

isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?

requestBody - new properties for this element

Returns:

void or 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)

publishDataAsset

public VoidResponse publishDataAsset(String serverName,
                                     String userId,
                                     String assetGUID,
                                     AssetManagerIdentifiersRequestBody requestBody)

Update the zones for the asset so that it becomes visible to consumers. (The zones are set to the list of zones in the publishedZones option configured for each instance of the Asset Manager OMAS).

Parameters:

serverName - name of the server to route the request to

userId - calling user

assetGUID - unique identifier of the metadata element to publish

requestBody - correlation properties

Returns:

void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

withdrawDataAsset

public VoidResponse withdrawDataAsset(String serverName,
                                      String userId,
                                      String assetGUID,
                                      AssetManagerIdentifiersRequestBody requestBody)

Update the zones for the asset so that it is no longer visible to consumers. (The zones are set to the list of zones in the defaultZones option configured for each instance of the Asset Manager OMAS. This is the setting when the database is first created).

Parameters:

serverName - name of the server to route the request to

userId - calling user

assetGUID - unique identifier of the metadata element to withdraw

requestBody - correlation properties

Returns:

void or 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)

removeDataAsset

public VoidResponse removeDataAsset(String serverName,
                                    String userId,
                                    String assetGUID,
                                    MetadataCorrelationProperties requestBody)

Remove the metadata element representing an asset. This will delete the asset and all anchored elements such as schema and comments.

Parameters:

serverName - name of the server to route the request to

userId - calling user

assetGUID - unique identifier of the metadata element to remove

requestBody - correlation properties

Returns:

void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

setDataAssetAsReferenceData

public VoidResponse setDataAssetAsReferenceData(String serverName,
                                                String userId,
                                                String assetGUID,
                                                MetadataCorrelationProperties requestBody)

Classify the asset to indicate that it can be used as reference data.

Parameters:

serverName - name of the server to route the request to

userId - calling user

assetGUID - unique identifier of the metadata element to update

requestBody - correlation properties

Returns:

void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

clearDataAssetAsReferenceData

public VoidResponse clearDataAssetAsReferenceData(String serverName,
                                                  String userId,
                                                  String assetGUID,
                                                  MetadataCorrelationProperties requestBody)

Remove the reference data designation from the asset.

Parameters:

serverName - name of the server to route the request to

userId - calling user

assetGUID - unique identifier of the metadata element to update

requestBody - correlation properties

Returns:

void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

findDataAssets

public DataAssetElementsResponse findDataAssets(String serverName,
                                                String userId,
                                                int startFrom,
                                                int pageSize,
                                                SearchStringRequestBody requestBody)

Retrieve the list of asset metadata elements that contain the search string. The search string is treated as a regular expression.

Parameters:

serverName - name of the server to route the request to

userId - calling user

startFrom - paging start point

pageSize - maximum results that can be returned

requestBody - search parameter and correlation properties

Returns:

list of matching metadata elements or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

scanDataAssets

public DataAssetElementsResponse scanDataAssets(String serverName,
                                                String userId,
                                                int startFrom,
                                                int pageSize,
                                                AssetManagerIdentifiersRequestBody requestBody)

Step through the assets visible to this caller.

Parameters:

serverName - name of the server to route the request to

userId - calling user

startFrom - paging start point

pageSize - maximum results that can be returned

requestBody - search parameter and correlation properties

Returns:

list of matching metadata elements or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

getDataAssetsByName

public DataAssetElementsResponse getDataAssetsByName(String serverName,
                                                     String userId,
                                                     int startFrom,
                                                     int pageSize,
                                                     NameRequestBody requestBody)

Retrieve the list of asset metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Parameters:

serverName - name of the server to route the request to

userId - calling user

startFrom - paging start point

pageSize - maximum results that can be returned

requestBody - search parameter and correlation properties

Returns:

list of matching metadata elements or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

getDataAssetsForAssetManager

public DataAssetElementsResponse getDataAssetsForAssetManager(String serverName,
                                                              String userId,
                                                              int startFrom,
                                                              int pageSize,
                                                              AssetManagerIdentifiersRequestBody requestBody)

Retrieve the list of assets created on behalf of the named asset manager.

Parameters:

serverName - name of the server to route the request to

userId - calling user

startFrom - paging start point

pageSize - maximum results that can be returned

requestBody - search parameters and correlation properties

Returns:

list of matching metadata elements or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

getDataAssetByGUID

public DataAssetElementResponse getDataAssetByGUID(String serverName,
                                                   String userId,
                                                   String assetGUID,
                                                   AssetManagerIdentifiersRequestBody requestBody)

Retrieve the asset metadata element with the supplied unique identifier.

Parameters:

serverName - name of the server to route the request to

userId - calling user

assetGUID - unique identifier of the requested metadata element

requestBody - correlation properties

Returns:

matching metadata element or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)