Package org.forgerock.openig.secrets

Class Base64PropertyFormat

java.lang.Object

org.forgerock.openig.secrets.Base64PropertyFormat

All Implemented Interfaces:

SecretPropertyFormat, SecretDecoder

public class Base64PropertyFormat
extends Object
implements SecretPropertyFormat

A SecretPropertyFormat for a BASE64 format.

Usage:

 {
       "type": "Base64PropertyFormat"
 }
 

Note that it's not necessary to create new instances of this format. An instance of this object is already present in the heap at key Keys.BASE64_PROPERTY_FORMAT.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Base64PropertyFormat.Base64PropertyFormatTypeProvider	Provide the Base64PropertyFormat's ComponentTypeDefinition.
static class	Base64PropertyFormat.Heaplet	Assocated Base64PropertyFormat heaplet.

Field Summary

Fields inherited from interface org.forgerock.secrets.SecretDecoder

RAW

Fields inherited from interface org.forgerock.secrets.propertyresolver.SecretPropertyFormat

PLAIN

Constructor Summary

Constructors

Constructor	Description
Base64PropertyFormat()

Method Summary

Modifier and Type	Method	Description
SecretBuilder	decode(String value)	Decodes the input property value, setting relevant properties on a SecretBuilder object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.forgerock.secrets.propertyresolver.SecretPropertyFormat

decodeToPromise, decodeToPromise

Constructor Details

Base64PropertyFormat

public Base64PropertyFormat()

Method Details

decode

public SecretBuilder decode(String value)
                     throws NoSuchSecretException

Description copied from interface: SecretPropertyFormat

Decodes the input property value, setting relevant properties on a SecretBuilder object.

Specified by:

decode in interface SecretPropertyFormat

Parameters:

value - 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.