org.springframework.cloud.vault.config

Interface SecretBackendMetadataFactory<T extends VaultSecretBackendDescriptor>

Type Parameters:

T - descriptor type.

public interface SecretBackendMetadataFactory<T extends VaultSecretBackendDescriptor>

Strategy interface to create SecretBackendMetadata from VaultSecretBackendDescriptor properties. Mainly for internal use within the framework.

Classes implementing this interface must implement supports(VaultSecretBackendDescriptor) to determine whether a particular VaultSecretBackendDescriptor is supported by this implementation. If a VaultSecretBackendDescriptor instance is supported by the implementation, it must be able to create SecretBackendMetadata, see createMetadata(VaultSecretBackendDescriptor).

Typically implemented by secret backend providers that implement access to a particular backend using read operations.

Author:

Mark Paluch

See Also:

SecretBackendMetadata, LeasingSecretBackendMetadata, VaultSecretBackendDescriptor

Method Summary

Modifier and Type	Method and Description
SecretBackendMetadata	createMetadata(T backendDescriptor) Converts a VaultSecretBackendDescriptor into a SecretBackendMetadata.
boolean	supports(VaultSecretBackendDescriptor backendDescriptor) Checks whether the VaultSecretBackendDescriptor is supported by this SecretBackendMetadataFactory.

Method Detail

createMetadata

SecretBackendMetadata createMetadata(T backendDescriptor)

Converts a VaultSecretBackendDescriptor into a SecretBackendMetadata.

Parameters:

backendDescriptor - must not be null.

Returns:

the SecretBackendMetadata.

See Also:

LeasingSecretBackendMetadata

supports

boolean supports(VaultSecretBackendDescriptor backendDescriptor)

Checks whether the VaultSecretBackendDescriptor is supported by this SecretBackendMetadataFactory.

Parameters:

backendDescriptor - must not be null.

Returns:

true if the given VaultSecretBackendDescriptor is supported.