Package org.springframework.vault.core

Interface VaultSysOperations

All Known Implementing Classes:

VaultSysTemplate

public interface VaultSysOperations

Interface that specifies a basic set of administrative Vault operations.

Author:

Mark Paluch

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.

Method Details

isInitialized

boolean isInitialized()
               throws VaultException

Returns:

true if Vault is initialized.

Throws:

VaultException

See Also:

• GET /sys/init

initialize

VaultInitializationResponse initialize(VaultInitializationRequest vaultInitializationRequest)
                                throws VaultException

Initialize Vault with a VaultInitializationRequest.

Parameters:

vaultInitializationRequest - must not be null.

Returns:

the VaultInitializationResponse.

Throws:

VaultException

See Also:

• PUT /sys/init

seal

void seal()
   throws VaultException

Seal vault.

Throws:

VaultException

See Also:

• PUT /sys/seal

unseal

VaultUnsealStatus unseal(String keyShare)
                  throws VaultException

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

Parameters:

keyShare - must not be empty and not null.

Returns:

the VaultUnsealStatus.

Throws:

VaultException

See Also:

• PUT /sys/unseal

getUnsealStatus

VaultUnsealStatus getUnsealStatus()
                           throws VaultException

Returns:

the VaultUnsealStatus.

Throws:

VaultException

See Also:

• GET /sys/unseal

mount

void mount(String path,
 VaultMount vaultMount)
    throws VaultException

Mounts a secret backend VaultMount to path.

Parameters:

path - must not be empty or null.

vaultMount - must not be null.

Throws:

VaultException

See Also:

• POST /sys/mounts/{mount}

getMounts

Map<String,VaultMount> getMounts()
                          throws VaultException

Returns:

Map of all secret backend mounts.

Throws:

VaultException

See Also:

• GET /sys/mounts/

unmount

void unmount(String path)
      throws VaultException

Unmounts the secret backend mount at path.

Parameters:

path - must not be empty or null.

Throws:

VaultException

See Also:

• DELETE /sys/mounts/{mount}

authMount

void authMount(String path,
 VaultMount vaultMount)
        throws VaultException

Mounts an auth backend VaultMount to path.

Parameters:

path - must not be empty or null.

vaultMount - must not be null.

Throws:

VaultException

See Also:

• POST /sys/auth/{mount}

getAuthMounts

Map<String,VaultMount> getAuthMounts()
                              throws VaultException

Returns:

Map of all auth backend mounts.

Throws:

VaultException

See Also:

• GET /sys/auth/

authUnmount

void authUnmount(String path)
          throws VaultException

Unmounts the auth backend mount at path.

Parameters:

path - must not be empty or null.

Throws:

VaultException

See Also:

• DELETE /sys/auth/{mount}

getPolicyNames

List<String> getPolicyNames()
                     throws VaultException

Lists policy names stored in Vault.

Returns:

policy names.

Throws:

VaultException

Since:

2.0

See Also:

• GET /sys/policy/

getPolicy

@Nullable
Policy getPolicy(String name)
          throws VaultException

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.

Returns:

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

Throws:

UnsupportedOperationException - if the policy is represented as HCL.

VaultException

Since:

2.0

See Also:

• GET /sys/policy/{name}

createOrUpdatePolicy

void createOrUpdatePolicy(String name,
 Policy policy)
                   throws VaultException

Create or update a Policy.

Parameters:

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

Throws:

VaultException

Since:

2.0

See Also:

• PUT /sys/policy/{name}

deletePolicy

void deletePolicy(String name)
           throws VaultException

Delete a Policy by its name.

Parameters:

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

Throws:

VaultException

Since:

2.0

See Also:

• DELETE /sys/policy/{name}

health

VaultHealth health()
            throws VaultException

Return the health status of Vault.

Returns:

the VaultHealth.

Throws:

VaultException

See Also:

• GET /sys/health