com.bettercloud.vault.api

Class Logical

java.lang.Object

com.bettercloud.vault.api.Logical

public class Logical
extends java.lang.Object

The implementing class for Vault's core/logical operations (e.g. read, write).

This class is not intended to be constructed directly. Rather, it is meant to used by way of Vault in a DSL-style builder pattern. See the Javadoc comments of each public method for usage examples.

Constructor Summary

Constructors

Constructor and Description
Logical(VaultConfig config)

Method Summary

Modifier and Type	Method and Description
LogicalResponse	read(java.lang.String path) Basic read operation to retrieve a secret.
LogicalResponse	write(java.lang.String path, java.util.Map<java.lang.String,java.lang.String> nameValuePairs) Basic operation to store secrets.

Methods inherited from class java.lang.Object

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

Constructor Detail

Logical

public Logical(VaultConfig config)

Method Detail

read

public LogicalResponse read(java.lang.String path)
                     throws VaultException

Basic read operation to retrieve a secret. A single secret key can map to multiple name-value pairs, which can be retrieved from the response object. E.g.:

 final LogicalResponse response = vault.logical().read("secret/hello");

 final String value = response.getData().get("value");
 final String otherValue = response.getData().get("other_value");
 

Parameters:

path - The Vault key value from which to read (e.g. secret/hello)

Returns:

Throws:

VaultException - If any errors occurs with the REST request (e.g. non-200 status code, invalid JSON payload, etc), and the maximum number of retries is exceeded.

write

public LogicalResponse write(java.lang.String path,
                             java.util.Map<java.lang.String,java.lang.String> nameValuePairs)
                      throws VaultException

Basic operation to store secrets. Multiple name value pairs can be stored under the same secret key. E.g.:

 final Map<String, String> nameValuePairs = new HashMap<String, String>();
 nameValuePairs.put("value", "foo");
 nameValuePairs.put("other_value", "bar");

 final LogicalResponse response = vault.logical().write("secret/hello", nameValuePairs);
 

Parameters:

path - The Vault key value to which to write (e.g. secret/hello)

nameValuePairs - Secret name and value pairs to store under this Vault key

Throws:

VaultException