Package org.apache.pulsar.functions.secretsprovider

Class EnvironmentBasedSecretsProvider

java.lang.Object

org.apache.pulsar.functions.secretsprovider.EnvironmentBasedSecretsProvider

All Implemented Interfaces:

SecretsProvider

public class EnvironmentBasedSecretsProvider
extends Object
implements SecretsProvider

This defines a very simple Secrets Provider that looks up environment variable thats named the same as secretName and fetches it.

Constructor Summary

Constructors

Constructor	Description
EnvironmentBasedSecretsProvider()

Method Summary

Modifier and Type	Method	Description
String	interpolateSecretForValue(String value)	If the passed value is formatted as a reference to a secret, as defined by the implementation, return the referenced secret.
String	provideSecret(String secretName, Object pathToSecret)	Fetches a secret.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.pulsar.functions.secretsprovider.SecretsProvider

init

Constructor Details

EnvironmentBasedSecretsProvider

public EnvironmentBasedSecretsProvider()

Method Details

provideSecret

public String provideSecret(String secretName,
 Object pathToSecret)

Fetches a secret.

Specified by:

provideSecret in interface SecretsProvider

Returns:

The actual secret

interpolateSecretForValue

public String interpolateSecretForValue(String value)

Description copied from interface: SecretsProvider

If the passed value is formatted as a reference to a secret, as defined by the implementation, return the referenced secret. If the value is not formatted as a secret reference or the referenced secret does not exist, return null.

Specified by:

interpolateSecretForValue in interface SecretsProvider

Parameters:

value - a config value that may be formatted as a reference to a secret

Returns:

the materialized secret. Otherwise, null.