org.springframework.credhub.support

Enum WriteMode

java.lang.Object

java.lang.Enum<WriteMode>

org.springframework.credhub.support.WriteMode

All Implemented Interfaces:

Serializable, Comparable<WriteMode>

public enum WriteMode
extends Enum<WriteMode>

The acceptable values for the mode parameter on a set or generate request, indicating the action CredHub should take when the credential being set or generated already exists.

Author:

Scott Frederick

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONVERGE Indicates that CredHub should replace any existing credential value with a new value only if generation parameters are different from the original generation parameters.
NO_OVERWRITE Indicates that CredHub should not replace the value of a credential if the credential exists.
OVERWRITE Indicates that CredHub should replace any existing credential value with a new value.

Method Summary

Modifier and Type	Method and Description
String	getMode() Get the mode value as a String.
String	toString()
static WriteMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static WriteMode[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NO_OVERWRITE

public static final WriteMode NO_OVERWRITE

Indicates that CredHub should not replace the value of a credential if the credential exists.

OVERWRITE

public static final WriteMode OVERWRITE

Indicates that CredHub should replace any existing credential value with a new value.

CONVERGE

public static final WriteMode CONVERGE

Indicates that CredHub should replace any existing credential value with a new value only if generation parameters are different from the original generation parameters.

Method Detail

values

public static WriteMode[] 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 (WriteMode c : WriteMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static WriteMode 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

getMode

public String getMode()

Get the mode value as a String.

Returns:

the mode value

toString

public String toString()

Overrides:

toString in class Enum<WriteMode>