Package org.odpi.openmetadata.frameworks.surveyaction

Class SurveyAssetStore

java.lang.Object
org.odpi.openmetadata.frameworks.surveyaction.SurveyAssetStore
public abstract class SurveyAssetStore extends Object
SurveyAssetStore defines the interface to a connector broker backed by an open metadata repository that returns information about the Asset that a survey action service is to analyze. It is built around the Open Connector Framework (OCF) services and Governance Action Framework (GAF).

  • Constructor Details

    • SurveyAssetStore

      public SurveyAssetStore(String assetGUID, String userId)
      Constructor sets up the key parameters for accessing the asset store.
      Parameters:
      userId - calling user
      assetGUID - unique identifier of the asset that the annotations should be attached to

  • Method Details

    • getAssetGUID

      public String getAssetGUID()
      Return the unique identifier for the asset.
      Returns:
      guid

    • getConnectorByConnection

      public abstract org.odpi.openmetadata.frameworks.connectors.Connector getConnectorByConnection(org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectionCheckedException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      Returns the connector corresponding to the supplied connection.
      Parameters:
      connection - the connection object that contains the properties needed to create the connection.
      Returns:
      the connector instance
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectionCheckedException - there are errors in the configuration of the connection which is preventing the creation of a connector.
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - there are errors in the initialization of the connector.

    • getAssetProperties

      public abstract org.odpi.openmetadata.frameworks.connectors.properties.AssetUniverse getAssetProperties() throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Returns a comprehensive collection of properties about the requested asset.
      Returns:
      a comprehensive collection of properties about the asset.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving the asset properties from the property servers.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • logAssetAuditMessage

      public abstract void logAssetAuditMessage(String surveyService, String message) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Log an audit message about this asset.
      Parameters:
      surveyService - name of survey service
      message - message to log
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving the asset properties from the property servers.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • getConnectorToAsset

      public abstract org.odpi.openmetadata.frameworks.connectors.Connector getConnectorToAsset() throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectionCheckedException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Return the connector to the requested asset.
      Returns:
      Open Connector Framework (OCF) connector
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the asset guid is not recognized or the userId is null
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectionCheckedException - there are errors in the configuration of the connection which is preventing the creation of a connector.
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - there are errors in the initialization of the connector.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to access the asset and/or connection needed to create the connector.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there was a problem in the store whether the asset/connection properties are kept.

    • addDataFileAssetToCatalog

      public abstract String addDataFileAssetToCatalog(String displayName, String description, String pathName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Creates a new data file asset and links it to the folder structure implied in the path name. If the folder structure is not catalogued already, this is created automatically using the createFolderStructureInCatalog() method. For example, a pathName of "one/two/three/MyFile.txt" potentially creates 3 new folder assets, one called "one", the next called "one/two" and the last one called "one/two/three" plus a file asset called "one/two/three/MyFile.txt".
      Parameters:
      displayName - display name for the file in the catalog
      description - description of the file in the catalog
      pathName - pathname of the data file
      Returns:
      list of GUIDs from the top level to the root of the pathname
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • addCSVFileToCatalog

      public abstract String addCSVFileToCatalog(String displayName, String description, String pathName, List<String> columnHeaders, Character delimiterCharacter, Character quoteCharacter) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Add a simple asset description linked to a connection object for a CSV file.
      Parameters:
      displayName - display name for the file in the catalog
      description - description of the file in the catalog
      pathName - full path of the file - used to access the file through the connector
      columnHeaders - does the first line of the file contain the column names. If not pass the list of column headers.
      delimiterCharacter - what is the delimiter character - null for default of comma
      quoteCharacter - what is the character to group a field that contains delimiter characters
      Returns:
      list of GUIDs from the top level to the root of the pathname
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - full path or userId is null
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem