Package org.odpi.openmetadata.adapters.connectors.datastore.basicfile

Class BasicFileStoreConnector

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.Connector

org.odpi.openmetadata.frameworks.connectors.ConnectorBase

org.odpi.openmetadata.adapters.connectors.datastore.basicfile.BasicFileStoreConnector

All Implemented Interfaces:

BasicFileStore, SecureConnectorExtension, VirtualConnectorExtension

Direct Known Subclasses:

CSVFileStoreConnector

public class BasicFileStoreConnector
extends ConnectorBase
implements BasicFileStore

BasicFileStoreConnector works with files to retrieve simple information about the file and provides access to the file object.

Nested Class Summary

Nested classes/interfaces inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase

ConnectorBase.ProtectedConnection

Field Summary

Fields

Modifier and Type	Field	Description
protected String	fileStoreName

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase

auditLog, connectionBean, connectorInstanceId, embeddedConnectors, messageFormatter, secretsStoreConnectorMap

Constructor Summary

Constructors

Constructor	Description
BasicFileStoreConnector()

Method Summary

Modifier and Type	Method	Description
void	disconnect()	Close the file
Date	getCreationDate()	Return the creation date for the file.
File	getFile()	Return the Java File object that provides access to the file.
protected File	getFile(String methodName)	Return the Java File object that provides access to the file.
long	getFileLength()	Return the number of bytes in the file
String	getFileName()	Return the name of the file to read.
Date	getLastAccessDate()	Return the last accessed date for the file.
Date	getLastUpdateDate()	Return the last update date for the file.
void	setFileStoreName(String fileStoreName)	Set up the name of the file store.
void	start()	Indicates that the connector is completely configured and can begin processing.

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase

combineConfigurationProperties, disconnectConnectors, equals, fromCanonicalToKebabCase, fromCanonicalToSnakeCase, fromKebabToCanonicalCase, fromSnakeToCanonicalCase, getArrayConfigurationProperty, getArrayConfigurationProperty, getArrayConfigurationProperty, getBooleanConfigurationProperty, getConnection, getConnectorInstanceId, getDateConfigurationProperty, getIntConfigurationProperty, getLongConfigurationProperty, getStringConfigurationProperty, getStringConfigurationProperty, getSuppliedPlaceholderProperties, hashCode, initialize, initializeEmbeddedConnectors, initializeSecretsStoreConnector, isActive, logExceptionRecord, logRecord, logRecord, throwMissingConfigurationProperty, throwMissingEndpointAddress, throwMissingResource, throwNoAsset, throwWrongTypeOfAsset, throwWrongTypeOfResource, throwWrongTypeOfRootSchema, toString

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.Connector

clearStatisticProperty, clearStatisticTimestamp, getConnectorStatistics, getStatisticCounter, getStatisticProperty, getStatisticTimestamp, incrementStatisticCounter, initializeStatisticCounter, refreshStatistics, setStatisticProperty, setStatisticTimestamp

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

fileStoreName

protected String fileStoreName

Constructor Details

BasicFileStoreConnector

public BasicFileStoreConnector()

Method Details

start

public void start()
           throws UserNotAuthorizedException,
ConnectorCheckedException

Indicates that the connector is completely configured and can begin processing.

Overrides:

start in class ConnectorBase

Throws:

ConnectorCheckedException - there is a problem within the connector.

UserNotAuthorizedException - the connector was disconnected before/during start

setFileStoreName

public void setFileStoreName(String fileStoreName)
                      throws FileException

Set up the name of the file store. This may override the value supplied in the endpoint. An exception is thrown if the file name is not valid.

Parameters:

fileStoreName - path name of the desired file

Throws:

FileException - this is not a file that can be used

getFileName

public String getFileName()
                   throws FileException

Return the name of the file to read.

Specified by:

getFileName in interface BasicFileStore

Returns:

file name

Throws:

FileException - problem accessing the file

getFileLength

public long getFileLength()
                   throws FileException

Return the number of bytes in the file

Specified by:

getFileLength in interface BasicFileStore

Returns:

number

Throws:

FileException - unable to locate the file

getCreationDate

public Date getCreationDate()
                     throws FileException,
FileReadException

Return the creation date for the file.

Specified by:

getCreationDate in interface BasicFileStore

Returns:

Date object

Throws:

FileException - problem accessing the file

FileReadException - - the file name is null, the file does not exist, or is a directory or is not readable.

getLastUpdateDate

public Date getLastUpdateDate()
                       throws FileReadException,
FileException

Return the last update date for the file.

Specified by:

getLastUpdateDate in interface BasicFileStore

Returns:

Date object

Throws:

FileReadException - problem accessing the file

FileReadException - problem accessing the file

FileException - there is a problem accessing the file

getLastAccessDate

public Date getLastAccessDate()
                       throws FileException,
FileReadException

Return the last accessed date for the file.

Specified by:

getLastAccessDate in interface BasicFileStore

Returns:

Date object

Throws:

FileException - problem accessing the file

FileReadException - - the file name is null, the file does not exist, or is a directory or is not readable.

getFile

public File getFile()
             throws FileException

Return the Java File object that provides access to the file.

Specified by:

getFile in interface BasicFileStore

Returns:

File object

Throws:

FileException - problem accessing the file

getFile

protected File getFile(String methodName)
                throws FileException

Return the Java File object that provides access to the file.

Parameters:

methodName - , calling method

Returns:

File object

Throws:

FileException - problem accessing the file

disconnect

public void disconnect()

Close the file

Overrides:

disconnect in class ConnectorBase