Class DataAssetExchangeService


  • public class DataAssetExchangeService
    extends SchemaExchangeService
    DataAssetExchangeService is the context for managing data assets and associated elements such as schemas.
    • Method Detail

      • createDataAssetFromTemplate

        public java.lang.String createDataAssetFromTemplate​(boolean assetManagerIsHome,
                                                            java.lang.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​(java.lang.String userId,
                                    java.lang.String assetGUID,
                                    java.lang.String assetExternalIdentifier,
                                    boolean isMergeUpdate,
                                    DataAssetProperties assetProperties,
                                    java.util.Date effectiveTime)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException
        Update the metadata element representing an asset.
        Parameters:
        userId - calling user
        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​(java.lang.String userId,
                                     java.lang.String assetGUID,
                                     java.util.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:
        userId - calling user
        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​(java.lang.String userId,
                                      java.lang.String assetGUID,
                                      java.util.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:
        userId - calling user
        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​(java.lang.String userId,
                                    java.lang.String assetGUID,
                                    java.lang.String assetExternalIdentifier,
                                    java.util.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:
        userId - calling user
        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​(java.lang.String userId,
                                                java.lang.String assetGUID,
                                                java.lang.String assetExternalIdentifier,
                                                java.util.Date effectiveTime)
                                         throws InvalidParameterException,
                                                UserNotAuthorizedException,
                                                PropertyServerException
        Classify the asset to indicate that it can be used as reference data.
        Parameters:
        userId - calling user
        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​(java.lang.String userId,
                                                  java.lang.String assetGUID,
                                                  java.lang.String assetExternalIdentifier,
                                                  java.util.Date effectiveTime)
                                           throws InvalidParameterException,
                                                  UserNotAuthorizedException,
                                                  PropertyServerException
        Remove the reference data designation from the asset.
        Parameters:
        userId - calling user
        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 java.lang.String setupRelatedDataAsset​(java.lang.String userId,
                                                      boolean assetManagerIsHome,
                                                      java.lang.String relationshipTypeName,
                                                      java.lang.String fromAssetGUID,
                                                      java.lang.String toAssetGUID,
                                                      RelationshipProperties relationshipProperties,
                                                      java.util.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:
        userId - calling user
        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​(java.lang.String userId,
                                                        java.lang.String relationshipTypeName,
                                                        java.lang.String fromAssetGUID,
                                                        java.lang.String toAssetGUID,
                                                        java.util.Date effectiveTime)
                                                 throws InvalidParameterException,
                                                        UserNotAuthorizedException,
                                                        PropertyServerException
        Retrieve the relationship between two elements.
        Parameters:
        userId - calling user
        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​(java.lang.String userId,
                                            java.lang.String relationshipTypeName,
                                            java.lang.String relationshipGUID,
                                            boolean isMergeUpdate,
                                            RelationshipProperties relationshipProperties,
                                            java.util.Date effectiveTime)
                                     throws InvalidParameterException,
                                            UserNotAuthorizedException,
                                            PropertyServerException
        Update relationship between two elements.
        Parameters:
        userId - calling user
        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​(java.lang.String userId,
                                           java.lang.String relationshipTypeName,
                                           java.lang.String relationshipGUID,
                                           java.util.Date effectiveTime)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException
        Remove the relationship between two elements.
        Parameters:
        userId - calling user
        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 java.util.List<RelationshipElement> getRelatedAssetsAtEnd2​(java.lang.String userId,
                                                                          java.lang.String relationshipTypeName,
                                                                          java.lang.String fromAssetGUID,
                                                                          int startingFrom,
                                                                          int pageSize,
                                                                          java.util.Date effectiveTime)
                                                                   throws InvalidParameterException,
                                                                          UserNotAuthorizedException,
                                                                          PropertyServerException
        Retrieve the requested relationships linked from a specific element at end 2.
        Parameters:
        userId - calling user
        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 java.util.List<RelationshipElement> getRelatedAssetsAtEnd1​(java.lang.String userId,
                                                                          java.lang.String relationshipTypeName,
                                                                          java.lang.String toAssetGUID,
                                                                          int startingFrom,
                                                                          int pageSize,
                                                                          java.util.Date effectiveTime)
                                                                   throws InvalidParameterException,
                                                                          UserNotAuthorizedException,
                                                                          PropertyServerException
        Retrieve the relationships linked from a specific element at end 2 of the relationship.
        Parameters:
        userId - calling user
        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 java.util.List<DataAssetElement> findDataAssets​(java.lang.String searchString,
                                                               int startFrom,
                                                               int pageSize,
                                                               java.util.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 java.util.List<DataAssetElement> getDataAssetsByName​(java.lang.String name,
                                                                    int startFrom,
                                                                    int pageSize,
                                                                    java.util.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)
      • getDataAssetByGUID

        public DataAssetElement getDataAssetByGUID​(java.lang.String userId,
                                                   java.lang.String assetManagerGUID,
                                                   java.lang.String assetManagerName,
                                                   java.lang.String dataAssetGUID,
                                                   java.util.Date effectiveTime)
                                            throws InvalidParameterException,
                                                   UserNotAuthorizedException,
                                                   PropertyServerException
        Retrieve the asset metadata element with the supplied unique identifier.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        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)