Package org.odpi.openmetadata.adapters.connectors.secretsstore.yaml

Class YAMLSecretsFileConnector

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.Connector

org.odpi.openmetadata.frameworks.connectors.ConnectorBase

org.odpi.openmetadata.frameworks.connectors.SecretsStoreConnector

org.odpi.openmetadata.adapters.connectors.secretsstore.yaml.YAMLSecretsStoreConnector

org.odpi.openmetadata.adapters.connectors.secretsstore.yaml.YAMLSecretsFileConnector

All Implemented Interfaces:

AuditLoggingComponent, SecureConnectorExtension, VirtualConnectorExtension

public class YAMLSecretsFileConnector
extends YAMLSecretsStoreConnector

YAMLSecretsStoreConnector retrieves secrets from a YAML File

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.adapters.connectors.secretsstore.yaml.YAMLSecretsStoreConnector

secretsStore, secretsStoreFile, securityAccessControlMap, userAccountMap

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

secretsCollectionName

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

auditLog, connectionBean, connectorInstanceId, embeddedConnectors, messageFormatter, secretsStoreConnectorMap

Constructor Summary

Constructors

Constructor	Description
YAMLSecretsFileConnector()

Method Summary

Modifier and Type	Method	Description
void	deleteSecretsCollection(String collectionName)	Delete the requested secrets collection from the secrets store.
SecretsStore	getSecretsStore()	Retrieve the refresh time from the secrets store.
protected boolean	isSecretsCollectionNameRequired()	The YAML secrets file manages whole secrets collections, so it is not configured with one.
boolean	isSecretsCollectionUpdateSupported()	The YAML secrets file can save and delete secrets collections.
void	saveSecretsCollection(String collectionName, SecretsCollection newSecretsCollection)	Save the requested secrets collection in the secrets store.
void	setSecretsCollectionName(String secretsCollectionName)	Dynamically set the secrets collection name for the secrets store.
void	start()	Indicates that the connector is completely configured and can begin processing.

Methods inherited from class org.odpi.openmetadata.adapters.connectors.secretsstore.yaml.YAMLSecretsStoreConnector

deleteSecurityAccessControl, deleteUser, getNamedList, getNamedLists, getRefreshTimeInterval, getSecret, getSecurityAccessControl, getUser, getUsers, initialize, ofForm, ofJSON, refreshSecrets, saveSecrets, saveSecurityAccessControl, saveUser

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

checkSecretsStillValid, getConnectorComponentDescription, getSecretsCollectionName, getSecretsLocation, getSecretsProvider, resetRefreshTime, setAuditLog

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

combineConfigurationProperties, disconnect, disconnectConnectors, equals, fromCamelToCanonicalCase, fromCanonicalToCamelCase, fromCanonicalToKebabCase, fromCanonicalToSnakeCase, fromKebabToCanonicalCase, fromSnakeToCanonicalCase, getArrayConfigurationProperty, getArrayConfigurationProperty, getArrayConfigurationProperty, getArrayValue, getBooleanConfigurationProperty, getConnection, getConnectorInstanceId, getDateConfigurationProperty, getIntConfigurationProperty, getLongConfigurationProperty, getSecretsCollectionName, getSecretsLocation, getSecretsProvider, getStringConfigurationProperty, getStringConfigurationProperty, getSuppliedPlaceholderProperties, hashCode, initializeEmbeddedConnectors, initializeSecretsStoreConnector, isActive, logExceptionRecord, logExceptionRecord, logRecord, logRecord, throwMissingConfigurationProperty, throwMissingElement, 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

YAMLSecretsFileConnector

public YAMLSecretsFileConnector()

Method Details

start

public void start()
           throws ConnectorCheckedException,
UserNotAuthorizedException

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

Overrides:

start in class YAMLSecretsStoreConnector

Throws:

ConnectorCheckedException - the connector detected a problem.

UserNotAuthorizedException - the connector was disconnected before/during start

isSecretsCollectionNameRequired

protected boolean isSecretsCollectionNameRequired()

The YAML secrets file manages whole secrets collections, so it is not configured with one.

Overrides:

isSecretsCollectionNameRequired in class SecretsStoreConnector

Returns:

false

getSecretsStore

public SecretsStore getSecretsStore()

Retrieve the refresh time from the secrets store.

Returns:

how long the secrets can be cached - 0 means indefinitely

setSecretsCollectionName

public void setSecretsCollectionName(String secretsCollectionName)

Dynamically set the secrets collection name for the secrets store.

Parameters:

secretsCollectionName - name of the secrets collection

isSecretsCollectionUpdateSupported

public boolean isSecretsCollectionUpdateSupported()

The YAML secrets file can save and delete secrets collections.

Overrides:

isSecretsCollectionUpdateSupported in class SecretsStoreConnector

Returns:

true

saveSecretsCollection

public void saveSecretsCollection(String collectionName,
 SecretsCollection newSecretsCollection)
                           throws ConnectorCheckedException

Save the requested secrets collection in the secrets store.

Overrides:

saveSecretsCollection in class SecretsStoreConnector

Parameters:

collectionName - collectionName for the save

newSecretsCollection - associated collection details

Throws:

ConnectorCheckedException - a problem with the connector

deleteSecretsCollection

public void deleteSecretsCollection(String collectionName)
                             throws ConnectorCheckedException

Delete the requested secrets collection from the secrets store.

Overrides:

deleteSecretsCollection in class SecretsStoreConnector

Parameters:

collectionName - name for the lookup

Throws:

ConnectorCheckedException - a problem with the connector