PropertyFormat (Microservice Token Validation Doc 1.0.2-SNAPSHOT Documentation)

java.lang.Object
- java.lang.Enum<PropertyFormat>
- - org.forgerock.openig.secrets.PropertyFormat

All Implemented Interfaces:

Serializable, Comparable<PropertyFormat>, SecretPropertyFormat
```
public enum PropertyFormat
extends Enum<PropertyFormat>
implements SecretPropertyFormat
```
Supported property formats for secrets exposed in unsecure context, such as file-based and system/environment variables.

Enum Constant Summary

Enum Constants
Enum Constant Description

BASE64
A base64-encoded binary value.

PLAIN
A plain text value.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static PropertyFormat`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static PropertyFormat[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.forgerock.secrets.propertyresolver.SecretPropertyFormat
decode, decodeToPromise

- Enum Constant Detail
  - PLAIN
```
public static final PropertyFormat PLAIN
```
    A plain text value. The UTF-8 bytes of the value are used as the secret.
  - BASE64
```
public static final PropertyFormat BASE64
```
    A base64-encoded binary value.
- Method Detail
  - values
```
public static PropertyFormat[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
    for (PropertyFormat c : PropertyFormat.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static PropertyFormat valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null