Package org.odpi.openmetadata.accessservices.assetowner.client

Class SurveyAssetStoreClient

java.lang.Object

org.odpi.openmetadata.frameworks.surveyaction.SurveyAssetStore

org.odpi.openmetadata.accessservices.assetowner.client.SurveyAssetStoreClient

public class SurveyAssetStoreClient
extends SurveyAssetStore

SurveyAssetStoreClient provides a concrete implementation of the SurveyAssetStore for the Survey Action Framework (SAF). It delegates the work to the supplied connected asset client.

Field Summary

Fields inherited from class org.odpi.openmetadata.frameworks.surveyaction.SurveyAssetStore

assetGUID, userId

Constructor Summary

Constructors

Constructor	Description
SurveyAssetStoreClient(String assetGUID, String userId, ConnectedAssetClient connectedAssetClient, FileSystemAssetOwner fileSystemAssetOwner, CSVFileAssetOwner csvFileAssetOwner, AuditLog auditLog)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	addCSVFileToCatalog(String displayName, String description, String pathName, List<String> columnHeaders, Character delimiterCharacter, Character quoteCharacter)	Add a simple asset description linked to a connection object for a CSV file.
String	addDataFileAssetToCatalog(String displayName, String description, String pathName)	Creates a new data file asset and links it to the folder structure implied in the path name.
AssetUniverse	getAssetProperties()	Returns a comprehensive collection of properties about the requested asset.
Connector	getConnectorByConnection(Connection connection)	Returns the connector corresponding to the supplied connection.
Connector	getConnectorToAsset()	Return the connector to the requested asset.
void	logAssetAuditMessage(String surveyService, String message)	Log an audit message about this asset.

Methods inherited from class org.odpi.openmetadata.frameworks.surveyaction.SurveyAssetStore

getAssetGUID

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SurveyAssetStoreClient

public SurveyAssetStoreClient(String assetGUID,
 String userId,
 ConnectedAssetClient connectedAssetClient,
 FileSystemAssetOwner fileSystemAssetOwner,
 CSVFileAssetOwner csvFileAssetOwner,
 AuditLog auditLog)

Constructor.

Parameters:

assetGUID - unique identifier for the asset un

userId - calling user

connectedAssetClient - connected asset client implements the REST API calls needed to support the OCF calls.

fileSystemAssetOwner - client to work with files and folders

csvFileAssetOwner - client to work with CSV files

Method Details

getConnectorByConnection

public Connector getConnectorByConnection(Connection connection)
                                   throws InvalidParameterException,
ConnectionCheckedException,
ConnectorCheckedException

Returns the connector corresponding to the supplied connection.

Specified by:

getConnectorByConnection in class SurveyAssetStore

Parameters:

connection - the connection object that contains the properties needed to create the connection.

Returns:

Connector connector instance

Throws:

InvalidParameterException - one of the parameters is null or invalid.

ConnectionCheckedException - there are errors in the configuration of the connection which is preventing the creation of a connector.

ConnectorCheckedException - there are errors in the initialization of the connector.

getAssetProperties

public AssetUniverse getAssetProperties()
                                 throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Returns a comprehensive collection of properties about the requested asset.

Specified by:

getAssetProperties in class SurveyAssetStore

Returns:

a comprehensive collection of properties about the asset.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem retrieving the asset properties from the property servers.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

logAssetAuditMessage

public void logAssetAuditMessage(String surveyService,
 String message)
                          throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Log an audit message about this asset.

Specified by:

logAssetAuditMessage in class SurveyAssetStore

Parameters:

surveyService - name of survey service

message - message to log

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem retrieving the asset properties from the property servers.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getConnectorToAsset

public Connector getConnectorToAsset()
                              throws InvalidParameterException,
ConnectionCheckedException,
ConnectorCheckedException,
UserNotAuthorizedException,
PropertyServerException

Return the connector to the requested asset.

Specified by:

getConnectorToAsset in class SurveyAssetStore

Returns:

Open Connector Framework (OCF) connector

Throws:

InvalidParameterException - the asset guid is not recognized or the userId is null

ConnectionCheckedException - there are errors in the configuration of the connection which is preventing the creation of a connector.

ConnectorCheckedException - there are errors in the initialization of the connector.

UserNotAuthorizedException - the user is not authorized to access the asset and/or connection needed to create the connector.

PropertyServerException - there was a problem in the store whether the asset/connection properties are kept.

addDataFileAssetToCatalog

public String addDataFileAssetToCatalog(String displayName,
 String description,
 String pathName)
                                 throws InvalidParameterException,
UserNotAuthorizedException,
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".

Specified by:

addDataFileAssetToCatalog in class SurveyAssetStore

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:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

addCSVFileToCatalog

public String addCSVFileToCatalog(String displayName,
 String description,
 String pathName,
 List<String> columnHeaders,
 Character delimiterCharacter,
 Character quoteCharacter)
                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Add a simple asset description linked to a connection object for a CSV file.

Specified by:

addCSVFileToCatalog in class SurveyAssetStore

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:

InvalidParameterException - full path or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem