org.springframework.vault.repository.query

Class VaultQuery

java.lang.Object

org.springframework.vault.repository.query.VaultQuery

public class VaultQuery
extends Object

Vault query consisting of a single Predicate. A new (empty) query evaluates unconditionally to true and can be composed using and(VaultQuery) and or(VaultQuery).

A query can express predicates only against the Id field of a SecretDocument.

Since:

2.0

Author:

Mark Paluch

Constructor Summary

Constructors

Constructor and Description
VaultQuery() Create a new VaultQuery that evaluates unconditionally to true.
VaultQuery(Predicate<String> predicate) Create a new VaultQuery given Predicate.

Method Summary

Modifier and Type	Method and Description
VaultQuery	and(Predicate<String> predicate) Compose a new VaultQuery using predicates of this and the other query using logical AND.
VaultQuery	and(VaultQuery other) Compose a new VaultQuery using predicates of this and the other query using logical AND.
Predicate<String>	getPredicate()
VaultQuery	or(VaultQuery other) Compose a new VaultQuery using predicates of this and the other query using logical OR.
boolean	test(SecretDocument document) Evaluate the query against a SecretDocument.
boolean	test(String id) Evaluate the query against a String.

Methods inherited from class java.lang.Object

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

Constructor Detail

VaultQuery

public VaultQuery()

Create a new VaultQuery that evaluates unconditionally to true.

VaultQuery

public VaultQuery(Predicate<String> predicate)

Create a new VaultQuery given Predicate.

Parameters:

predicate - must not be null.

Method Detail

test

public boolean test(SecretDocument document)

Evaluate the query against a SecretDocument.

Parameters:

document - must not be null.

Returns:

true if the predicate matches, false otherwise.

test

public boolean test(String id)

Evaluate the query against a String.

Parameters:

id - must not be null.

Returns:

true if the predicate matches, false otherwise.

and

public VaultQuery and(VaultQuery other)

Compose a new VaultQuery using predicates of this and the other query using logical AND.

Parameters:

other - must not be null.

Returns:

a new composed VaultQuery.

See Also:

Predicate.and(Predicate)

and

public VaultQuery and(Predicate<String> predicate)

Compose a new VaultQuery using predicates of this and the other query using logical AND.

Parameters:

predicate - must not be null.

Returns:

a new composed VaultQuery.

See Also:

Predicate.and(Predicate)

or

public VaultQuery or(VaultQuery other)

Compose a new VaultQuery using predicates of this and the other query using logical OR.

Parameters:

other - must not be null.

Returns:

a new composed VaultQuery.

See Also:

Predicate.and(Predicate)

getPredicate

public Predicate<String> getPredicate()

Returns:

the underlying predicate.