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

Class EnvVarSecretsStoreConnector

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.envar.EnvVarSecretsStoreConnector

All Implemented Interfaces:

AuditLoggingComponent, SecureConnectorExtension, VirtualConnectorExtension

public class EnvVarSecretsStoreConnector
extends SecretsStoreConnector

EnvVarSecretsStoreConnector retrieves secrets from environment variables. Each secret is named for its environment variable.

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.frameworks.connectors.SecretsStoreConnector

secretsCollectionName

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

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

Constructor Summary

Constructors

Constructor	Description
EnvVarSecretsStoreConnector()

Method Summary

Modifier and Type	Method	Description
long	getRefreshTimeInterval()	Retrieve the refresh time from the secrets store.
String	getSecret(String secretName)	Retrieve a secret from the secrets store.
String	getSecret(String secretsCollectionName, String secretName)	Retrieve a secret from the secrets store.
UserAccount	getUser(String userId)	Retrieve the requested user definitions stored in the secrets collection.
Map<String,UserAccount>	getUsers()	Retrieve any user definitions stored in the secrets collection.
protected void	refreshSecrets()	Request that the subclass refreshes its secrets.

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

checkSecretsStillValid, getConnectorComponentDescription, resetRefreshTime, setAuditLog, start

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

combineConfigurationProperties, disconnect, disconnectConnectors, equals, getArrayConfigurationProperty, getAssetTypeName, getBooleanConfigurationProperty, getConnectedAssetProperties, getConnection, getConnectorInstanceId, getDateConfigurationProperty, getIntConfigurationProperty, getLongConfigurationProperty, getNetworkAddresses, getStringConfigurationProperty, getSuppliedPlaceholderProperties, hashCode, 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

Constructor Details

EnvVarSecretsStoreConnector

public EnvVarSecretsStoreConnector()

Method Details

refreshSecrets

protected void refreshSecrets()

Request that the subclass refreshes its secrets.

Specified by:

refreshSecrets in class SecretsStoreConnector

getSecret

public String getSecret(String secretName)

Retrieve a secret from the secrets store.

Specified by:

getSecret in class SecretsStoreConnector

Parameters:

secretName - name of the secret.

Returns:

secret

getSecret

public String getSecret(String secretsCollectionName,
 String secretName)

Retrieve a secret from the secrets store.

Specified by:

getSecret in class SecretsStoreConnector

Parameters:

secretsCollectionName - name of collection

secretName - name of the secret.

Returns:

secret

getUsers

public Map<String,UserAccount> getUsers()

Retrieve any user definitions stored in the secrets collection.

Specified by:

getUsers in class SecretsStoreConnector

Returns:

map of userIds to user details

getUser

public UserAccount getUser(String userId)

Retrieve the requested user definitions stored in the secrets collection.

Specified by:

getUser in class SecretsStoreConnector

Parameters:

userId - userId for the lookup

Returns:

associated user details or null

getRefreshTimeInterval

public long getRefreshTimeInterval()

Retrieve the refresh time from the secrets store.

Specified by:

getRefreshTimeInterval in class SecretsStoreConnector

Returns:

how long the secrets can be cached - 0 means indefinitely