org.springframework.vault.support

Enum Policy.BuiltinCapabilities

java.lang.Object

java.lang.Enum<Policy.BuiltinCapabilities>

org.springframework.vault.support.Policy.BuiltinCapabilities

All Implemented Interfaces:

Serializable, Comparable<Policy.BuiltinCapabilities>, Policy.Capability

Enclosing class:

Policy

public static enum Policy.BuiltinCapabilities
extends Enum<Policy.BuiltinCapabilities>
implements Policy.Capability

Built-in Vault capabilities.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CREATE Allows creating data at the given path.
DELETE Allows deleting the data at the given path.
DENY Disallows access.
LIST Allows listing values at the given path.
READ Allows reading the data at the given path.
SUDO Allows access to paths that are root-protected.
UPDATE Allows change the data at the given path.
WRITE Deprecated. since 2.3 and Vault 0.5.

Method Summary

Modifier and Type	Method and Description
static List<Policy.Capability>	crud() Return all capabilities (CREATE,READ,UPDATE, DELETE, LIST) for regular CRUD operations.
static List<Policy.Capability>	crudAndSudo() Return all capabilities (CREATE,READ,UPDATE, DELETE, LIST) for regular CRUD operations including SUDO.
static Policy.Capability	find(String value) Find a Policy.Capability by its name.
static Policy.BuiltinCapabilities	valueOf(String name) Returns the enum constant of this type with the specified name.
static Policy.BuiltinCapabilities[]	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.springframework.vault.support.Policy.Capability

name

Enum Constant Detail

CREATE

public static final Policy.BuiltinCapabilities CREATE

Allows creating data at the given path. Very few parts of Vault distinguish between create and update, so most operations require both create and update capabilities.

READ

public static final Policy.BuiltinCapabilities READ

Allows reading the data at the given path.

UPDATE

public static final Policy.BuiltinCapabilities UPDATE

Allows change the data at the given path. In most parts of Vault, this implicitly includes the ability to create the initial value at the path.

WRITE

@Deprecated
public static final Policy.BuiltinCapabilities WRITE

Deprecated. since 2.3 and Vault 0.5.

Deprecated: Previous capability literal before it was split into CREATE and UPDATE.

DELETE

public static final Policy.BuiltinCapabilities DELETE

Allows deleting the data at the given path.

LIST

public static final Policy.BuiltinCapabilities LIST

Allows listing values at the given path. Note that the keys returned by a list operation are not filtered by policies. Do not encode sensitive information in key names. Not all backends support listing.

SUDO

public static final Policy.BuiltinCapabilities SUDO

Allows access to paths that are root-protected. Tokens are not permitted to interact with these paths unless they are have the sudo capability (in addition to the other necessary capabilities for performing an operation against that path, such as read or delete).

DENY

public static final Policy.BuiltinCapabilities DENY

Disallows access. This always takes precedence regardless of any other defined capabilities, including SUDO.

Method Detail

values

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

Returns:

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

valueOf

public static Policy.BuiltinCapabilities 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

find

@Nullable
public static Policy.Capability find(String value)

Find a Policy.Capability by its name. The name is compared case-insensitive.

Parameters:

value - must not be null.

Returns:

the Policy.Capability or null, if not found.

crud

public static List<Policy.Capability> crud()

Return all capabilities (CREATE,READ,UPDATE, DELETE, LIST) for regular CRUD operations.

Returns:

all CRUD operations.

Since:

2.3

crudAndSudo

public static List<Policy.Capability> crudAndSudo()

Return all capabilities (CREATE,READ,UPDATE, DELETE, LIST) for regular CRUD operations including SUDO.

Returns:

all CRUD operations including SUDO.

Since:

2.3