Package io.quarkus.vault.runtime
Class VaultSystemBackendManager
- java.lang.Object
-
- io.quarkus.vault.runtime.VaultSystemBackendManager
-
- All Implemented Interfaces:
VaultSystemBackendReactiveEngine
@ApplicationScoped public class VaultSystemBackendManager extends Object implements VaultSystemBackendReactiveEngine
-
-
Constructor Summary
Constructors Constructor Description VaultSystemBackendManager()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description io.smallrye.mutiny.Uni<Void>createUpdatePolicy(String name, String policy)Create or update a policy.io.smallrye.mutiny.Uni<Void>deletePolicy(String name)Delete a policy by its name.io.smallrye.mutiny.Uni<Void>disable(String mount)Disables the engine at a specific mount.io.smallrye.mutiny.Uni<Void>enable(VaultSecretEngine engine, String mount, String description, EnableEngineOptions options)Enables a secret engine at a specific mount.io.smallrye.mutiny.Uni<Void>enable(String engineType, String mount, String description, EnableEngineOptions options)Enables a secret engine at a specific mount.io.smallrye.mutiny.Uni<List<String>>getPolicies()List existing policies.io.smallrye.mutiny.Uni<String>getPolicyRules(String name)Get the rules for the named policy.io.smallrye.mutiny.Uni<VaultSecretEngineInfo>getSecretEngineInfo(String mount)Get the info for a secret engine, including its type.io.smallrye.mutiny.Uni<VaultTuneInfo>getTuneInfo(String mount)Get the tune info for a secret engine at a specific mount.io.smallrye.mutiny.Uni<VaultHealth>health()Check the health status of Vault.io.smallrye.mutiny.Uni<VaultHealthStatus>healthStatus()Check and return the health status of Vault.io.smallrye.mutiny.Uni<VaultInit>init(int secretShares, int secretThreshold)Initializes a new Vault.io.smallrye.mutiny.Uni<Boolean>isEngineMounted(String mount)Check if an engine is mounted at a specific mount.io.smallrye.mutiny.Uni<VaultSealStatus>sealStatus()Check the seal status of a Vault.io.smallrye.mutiny.Uni<Void>updateTuneInfo(String mount, VaultTuneInfo tuneInfoUpdates)Update the tune info for a secret engine at a specific mount.
-
-
-
Method Detail
-
init
public io.smallrye.mutiny.Uni<VaultInit> init(int secretShares, int secretThreshold)
Description copied from interface:VaultSystemBackendReactiveEngineInitializes a new Vault.- Specified by:
initin interfaceVaultSystemBackendReactiveEngine- 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 io.smallrye.mutiny.Uni<VaultHealth> health()
Description copied from interface:VaultSystemBackendReactiveEngineCheck the health status of Vault. Returns Vault health status code only by using HTTP HEAD requests. It is faster than callinghealthStatus()method which uses HTTP GET to return a complete VaultHealthStatus state.- Specified by:
healthin interfaceVaultSystemBackendReactiveEngine- Returns:
- Vault Health Status.
-
healthStatus
public io.smallrye.mutiny.Uni<VaultHealthStatus> healthStatus()
Description copied from interface:VaultSystemBackendReactiveEngineCheck and return the health status of Vault. Returns a complete VaultHealthStatus state. This method uses HTTP GET to return a complete state.- Specified by:
healthStatusin interfaceVaultSystemBackendReactiveEngine- Returns:
- Complete Vault Health Status.
-
sealStatus
public io.smallrye.mutiny.Uni<VaultSealStatus> sealStatus()
Description copied from interface:VaultSystemBackendReactiveEngineCheck the seal status of a Vault.- Specified by:
sealStatusin interfaceVaultSystemBackendReactiveEngine- Returns:
- Vault Seal Status.
-
getPolicyRules
public io.smallrye.mutiny.Uni<String> getPolicyRules(String name)
Description copied from interface:VaultSystemBackendReactiveEngineGet the rules for the named policy.- Specified by:
getPolicyRulesin interfaceVaultSystemBackendReactiveEngine- Parameters:
name- of the policy- Returns:
- rules of named policy
-
createUpdatePolicy
public io.smallrye.mutiny.Uni<Void> createUpdatePolicy(String name, String policy)
Description copied from interface:VaultSystemBackendReactiveEngineCreate or update a policy.- Specified by:
createUpdatePolicyin interfaceVaultSystemBackendReactiveEngine- Parameters:
name- policy namepolicy- policy content
-
deletePolicy
public io.smallrye.mutiny.Uni<Void> deletePolicy(String name)
Description copied from interface:VaultSystemBackendReactiveEngineDelete a policy by its name.- Specified by:
deletePolicyin interfaceVaultSystemBackendReactiveEngine- Parameters:
name- policy name
-
getPolicies
public io.smallrye.mutiny.Uni<List<String>> getPolicies()
Description copied from interface:VaultSystemBackendReactiveEngineList existing policies.- Specified by:
getPoliciesin interfaceVaultSystemBackendReactiveEngine- Returns:
- a list of all policy names
-
getSecretEngineInfo
public io.smallrye.mutiny.Uni<VaultSecretEngineInfo> getSecretEngineInfo(String mount)
Description copied from interface:VaultSystemBackendReactiveEngineGet the info for a secret engine, including its type.- Specified by:
getSecretEngineInfoin interfaceVaultSystemBackendReactiveEngine- Parameters:
mount- Name of the secret engine- Returns:
- current secret engine info
-
getTuneInfo
public io.smallrye.mutiny.Uni<VaultTuneInfo> getTuneInfo(String mount)
Description copied from interface:VaultSystemBackendReactiveEngineGet the tune info for a secret engine at a specific mount.- Specified by:
getTuneInfoin interfaceVaultSystemBackendReactiveEngine- Parameters:
mount- Name of the mount- Returns:
- current tune info
-
updateTuneInfo
public io.smallrye.mutiny.Uni<Void> updateTuneInfo(String mount, VaultTuneInfo tuneInfoUpdates)
Description copied from interface:VaultSystemBackendReactiveEngineUpdate the tune info for a secret engine at a specific mount.- Specified by:
updateTuneInfoin interfaceVaultSystemBackendReactiveEngine- Parameters:
mount- Name of the mounttuneInfoUpdates- Tune info with fields to update
-
isEngineMounted
public io.smallrye.mutiny.Uni<Boolean> isEngineMounted(String mount)
Description copied from interface:VaultSystemBackendReactiveEngineCheck if an engine is mounted at a specific mount.- Specified by:
isEngineMountedin interfaceVaultSystemBackendReactiveEngine- Parameters:
mount- Name of the mount- Returns:
- True if an engine is mounted, false otherwise
-
enable
public io.smallrye.mutiny.Uni<Void> enable(VaultSecretEngine engine, String mount, String description, EnableEngineOptions options)
Description copied from interface:VaultSystemBackendReactiveEngineEnables a secret engine at a specific mount.- Specified by:
enablein interfaceVaultSystemBackendReactiveEngine- Parameters:
engine- Type of engine to mount.mount- Engine mount path.description- Human friendly description of mount point.options- Engine options.
-
enable
public io.smallrye.mutiny.Uni<Void> enable(String engineType, String mount, String description, EnableEngineOptions options)
Description copied from interface:VaultSystemBackendReactiveEngineEnables a secret engine at a specific mount.- Specified by:
enablein interfaceVaultSystemBackendReactiveEngine- Parameters:
engineType- Type of engine to mount.mount- Engine mount path.description- Human friendly description of mount point.options- Engine options.
-
disable
public io.smallrye.mutiny.Uni<Void> disable(String mount)
Description copied from interface:VaultSystemBackendReactiveEngineDisables the engine at a specific mount.- Specified by:
disablein interfaceVaultSystemBackendReactiveEngine- Parameters:
mount- Engine mount path.
-
-