org.springframework.vault.support

Class Policy

java.lang.Object

org.springframework.vault.support.Policy

public class Policy
extends Object

Value object representing a Vault policy associated with Policy.Rules. Instances of Policy support JSON serialization and deserialization using Jackson.

Since:

2.0

Author:

Mark Paluch

See Also:

Policy.Rule, ObjectMapper

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Policy.BuiltinCapabilities Built-in Vault capabilities.
static interface	Policy.Capability Capability interface representing capability literals.
static class	Policy.Rule Value object representing a rule for a certain path.

Method Summary

Modifier and Type	Method and Description
static Policy	empty() Create an empty Policy without rules.
Policy.Rule	getRule(String path) Lookup a Policy.Rule by its path.
Set<Policy.Rule>	getRules()
static Policy	of(Policy.Rule... rules) Create a Policy from one or more rules.
static Policy	of(Set<Policy.Rule> rules) Create a Policy from one or more rules.
Policy	with(Policy.Rule rule) Create a new Policy object containing all configured rules and add the given Policy.Rule to the new policy object.

Methods inherited from class java.lang.Object

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

Method Detail

empty

public static Policy empty()

Create an empty Policy without rules.

Returns:

an empty Policy.

of

public static Policy of(Policy.Rule... rules)

Create a Policy from one or more rules.

Parameters:

rules - must not be null.

Returns:

the Policy object containing rules.

of

public static Policy of(Set<Policy.Rule> rules)

Create a Policy from one or more rules.

Parameters:

rules - must not be null.

Returns:

the Policy object containing rules.

with

public Policy with(Policy.Rule rule)

Create a new Policy object containing all configured rules and add the given Policy.Rule to the new policy object. If the given Policy.Rule matches an existing rule path, the exiting rule will be overridden by the new rule object.

Parameters:

rule - must not be null.

Returns:

the new Policy object containing all configured rules and the given Policy.Rule.

getRules

public Set<Policy.Rule> getRules()

getRule

@Nullable
public Policy.Rule getRule(String path)

Lookup a Policy.Rule by its path. Returns null if the rule was not found.

Parameters:

path - must not be null.

Returns:

the Policy.Rule or null, if not found.