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

Class YAMLSecretsStoreConnector

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

All Implemented Interfaces:

AuditLoggingComponent, SecureConnectorExtension, VirtualConnectorExtension

Direct Known Subclasses:

YAMLSecretsFileConnector

public class YAMLSecretsStoreConnector
extends SecretsStoreConnector

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

Modifier and Type	Field	Description
protected SecretsStore	secretsStore
protected File	secretsStoreFile
protected Map<String,SecurityAccessControl>	securityAccessControlMap
protected Map<String,UserAccount>	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
YAMLSecretsStoreConnector()

Method Summary

Modifier and Type	Method	Description
void	deleteSecurityAccessControl(String controlName)	Delete the requested security access control stored in the secrets collection.
void	deleteUser(String userId)	Delete the requested user definitions stored in the secrets collection.
NamedList	getNamedList(String listName)	Look up a particular named list in the collection.
Map<String,NamedList>	getNamedLists()	Return all the known named lists in this collection
long	getRefreshTimeInterval()	Retrieve the refresh time from the secrets store.
String	getSecret(String secretName)	Retrieve a secret from the secrets store.
SecurityAccessControl	getSecurityAccessControl(String controlName)	Look up a particular named security access control in the collection.
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.
void	initialize(String connectorInstanceId, Connection connectionDetails)	Call made by the ConnectorProvider to initialize the Connector with the base services.
HttpRequest.BodyPublisher	ofForm(Map<String,Object> data)	Return the HTTPBodyPublisher populated with the data for the http request.
HttpRequest.BodyPublisher	ofJSON(Map<String,Object> data)	Return the HTTPBodyPublisher populated with the data for the http request.
protected void	refreshSecrets()	Request that the subclass refreshes its secrets.
protected void	saveSecrets()	Request that the subclass save its secrets.
void	saveSecurityAccessControl(String controlName, SecurityAccessControl securityAccessControl)	Save the requested security access control in the secrets collection.
void	saveUser(String userId, UserAccount userAccount)	Save the requested user definitions in the secrets collection.
void	start()	Indicates that the connector is completely configured and can begin processing.

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, 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

Field Details

secretsStoreFile

protected File secretsStoreFile

secretsStore

protected SecretsStore secretsStore

userAccountMap

protected Map<String,UserAccount> userAccountMap

securityAccessControlMap

protected Map<String,SecurityAccessControl> securityAccessControlMap

Constructor Details

YAMLSecretsStoreConnector

public YAMLSecretsStoreConnector()

Method Details

initialize

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

Call made by the ConnectorProvider to initialize the Connector with the base services.

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.

start

public void start()
           throws ConnectorCheckedException,
UserNotAuthorizedException

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

Overrides:

start in class SecretsStoreConnector

Throws:

ConnectorCheckedException - the connector detected a problem.

UserNotAuthorizedException - the connector was disconnected before/during start

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

getSecret

public String getSecret(String secretName)
                 throws ConnectorCheckedException

Retrieve a secret from the secrets store.

Specified by:

getSecret in class SecretsStoreConnector

Parameters:

secretName - name of the secret.

Returns:

secret

Throws:

ConnectorCheckedException - problem with the store

getNamedList

public NamedList getNamedList(String listName)
                       throws ConnectorCheckedException

Look up a particular named list in the collection.

Overrides:

getNamedList in class SecretsStoreConnector

Parameters:

listName - name of a list

Returns:

corresponding named list or null

Throws:

ConnectorCheckedException - a problem with the connector

getNamedLists

public Map<String,NamedList> getNamedLists()
                                    throws ConnectorCheckedException

Return all the known named lists in this collection

Overrides:

getNamedLists in class SecretsStoreConnector

Returns:

map of named lists in this collection

Throws:

ConnectorCheckedException - a problem with the connector

getSecurityAccessControl

public SecurityAccessControl getSecurityAccessControl(String controlName)
                                               throws ConnectorCheckedException

Look up a particular named security access control in the collection.

Overrides:

getSecurityAccessControl in class SecretsStoreConnector

Parameters:

controlName - name of the control

Returns:

corresponding named control or null

Throws:

ConnectorCheckedException - a problem with the connector

saveSecurityAccessControl

public void saveSecurityAccessControl(String controlName,
 SecurityAccessControl securityAccessControl)
                               throws ConnectorCheckedException

Save the requested security access control in the secrets collection.

Overrides:

saveSecurityAccessControl in class SecretsStoreConnector

Parameters:

controlName - controlName for the lookup

securityAccessControl - associated control details

Throws:

ConnectorCheckedException - a problem with the connector

deleteSecurityAccessControl

public void deleteSecurityAccessControl(String controlName)
                                 throws ConnectorCheckedException

Delete the requested security access control stored in the secrets collection.

Overrides:

deleteSecurityAccessControl in class SecretsStoreConnector

Parameters:

controlName - control for the lookup

Throws:

ConnectorCheckedException - a problem with the connector

getUser

public UserAccount getUser(String userId)
                    throws ConnectorCheckedException

Retrieve the requested user definitions stored in the secrets collection.

Overrides:

getUser in class SecretsStoreConnector

Parameters:

userId - userId for the lookup

Returns:

associated user details or null

Throws:

ConnectorCheckedException - problem with the store

saveUser

public void saveUser(String userId,
 UserAccount userAccount)
              throws ConnectorCheckedException

Save the requested user definitions in the secrets collection.

Overrides:

saveUser in class SecretsStoreConnector

Parameters:

userId - userId for the lookup

userAccount - associated user details

Throws:

ConnectorCheckedException - a problem with the connector

deleteUser

public void deleteUser(String userId)
                throws ConnectorCheckedException

Delete the requested user definitions stored in the secrets collection.

Overrides:

deleteUser in class SecretsStoreConnector

Parameters:

userId - userId for the lookup

Throws:

ConnectorCheckedException - a problem with the connector

getUsers

public Map<String,UserAccount> getUsers()
                                 throws ConnectorCheckedException

Retrieve any user definitions stored in the secrets collection.

Overrides:

getUsers in class SecretsStoreConnector

Returns:

map of userIds to user details

Throws:

ConnectorCheckedException - problem with the store

ofForm

public HttpRequest.BodyPublisher ofForm(Map<String,Object> data)

Return the HTTPBodyPublisher populated with the data for the http request.

Parameters:

data - HTTP request parameters

Returns:

populated HTTPBodyPublisher

ofJSON

public HttpRequest.BodyPublisher ofJSON(Map<String,Object> data)

Return the HTTPBodyPublisher populated with the data for the http request.

Parameters:

data - HTTP request parameters

Returns:

populated HTTPBodyPublisher

refreshSecrets

protected void refreshSecrets()
                       throws ConnectorCheckedException

Request that the subclass refreshes its secrets.

Specified by:

refreshSecrets in class SecretsStoreConnector

Throws:

ConnectorCheckedException - problem with secrets file

saveSecrets

protected void saveSecrets()
                    throws ConnectorCheckedException

Request that the subclass save its secrets.

Specified by:

saveSecrets in class SecretsStoreConnector

Throws:

ConnectorCheckedException - problem with secrets file