Package com.evolveum.midpoint.common.secrets

Class CacheableSecretsProviderDelegate<C>

java.lang.Object

com.evolveum.midpoint.common.secrets.CacheableSecretsProviderDelegate<C>

Type Parameters:

C -

All Implemented Interfaces:

SecretsProvider<C>

public class CacheableSecretsProviderDelegate<C>
extends Object
implements SecretsProvider<C>

Delegate implementation for secret providers that is able to cache the resolved secrets and check keys for allowed prefixes.

Field Summary

Fields inherited from interface com.evolveum.midpoint.prism.crypto.SecretsProvider

EMPTY_DEPENDENCIES

Constructor Summary

Constructors

Constructor	Description
CacheableSecretsProviderDelegate(@NotNull SecretsProvider<C> delegate, Duration duration)

Method Summary

Modifier and Type	Method	Description
void	destroy()	This method can be used to clean-up resources of secret provider.
C	getConfiguration()	Returns configuration of the provider.
@NotNull String[]	getDependencies()	Returns list of providers that this provider depends on.
@NotNull String	getIdentifier()	Returns unique identifier of the provider.
ByteBuffer	getSecretBinary(@NotNull String key)	Returns secret ByteBuffer for given key.
String	getSecretString(@NotNull String key)	Returns secret String for given key.
void	initialize()	Post-construction initialization.
protected <ST> ST	resolveSecret(@NotNull String key, @NotNull Class<ST> type)

Methods inherited from class java.lang.Object

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

Constructor Details

CacheableSecretsProviderDelegate

public CacheableSecretsProviderDelegate(@NotNull
 @NotNull SecretsProvider<C> delegate,
 Duration duration)

Method Details

initialize

public void initialize()

Description copied from interface: SecretsProvider

Post-construction initialization. Called before the provider is added to the list of usable providers.

Specified by:

initialize in interface SecretsProvider<C>

destroy

public void destroy()

Description copied from interface: SecretsProvider

This method can be used to clean-up resources of secret provider. Called after provider was removed from the list of usable providers.

Specified by:

destroy in interface SecretsProvider<C>

getIdentifier

@NotNull
public @NotNull String getIdentifier()

Description copied from interface: SecretsProvider

Returns unique identifier of the provider.

Specified by:

getIdentifier in interface SecretsProvider<C>

getDependencies

@NotNull
public @NotNull String[] getDependencies()

Description copied from interface: SecretsProvider

Returns list of providers that this provider depends on. The provider will be initialized after all dependencies are available and initialized. Default implementation returns an empty array.

Specified by:

getDependencies in interface SecretsProvider<C>

getConfiguration

public C getConfiguration()

Description copied from interface: SecretsProvider

Returns configuration of the provider.

Specified by:

getConfiguration in interface SecretsProvider<C>

getSecretBinary

public ByteBuffer getSecretBinary(@NotNull
 @NotNull String key)
                           throws EncryptionException

Description copied from interface: SecretsProvider

Returns secret ByteBuffer for given key. Returns null if the secret does not exist.

Specified by:

getSecretBinary in interface SecretsProvider<C>

Throws:

EncryptionException - if the secret cannot be resolved (e.g. due to network problems)

getSecretString

public String getSecretString(@NotNull
 @NotNull String key)
                       throws EncryptionException

Description copied from interface: SecretsProvider

Returns secret String for given key. Returns null if the secret does not exist.

Specified by:

getSecretString in interface SecretsProvider<C>

Throws:

EncryptionException - if the secret cannot be resolved (e.g. due to network problems)

resolveSecret

protected <ST> ST resolveSecret(@NotNull
 @NotNull String key,
 @NotNull
 @NotNull Class<ST> type)
                         throws EncryptionException

Throws:

EncryptionException