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

Class DataAssetExchangeClient

java.lang.Object

org.odpi.openmetadata.accessservices.assetmanager.client.AssetManagerBaseClient

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

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

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

All Implemented Interfaces:

DataAssetExchangeInterface, SchemaExchangeInterface, ExternalIdentifierManagerInterface

public class DataAssetExchangeClient
extends SchemaExchangeClientBase
implements DataAssetExchangeInterface

DataAssetExchangeClient is the client for managing Data Assets, Schemas and Connections.

Field Summary

Fields inherited from class org.odpi.openmetadata.accessservices.assetmanager.client.AssetManagerBaseClient

assetManagerGUIDParameterName, assetManagerNameParameterName, invalidParameterHandler, metadataElementSummaryConverter, metadataRelationshipSummaryConverter, nullRequestBody, openMetadataStoreClient, propertyHelper, relatedMetadataElementSummaryConverter, restClient, serverName, serverPlatformURLRoot, urlTemplatePrefix

Constructor Summary

Constructors

Constructor	Description
DataAssetExchangeClient(String serverName, String serverPlatformURLRoot, int maxPageSize)	Create a new client with no authentication embedded in the HTTP request.
DataAssetExchangeClient(String serverName, String serverPlatformURLRoot, String userId, String password, int maxPageSize)	Create a new client that passes userId and password in each HTTP request.
DataAssetExchangeClient(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.
DataAssetExchangeClient(String serverName, String serverPlatformURLRoot, AssetManagerRESTClient restClient, int maxPageSize, AuditLog auditLog)	Create a new client that is going to be used in an OMAG Server.
DataAssetExchangeClient(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	clearAssetRelationship(String userId, String assetManagerGUID, String assetManagerName, String relationshipTypeName, String relationshipGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)	Remove the relationship between two elements.
void	clearDataAssetAsReferenceData(String userId, String assetManagerGUID, String assetManagerName, String assetGUID, String assetExternalIdentifier, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)	Remove the reference data designation from the asset.
String	createDataAsset(String userId, String assetManagerGUID, String assetManagerName, boolean assetManagerIsHome, ExternalIdentifierProperties externalIdentifierProperties, DataAssetProperties assetProperties)	Create a new metadata element to represent the root of an asset.
String	createDataAssetFromTemplate(String userId, String assetManagerGUID, String assetManagerName, boolean assetManagerIsHome, String templateGUID, ExternalIdentifierProperties externalIdentifierProperties, 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 assetManagerGUID, String assetManagerName, String searchString, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)	Retrieve the list of asset metadata elements that contain the search string.
RelationshipElement	getAssetRelationship(String userId, String assetManagerGUID, String assetManagerName, String relationshipTypeName, String fromAssetGUID, String toAssetGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)	Retrieve the relationship between two elements.
DataAssetElement	getDataAssetByGUID(String userId, String assetManagerGUID, String assetManagerName, String openMetadataGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)	Retrieve the asset metadata element with the supplied unique identifier.
List<DataAssetElement>	getDataAssetsByName(String userId, String assetManagerGUID, String assetManagerName, String name, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)	Retrieve the list of asset metadata elements with a matching qualified or display name.
List<DataAssetElement>	getDataAssetsForAssetManager(String userId, String assetManagerGUID, String assetManagerName, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)	Retrieve the list of assets created on behalf of the named asset manager.
List<RelationshipElement>	getRelatedAssetsAtEnd1(String userId, String assetManagerGUID, String assetManagerName, String relationshipTypeName, String toAssetGUID, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)	Retrieve the relationships linked from a specific element at end 2 of the relationship.
List<RelationshipElement>	getRelatedAssetsAtEnd2(String userId, String assetManagerGUID, String assetManagerName, String relationshipTypeName, String fromAssetGUID, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)	Retrieve the requested relationships linked from a specific element at end 2.
void	publishDataAsset(String userId, String assetManagerGUID, String assetManagerName, String assetGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)	Update the zones for the asset so that it becomes visible to consumers.
void	removeDataAsset(String userId, String assetManagerGUID, String assetManagerName, String assetGUID, String assetExternalIdentifier, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)	Remove the metadata element representing an asset.
List<DataAssetElement>	scanDataAssets(String userId, String assetManagerGUID, String assetManagerName, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)	Step through the assets visible to this caller.
void	setDataAssetAsReferenceData(String userId, String assetManagerGUID, String assetManagerName, String assetGUID, String assetExternalIdentifier, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)	Classify the asset to indicate that it can be used as reference data.
String	setupRelatedDataAsset(String userId, String assetManagerGUID, String assetManagerName, boolean assetManagerIsHome, String relationshipTypeName, String fromAssetGUID, String toAssetGUID, RelationshipProperties relationshipProperties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)	Link two asset together.
void	updateAssetRelationship(String userId, String assetManagerGUID, String assetManagerName, String relationshipTypeName, String relationshipGUID, boolean isMergeUpdate, RelationshipProperties relationshipProperties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)	Update relationship between two elements.
void	updateDataAsset(String userId, String assetManagerGUID, String assetManagerName, String assetGUID, String assetExternalIdentifier, boolean isMergeUpdate, DataAssetProperties assetProperties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)	Update the metadata element representing an asset.
void	withdrawDataAsset(String userId, String assetManagerGUID, String assetManagerName, String assetGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)	Update the zones for the asset so that it is no longer visible to consumers.

Methods inherited from class org.odpi.openmetadata.accessservices.assetmanager.client.exchange.SchemaExchangeClientBase

clearColumnAsPrimaryKey, clearForeignKeyRelationship, clearSchemaElementAsCalculatedValue, clearSchemaElementRelationship, clearSchemaTypeParent, createAnchoredSchemaType, createSchemaAttribute, createSchemaAttributeFromTemplate, createSchemaType, createSchemaTypeFromTemplate, findSchemaAttributes, findSchemaType, getNestedSchemaAttributes, getSchemaAttributeByGUID, getSchemaAttributesByName, getSchemaTypeByGUID, getSchemaTypeByName, getSchemaTypeForElement, getSchemaTypeParent, removeSchemaAttribute, removeSchemaType, setSchemaElementAsCalculatedValue, setupColumnAsPrimaryKey, setupForeignKeyRelationship, setupSchemaElementRelationship, setupSchemaTypeParent, updateForeignKeyRelationship, updateSchemaAttribute, updateSchemaType

Methods inherited from class org.odpi.openmetadata.accessservices.assetmanager.client.AssetManagerBaseClient

addExternalIdentifier, addExternalIdentifier, clearRelationship, clearRelationship, confirmSynchronization, createFeedbackFromTemplateWithParent, createFeedbackWithParent, createReferenceable, createReferenceableFromTemplate, createReferenceableFromTemplate, createReferenceableFromTemplateWithParent, createReferenceableFromTemplateWithParent, createReferenceableWithParent, getAssetManagerIdentifiersRequestBody, getClassifiedElements, getClassifiedElements, getClassifiedElements, getClassifiedElements, getCorrelationProperties, getCorrelationProperties, getCorrelationProperties, getEffectiveTimeQueryRequestBody, getElementsForExternalIdentifier, getGlossaryTermRelationshipRequestBody, getMetadataCorrelationHeaders, getNameRequestBody, getNameRequestBody, getQualifiedNameRequestBody, getRelatedElements, getRelationshipRequestBody, getSearchStringRequestBody, getUpdateRequestBody, handleMissingScope, removeExternalIdentifier, removeReferenceable, removeReferenceableClassification, setReferenceableClassification, setupRelationship, setupRelationship, updateExternalIdentifier, updateFeedback, updateReferenceable

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.odpi.openmetadata.accessservices.assetmanager.api.exchange.SchemaExchangeInterface

clearColumnAsPrimaryKey, clearForeignKeyRelationship, clearSchemaElementAsCalculatedValue, clearSchemaElementRelationship, clearSchemaTypeParent, createAnchoredSchemaType, createSchemaAttribute, createSchemaAttributeFromTemplate, createSchemaType, createSchemaTypeFromTemplate, findSchemaAttributes, findSchemaType, getNestedSchemaAttributes, getSchemaAttributeByGUID, getSchemaAttributesByName, getSchemaTypeByGUID, getSchemaTypeByName, getSchemaTypeForElement, getSchemaTypeParent, removeSchemaAttribute, removeSchemaType, setSchemaElementAsCalculatedValue, setupColumnAsPrimaryKey, setupForeignKeyRelationship, setupSchemaElementRelationship, setupSchemaTypeParent, updateForeignKeyRelationship, updateSchemaAttribute, updateSchemaType

Constructor Details

DataAssetExchangeClient

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

DataAssetExchangeClient

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

DataAssetExchangeClient

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

DataAssetExchangeClient

public DataAssetExchangeClient(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 services

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.

DataAssetExchangeClient

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

Method Details

createDataAsset

public String createDataAsset(String userId,
 String assetManagerGUID,
 String assetManagerName,
 boolean assetManagerIsHome,
 ExternalIdentifierProperties externalIdentifierProperties,
 DataAssetProperties assetProperties)
                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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

Specified by:

createDataAsset in interface DataAssetExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

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

externalIdentifierProperties - optional properties used to define an external identifier

assetProperties - 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 assetManagerGUID,
 String assetManagerName,
 boolean assetManagerIsHome,
 String templateGUID,
 ExternalIdentifierProperties externalIdentifierProperties,
 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 DataAssetExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

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

externalIdentifierProperties - optional properties used to define an external identifier

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 assetManagerGUID,
 String assetManagerName,
 String assetGUID,
 String assetExternalIdentifier,
 boolean isMergeUpdate,
 DataAssetProperties assetProperties,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the metadata element representing an asset.

Specified by:

updateDataAsset in interface DataAssetExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

assetGUID - unique identifier of the metadata element to update

assetExternalIdentifier - unique identifier of the asset in the external asset manager

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

assetProperties - new properties for this element

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)

publishDataAsset

public void publishDataAsset(String userId,
 String assetManagerGUID,
 String assetManagerName,
 String assetGUID,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                      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 Asset Manager OMAS).

Specified by:

publishDataAsset in interface DataAssetExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

assetGUID - unique identifier of the metadata element to publish

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)

withdrawDataAsset

public void withdrawDataAsset(String userId,
 String assetManagerGUID,
 String assetManagerName,
 String assetGUID,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                       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 Asset Manager OMAS. This is the setting when the database is first created).

Specified by:

withdrawDataAsset in interface DataAssetExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

assetGUID - unique identifier of the metadata element to withdraw

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)

removeDataAsset

public void removeDataAsset(String userId,
 String assetManagerGUID,
 String assetManagerName,
 String assetGUID,
 String assetExternalIdentifier,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                     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 DataAssetExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

assetGUID - unique identifier of the metadata element to remove

assetExternalIdentifier - unique identifier of the asset 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)

setDataAssetAsReferenceData

public void setDataAssetAsReferenceData(String userId,
 String assetManagerGUID,
 String assetManagerName,
 String assetGUID,
 String assetExternalIdentifier,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                                 throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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

Specified by:

setDataAssetAsReferenceData in interface DataAssetExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

assetGUID - unique identifier of the metadata element to update

assetExternalIdentifier - unique identifier of the asset 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)

clearDataAssetAsReferenceData

public void clearDataAssetAsReferenceData(String userId,
 String assetManagerGUID,
 String assetManagerName,
 String assetGUID,
 String assetExternalIdentifier,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the reference data designation from the asset.

Specified by:

clearDataAssetAsReferenceData in interface DataAssetExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

assetGUID - unique identifier of the metadata element to update

assetExternalIdentifier - unique identifier of the asset 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)

setupRelatedDataAsset

public String setupRelatedDataAsset(String userId,
 String assetManagerGUID,
 String assetManagerName,
 boolean assetManagerIsHome,
 String relationshipTypeName,
 String fromAssetGUID,
 String toAssetGUID,
 RelationshipProperties relationshipProperties,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                             throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Link two asset together. Use information from the relationship type definition to ensure the fromAssetGUID and toAssetGUID are the right way around.

Specified by:

setupRelatedDataAsset in interface DataAssetExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

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

relationshipTypeName - type name of relationship to create

fromAssetGUID - unique identifier of the asset at end 1 of the relationship

toAssetGUID - unique identifier of the asset at end 2 of the relationship

relationshipProperties - unique identifier for this relationship

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?

Returns:

unique identifier of the relationship

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)

getAssetRelationship

public RelationshipElement getAssetRelationship(String userId,
 String assetManagerGUID,
 String assetManagerName,
 String relationshipTypeName,
 String fromAssetGUID,
 String toAssetGUID,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the relationship between two elements.

Specified by:

getAssetRelationship in interface DataAssetExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

relationshipTypeName - type name of relationship to create

fromAssetGUID - unique identifier of the asset at end 1 of the relationship

toAssetGUID - unique identifier of the asset at end 2 of the relationship

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?

Returns:

unique identifier and properties of the relationship

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)

updateAssetRelationship

public void updateAssetRelationship(String userId,
 String assetManagerGUID,
 String assetManagerName,
 String relationshipTypeName,
 String relationshipGUID,
 boolean isMergeUpdate,
 RelationshipProperties relationshipProperties,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                             throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update relationship between two elements.

Specified by:

updateAssetRelationship in interface DataAssetExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

relationshipTypeName - type name of relationship to update

relationshipGUID - unique identifier of the relationship

relationshipProperties - description and/or purpose of the relationship

isMergeUpdate - should the new properties be merged with the existing properties, or replace them entirely

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)

clearAssetRelationship

public void clearAssetRelationship(String userId,
 String assetManagerGUID,
 String assetManagerName,
 String relationshipTypeName,
 String relationshipGUID,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the relationship between two elements.

Specified by:

clearAssetRelationship in interface DataAssetExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

relationshipTypeName - type name of relationship to delete

relationshipGUID - unique identifier of the relationship

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)

getRelatedAssetsAtEnd2

public List<RelationshipElement> getRelatedAssetsAtEnd2(String userId,
 String assetManagerGUID,
 String assetManagerName,
 String relationshipTypeName,
 String fromAssetGUID,
 int startFrom,
 int pageSize,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                                                 throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the requested relationships linked from a specific element at end 2.

Specified by:

getRelatedAssetsAtEnd2 in interface DataAssetExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

relationshipTypeName - type name of relationship to delete

fromAssetGUID - unique identifier of the asset at end 1 of the relationship

startFrom - start position for results

pageSize - maximum number of results

effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Returns:

unique identifier and properties of the relationship

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)

getRelatedAssetsAtEnd1

public List<RelationshipElement> getRelatedAssetsAtEnd1(String userId,
 String assetManagerGUID,
 String assetManagerName,
 String relationshipTypeName,
 String toAssetGUID,
 int startFrom,
 int pageSize,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                                                 throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the relationships linked from a specific element at end 2 of the relationship.

Specified by:

getRelatedAssetsAtEnd1 in interface DataAssetExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

relationshipTypeName - type name of relationship to delete

toAssetGUID - unique identifier of the asset at end 2 of the relationship

startFrom - start position for results

pageSize - maximum number of results

effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Returns:

unique identifier and properties of the relationship

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 assetManagerGUID,
 String assetManagerName,
 String searchString,
 int startFrom,
 int pageSize,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                                      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 DataAssetExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

searchString - string to find in the properties

startFrom - paging start point

pageSize - maximum results that can be returned

effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

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)

scanDataAssets

public List<DataAssetElement> scanDataAssets(String userId,
 String assetManagerGUID,
 String assetManagerName,
 int startFrom,
 int pageSize,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                                      throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Step through the assets visible to this caller.

Specified by:

scanDataAssets in interface DataAssetExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

startFrom - paging start point

pageSize - maximum results that can be returned

effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

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 assetManagerGUID,
 String assetManagerName,
 String name,
 int startFrom,
 int pageSize,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                                           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 DataAssetExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

name - name to search for

startFrom - paging start point

pageSize - maximum results that can be returned

effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

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)

getDataAssetsForAssetManager

public List<DataAssetElement> getDataAssetsForAssetManager(String userId,
 String assetManagerGUID,
 String assetManagerName,
 int startFrom,
 int pageSize,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                                                    throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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

Specified by:

getDataAssetsForAssetManager in interface DataAssetExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

startFrom - paging start point

pageSize - maximum results that can be returned

effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

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 assetManagerGUID,
 String assetManagerName,
 String openMetadataGUID,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                                    throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the asset metadata element with the supplied unique identifier.

Specified by:

getDataAssetByGUID in interface DataAssetExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

openMetadataGUID - unique identifier of the requested metadata element

effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

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)