Class DataAssetExchangeHandler
java.lang.Object
org.odpi.openmetadata.accessservices.assetmanager.handlers.DataAssetExchangeHandler
DataAssetExchangeClient is the server-side for managing Data Assets.
-
Field Summary
-
Constructor Summary
ConstructorDescriptionDataAssetExchangeHandler
(String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, RepositoryHandler repositoryHandler, OMRSRepositoryHelper repositoryHelper, String localServerUserId, OpenMetadataServerSecurityVerifier securityVerifier, List<String> supportedZones, List<String> defaultZones, List<String> publishZones, AuditLog auditLog) Construct the data asset exchange handler with information needed to work with asset related objects for Asset Manager OMAS. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addAssetOrigin
(String userId, String assetGUID, String assetGUIDParameterName, String organizationGUID, String organizationGUIDParameterName, String businessCapabilityGUID, String businessCapabilityGUIDParameterName, Map<String, String> otherOriginValues, Date effectiveFrom, Date effectiveTo, boolean isMergeUpdate, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Add the asset origin classification to an asset.void
clearAssetRelationship
(String userId, String assetManagerGUID, String assetManagerName, String relationshipTypeName, String relationshipGUID, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Remove the relationship between two elements.void
clearDataAssetAsReferenceData
(String userId, String assetGUID, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Remove the reference data designation from the asset.void
clearElementAsDataField
(String userId, MetadataCorrelationProperties correlationProperties, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Remove the data field designation from the element.createDataAsset
(String userId, MetadataCorrelationProperties correlationProperties, boolean assetManagerIsHome, DataAssetProperties assetProperties, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Create a new metadata element to represent the root of an asset.createDataAssetFromTemplate
(String userId, MetadataCorrelationProperties correlationProperties, boolean assetManagerIsHome, String templateGUID, TemplateProperties templateProperties, String methodName) Create a new metadata element to represent an asset using an existing metadata element as a template.findDataAssets
(String userId, String assetManagerGUID, String assetManagerName, String searchString, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Retrieve the list of asset metadata elements that contain the search string.getAssetRelationship
(String userId, String assetManagerGUID, String assetManagerName, String relationshipTypeName, String fromAssetGUID, String toAssetGUID, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Retrieve the relationship between two elements.getDataAssetByGUID
(String userId, String assetManagerGUID, String assetManagerName, String openMetadataGUID, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Retrieve the asset metadata element with the supplied unique identifier.getDataAssetsByName
(String userId, String assetManagerGUID, String assetManagerName, String name, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Retrieve the list of asset metadata elements with a matching qualified or display name.getDataAssetsForAssetManager
(String userId, String assetManagerGUID, String assetManagerName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Retrieve the list of assets created on behalf of the named asset manager.getRelatedAssetsAtEnd1
(String userId, String assetManagerGUID, String assetManagerName, String relationshipTypeName, String toAssetGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Retrieve the relationships linked from a specific element at end 2 of the relationship.getRelatedAssetsAtEnd2
(String userId, String assetManagerGUID, String assetManagerName, String relationshipTypeName, String fromAssetGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Retrieve the requested relationships linked from a specific element at end 2.void
publishDataAsset
(String userId, String assetGUID, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Update the zones for the asset so that it becomes visible to consumers.void
removeAssetOrigin
(String userId, String assetGUID, String assetGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Remove the asset origin classification to an asset.void
removeDataAsset
(String userId, MetadataCorrelationProperties correlationProperties, String assetGUID, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Remove the metadata element representing an asset.scanDataAssets
(String userId, String assetManagerGUID, String assetManagerName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Step through the assets visible to this caller.void
setDataAssetAsReferenceData
(String userId, String assetGUID, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Classify the asset to indicate that it can be used as reference data.void
setElementAsDataField
(String userId, MetadataCorrelationProperties correlationProperties, String elementGUID, DataFieldValuesProperties properties, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Classify the element to indicate that it describes a data field and supply properties that describe the characteristics of the data values found within.setupRelatedDataAsset
(String userId, String assetManagerGUID, String assetManagerName, boolean assetManagerIsHome, String relationshipTypeName, String fromAssetGUID, String toAssetGUID, RelationshipProperties relationshipProperties, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Link two asset together.void
updateAssetRelationship
(String userId, String assetManagerGUID, String assetManagerName, String relationshipTypeName, String relationshipGUID, boolean isMergeUpdate, RelationshipProperties relationshipProperties, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Update relationship between two elements.void
updateDataAsset
(String userId, MetadataCorrelationProperties correlationProperties, String assetGUID, boolean isMergeUpdate, DataAssetProperties assetProperties, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Update the metadata element representing an asset.void
withdrawDataAsset
(String userId, String assetGUID, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Update the zones for the asset so that it is no longer visible to consumers.
-
Field Details
-
elementGUIDParameterName
- See Also:
-
-
Constructor Details
-
DataAssetExchangeHandler
public DataAssetExchangeHandler(String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, RepositoryHandler repositoryHandler, OMRSRepositoryHelper repositoryHelper, String localServerUserId, OpenMetadataServerSecurityVerifier securityVerifier, List<String> supportedZones, List<String> defaultZones, List<String> publishZones, AuditLog auditLog) Construct the data asset exchange handler with information needed to work with asset related objects for Asset Manager OMAS.- Parameters:
serviceName
- name of this serviceserverName
- name of the local serverinvalidParameterHandler
- handler for managing parameter errorsrepositoryHandler
- manages calls to the repository servicesrepositoryHelper
- provides utilities for manipulating the repository services objectslocalServerUserId
- userId for this serversecurityVerifier
- open metadata security services verifiersupportedZones
- list of zones that the access service is allowed to serve instances from.defaultZones
- list of zones that the access service should set in all new instances.publishZones
- list of zones that the access service sets up in published instances.auditLog
- destination for audit log events.
-
-
Method Details
-
createDataAsset
public String createDataAsset(String userId, MetadataCorrelationProperties correlationProperties, boolean assetManagerIsHome, DataAssetProperties assetProperties, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Create a new metadata element to represent the root of an asset.- Parameters:
userId
- calling usercorrelationProperties
- properties to help with the mapping of the elements in the external asset manager and open metadataassetManagerIsHome
- ensure that only the asset manager can update this assetassetProperties
- properties to storeforLineage
- the request is to support lineage retrieval this means entities with the Memento classification can be returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Returns:
- unique identifier of the new metadata element
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
createDataAssetFromTemplate
public String createDataAssetFromTemplate(String userId, MetadataCorrelationProperties correlationProperties, boolean assetManagerIsHome, String templateGUID, TemplateProperties templateProperties, String methodName) 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:
userId
- calling usercorrelationProperties
- properties to help with the mapping of the elements in the external asset manager and open metadataassetManagerIsHome
- ensure that only the asset manager can update this assettemplateGUID
- unique identifier of the metadata element to copytemplateProperties
- properties that override the templatemethodName
- calling method- Returns:
- unique identifier of the new metadata element
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
updateDataAsset
public void updateDataAsset(String userId, MetadataCorrelationProperties correlationProperties, String assetGUID, boolean isMergeUpdate, DataAssetProperties assetProperties, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Update the metadata element representing an asset.- Parameters:
userId
- calling usercorrelationProperties
- properties to help with the mapping of the elements in the external asset manager and open metadataassetGUID
- unique identifier of the metadata element to updateisMergeUpdate
- should the new properties be merged with existing properties (true) or completely replace them (false)?assetProperties
- new properties for this elementforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- when should the elements be effected for - null is anytime; new Date() is nowmethodName
- calling method- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
addAssetOrigin
public void addAssetOrigin(String userId, String assetGUID, String assetGUIDParameterName, String organizationGUID, String organizationGUIDParameterName, String businessCapabilityGUID, String businessCapabilityGUIDParameterName, Map<String, String> otherOriginValues, Date effectiveFrom, Date effectiveTo, boolean isMergeUpdate, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerExceptionAdd the asset origin classification to an asset. The method needs to build a before an after image of the asset to perform a security check before the update is pushed to the repository.- Parameters:
userId
- calling userassetGUID
- unique identifier of assetassetGUIDParameterName
- parameter name supplying assetGUIDorganizationGUID
- Unique identifier (GUID) of the organization where this asset originated from - or nullorganizationGUIDParameterName
- parameter name supplying organizationGUIDbusinessCapabilityGUID
- Unique identifier (GUID) of the business capability where this asset originated from.businessCapabilityGUIDParameterName
- parameter name supplying businessCapabilityGUIDotherOriginValues
- Descriptive labels describing origin of the asseteffectiveFrom
- the time that the elements must be effective from (null for any time)effectiveTo
- the time that the elements must be effective from (null for any time)isMergeUpdate
- should the new properties be merged with existing properties (true) or completely replace them (false)?forLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Throws:
InvalidParameterException
- entity not known, null userId or guidPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
removeAssetOrigin
public void removeAssetOrigin(String userId, String assetGUID, String assetGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Remove the asset origin classification to an asset.- Parameters:
userId
- calling userassetGUID
- unique identifier of assetassetGUIDParameterName
- parameter name supplying assetGUIDforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Throws:
InvalidParameterException
- entity not known, null userId or guidPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
publishDataAsset
public void publishDataAsset(String userId, String assetGUID, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) 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:
userId
- calling userassetGUID
- unique identifier of the metadata element to publishforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- when should the elements be effected for - null is anytime; new Date() is nowmethodName
- calling method- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
withdrawDataAsset
public void withdrawDataAsset(String userId, String assetGUID, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) 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:
userId
- calling userassetGUID
- unique identifier of the metadata element to withdrawforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- when should the elements be effected for - null is anytime; new Date() is nowmethodName
- calling method- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
removeDataAsset
public void removeDataAsset(String userId, MetadataCorrelationProperties correlationProperties, String assetGUID, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) 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:
userId
- calling usercorrelationProperties
- properties to help with the mapping of the elements in the external asset manager and open metadataassetGUID
- unique identifier of the metadata element to removeforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- when should the elements be effected for - null is anytime; new Date() is nowmethodName
- calling method- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
setDataAssetAsReferenceData
public void setDataAssetAsReferenceData(String userId, String assetGUID, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Classify the asset to indicate that it can be used as reference data.- Parameters:
userId
- calling userassetGUID
- unique identifier of the metadata element to updateforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- when should the elements be effected for - null is anytime; new Date() is nowmethodName
- calling method- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
clearDataAssetAsReferenceData
public void clearDataAssetAsReferenceData(String userId, String assetGUID, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Remove the reference data designation from the asset.- Parameters:
userId
- calling userassetGUID
- unique identifier of the metadata element to removeforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- when should the elements be effected for - null is anytime; new Date() is nowmethodName
- calling method- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- 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, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) 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:
userId
- calling userassetManagerGUID
- unique identifier of software server capability representing the callerassetManagerName
- unique name of software server capability representing the callerassetManagerIsHome
- ensure that only the process manager can update this processrelationshipTypeName
- type name of relationship to createfromAssetGUID
- unique identifier of the asset at end 1 of the relationshiptoAssetGUID
- unique identifier of the asset at end 2 of the relationshiprelationshipProperties
- unique identifier for this relationshipforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- when should the elements be effected for - null is anytime; new Date() is nowmethodName
- calling method- Returns:
- unique identifier of the relationship
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- 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, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Retrieve the relationship between two elements.- Parameters:
userId
- calling userassetManagerGUID
- unique identifier of software server capability representing the callerassetManagerName
- unique name of software server capability representing the callerrelationshipTypeName
- type name of relationship to createfromAssetGUID
- unique identifier of the asset at end 1 of the relationshiptoAssetGUID
- unique identifier of the asset at end 2 of the relationshipforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- when should the elements be effected for - null is anytime; new Date() is nowmethodName
- calling method- Returns:
- unique identifier and properties of the relationship
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- 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, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Update relationship between two elements.- Parameters:
userId
- calling userassetManagerGUID
- unique identifier of software server capability representing the callerassetManagerName
- unique name of software server capability representing the callerrelationshipTypeName
- type name of relationship to updaterelationshipGUID
- unique identifier of the relationshiprelationshipProperties
- description and/or purpose of the relationshipisMergeUpdate
- should the new properties be merged with the existing properties, or replace them entirelyforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- when should the elements be effected for - null is anytime; new Date() is nowmethodName
- calling method- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- 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, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Remove the relationship between two elements.- Parameters:
userId
- calling userassetManagerGUID
- unique identifier of software server capability representing the callerassetManagerName
- unique name of software server capability representing the callerrelationshipTypeName
- type name of relationship to deleterelationshipGUID
- unique identifier of the relationshipforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- when should the elements be effected for - null is anytime; new Date() is nowmethodName
- calling method- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- 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, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Retrieve the requested relationships linked from a specific element at end 2.- Parameters:
userId
- calling userassetManagerGUID
- unique identifier of software server capability representing the callerassetManagerName
- unique name of software server capability representing the callerrelationshipTypeName
- type name of relationship to deletefromAssetGUID
- unique identifier of the asset at end 1 of the relationshipstartFrom
- start position for resultspageSize
- maximum number of resultsforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- when should the elements be effected for - null is anytime; new Date() is nowmethodName
- calling method- Returns:
- unique identifier and properties of the relationship
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- 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, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Retrieve the relationships linked from a specific element at end 2 of the relationship.- Parameters:
userId
- calling userassetManagerGUID
- unique identifier of software server capability representing the callerassetManagerName
- unique name of software server capability representing the callerrelationshipTypeName
- type name of relationship to deletetoAssetGUID
- unique identifier of the asset at end 2 of the relationshipstartFrom
- start position for resultspageSize
- maximum number of resultsforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- when should the elements be effected for - null is anytime; new Date() is nowmethodName
- calling method- Returns:
- unique identifier and properties of the relationship
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- 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, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) 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:
userId
- calling userassetManagerGUID
- unique identifier of software server capability representing the callerassetManagerName
- unique name of software server capability representing the callersearchString
- string to find in the propertiesstartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- when should the elements be effected for - null is anytime; new Date() is nowmethodName
- calling method- Returns:
- list of matching metadata elements
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- 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, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Step through the assets visible to this caller.- Parameters:
userId
- calling userassetManagerGUID
- unique identifier of software server capability representing the callerassetManagerName
- unique name of software server capability representing the callerstartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- when should the elements be effected for - null is anytime; new Date() is nowmethodName
- calling method- Returns:
- list of matching metadata elements
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- 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, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) 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:
userId
- calling userassetManagerGUID
- unique identifier of software server capability representing the callerassetManagerName
- unique name of software server capability representing the callername
- name to search forstartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- when should the elements be effected for - null is anytime; new Date() is nowmethodName
- calling method- Returns:
- list of matching metadata elements
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- 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, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Retrieve the list of assets created on behalf of the named asset manager.- Parameters:
userId
- calling userassetManagerGUID
- unique identifier of software server capability representing the callerassetManagerName
- unique name of software server capability representing the callerstartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- when should the elements be effected for - null is anytime; new Date() is nowmethodName
- calling method- Returns:
- list of matching metadata elements
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getDataAssetByGUID
public DataAssetElement getDataAssetByGUID(String userId, String assetManagerGUID, String assetManagerName, String openMetadataGUID, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Retrieve the asset metadata element with the supplied unique identifier.- Parameters:
userId
- calling userassetManagerGUID
- unique identifier of software server capability representing the callerassetManagerName
- unique name of software server capability representing the calleropenMetadataGUID
- unique identifier of the requested metadata elementforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- when should the elements be effected for - null is anytime; new Date() is nowmethodName
- calling method- Returns:
- matching metadata element
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
setElementAsDataField
public void setElementAsDataField(String userId, MetadataCorrelationProperties correlationProperties, String elementGUID, DataFieldValuesProperties properties, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Classify the element to indicate that it describes a data field and supply properties that describe the characteristics of the data values found within.- Parameters:
userId
- calling usercorrelationProperties
- properties to help with the mapping of the elements in the external asset manager and open metadataelementGUID
- unique identifier of the metadata element to updateproperties
- characterizations of the data values stored in the data fieldforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- optional date for effective time of the query. Null means any effective timemethodName
- calling method- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
clearElementAsDataField
public void clearElementAsDataField(String userId, MetadataCorrelationProperties correlationProperties, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Remove the data field designation from the element.- Parameters:
userId
- calling usercorrelationProperties
- properties to help with the mapping of the elements in the external asset manager and open metadataelementGUID
- unique identifier of the metadata element to updateforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- optional date for effective time of the query. Null means any effective timemethodName
- calling method- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-