Package org.forgerock.secrets

Interface SecretDecoder

All Known Subinterfaces:

SecretPropertyFormat

All Known Implementing Classes:

GoogleKmsEncryptedPropertyFormat, JwkPropertyFormat, PemPropertyFormat, PropertyFormat, PropertyFormatBase64, SecretKeyPropertyFormat

public interface SecretDecoder

Specifies how data retrieved from a SecretStore should be decoded into a secret object. This interface is used when there may be multiple ways to interpret the data being retrieved. For example, a file containing secret data could be raw binary data or it could be a PEM-encoded certificate.

Field Summary

Fields

Modifier and Type	Field	Description
static final SecretDecoder	RAW	A decoder that populates the raw data of the secret.

Method Summary

Modifier and Type	Method	Description
Promise<SecretBuilder,NoSuchSecretException>	decodeToPromise(byte[] data)	Decodes the raw data retrieved from a backend into a SecretBuilder for further processing.

Field Details

RAW

static final SecretDecoder RAW

A decoder that populates the raw data of the secret.

Method Details

decodeToPromise

Promise<SecretBuilder,NoSuchSecretException> decodeToPromise(byte[] data)

Decodes the raw data retrieved from a backend into a SecretBuilder for further processing.

Parameters:

data - the raw secret data.

Returns:

a promise of the decoded secret information.