Package org.springframework.vault.core

Class VaultSysTemplate

java.lang.Object

org.springframework.vault.core.VaultSysTemplate

All Implemented Interfaces:

VaultSysOperations

public class VaultSysTemplate
extends Object
implements VaultSysOperations

Default implementation of VaultSysOperations.

Author:

Mark Paluch

Constructor Summary

Constructors

Constructor	Description
VaultSysTemplate(VaultOperations vaultOperations)	Create a new VaultSysTemplate with the given VaultOperations.

Method Summary

Modifier and Type	Method	Description
void	authMount(String path, VaultMount vaultMount)	Mounts an auth backend VaultMount to path.
void	authUnmount(String path)	Unmounts the auth backend mount at path.
void	createOrUpdatePolicy(String name, Policy policy)	Create or update a Policy.
void	deletePolicy(String name)	Delete a Policy by its name.
Map<String,VaultMount>	getAuthMounts()
Map<String,VaultMount>	getMounts()
Policy	getPolicy(String name)	Read a Policy by its name.
List<String>	getPolicyNames()	Lists policy names stored in Vault.
VaultUnsealStatus	getUnsealStatus()
VaultHealth	health()	Return the health status of Vault.
VaultInitializationResponse	initialize(VaultInitializationRequest vaultInitializationRequest)	Initialize Vault with a VaultInitializationRequest.
boolean	isInitialized()
void	mount(String path, VaultMount vaultMount)	Mounts a secret backend VaultMount to path.
void	seal()	Seal vault.
void	unmount(String path)	Unmounts the secret backend mount at path.
VaultUnsealStatus	unseal(String keyShare)	Unseal vault.

Methods inherited from class java.lang.Object

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

Constructor Details

VaultSysTemplate

public VaultSysTemplate(VaultOperations vaultOperations)

Create a new VaultSysTemplate with the given VaultOperations.

Parameters:

vaultOperations - must not be null.

Method Details

isInitialized

public boolean isInitialized()

Specified by:

isInitialized in interface VaultSysOperations

Returns:

true if Vault is initialized.

See Also:

• GET /sys/init

initialize

public VaultInitializationResponse initialize(VaultInitializationRequest vaultInitializationRequest)

Description copied from interface: VaultSysOperations

Initialize Vault with a VaultInitializationRequest.

Specified by:

initialize in interface VaultSysOperations

Parameters:

vaultInitializationRequest - must not be null.

Returns:

the VaultInitializationResponse.

See Also:

• PUT /sys/init

seal

public void seal()

Description copied from interface: VaultSysOperations

Seal vault.

Specified by:

seal in interface VaultSysOperations

See Also:

• PUT /sys/seal

unseal

public VaultUnsealStatus unseal(String keyShare)

Description copied from interface: VaultSysOperations

Unseal vault. See VaultUnsealStatus.getProgress() for progress.

Specified by:

unseal in interface VaultSysOperations

Parameters:

keyShare - must not be empty and not null.

Returns:

the VaultUnsealStatus.

See Also:

• PUT /sys/unseal

getUnsealStatus

public VaultUnsealStatus getUnsealStatus()

Specified by:

getUnsealStatus in interface VaultSysOperations

Returns:

the VaultUnsealStatus.

See Also:

• GET /sys/unseal

mount

public void mount(String path,
 VaultMount vaultMount)

Description copied from interface: VaultSysOperations

Mounts a secret backend VaultMount to path.

Specified by:

mount in interface VaultSysOperations

Parameters:

path - must not be empty or null.

vaultMount - must not be null.

See Also:

• POST /sys/mounts/{mount}

getMounts

public Map<String,VaultMount> getMounts()

Specified by:

getMounts in interface VaultSysOperations

Returns:

Map of all secret backend mounts.

See Also:

• GET /sys/mounts/

unmount

public void unmount(String path)

Description copied from interface: VaultSysOperations

Unmounts the secret backend mount at path.

Specified by:

unmount in interface VaultSysOperations

Parameters:

path - must not be empty or null.

See Also:

• DELETE /sys/mounts/{mount}

authMount

public void authMount(String path,
 VaultMount vaultMount)
               throws VaultException

Description copied from interface: VaultSysOperations

Mounts an auth backend VaultMount to path.

Specified by:

authMount in interface VaultSysOperations

Parameters:

path - must not be empty or null.

vaultMount - must not be null.

Throws:

VaultException

See Also:

• POST /sys/auth/{mount}

getAuthMounts

public Map<String,VaultMount> getAuthMounts()
                                     throws VaultException

Specified by:

getAuthMounts in interface VaultSysOperations

Returns:

Map of all auth backend mounts.

Throws:

VaultException

See Also:

• GET /sys/auth/

authUnmount

public void authUnmount(String path)
                 throws VaultException

Description copied from interface: VaultSysOperations

Unmounts the auth backend mount at path.

Specified by:

authUnmount in interface VaultSysOperations

Parameters:

path - must not be empty or null.

Throws:

VaultException

See Also:

• DELETE /sys/auth/{mount}

getPolicyNames

public List<String> getPolicyNames()
                            throws VaultException

Description copied from interface: VaultSysOperations

Lists policy names stored in Vault.

Specified by:

getPolicyNames in interface VaultSysOperations

Returns:

policy names.

Throws:

VaultException

See Also:

• GET /sys/policy/

getPolicy

@Nullable
public Policy getPolicy(String name)
                 throws VaultException

Description copied from interface: VaultSysOperations

Read a Policy by its name. Policies are either represented as HCL (HashiCorp configuration language) or JSON. Retrieving policies is only possible if the policy is represented as JSON.

Specified by:

getPolicy in interface VaultSysOperations

Returns:

the Policy or null, if the policy was not found.

Throws:

VaultException

See Also:

• GET /sys/policy/{name}

createOrUpdatePolicy

public void createOrUpdatePolicy(String name,
 Policy policy)
                          throws VaultException

Description copied from interface: VaultSysOperations

Create or update a Policy.

Specified by:

createOrUpdatePolicy in interface VaultSysOperations

Parameters:

name - the policy name, must not be null or empty.

Throws:

VaultException

See Also:

• PUT /sys/policy/{name}

deletePolicy

public void deletePolicy(String name)
                  throws VaultException

Description copied from interface: VaultSysOperations

Delete a Policy by its name.

Specified by:

deletePolicy in interface VaultSysOperations

Parameters:

name - the policy name, must not be null or empty.

Throws:

VaultException

See Also:

• DELETE /sys/policy/{name}

health

public VaultHealth health()

Description copied from interface: VaultSysOperations

Return the health status of Vault.

Specified by:

health in interface VaultSysOperations

Returns:

the VaultHealth.

See Also:

• GET /sys/health