Package io.quarkus.vault.runtime

Class VaultSystemBackendManager

java.lang.Object

io.quarkus.vault.runtime.VaultSystemBackendManager

All Implemented Interfaces:

VaultSystemBackendEngine

@ApplicationScoped
public class VaultSystemBackendManager
extends Object
implements VaultSystemBackendEngine

Constructor Summary

Constructors

Constructor	Description
VaultSystemBackendManager()

Method Summary

Modifier and Type	Method	Description
void	createUpdatePolicy(String name, String policy)	Create or update a policy.
void	deletePolicy(String name)	Delete a policy by its name.
void	disable(String mount)	Disables the engine at a specific mount.
void	enable(VaultSecretEngine engine, String mount, String description, EnableEngineOptions options)	Enables a secret engine at a specific mount.
void	enable(String engineType, String mount, String description, EnableEngineOptions options)	Enables a secret engine at a specific mount.
List<String>	getPolicies()	List existing policies.
String	getPolicyRules(String name)	Get the rules for the named policy.
VaultTuneInfo	getTuneInfo(String mount)	Get the tune info for a secret engine at a specific mount.
VaultHealth	health()	Check the health status of Vault.
VaultHealthStatus	healthStatus()	Check and return the health status of Vault.
VaultInit	init(int secretShares, int secretThreshold)	Initializes a new Vault.
boolean	isEngineMounted(String mount)	Check if an engine is mounted at a specific mount.
VaultSealStatus	sealStatus()	Check the seal status of a Vault.
void	updateTuneInfo(String mount, VaultTuneInfo tuneInfoUpdates)	Update the tune info for a secret engine at a specific mount.

Methods inherited from class java.lang.Object

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

Constructor Detail

VaultSystemBackendManager

public VaultSystemBackendManager()

Method Detail

init

public VaultInit init(int secretShares,
                      int secretThreshold)

Description copied from interface: VaultSystemBackendEngine

Initializes a new Vault.

Specified by:

init in interface VaultSystemBackendEngine

Parameters:

secretShares - specifies the number of shares to split the master key into.

secretThreshold - specifies the number of shares required to reconstruct the master key.

Returns:

Vault Init.

health

public VaultHealth health()

Description copied from interface: VaultSystemBackendEngine

Check the health status of Vault. Returns Vault health status code only by using HTTP HEAD requests. It is faster than calling healthStatus() method which uses HTTP GET to return a complete VaultHealthStatus state.

Specified by:

health in interface VaultSystemBackendEngine

Returns:

Vault Health Status.

healthStatus

public VaultHealthStatus healthStatus()

Description copied from interface: VaultSystemBackendEngine

Check and return the health status of Vault. Returns a complete VaultHealthStatus state. This method uses HTTP GET to return a complete state.

Specified by:

healthStatus in interface VaultSystemBackendEngine

Returns:

Complete Vault Health Status.

sealStatus

public VaultSealStatus sealStatus()

Description copied from interface: VaultSystemBackendEngine

Check the seal status of a Vault.

Specified by:

sealStatus in interface VaultSystemBackendEngine

Returns:

Vault Seal Status.

getPolicyRules

public String getPolicyRules(String name)

Description copied from interface: VaultSystemBackendEngine

Get the rules for the named policy.

Specified by:

getPolicyRules in interface VaultSystemBackendEngine

Parameters:

name - of the policy

Returns:

rules of named policy

createUpdatePolicy

public void createUpdatePolicy(String name,
                               String policy)

Description copied from interface: VaultSystemBackendEngine

Create or update a policy.

Specified by:

createUpdatePolicy in interface VaultSystemBackendEngine

Parameters:

name - policy name

policy - policy content

deletePolicy

public void deletePolicy(String name)

Description copied from interface: VaultSystemBackendEngine

Delete a policy by its name.

Specified by:

deletePolicy in interface VaultSystemBackendEngine

Parameters:

name - policy name

getPolicies

public List<String> getPolicies()

Description copied from interface: VaultSystemBackendEngine

List existing policies.

Specified by:

getPolicies in interface VaultSystemBackendEngine

Returns:

a list of all policy names

getTuneInfo

public VaultTuneInfo getTuneInfo(String mount)

Description copied from interface: VaultSystemBackendEngine

Get the tune info for a secret engine at a specific mount.

Specified by:

getTuneInfo in interface VaultSystemBackendEngine

Parameters:

mount - Name of the mount

Returns:

current tune info

updateTuneInfo

public void updateTuneInfo(String mount,
                           VaultTuneInfo tuneInfoUpdates)

Description copied from interface: VaultSystemBackendEngine

Update the tune info for a secret engine at a specific mount.

Specified by:

updateTuneInfo in interface VaultSystemBackendEngine

Parameters:

mount - Name of the mount

tuneInfoUpdates - Tune info with fields to update

isEngineMounted

public boolean isEngineMounted(String mount)

Description copied from interface: VaultSystemBackendEngine

Check if an engine is mounted at a specific mount.

Specified by:

isEngineMounted in interface VaultSystemBackendEngine

Parameters:

mount - Name of the mount

Returns:

True if an engine is mounted, false otherwise

enable

public void enable(VaultSecretEngine engine,
                   String mount,
                   String description,
                   EnableEngineOptions options)

Description copied from interface: VaultSystemBackendEngine

Enables a secret engine at a specific mount.

Specified by:

enable in interface VaultSystemBackendEngine

Parameters:

engine - Type of engine to mount.

mount - Engine mount path.

description - Human friendly description of mount point.

options - Engine options.

enable

public void enable(String engineType,
                   String mount,
                   String description,
                   EnableEngineOptions options)

Description copied from interface: VaultSystemBackendEngine

Enables a secret engine at a specific mount.

Specified by:

enable in interface VaultSystemBackendEngine

Parameters:

engineType - Type of engine to mount.

mount - Engine mount path.

description - Human friendly description of mount point.

options - Engine options.

disable

public void disable(String mount)

Description copied from interface: VaultSystemBackendEngine

Disables the engine at a specific mount.

Specified by:

disable in interface VaultSystemBackendEngine

Parameters:

mount - Engine mount path.