Class DataAssetManagerClient

java.lang.Object
org.odpi.openmetadata.accessservices.itinfrastructure.client.ITInfrastructureClientBase
org.odpi.openmetadata.accessservices.itinfrastructure.client.DataAssetManagerClient
All Implemented Interfaces:
org.odpi.openmetadata.accessservices.itinfrastructure.api.DataAssetManagerInterface, org.odpi.openmetadata.accessservices.itinfrastructure.api.DeploymentManagementInterface, org.odpi.openmetadata.accessservices.itinfrastructure.api.ServerPurposeManagerInterface

public class DataAssetManagerClient extends ITInfrastructureClientBase implements org.odpi.openmetadata.accessservices.itinfrastructure.api.DataAssetManagerInterface
PlatformManagerClient supports the APIs to maintain software server platforms and their related objects.
  • Constructor Details

    • DataAssetManagerClient

      public DataAssetManagerClient(String serverName, String serverPlatformURLRoot, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog, int maxPageSize) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException
      Create a new client with no authentication embedded in the HTTP request.
      Parameters:
      serverName - name of the server to connect to
      serverPlatformURLRoot - the network address of the server running the OMAS REST services
      auditLog - logging destination
      maxPageSize - maximum value allowed for page size
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
    • DataAssetManagerClient

      public DataAssetManagerClient(String serverName, String serverPlatformURLRoot, int maxPageSize) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException
      Create a new client with no authentication embedded in the HTTP request.
      Parameters:
      serverName - name of the server to connect to
      serverPlatformURLRoot - the network address of the server running the OMAS REST services
      maxPageSize - maximum value allowed for page size
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
    • DataAssetManagerClient

      public DataAssetManagerClient(String serverName, String serverPlatformURLRoot, String userId, String password, int maxPageSize) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException
      Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
      Parameters:
      serverName - name of the server to connect to
      serverPlatformURLRoot - the network address of the server running the OMAS REST services
      userId - caller's userId embedded in all HTTP requests
      password - caller's userId embedded in all HTTP requests
      maxPageSize - maximum value allowed for page size
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
    • DataAssetManagerClient

      public DataAssetManagerClient(String serverName, String serverPlatformURLRoot, String userId, String password, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog, int maxPageSize) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException
      Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
      Parameters:
      serverName - name of the server to connect to
      serverPlatformURLRoot - the network address of the server running the OMAS REST services
      userId - caller's userId embedded in all HTTP requests
      password - caller's userId embedded in all HTTP requests
      auditLog - logging destination
      maxPageSize - maximum value allowed for page size
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
    • DataAssetManagerClient

      public DataAssetManagerClient(String serverName, String serverPlatformURLRoot, ITInfrastructureRESTClient restClient, int maxPageSize) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException
      Create a new client that is going to be used in an OMAG Server.
      Parameters:
      serverName - name of the server to connect to
      serverPlatformURLRoot - the network address of the server running the OMAS REST services
      restClient - client that issues the REST API calls
      maxPageSize - maximum number of results supported by this server
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
  • Method Details

    • createDataAsset

      public String createDataAsset(String userId, String infrastructureManagerGUID, String infrastructureManagerName, boolean infrastructureManagerIsHome, org.odpi.openmetadata.frameworks.openmetadata.properties.assets.DataAssetProperties dataAssetProperties) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Create a new metadata element to represent the root of an asset.
      Specified by:
      createDataAsset in interface org.odpi.openmetadata.accessservices.itinfrastructure.api.DataAssetManagerInterface
      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
      dataAssetProperties - properties to store
      Returns:
      unique identifier of the new metadata element
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)
    • createDataAssetFromTemplate

      public String createDataAssetFromTemplate(String userId, String infrastructureManagerGUID, String infrastructureManagerName, boolean infrastructureManagerIsHome, String templateGUID, org.odpi.openmetadata.accessservices.itinfrastructure.properties.TemplateProperties templateProperties) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Create a new metadata element to represent an asset using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new asset.
      Specified by:
      createDataAssetFromTemplate in interface org.odpi.openmetadata.accessservices.itinfrastructure.api.DataAssetManagerInterface
      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:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)
    • updateDataAsset

      public void updateDataAsset(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String assetGUID, boolean isMergeUpdate, org.odpi.openmetadata.frameworks.openmetadata.properties.assets.DataAssetProperties dataAssetProperties) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Update the metadata element representing an asset.
      Specified by:
      updateDataAsset in interface org.odpi.openmetadata.accessservices.itinfrastructure.api.DataAssetManagerInterface
      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)?
      dataAssetProperties - new properties for this element
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)
    • setDataAssetAsReferenceData

      public void setDataAssetAsReferenceData(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String assetGUID, Date effectiveFrom, Date effectiveTo) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Classify the asset to indicate that it can be used as reference data.
      Specified by:
      setDataAssetAsReferenceData in interface org.odpi.openmetadata.accessservices.itinfrastructure.api.DataAssetManagerInterface
      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 - when should classification be effective - null means immediately
      effectiveTo - when should classification no longer be effective - null means never
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)
    • clearDataAssetAsReferenceData

      public void clearDataAssetAsReferenceData(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String assetGUID, Date effectiveTime) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Remove the reference data designation from the asset.
      Specified by:
      clearDataAssetAsReferenceData in interface org.odpi.openmetadata.accessservices.itinfrastructure.api.DataAssetManagerInterface
      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:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)
    • publishDataAsset

      public void publishDataAsset(String userId, String assetGUID) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.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 IT Infrastructure OMAS).
      Specified by:
      publishDataAsset in interface org.odpi.openmetadata.accessservices.itinfrastructure.api.DataAssetManagerInterface
      Parameters:
      userId - calling user
      assetGUID - unique identifier of the metadata element to publish
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)
    • withdrawDataAsset

      public void withdrawDataAsset(String userId, String assetGUID) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.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).
      Specified by:
      withdrawDataAsset in interface org.odpi.openmetadata.accessservices.itinfrastructure.api.DataAssetManagerInterface
      Parameters:
      userId - calling user
      assetGUID - unique identifier of the metadata element to withdraw
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)
    • removeDataAsset

      public void removeDataAsset(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String assetGUID) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Remove the metadata element representing an asset. This will delete the asset and all anchored elements such as schema and comments.
      Specified by:
      removeDataAsset in interface org.odpi.openmetadata.accessservices.itinfrastructure.api.DataAssetManagerInterface
      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:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)
    • findDataAssets

      public List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.DataAssetElement> findDataAssets(String userId, String searchString, Date effectiveTime, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Retrieve the list of asset metadata elements that contain the search string. The search string is treated as a regular expression.
      Specified by:
      findDataAssets in interface org.odpi.openmetadata.accessservices.itinfrastructure.api.DataAssetManagerInterface
      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:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)
    • getDataAssetsByName

      public List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.DataAssetElement> getDataAssetsByName(String userId, String name, Date effectiveTime, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Retrieve the list of asset metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
      Specified by:
      getDataAssetsByName in interface org.odpi.openmetadata.accessservices.itinfrastructure.api.DataAssetManagerInterface
      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:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)
    • getDataAssetsForInfrastructureManager

      public List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.DataAssetElement> getDataAssetsForInfrastructureManager(String userId, String infrastructureManagerGUID, String infrastructureManagerName, Date effectiveTime, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Retrieve the list of assets created on behalf of the named infrastructure manager.
      Specified by:
      getDataAssetsForInfrastructureManager in interface org.odpi.openmetadata.accessservices.itinfrastructure.api.DataAssetManagerInterface
      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:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)
    • getDataAssetByGUID

      public org.odpi.openmetadata.frameworks.openmetadata.metadataelements.DataAssetElement getDataAssetByGUID(String userId, String guid) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Retrieve the asset metadata element with the supplied unique identifier.
      Specified by:
      getDataAssetByGUID in interface org.odpi.openmetadata.accessservices.itinfrastructure.api.DataAssetManagerInterface
      Parameters:
      userId - calling user
      guid - unique identifier of the requested metadata element
      Returns:
      matching metadata element
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)