Package org.springframework.vault.support

Class VaultMount

java.lang.Object

org.springframework.vault.support.VaultMount

public class VaultMount
extends Object

Value object to bind Vault HTTP Mount API requests/responses.

A VaultMount represents an auth or secret mount with its config details. Instances of this class are immutable once constructed.

Author:

Mark Paluch, Maciej Drozdzowski

See Also:

• builder()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VaultMount.VaultMountBuilder	Builder to build a VaultMount.

Method Summary

Modifier and Type	Method	Description
static VaultMount.VaultMountBuilder	builder()
static VaultMount	create(String type)	Create a new VaultMount given a type.
@Nullable Map<String,Object>	getConfig()
@Nullable String	getDescription()
@Nullable Map<String,String>	getOptions()
String	getType()

Methods inherited from class java.lang.Object

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

Method Details

create

public static VaultMount create(String type)

Create a new VaultMount given a type.

Parameters:

type - backend type, must not be empty or null.

Returns:

the created VaultMount.

builder

public static VaultMount.VaultMountBuilder builder()

Returns:

a new VaultMount.VaultMountBuilder.

getType

public String getType()

Returns:

the backend type.

getDescription

public @Nullable String getDescription()

Returns:

human readable description of this mount.

getConfig

public @Nullable Map<String,Object> getConfig()

Returns:

additional configuration details.

getOptions

public @Nullable Map<String,String> getOptions()

Returns:

mount type specific options.

Since:

2.2