Package io.quarkus.vault
Interface VaultSystemBackendReactiveEngine
-
- All Known Implementing Classes:
VaultSystemBackendManager
public interface VaultSystemBackendReactiveEngineThis service provides access to the system backend.- See Also:
VaultRuntimeConfig
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description io.smallrye.mutiny.Uni<Void>createUpdatePolicy(String name, String rules)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 tuneInfo)Update the tune info for a secret engine at a specific mount.
-
-
-
Method Detail
-
init
io.smallrye.mutiny.Uni<VaultInit> init(int secretShares, int secretThreshold)
Initializes a new Vault.- 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
io.smallrye.mutiny.Uni<VaultHealth> health()
Check 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.- Returns:
- Vault Health Status.
-
healthStatus
io.smallrye.mutiny.Uni<VaultHealthStatus> healthStatus()
Check and return the health status of Vault. Returns a complete VaultHealthStatus state. This method uses HTTP GET to return a complete state.- Returns:
- Complete Vault Health Status.
-
sealStatus
io.smallrye.mutiny.Uni<VaultSealStatus> sealStatus()
Check the seal status of a Vault.- Returns:
- Vault Seal Status.
-
getPolicyRules
io.smallrye.mutiny.Uni<String> getPolicyRules(String name)
Get the rules for the named policy.- Parameters:
name- of the policy- Returns:
- rules of named policy
-
createUpdatePolicy
io.smallrye.mutiny.Uni<Void> createUpdatePolicy(String name, String rules)
Create or update a policy.- Parameters:
name- policy namerules- policy content
-
deletePolicy
io.smallrye.mutiny.Uni<Void> deletePolicy(String name)
Delete a policy by its name.- Parameters:
name- policy name
-
getPolicies
io.smallrye.mutiny.Uni<List<String>> getPolicies()
List existing policies.- Returns:
- a list of all policy names
-
getSecretEngineInfo
io.smallrye.mutiny.Uni<VaultSecretEngineInfo> getSecretEngineInfo(String mount)
Get the info for a secret engine, including its type.- Parameters:
mount- Name of the secret engine- Returns:
- current secret engine info
- Since:
- Vault 1.10.0
-
getTuneInfo
io.smallrye.mutiny.Uni<VaultTuneInfo> getTuneInfo(String mount)
Get the tune info for a secret engine at a specific mount.- Parameters:
mount- Name of the mount- Returns:
- current tune info
-
updateTuneInfo
io.smallrye.mutiny.Uni<Void> updateTuneInfo(String mount, VaultTuneInfo tuneInfo)
Update the tune info for a secret engine at a specific mount.- Parameters:
mount- Name of the mounttuneInfo- Tune info with fields to update
-
isEngineMounted
io.smallrye.mutiny.Uni<Boolean> isEngineMounted(String mount)
Check if an engine is mounted at a specific mount.- Parameters:
mount- Name of the mount- Returns:
- True if an engine is mounted, false otherwise
-
enable
io.smallrye.mutiny.Uni<Void> enable(VaultSecretEngine engine, String mount, String description, EnableEngineOptions options)
Enables a secret engine at a specific mount.- Parameters:
engine- Type of engine to mount.mount- Engine mount path.description- Human friendly description of mount point.options- Engine options.
-
enable
io.smallrye.mutiny.Uni<Void> enable(String engineType, String mount, String description, EnableEngineOptions options)
Enables a secret engine at a specific mount.- Parameters:
engineType- Type of engine to mount.mount- Engine mount path.description- Human friendly description of mount point.options- Engine options.
-
-