SecretPropertyFormat (OpenAM Server Only 7.0.2 Documentation)

All Known Implementing Classes:

GoogleKmsEncryptedPropertyFormat, PemPropertyFormat, PropertyFormat, PropertyFormatBase64, SecretKeyPropertyFormat
```
public interface SecretPropertyFormat
```
Defines the format of secrets loaded from configuration properties.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`SecretBuilder`	`decode(String propertyValue)`	Decodes the input property value, setting relevant properties on a `SecretBuilder` object.
`default Promise<SecretBuilder,NoSuchSecretException>`	`decodeToPromise(String propertyValue)`	Decodes the input property value, setting relevant properties on a `SecretBuilder` object.

- Method Detail
  - decode
```
SecretBuilder decode(String propertyValue)
              throws NoSuchSecretException
```
    Decodes the input property value, setting relevant properties on a SecretBuilder object.
    
    Parameters:
    
    propertyValue - the value of the secret property.
    
    Returns:
    
    the decoded secret information.
    
    Throws:
    
    NoSuchSecretException - If the property value does not contain a value that can be decoded.
  - decodeToPromise
```
default Promise<SecretBuilder,NoSuchSecretException> decodeToPromise(String propertyValue)
```
    Decodes the input property value, setting relevant properties on a SecretBuilder object.
    
    Parameters:
    
    propertyValue - the value of the secret property.
    
    Returns:
    
    a promise of the decoded secret information.