Package org.forgerock.secrets
Interface SecretDecoder
-
- All Known Subinterfaces:
SecretPropertyFormat
- All Known Implementing Classes:
GoogleKmsEncryptedPropertyFormat
,PemPropertyFormat
,PropertyFormat
,PropertyFormatBase64
,SecretKeyPropertyFormat
public interface SecretDecoder
Specifies how data retrieved from aSecretStore
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 SecretDecoder
RAW
A decoder that populates the raw data of the secret.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Promise<SecretBuilder,NoSuchSecretException>
decodeToPromise(byte[] data)
Decodes the raw data retrieved from a backend into aSecretBuilder
for further processing.
-
-
-
Field Detail
-
RAW
static final SecretDecoder RAW
A decoder that populates the raw data of the secret.
-
-
Method Detail
-
decodeToPromise
Promise<SecretBuilder,NoSuchSecretException> decodeToPromise(byte[] data)
Decodes the raw data retrieved from a backend into aSecretBuilder
for further processing.- Parameters:
data
- the raw secret data.- Returns:
- a promise of the decoded secret information.
-
-