Package org.odpi.openmetadata.integrationservices.catalog.connector

Class DataAssetExchangeService

java.lang.Object

org.odpi.openmetadata.integrationservices.catalog.connector.SchemaExchangeService

org.odpi.openmetadata.integrationservices.catalog.connector.DataAssetExchangeService

public class DataAssetExchangeService
extends SchemaExchangeService

DataAssetExchangeService is the context for managing data assets and associated elements such as schemas.

Method Summary

Modifier and Type	Method	Description
void	clearAssetRelationship(String relationshipTypeName, String relationshipGUID, Date effectiveTime)	Remove the relationship between two elements.
void	clearDataAssetAsReferenceData(String assetGUID, String assetExternalIdentifier, Date effectiveTime)	Remove the reference data designation from the asset.
String	createDataAsset(boolean assetManagerIsHome, ExternalIdentifierProperties externalIdentifierProperties, DataAssetProperties assetProperties)	Create a new metadata element to represent the root of an asset.
String	createDataAssetFromTemplate(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 searchString, int startFrom, int pageSize, Date effectiveTime)	Retrieve the list of asset metadata elements that contain the search string.
RelationshipElement	getAssetRelationship(String relationshipTypeName, String fromAssetGUID, String toAssetGUID, Date effectiveTime)	Retrieve the relationship between two elements.
DataAssetElement	getDataAssetByGUID(String dataAssetGUID, Date effectiveTime)	Retrieve the asset metadata element with the supplied unique identifier.
List<DataAssetElement>	getDataAssetsByName(String name, int startFrom, int pageSize, Date effectiveTime)	Retrieve the list of asset metadata elements with a matching qualified or display name.
List<DataAssetElement>	getDataAssetsForAssetManager(int startFrom, int pageSize, Date effectiveTime)	Retrieve the list of assets created on behalf of the named asset manager.
List<RelationshipElement>	getRelatedAssetsAtEnd1(String relationshipTypeName, String toAssetGUID, int startingFrom, int pageSize, Date effectiveTime)	Retrieve the relationships linked from a specific element at end 2 of the relationship.
List<RelationshipElement>	getRelatedAssetsAtEnd2(String relationshipTypeName, String fromAssetGUID, int startingFrom, int pageSize, Date effectiveTime)	Retrieve the requested relationships linked from a specific element at end 2.
void	publishDataAsset(String assetGUID, Date effectiveTime)	Update the zones for the asset so that it becomes visible to consumers.
void	removeDataAsset(String assetGUID, String assetExternalIdentifier, Date effectiveTime)	Remove the metadata element representing an asset.
void	setDataAssetAsReferenceData(String assetGUID, String assetExternalIdentifier, Date effectiveTime)	Classify the asset to indicate that it can be used as reference data.
String	setupRelatedDataAsset(boolean assetManagerIsHome, String relationshipTypeName, String fromAssetGUID, String toAssetGUID, RelationshipProperties relationshipProperties, Date effectiveTime)	Link two asset together.
void	updateAssetRelationship(String relationshipTypeName, String relationshipGUID, boolean isMergeUpdate, RelationshipProperties relationshipProperties, Date effectiveTime)	Update relationship between two elements.
void	updateDataAsset(String assetGUID, String assetExternalIdentifier, boolean isMergeUpdate, DataAssetProperties assetProperties, Date effectiveTime)	Update the metadata element representing an asset.
void	withdrawDataAsset(String assetGUID, Date effectiveTime)	Update the zones for the asset so that it is no longer visible to consumers.

Methods inherited from class org.odpi.openmetadata.integrationservices.catalog.connector.SchemaExchangeService

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

Methods inherited from class java.lang.Object

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

Method Details

createDataAsset

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

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

Parameters:

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

Parameters:

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

templateGUID - unique identifier of the metadata element to copy

externalIdentifierProperties - optional properties used to define an external identifier

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

Update the metadata element representing an asset.

Parameters:

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

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 assetGUID,
 Date effectiveTime)
                      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).

Parameters:

assetGUID - unique identifier of the metadata element to publish

effectiveTime - optional date for effective time of the query. Null means any effective time

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 assetGUID,
 Date effectiveTime)
                       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).

Parameters:

assetGUID - unique identifier of the metadata element to withdraw

effectiveTime - optional date for effective time of the query. Null means any effective time

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 assetGUID,
 String assetExternalIdentifier,
 Date effectiveTime)
                     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.

Parameters:

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

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 assetGUID,
 String assetExternalIdentifier,
 Date effectiveTime)
                                 throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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

Parameters:

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

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 assetGUID,
 String assetExternalIdentifier,
 Date effectiveTime)
                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the reference data designation from the asset.

Parameters:

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

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(boolean assetManagerIsHome,
 String relationshipTypeName,
 String fromAssetGUID,
 String toAssetGUID,
 RelationshipProperties relationshipProperties,
 Date effectiveTime)
                             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.

Parameters:

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

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 relationshipTypeName,
 String fromAssetGUID,
 String toAssetGUID,
 Date effectiveTime)
                                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the relationship between two elements.

Parameters:

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

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 relationshipTypeName,
 String relationshipGUID,
 boolean isMergeUpdate,
 RelationshipProperties relationshipProperties,
 Date effectiveTime)
                             throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update relationship between two elements.

Parameters:

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

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 relationshipTypeName,
 String relationshipGUID,
 Date effectiveTime)
                            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the relationship between two elements.

Parameters:

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

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 relationshipTypeName,
 String fromAssetGUID,
 int startingFrom,
 int pageSize,
 Date effectiveTime)
                                                 throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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

Parameters:

relationshipTypeName - type name of relationship to delete

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

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

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 relationshipTypeName,
 String toAssetGUID,
 int startingFrom,
 int pageSize,
 Date effectiveTime)
                                                 throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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

Parameters:

relationshipTypeName - type name of relationship to delete

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

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

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 searchString,
 int startFrom,
 int pageSize,
 Date effectiveTime)
                                      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.

Parameters:

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)

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 name,
 int startFrom,
 int pageSize,
 Date effectiveTime)
                                           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.

Parameters:

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)

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(int startFrom,
 int pageSize,
 Date effectiveTime)
                                                    throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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

Parameters:

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)

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 dataAssetGUID,
 Date effectiveTime)
                                    throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the asset metadata element with the supplied unique identifier.

Parameters:

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

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)