Interface DataAssetManagerInterface

  • All Known Implementing Classes:
    DataAssetManagerClient

    public interface DataAssetManagerInterface
    DataAssetExchangeInterface provides methods to define data assets.
    • Method Summary

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

      • createDataAsset

        java.lang.String createDataAsset​(java.lang.String userId,
                                         java.lang.String infrastructureManagerGUID,
                                         java.lang.String infrastructureManagerName,
                                         boolean infrastructureManagerIsHome,
                                         DataAssetProperties assetProperties)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         PropertyServerException
        Create a new metadata element to represent the root of an asset.
        Parameters:
        userId - calling user
        infrastructureManagerGUID - unique identifier of software server capability representing the caller
        infrastructureManagerName - unique name of software server capability representing the caller
        infrastructureManagerIsHome - ensure that only the infrastructure manager can update this asset
        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

        java.lang.String createDataAssetFromTemplate​(java.lang.String userId,
                                                     java.lang.String infrastructureManagerGUID,
                                                     java.lang.String infrastructureManagerName,
                                                     boolean infrastructureManagerIsHome,
                                                     java.lang.String templateGUID,
                                                     TemplateProperties templateProperties)
                                              throws InvalidParameterException,
                                                     UserNotAuthorizedException,
                                                     PropertyServerException
        Create a new metadata element to represent an asset using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new asset.
        Parameters:
        userId - calling user
        infrastructureManagerGUID - unique identifier of software server capability representing the caller
        infrastructureManagerName - unique name of software server capability representing the caller
        infrastructureManagerIsHome - ensure that only the infrastructure manager can update this asset
        templateGUID - unique identifier of the metadata element to copy
        templateProperties - properties that override the template
        Returns:
        unique identifier of the new metadata element
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • updateDataAsset

        void updateDataAsset​(java.lang.String userId,
                             java.lang.String infrastructureManagerGUID,
                             java.lang.String infrastructureManagerName,
                             java.lang.String assetGUID,
                             boolean isMergeUpdate,
                             DataAssetProperties assetProperties)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException
        Update the metadata element representing an asset.
        Parameters:
        userId - calling user
        infrastructureManagerGUID - unique identifier of software server capability representing the caller
        infrastructureManagerName - unique name of software server capability representing the caller
        assetGUID - unique identifier of the metadata element to update
        isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
        assetProperties - new properties for this element
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • setDataAssetAsReferenceData

        void setDataAssetAsReferenceData​(java.lang.String userId,
                                         java.lang.String infrastructureManagerGUID,
                                         java.lang.String infrastructureManagerName,
                                         java.lang.String assetGUID,
                                         java.util.Date effectiveFrom,
                                         java.util.Date effectiveTo)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         PropertyServerException
        Classify the asset to indicate that it can be used as reference data.
        Parameters:
        userId - calling user
        infrastructureManagerGUID - unique identifier of software server capability representing the caller
        infrastructureManagerName - unique name of software server capability representing the caller
        assetGUID - unique identifier of the metadata element to update
        effectiveFrom - time when this hosting is effective - null means immediately
        effectiveTo - time when this hosting is no longer effective - null means forever
        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

        void clearDataAssetAsReferenceData​(java.lang.String userId,
                                           java.lang.String infrastructureManagerGUID,
                                           java.lang.String infrastructureManagerName,
                                           java.lang.String assetGUID,
                                           java.util.Date effectiveTime)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException
        Remove the reference data designation from the asset.
        Parameters:
        userId - calling user
        infrastructureManagerGUID - unique identifier of software server capability representing the caller
        infrastructureManagerName - unique name of software server capability representing the caller
        assetGUID - unique identifier of the metadata element to update
        effectiveTime - time when the classification is effective
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • withdrawDataAsset

        void withdrawDataAsset​(java.lang.String userId,
                               java.lang.String assetGUID)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException
        Update the zones for the asset so that it is no longer visible to consumers. (The zones are set to the list of zones in the defaultZones option configured for each instance of the IT Infrastructure OMAS. This is the setting when the database is first created).
        Parameters:
        userId - calling user
        assetGUID - unique identifier of the metadata element to withdraw
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • removeDataAsset

        void removeDataAsset​(java.lang.String userId,
                             java.lang.String infrastructureManagerGUID,
                             java.lang.String infrastructureManagerName,
                             java.lang.String assetGUID)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException
        Remove the metadata element representing an asset. This will delete the asset and all anchored elements such as schema and comments.
        Parameters:
        userId - calling user
        infrastructureManagerGUID - unique identifier of software server capability representing the caller
        infrastructureManagerName - unique name of software server capability representing the caller
        assetGUID - unique identifier of the metadata element to remove
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • findDataAssets

        java.util.List<DataAssetElement> findDataAssets​(java.lang.String userId,
                                                        java.lang.String searchString,
                                                        java.util.Date effectiveTime,
                                                        int startFrom,
                                                        int pageSize)
                                                 throws InvalidParameterException,
                                                        UserNotAuthorizedException,
                                                        PropertyServerException
        Retrieve the list of asset metadata elements that contain the search string. The search string is treated as a regular expression.
        Parameters:
        userId - calling user
        searchString - string to find in the properties
        effectiveTime - effective time for the query
        startFrom - paging start point
        pageSize - maximum results that can be returned
        Returns:
        list of matching metadata elements
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • getDataAssetsByName

        java.util.List<DataAssetElement> getDataAssetsByName​(java.lang.String userId,
                                                             java.lang.String name,
                                                             java.util.Date effectiveTime,
                                                             int startFrom,
                                                             int pageSize)
                                                      throws InvalidParameterException,
                                                             UserNotAuthorizedException,
                                                             PropertyServerException
        Retrieve the list of asset metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
        Parameters:
        userId - calling user
        name - name to search for
        effectiveTime - effective time for the query
        startFrom - paging start point
        pageSize - maximum results that can be returned
        Returns:
        list of matching metadata elements
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • getDataAssetsForInfrastructureManager

        java.util.List<DataAssetElement> getDataAssetsForInfrastructureManager​(java.lang.String userId,
                                                                               java.lang.String infrastructureManagerGUID,
                                                                               java.lang.String infrastructureManagerName,
                                                                               java.util.Date effectiveTime,
                                                                               int startFrom,
                                                                               int pageSize)
                                                                        throws InvalidParameterException,
                                                                               UserNotAuthorizedException,
                                                                               PropertyServerException
        Retrieve the list of assets created on behalf of the named infrastructure manager.
        Parameters:
        userId - calling user
        infrastructureManagerGUID - unique identifier of software server capability representing the caller
        infrastructureManagerName - unique name of software server capability representing the caller
        effectiveTime - effective time for the query
        startFrom - paging start point
        pageSize - maximum results that can be returned
        Returns:
        list of matching metadata elements
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)