Package org.odpi.openmetadata.adapters.adminservices.configurationstore.encryptedfile

Class EncryptedFileBasedServerConfigStoreConnector

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.Connector

org.odpi.openmetadata.frameworks.connectors.ConnectorBase

org.odpi.openmetadata.adminservices.store.OMAGServerConfigStoreConnectorBase

org.odpi.openmetadata.adapters.adminservices.configurationstore.encryptedfile.EncryptedFileBasedServerConfigStoreConnector

All Implemented Interfaces:

OMAGServerConfigStore, OMAGServerConfigStoreRetrieveAll, SecureConnectorExtension, VirtualConnectorExtension

public class EncryptedFileBasedServerConfigStoreConnector
extends OMAGServerConfigStoreConnectorBase
implements OMAGServerConfigStoreRetrieveAll

EncryptedFileBasedServerConfigStoreConnector is the OCF connector for the encrypted file based server configuration store.

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.adminservices.store.OMAGServerConfigStoreConnectorBase

serverName

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

auditLog, connectedAssetProperties, connectionBean, connectionProperties, connectorInstanceId, embeddedConnectors, messageFormatter, secretsStoreConnectorMap

Constructor Summary

Constructors

Constructor	Description
EncryptedFileBasedServerConfigStoreConnector()	Default constructor

Method Summary

Modifier and Type	Method	Description
void	disconnect()	Free up any resources held since the connector is no longer needed.
boolean	equals(Object obj)	Provide a common implementation of equals for all OCF Connector Provider objects.
protected Set<String>	getFileNames(String templateString, String methodName)	Get filenames from the file system that match the store template.
int	hashCode()	Provide a common implementation of hashCode for all OCF Connector objects.
void	removeServerConfig()	Remove the server configuration.
Set<OMAGServerConfig>	retrieveAllServerConfigs()	Retrieve all the stored server configurations
OMAGServerConfig	retrieveServerConfig()	Retrieve the configuration saved from a previous run of the server.
void	saveServerConfig(OMAGServerConfig omagServerConfig)	Save the server configuration.
void	start()	Indicates that the connector is completely configured and can begin processing.

Methods inherited from class org.odpi.openmetadata.adminservices.store.OMAGServerConfigStoreConnectorBase

getStoreName, setServerName

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

combineConfigurationProperties, disconnectConnectors, getArrayConfigurationProperty, getAssetTypeName, getBooleanConfigurationProperty, getConnectedAssetProperties, getConnection, getConnectorInstanceId, getDateConfigurationProperty, getIntConfigurationProperty, getLongConfigurationProperty, getNetworkAddresses, getStringConfigurationProperty, getSuppliedPlaceholderProperties, initialize, initializeConnectedAssetProperties, initializeEmbeddedConnectors, initializeSecretsStoreConnector, isActive, logExceptionRecord, logRecord, logRecord, throwMissingConfigurationProperty, throwMissingResource, throwNoAsset, throwWrongTypeOfAsset, throwWrongTypeOfResource, throwWrongTypeOfRootSchema, toString

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.odpi.openmetadata.adminservices.store.OMAGServerConfigStore

setServerName

Constructor Details

EncryptedFileBasedServerConfigStoreConnector

public EncryptedFileBasedServerConfigStoreConnector()

Default constructor

Method Details

start

public void start()
           throws 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.

saveServerConfig

public void saveServerConfig(OMAGServerConfig omagServerConfig)

Save the server configuration.

Specified by:

saveServerConfig in interface OMAGServerConfigStore

Parameters:

omagServerConfig - configuration properties to save

retrieveServerConfig

public OMAGServerConfig retrieveServerConfig()

Retrieve the configuration saved from a previous run of the server.

Specified by:

retrieveServerConfig in interface OMAGServerConfigStore

Returns:

server configuration

removeServerConfig

public void removeServerConfig()

Remove the server configuration.

Specified by:

removeServerConfig in interface OMAGServerConfigStore

retrieveAllServerConfigs

public Set<OMAGServerConfig> retrieveAllServerConfigs()

Retrieve all the stored server configurations

Specified by:

retrieveAllServerConfigs in interface OMAGServerConfigStoreRetrieveAll

Returns:

the set of server configurations present in this OMAG Server Config store

getFileNames

protected Set<String> getFileNames(String templateString,
 String methodName)

Get filenames from the file system that match the store template. Only supports 1 or 2 inserts in the template and they need to be in different url segments. When a file is matched on the file system, the match for the insert is the serverName.

Parameters:

methodName - callers name for diagnostics

Returns:

set of filenames fro the file System that match the template

disconnect

public void disconnect()

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

Overrides:

disconnect in class ConnectorBase

equals

public boolean equals(Object obj)

Provide a common implementation of equals for all OCF Connector Provider objects. The UUID is unique and is randomly assigned and so its hashCode is as good as anything to evaluate the equality of the connector provider object.

Overrides:

equals in class ConnectorBase

Parameters:

obj - object to test

Returns:

boolean flag

hashCode

public int hashCode()

Provide a common implementation of hashCode for all OCF Connector objects. The UUID is unique and is randomly assigned and so its hashCode is as good as anything to describe the hash code of the connector object.

Overrides:

hashCode in class ConnectorBase

Returns:

random UUID as hashcode