Package org.odpi.openmetadata.adapters.repositoryservices.archiveconnector.file

Class FileBasedOpenMetadataArchiveStoreConnector

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.Connector

org.odpi.openmetadata.frameworks.connectors.ConnectorBase

org.odpi.openmetadata.repositoryservices.connectors.stores.archivestore.OpenMetadataArchiveStoreConnector

org.odpi.openmetadata.adapters.repositoryservices.archiveconnector.file.FileBasedOpenMetadataArchiveStoreConnector

All Implemented Interfaces:

AuditLoggingComponent, SecureConnectorExtension, VirtualConnectorExtension, OpenMetadataArchiveStore

public class FileBasedOpenMetadataArchiveStoreConnector
extends OpenMetadataArchiveStoreConnector

FileBasedOpenMetadataArchiveStoreConnector provides a connector that can read an Open Metadata Archive file coded in JSON.

Nested Class Summary

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

ConnectorBase.ProtectedConnection

Field Summary

Fields inherited from class org.odpi.openmetadata.repositoryservices.connectors.stores.archivestore.OpenMetadataArchiveStoreConnector

auditLog

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

connectionBean, connectorInstanceId, embeddedConnectors, messageFormatter, secretsStoreConnectorMap

Constructor Summary

Constructors

Constructor	Description
FileBasedOpenMetadataArchiveStoreConnector()	Default constructor

Method Summary

Modifier and Type	Method	Description
void	disconnect()	Free up any resources held since the connector is no longer needed.
OpenMetadataArchive	getArchiveContents()	Return the contents of the archive.
void	initialize(String connectorInstanceId, Connection connectionDetails)	Retrieve the archive store information from the endpoint.
void	setArchiveContents(OpenMetadataArchive archiveContents)	Set new contents into the archive.
void	start()	Indicates that the connector is completely configured and can begin processing.

Methods inherited from class org.odpi.openmetadata.repositoryservices.connectors.stores.archivestore.OpenMetadataArchiveStoreConnector

getConnectorComponentDescription, setAuditLog

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

combineConfigurationProperties, disconnectConnectors, equals, fromCamelToCanonicalCase, fromCanonicalToCamelCase, fromCanonicalToKebabCase, fromCanonicalToSnakeCase, fromKebabToCanonicalCase, fromSnakeToCanonicalCase, getArrayConfigurationProperty, getArrayConfigurationProperty, getArrayConfigurationProperty, getBooleanConfigurationProperty, getConnection, getConnectorInstanceId, getDateConfigurationProperty, getIntConfigurationProperty, getLongConfigurationProperty, getSecretsCollectionName, getSecretsLocation, getSecretsProvider, getStringConfigurationProperty, getStringConfigurationProperty, getSuppliedPlaceholderProperties, hashCode, 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

Constructor Details

FileBasedOpenMetadataArchiveStoreConnector

public FileBasedOpenMetadataArchiveStoreConnector()

Default constructor

Method Details

initialize

public void initialize(String connectorInstanceId,
 Connection connectionDetails)
                throws ConnectorCheckedException

Retrieve the archive store information from the endpoint.

Overrides:

initialize in class ConnectorBase

Parameters:

connectorInstanceId - unique id for the connector instance useful for messages etc

connectionDetails - POJO for the configuration used to create the connector.

Throws:

ConnectorCheckedException - a problem within the connector.

getArchiveContents

public OpenMetadataArchive getArchiveContents()
                                       throws RepositoryErrorException

Return the contents of the archive.

Returns:

OpenMetadataArchive object

Throws:

RepositoryErrorException - a problem accessing the archive

setArchiveContents

public void setArchiveContents(OpenMetadataArchive archiveContents)

Set new contents into the archive. This overrides any content previously stored.

Parameters:

archiveContents - OpenMetadataArchive object

start

public void start()
           throws ConnectorCheckedException,
UserNotAuthorizedException

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

Overrides:

start in class ConnectorBase

Throws:

ConnectorCheckedException - the connector detected a problem.

UserNotAuthorizedException - the connector was disconnected before/during start

disconnect

public void disconnect()
                throws ConnectorCheckedException

Free up any resources held since the connector is no longer needed.

Overrides:

disconnect in class ConnectorBase

Throws:

ConnectorCheckedException - the connector detected a problem.