Package org.odpi.openmetadata.accessservices.itinfrastructure.client

Class DataAssetManagerClient

java.lang.Object

org.odpi.openmetadata.accessservices.itinfrastructure.client.ITInfrastructureClientBase

org.odpi.openmetadata.accessservices.itinfrastructure.client.DataAssetManagerClient

All Implemented Interfaces:

DataAssetManagerInterface, DeploymentManagementInterface, ServerPurposeManagerInterface

public class DataAssetManagerClient
extends ITInfrastructureClientBase
implements DataAssetManagerInterface

PlatformManagerClient supports the APIs to maintain software server platforms and their related objects.

Constructor Summary

Constructors

Constructor	Description
DataAssetManagerClient(String serverName, String serverPlatformURLRoot, int maxPageSize)	Create a new client with no authentication embedded in the HTTP request.
DataAssetManagerClient(String serverName, String serverPlatformURLRoot, String userId, String password, int maxPageSize)	Create a new client that passes userId and password in each HTTP request.
DataAssetManagerClient(String serverName, String serverPlatformURLRoot, String userId, String password, AuditLog auditLog, int maxPageSize)	Create a new client that passes userId and password in each HTTP request.
DataAssetManagerClient(String serverName, String serverPlatformURLRoot, ITInfrastructureRESTClient restClient, int maxPageSize)	Create a new client that is going to be used in an OMAG Server.
DataAssetManagerClient(String serverName, String serverPlatformURLRoot, AuditLog auditLog, int maxPageSize)	Create a new client with no authentication embedded in the HTTP request.

Method Summary

Modifier and Type	Method	Description
void	clearDataAssetAsReferenceData(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String assetGUID, Date effectiveTime)	Remove the reference data designation from the asset.
String	createDataAsset(String userId, String infrastructureManagerGUID, String infrastructureManagerName, boolean infrastructureManagerIsHome, DataAssetProperties dataAssetProperties)	Create a new metadata element to represent the root of an asset.
String	createDataAssetFromTemplate(String userId, String infrastructureManagerGUID, String infrastructureManagerName, boolean infrastructureManagerIsHome, String templateGUID, TemplateProperties templateProperties)	Create a new metadata element to represent an asset using an existing metadata element as a template.
List<DataAssetElement>	findDataAssets(String userId, String searchString, Date effectiveTime, int startFrom, int pageSize)	Retrieve the list of asset metadata elements that contain the search string.
DataAssetElement	getDataAssetByGUID(String userId, String guid)	Retrieve the asset metadata element with the supplied unique identifier.
List<DataAssetElement>	getDataAssetsByName(String userId, String name, Date effectiveTime, int startFrom, int pageSize)	Retrieve the list of asset metadata elements with a matching qualified or display name.
List<DataAssetElement>	getDataAssetsForInfrastructureManager(String userId, String infrastructureManagerGUID, String infrastructureManagerName, Date effectiveTime, int startFrom, int pageSize)	Retrieve the list of assets created on behalf of the named infrastructure manager.
void	publishDataAsset(String userId, String assetGUID)	Update the zones for the asset so that it becomes visible to consumers.
void	removeDataAsset(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String assetGUID)	Remove the metadata element representing an asset.
void	setDataAssetAsReferenceData(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String assetGUID, Date effectiveFrom, Date effectiveTo)	Classify the asset to indicate that it can be used as reference data.
void	updateDataAsset(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String assetGUID, boolean isMergeUpdate, DataAssetProperties dataAssetProperties)	Update the metadata element representing an asset.
void	withdrawDataAsset(String userId, String assetGUID)	Update the zones for the asset so that it is no longer visible to consumers.

Methods inherited from class org.odpi.openmetadata.accessservices.itinfrastructure.client.ITInfrastructureClientBase

addServerPurpose, clearDeployment, clearServerPurpose, deployITAsset, getDeployedITAssets, getDeploymentDestinations, updateITAssetDeployment, updateServerPurpose

Methods inherited from class java.lang.Object

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

Constructor Details

DataAssetManagerClient

public DataAssetManagerClient(String serverName,
 String serverPlatformURLRoot,
 AuditLog auditLog,
 int maxPageSize)
                       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 services

auditLog - logging destination

maxPageSize - maximum value allowed for page size

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

DataAssetManagerClient

public DataAssetManagerClient(String serverName,
 String serverPlatformURLRoot,
 int maxPageSize)
                       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 services

maxPageSize - maximum value allowed for page size

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

DataAssetManagerClient

public DataAssetManagerClient(String serverName,
 String serverPlatformURLRoot,
 String userId,
 String password,
 int maxPageSize)
                       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 services

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

maxPageSize - maximum value allowed for page size

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

DataAssetManagerClient

public DataAssetManagerClient(String serverName,
 String serverPlatformURLRoot,
 String userId,
 String password,
 AuditLog auditLog,
 int maxPageSize)
                       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 services

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

auditLog - logging destination

maxPageSize - maximum value allowed for page size

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

DataAssetManagerClient

public DataAssetManagerClient(String serverName,
 String serverPlatformURLRoot,
 ITInfrastructureRESTClient restClient,
 int maxPageSize)
                       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 services

restClient - client that issues the REST API calls

maxPageSize - maximum number of results supported by this server

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

Method Details

createDataAsset

public String createDataAsset(String userId,
 String infrastructureManagerGUID,
 String infrastructureManagerName,
 boolean infrastructureManagerIsHome,
 DataAssetProperties dataAssetProperties)
                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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

Specified by:

createDataAsset in interface DataAssetManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the caller

infrastructureManagerName - unique name of software server capability representing the caller

infrastructureManagerIsHome - ensure that only the infrastructure manager can update this asset

dataAssetProperties - properties to store

Returns:

unique identifier of the new metadata element

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)

createDataAssetFromTemplate

public String createDataAssetFromTemplate(String userId,
 String infrastructureManagerGUID,
 String infrastructureManagerName,
 boolean infrastructureManagerIsHome,
 String templateGUID,
 TemplateProperties templateProperties)
                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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.

Specified by:

createDataAssetFromTemplate in interface DataAssetManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the caller

infrastructureManagerName - unique name of software server capability representing the caller

infrastructureManagerIsHome - ensure that only the infrastructure manager can update this asset

templateGUID - unique identifier of the metadata element to copy

templateProperties - properties that override the template

Returns:

unique identifier of the new metadata element

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)

updateDataAsset

public void updateDataAsset(String userId,
 String infrastructureManagerGUID,
 String infrastructureManagerName,
 String assetGUID,
 boolean isMergeUpdate,
 DataAssetProperties dataAssetProperties)
                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the metadata element representing an asset.

Specified by:

updateDataAsset in interface DataAssetManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the caller

infrastructureManagerName - unique name of software server capability representing the caller

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

dataAssetProperties - new properties for this element

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)

setDataAssetAsReferenceData

public void setDataAssetAsReferenceData(String userId,
 String infrastructureManagerGUID,
 String infrastructureManagerName,
 String assetGUID,
 Date effectiveFrom,
 Date effectiveTo)
                                 throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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

Specified by:

setDataAssetAsReferenceData in interface DataAssetManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the caller

infrastructureManagerName - unique name of software server capability representing the caller

assetGUID - unique identifier of the metadata element to update

effectiveFrom - when should classification be effective - null means immediately

effectiveTo - when should classification no longer be effective - null means never

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)

clearDataAssetAsReferenceData

public void clearDataAssetAsReferenceData(String userId,
 String infrastructureManagerGUID,
 String infrastructureManagerName,
 String assetGUID,
 Date effectiveTime)
                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the reference data designation from the asset.

Specified by:

clearDataAssetAsReferenceData in interface DataAssetManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the caller

infrastructureManagerName - unique name of software server capability representing the caller

assetGUID - unique identifier of the metadata element to update

effectiveTime - time when the classification is effective

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)

publishDataAsset

public void publishDataAsset(String userId,
 String assetGUID)
                      throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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 IT Infrastructure OMAS).

Specified by:

publishDataAsset in interface DataAssetManagerInterface

Parameters:

userId - calling user

assetGUID - unique identifier of the metadata element to publish

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)

withdrawDataAsset

public void withdrawDataAsset(String userId,
 String assetGUID)
                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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 IT Infrastructure OMAS).

Specified by:

withdrawDataAsset in interface DataAssetManagerInterface

Parameters:

userId - calling user

assetGUID - unique identifier of the metadata element to withdraw

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)

removeDataAsset

public void removeDataAsset(String userId,
 String infrastructureManagerGUID,
 String infrastructureManagerName,
 String assetGUID)
                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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

Specified by:

removeDataAsset in interface DataAssetManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the caller

infrastructureManagerName - unique name of software server capability representing the caller

assetGUID - unique identifier of the metadata element to remove

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)

findDataAssets

public List<DataAssetElement> findDataAssets(String userId,
 String searchString,
 Date effectiveTime,
 int startFrom,
 int pageSize)
                                      throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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

Specified by:

findDataAssets in interface DataAssetManagerInterface

Parameters:

userId - calling user

searchString - string to find in the properties

effectiveTime - effective time for the query

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

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)

getDataAssetsByName

public List<DataAssetElement> getDataAssetsByName(String userId,
 String name,
 Date effectiveTime,
 int startFrom,
 int pageSize)
                                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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

Specified by:

getDataAssetsByName in interface DataAssetManagerInterface

Parameters:

userId - calling user

name - name to search for

effectiveTime - effective time for the query

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

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)

getDataAssetsForInfrastructureManager

public List<DataAssetElement> getDataAssetsForInfrastructureManager(String userId,
 String infrastructureManagerGUID,
 String infrastructureManagerName,
 Date effectiveTime,
 int startFrom,
 int pageSize)
                                                             throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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

Specified by:

getDataAssetsForInfrastructureManager in interface DataAssetManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the caller

infrastructureManagerName - unique name of software server capability representing the caller

effectiveTime - effective time for the query

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

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)

getDataAssetByGUID

public DataAssetElement getDataAssetByGUID(String userId,
 String guid)
                                    throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the asset metadata element with the supplied unique identifier.

Specified by:

getDataAssetByGUID in interface DataAssetManagerInterface

Parameters:

userId - calling user

guid - unique identifier of the requested metadata element

Returns:

matching metadata element

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)