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:
org.odpi.openmetadata.frameworks.auditlog.AuditLoggingComponent, org.odpi.openmetadata.frameworks.connectors.SecureConnectorExtension, org.odpi.openmetadata.frameworks.connectors.VirtualConnectorExtension
public class YAMLSecretsStoreConnector extends org.odpi.openmetadata.frameworks.connectors.SecretsStoreConnector
YAMLSecretsStoreConnector retrieves secrets from environment variables. Each secret is named for its environment variable.

  • Constructor Summary

    Constructors
    Constructor
    Description
    YAMLSecretsStoreConnector()
     

  • 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.
    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, setAuditLog

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

    disconnect, equals, getConnectedAssetProperties, getConnection, getConnectorInstanceId, hashCode, initialize, initializeConnectedAssetProperties, initializeEmbeddedConnectors, initializeSecretsStoreConnector, isActive, 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

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • YAMLSecretsStoreConnector

      public YAMLSecretsStoreConnector()

  • Method Details

    • start

      public void start() throws org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      Indicates that the connector is completely configured and can begin processing.
      Overrides:
      start in class org.odpi.openmetadata.frameworks.connectors.SecretsStoreConnector
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - there is a problem within the connector.

    • getRefreshTimeInterval

      public long getRefreshTimeInterval() throws org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      Retrieve the refresh time from the secrets store.
      Specified by:
      getRefreshTimeInterval in class org.odpi.openmetadata.frameworks.connectors.SecretsStoreConnector
      Returns:
      how long the secrets can be cached - 0 means indefinitely
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - there is a problem with the connector

    • getSecret

      public String getSecret(String secretName)
      Retrieve a secret from the secrets store.
      Specified by:
      getSecret in class org.odpi.openmetadata.frameworks.connectors.SecretsStoreConnector
      Parameters:
      secretName - name of the secret.
      Returns:
      secret