Package org.openmetadata.service.secrets

Class SecretsManager

java.lang.Object

org.openmetadata.service.secrets.SecretsManager

Direct Known Subclasses:

DBSecretsManager, ExternalSecretsManager

public abstract class SecretsManager
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	SecretsManager.SecretsConfig
protected static final record	SecretsManager.SecretsIdConfig

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SecretsManager(SecretsManagerProvider secretsManagerProvider, SecretsManager.SecretsConfig secretsConfig)

Method Summary

Modifier and Type	Method	Description
protected String	buildSecretId(boolean addClusterPrefix, String... secretIdValues)
protected SecretsManager.SecretsIdConfig	builSecretsIdConfig()	Override this method in any Secrets Manager implementation that has other requirements
void	decryptAuthenticationMechanism(String name, AuthenticationMechanism authenticationMechanism)
void	decryptIngestionPipeline(IngestionPipeline ingestionPipeline)
OpenMetadataConnection	decryptOpenMetadataConnection(OpenMetadataConnection openMetadataConnection)
Object	decryptServiceConnectionConfig(Object connectionConfig, String connectionType, ServiceType serviceType)
Workflow	decryptWorkflow(Workflow workflow)
protected abstract void	deleteSecretInternal(String secretName)
void	deleteSecretsFromServiceConnectionConfig(Object connectionConfig, String connectionType, String connectionName, ServiceType serviceType)
void	deleteSecretsFromWorkflow(Workflow workflow)
void	encryptAuthenticationMechanism(String name, AuthenticationMechanism authenticationMechanism)
void	encryptIngestionPipeline(IngestionPipeline ingestionPipeline)
OpenMetadataConnection	encryptOpenMetadataConnection(OpenMetadataConnection openMetadataConnection, boolean store)
Object	encryptServiceConnectionConfig(Object connectionConfig, String connectionType, String connectionName, ServiceType serviceType)
Workflow	encryptWorkflow(Workflow workflow)
static Map<String,String>	getTags(SecretsManager.SecretsConfig secretsConfig)
protected abstract String	storeValue(String fieldName, String value, String secretId, boolean store)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SecretsManager

protected SecretsManager(SecretsManagerProvider secretsManagerProvider,
 SecretsManager.SecretsConfig secretsConfig)

Method Details

builSecretsIdConfig

protected SecretsManager.SecretsIdConfig builSecretsIdConfig()

Override this method in any Secrets Manager implementation that has other requirements

encryptServiceConnectionConfig

public Object encryptServiceConnectionConfig(Object connectionConfig,
 String connectionType,
 String connectionName,
 ServiceType serviceType)

decryptServiceConnectionConfig

public Object decryptServiceConnectionConfig(Object connectionConfig,
 String connectionType,
 ServiceType serviceType)

encryptAuthenticationMechanism

public void encryptAuthenticationMechanism(String name,
 AuthenticationMechanism authenticationMechanism)

decryptAuthenticationMechanism

public void decryptAuthenticationMechanism(String name,
 AuthenticationMechanism authenticationMechanism)

encryptIngestionPipeline

public void encryptIngestionPipeline(IngestionPipeline ingestionPipeline)

decryptIngestionPipeline

public void decryptIngestionPipeline(IngestionPipeline ingestionPipeline)

encryptWorkflow

public Workflow encryptWorkflow(Workflow workflow)

decryptWorkflow

public Workflow decryptWorkflow(Workflow workflow)

encryptOpenMetadataConnection

public OpenMetadataConnection encryptOpenMetadataConnection(OpenMetadataConnection openMetadataConnection,
 boolean store)

decryptOpenMetadataConnection

public OpenMetadataConnection decryptOpenMetadataConnection(OpenMetadataConnection openMetadataConnection)

storeValue

protected abstract String storeValue(String fieldName,
 String value,
 String secretId,
 boolean store)

buildSecretId

protected String buildSecretId(boolean addClusterPrefix,
 String... secretIdValues)

deleteSecretInternal

protected abstract void deleteSecretInternal(String secretName)

deleteSecretsFromServiceConnectionConfig

public void deleteSecretsFromServiceConnectionConfig(Object connectionConfig,
 String connectionType,
 String connectionName,
 ServiceType serviceType)

deleteSecretsFromWorkflow

public void deleteSecretsFromWorkflow(Workflow workflow)

getTags

public static Map<String,String> getTags(SecretsManager.SecretsConfig secretsConfig)