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

Class CSVFileAssetOwner

java.lang.Object

org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.client.ConnectedAssetClientBase

org.odpi.openmetadata.accessservices.assetowner.client.AssetOwnerBaseClient

org.odpi.openmetadata.accessservices.assetowner.client.AssetOwner

org.odpi.openmetadata.accessservices.assetowner.client.CSVFileAssetOwner

All Implemented Interfaces:

AssetClassificationInterface, AssetCollectionInterface, AssetConnectionManagementInterface, AssetDecommissioningInterface, AssetKnowledgeInterface, AssetOnboardingCSVFileInterface, AssetOnboardingInterface, AssetReviewInterface, RelatedElementsManagementInterface, ConnectorFactoryInterface

public class CSVFileAssetOwner
extends AssetOwner
implements AssetOnboardingCSVFileInterface

CSVFileAssetOwner provides specialist methods for working with CSV files.

Field Summary

Fields inherited from class org.odpi.openmetadata.accessservices.assetowner.client.AssetOwnerBaseClient

nullRequestBody, restClient, urlTemplatePrefix

Fields inherited from class org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.client.ConnectedAssetClientBase

auditLog, invalidParameterHandler, serverName, serverPlatformURLRoot

Constructor Summary

Constructors

Constructor	Description
CSVFileAssetOwner(String serverName, String serverPlatformURLRoot)	Create a new client with no authentication embedded in the HTTP request.
CSVFileAssetOwner(String serverName, String serverPlatformURLRoot, String userId, String password)	Create a new client that passes userId and password in each HTTP request.
CSVFileAssetOwner(String serverName, String serverPlatformURLRoot, String userId, String password, AuditLog auditLog)	Create a new client that passes userId and password in each HTTP request.
CSVFileAssetOwner(String serverName, String serverPlatformURLRoot, AssetOwnerRESTClient restClient, int maxPageSize, AuditLog auditLog)	Create a new client that is going to be used in an OMAG Server (view service or integration service typically).
CSVFileAssetOwner(String serverName, String serverPlatformURLRoot, AuditLog auditLog)	Create a new client with no authentication embedded in the HTTP request and an audit log.

Method Summary

Modifier and Type	Method	Description
List<String>	addCSVFileToCatalog(String userId, String displayName, String description, String fullPath)	Add a simple asset description linked to a connection object for a CSV file.
List<String>	addCSVFileToCatalog(String userId, String displayName, String description, String fullPath, List<String> columnHeaders, Character delimiterCharacter, Character quoteCharacter)	Add a simple asset description linked to a connection object for a CSV file.

Methods inherited from class org.odpi.openmetadata.accessservices.assetowner.client.AssetOwner

addAssetOrigin, addAssetToCatalog, addAssetToCatalog, addAssetToCatalogUsingTemplate, addCombinedSchemaToAsset, addConnectionToAsset, addGovernanceDefinitionToElement, addSchemaAttribute, addSchemaAttributes, addSchemaTypeToAsset, addSecurityTags, addSemanticAssignment, addSemanticAssignment, addTemplateClassification, attachSchemaTypeToAsset, clearAssetConnection, clearAssetRelationship, clearConfidenceClassification, clearConfidentialityClassification, clearConnectorType, clearCriticalityClassification, clearElementAsDataField, clearEmbeddedConnection, clearEndpoint, clearRetentionClassification, clearSchemaElementAsCalculatedValue, clearSchemaElementRelationship, clearSchemaTypeParent, createAnchoredSchemaType, createCollection, createConnection, createConnectionFromTemplate, createEndpoint, createEndpointFromTemplate, createFolderCollection, createSchemaAttributeFromTemplate, createSchemaType, createSchemaTypeFromTemplate, deleteAsset, deleteAssetSchemaType, detachSchemaTypeFromAsset, findAssets, findCollections, findConnections, findConnectorTypes, findEndpoints, findSchemaAttributes, findSchemaType, getAssetRelationship, getAssetsByName, getAssetsByOrigin, getAssetSummary, getCollection, getCollectionMember, getCollectionMembers, getCollections, getCollectionsByName, getConfidenceClassifiedElements, getConfidentialityClassifiedElements, getConnectionByGUID, getConnectionsByName, getConnectorToAsset, getConnectorTypeByGUID, getConnectorTypesByName, getCriticalityClassifiedElements, getDataFieldClassifiedElements, getElementsCollections, getElementsSourceFrom, getEndpointByGUID, getEndpointsByName, getExtendedAnnotations, getGovernedByDefinitions, getGovernedElements, getMeanings, getMembersOfSubjectArea, getNestedSchemaAttributes, getOwnersElements, getRelatedAssetsAtEnd1, getRelatedAssetsAtEnd2, getRetentionClassifiedElements, getSchemaAttributeByGUID, getSchemaAttributesByName, getSchemaTypeByGUID, getSchemaTypeByName, getSchemaTypeForElement, getSchemaTypeParent, getSecurityTaggedElements, getSemanticAssignees, getSourceElements, getSurveyReportAnnotations, getSurveyReports, getTypesOfAnnotation, getTypesOfAnnotationWithDescriptions, getTypesOfAsset, getTypesOfAssetWithDescriptions, publishAsset, removeAssetOrigin, removeAssetOwner, removeCollection, removeConnection, removeEndpoint, removeFromCollection, removeGovernanceDefinitionFromElement, removeSchemaAttribute, removeSchemaType, removeSecurityTags, removeSemanticAssignment, removeTemplateClassification, scanConnections, setConfidenceClassification, setConfidentialityClassification, setCriticalityClassification, setElementAsDataField, setRetentionClassification, setSchemaElementAsCalculatedValue, setupAssetConnection, setupConnectorType, setupEmbeddedConnection, setupEndpoint, setupRelatedAsset, setupSchemaElementRelationship, setupSchemaTypeParent, updateAsset, updateAssetOwner, updateAssetRelationship, updateAssetZones, updateCollection, updateCollectionMembership, updateConnection, updateEndpoint, updateSchemaAttribute, updateSchemaType, withdrawAsset

Methods inherited from class org.odpi.openmetadata.accessservices.assetowner.client.AssetOwnerBaseClient

clearCatalogTemplate, clearMoreInformation, clearResource, clearStakeholder, getCatalogTemplateList, getDescriptiveElements, getMoreInformation, getResourceList, getStakeholderCommissionedElements, getStakeholders, getSupportedByResource, getSupportedByTemplate, removeReferenceable, setupCatalogTemplate, setupMoreInformation, setupResource, setupStakeholder, updateRelationship

Methods inherited from class org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.client.ConnectedAssetClientBase

getAnchorAssetFromGUID, getAssetForConnection, getAssetProperties, getAssetSummary, getConnectionByGUID, getConnectionByName, getConnectionForAsset, getConnectorByConnection, getConnectorByGUID, getConnectorByName, getConnectorForAsset, getConnectorForAsset, getConnectorForConnection, logAssetAuditMessage, saveConnection, saveConnection

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.odpi.openmetadata.accessservices.assetowner.api.AssetReviewInterface

getAssetProperties

Constructor Details

CSVFileAssetOwner

public CSVFileAssetOwner(String serverName,
 String serverPlatformURLRoot,
 AuditLog auditLog)
                  throws InvalidParameterException

Create a new client with no authentication embedded in the HTTP request and an audit log.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST services

auditLog - logging destination

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

CSVFileAssetOwner

public CSVFileAssetOwner(String serverName,
 String serverPlatformURLRoot)
                  throws 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

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

CSVFileAssetOwner

public CSVFileAssetOwner(String serverName,
 String serverPlatformURLRoot,
 String userId,
 String password,
 AuditLog auditLog)
                  throws 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. There is also an audit log destination.

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

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

CSVFileAssetOwner

public CSVFileAssetOwner(String serverName,
 String serverPlatformURLRoot,
 String userId,
 String password)
                  throws 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

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

CSVFileAssetOwner

public CSVFileAssetOwner(String serverName,
 String serverPlatformURLRoot,
 AssetOwnerRESTClient restClient,
 int maxPageSize,
 AuditLog auditLog)
                  throws InvalidParameterException

Create a new client that is going to be used in an OMAG Server (view service or integration service typically).

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

auditLog - logging destination

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

Method Details

addCSVFileToCatalog

public List<String> addCSVFileToCatalog(String userId,
 String displayName,
 String description,
 String fullPath)
                                 throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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

Specified by:

addCSVFileToCatalog in interface AssetOnboardingCSVFileInterface

Parameters:

userId - calling user (assumed to be the owner)

displayName - display name for the file in the catalog

description - description of the file in the catalog

fullPath - full path of the file - used to access the file through the connector

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

addCSVFileToCatalog

public List<String> addCSVFileToCatalog(String userId,
 String displayName,
 String description,
 String fullPath,
 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 interface AssetOnboardingCSVFileInterface

Parameters:

userId - calling user (assumed to be the owner)

displayName - display name for the file in the catalog

description - description of the file in the catalog

fullPath - 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