Uses of Class
io.github.jopenlibs.vault.VaultException

Packages that use VaultException

Package	Description
io.github.jopenlibs.vault	The root package containing the primary Vault driver class.
io.github.jopenlibs.vault.api	Classes implementing the various endpoints of the Vault HTTP API.
io.github.jopenlibs.vault.api.database
io.github.jopenlibs.vault.api.pki
io.github.jopenlibs.vault.api.sys	Intended for internal use by other classes within the Vault driver library.
io.github.jopenlibs.vault.api.sys.mounts	Classes implementing Vault's mounts system.
io.github.jopenlibs.vault.response	Containers of data returned by the various Vault API calls.

Uses of VaultException in io.github.jopenlibs.vault

Methods in io.github.jopenlibs.vault that throw VaultException

Modifier and Type	Method	Description
SslConfig	SslConfig.build()	This is the terminating method in the builder pattern.
VaultConfig	VaultConfig.build()	This is the terminating method in the builder pattern.
SslConfig	SslConfig.clientKeyPemFile(File clientKeyPemFile)	An RSA private key, for use with Vault's TLS Certificate auth backend.
SslConfig	SslConfig.clientKeyPemResource(String classpathResource)	An RSA private key, for use with Vault's TLS Certificate auth backend.
SslConfig	SslConfig.clientPemFile(File clientPemFile)	An X.509 client certificate, for use with Vault's TLS Certificate auth backend.
SslConfig	SslConfig.clientPemResource(String classpathResource)	An X.509 certificate, for use with Vault's TLS Certificate auth backend.
static Vault	Vault.create(VaultConfig vaultConfig, Boolean useSecretsEnginePathMap, Integer globalFallbackVersion)	Construct a Vault driver instance with the provided config settings.
SslConfig	SslConfig.keyStoreFile(File keyStoreFile, String password)	A Java keystore, containing a client certificate that's registered with Vault's TLS Certificate auth backend.
SslConfig	SslConfig.keyStoreResource(String classpathResource, String password)	A Java keystore, containing a client certificate that's registered with Vault's TLS Certificate auth backend.
VaultConfig	VaultConfig.nameSpace(String nameSpace)	Optional.
SslConfig	SslConfig.pemFile(File pemFile)	An X.509 certificate, to use when communicating with Vault over HTTPS.
SslConfig	SslConfig.pemResource(String classpathResource)	An X.509 certificate, to use when communicating with Vault over HTTPS.
SslConfig	SslConfig.trustStoreFile(File trustStoreFile)	A Java keystore, containing the X509 certificate used by Vault.
SslConfig	SslConfig.trustStoreResource(String classpathResource)	A Java keystore, containing the X509 certificate used by Vault.

Constructors in io.github.jopenlibs.vault that throw VaultException

Modifier	Constructor	Description
	VaultImpl(VaultConfig vaultConfig, Boolean useSecretsEnginePathMap, Integer globalFallbackVersion)	Construct a Vault driver instance with the provided config settings.

Uses of VaultException in io.github.jopenlibs.vault.api

Methods in io.github.jopenlibs.vault.api that throw VaultException

Modifier and Type	Method	Description
AuthResponse	Auth.createToken(Auth.TokenRequest tokenRequest)	Operation to create an authentication token.
AuthResponse	Auth.createToken(Auth.TokenRequest tokenRequest, String tokenAuthMount)	Operation to create an authentication token.
LogicalResponse	Logical.delete(String path)	Deletes the key/value pair located at the provided path.
LogicalResponse	Logical.delete(String path, int[] versions)	Soft deletes the specified version of the key/value pair located at the provided path.
LogicalResponse	Logical.destroy(String path, int[] versions)	Performs a hard delete of the specified version of the key/value pair located at the provided path.
HealthResponse	Debug.health()	Returns the health status of Vault.
HealthResponse	Debug.health(Boolean standbyOk, Boolean perfstandbyOk, Integer activeCode, Integer standbyCode, Integer drsecondaryCode, Integer performanceStandbyCode, Integer sealedCode, Integer uninitCode)	An overloaded version of Debug.health() that allows for passing one or more optional parameters.
LogicalResponse	Logical.list(String path)	Retrieve a list of keys corresponding to key/value pairs at a given Vault path.
AuthResponse	Auth.loginByAppID(String path, String appId, String userId)	Deprecated.
AuthResponse	Auth.loginByAppRole(String roleId, String secretId)	Basic login operation to authenticate to an app-role backend.
AuthResponse	Auth.loginByAppRole(String path, String roleId, String secretId)	Basic login operation to authenticate to an app-role backend.
AuthResponse	Auth.loginByAwsEc2(String role, String pkcs7, String nonce, String awsAuthMount)	Basic login operation to authenticate to a AWS backend using EC2 authentication.
AuthResponse	Auth.loginByAwsEc2(String role, String identity, String signature, String nonce, String awsAuthMount)	Basic login operation to authenticate to a AWS backend using EC2 authentication.
AuthResponse	Auth.loginByAwsIam(String role, String iamRequestUrl, String iamRequestBody, String iamRequestHeaders, String awsAuthMount)	Basic login operation to authenticate to a AWS backend using IAM authentication.
AuthResponse	Auth.loginByCert()	Basic login operation to authenticate using Vault's TLS Certificate auth backend.
AuthResponse	Auth.loginByCert(String certAuthMount)	Basic login operation to authenticate using Vault's TLS Certificate auth backend.
AuthResponse	Auth.loginByGCP(String role, String jwt)	Basic login operation to authenticate to an GCP backend.
AuthResponse	Auth.loginByGithub(String githubToken)	Basic login operation to authenticate to an github backend.
AuthResponse	Auth.loginByGithub(String githubToken, String githubAuthMount)	Basic login operation to authenticate to an github backend.
AuthResponse	Auth.loginByJwt(String provider, String role, String jwt)	Basic login operation to authenticate to an JWT backend.
AuthResponse	Auth.loginByJwt(String provider, String role, String jwt, String authPath)	Basic login operation to authenticate to an JWT backend with custom authentication path.
AuthResponse	Auth.loginByKubernetes(String role, String jwt)	Basic login operation to authenticate to a kubernetes backend.
AuthResponse	Auth.loginByKubernetes(String role, String jwt, String authPath)	Basic login operation to authenticate to a kubernetes backend with custom path.
AuthResponse	Auth.loginByLDAP(String username, String password)	Basic login operation to authenticate to a LDAP backend.
AuthResponse	Auth.loginByLDAP(String username, String password, String ldapAuthMount)	Basic login operation to authenticate to a LDAP backend.
AuthResponse	Auth.loginByUserPass(String username, String password)	Basic login operation to authenticate to a Username & Password backend.
AuthResponse	Auth.loginByUserPass(String username, String password, String userpassAuthMount)	Basic login operation to authenticate to a Username & Password backend.
LookupResponse	Auth.lookupSelf()	Returns information about the current client token.
LookupResponse	Auth.lookupSelf(String tokenAuthMount)	Returns information about the current client token.
LogicalResponse	Auth.lookupWrap()	Deprecated. This method is deprecated and in future it will be removed
LogicalResponse	Auth.lookupWrap(String wrappedToken)	Deprecated. This method is deprecated and in future it will be removed
LogicalResponse	Auth.lookupWrap(String wrappedToken, boolean inBody)	Deprecated. This method is deprecated and in future it will be removed
LogicalResponse	Logical.read(String path)	Basic read operation to retrieve a secret.
LogicalResponse	Logical.read(String path, Boolean shouldRetry, Integer version)	Basic read operation to retrieve a specified secret version for KV engine version 2.
AuthResponse	Auth.renewSelf()	Renews the lease associated with the calling token.
AuthResponse	Auth.renewSelf(long increment)	Renews the lease associated with the calling token.
AuthResponse	Auth.renewSelf(long increment, String tokenAuthMount)	Renews the lease associated with the calling token.
protected <T> T	OperationsBase.retry(OperationsBase.EndpointOperation<T> op)
void	Auth.revokeSelf()	Revokes current client token.
void	Auth.revokeSelf(String tokenAuthMount)	Revokes current client token.
WrapResponse	Auth.rewrap(String wrappedToken)	Deprecated. This method is deprecated and in future it will be removed
LogicalResponse	Logical.unDelete(String path, int[] versions)	Recovers a soft delete of the specified version of the key/value pair located at the provided path.
UnwrapResponse	Auth.unwrap()	Deprecated. This method is deprecated and in future it will be removed
UnwrapResponse	Auth.unwrap(String wrappedToken)	Deprecated. This method is deprecated and in future it will be removed
UnwrapResponse	Auth.unwrap(String wrappedToken, boolean inBody)	Deprecated. This method is deprecated and in future it will be removed
LogicalResponse	Logical.upgrade(String kvPath)	Performs an upgrade of the secrets engine version of the specified KV store to version 2.
WrapResponse	Auth.wrap(JsonObject jsonObject, int ttlInSec)	Deprecated. This method is deprecated and in future it will be removed
LogicalResponse	Logical.write(String path, Map<String,Object> nameValuePairs)	Basic operation to store secrets.
LogicalResponse	Logical.write(String path, Map<String,Object> nameValuePairs, Integer wrapTTL)	Basic operation to store secrets.
LogicalResponse	Logical.write(String path, Map<String,Object> nameValuePairs, Integer wrapTTL, WriteOptions writeOptions)	Operation to store secrets with the ability to specify additional write options See write for common behavior

Uses of VaultException in io.github.jopenlibs.vault.api.database

Methods in io.github.jopenlibs.vault.api.database that throw VaultException

Modifier and Type	Method	Description
DatabaseResponse	Database.createOrUpdateRole(String roleName, DatabaseRoleOptions options)	Operation to create or update an role using the Database Secret engine.
DatabaseResponse	Database.creds(String roleName)	Operation to generate a new set of credentials using the Database backend.
DatabaseResponse	Database.deleteRole(String roleName)	Operation to delete an role using the Database backend.
DatabaseResponse	Database.getRole(String roleName)	Operation to retrieve an role using the Database backend.
DatabaseResponse	Database.revoke(String serialNumber)	Operation to revike a certificate in the vault using the Database backend.

Uses of VaultException in io.github.jopenlibs.vault.api.pki

Methods in io.github.jopenlibs.vault.api.pki that throw VaultException

Modifier and Type	Method	Description
PkiResponse	Pki.createOrUpdateRole(String roleName)	Operation to create an role using the PKI backend.
PkiResponse	Pki.createOrUpdateRole(String roleName, RoleOptions options)	Operation to create an role using the PKI backend.
PkiResponse	Pki.deleteRole(String roleName)	Operation to delete an role using the PKI backend.
PkiResponse	Pki.getRole(String roleName)	Operation to retrieve an role using the PKI backend.
PkiResponse	Pki.issue(String roleName, String commonName, List<String> altNames, List<String> ipSans, String ttl, CredentialFormat format)	Operation to generate a new set of credentials (private key and certificate) based on a given role using the PKI backend.
PkiResponse	Pki.issue(String roleName, String commonName, List<String> altNames, List<String> ipSans, String ttl, CredentialFormat format, PrivateKeyFormat privateKeyFormat)	Operation to generate a new set of credentials (private key and certificate) based on a given role using the PKI backend.
PkiResponse	Pki.issue(String roleName, String commonName, List<String> altNames, List<String> ipSans, String ttl, CredentialFormat format, String csr)	Operation to generate a new set of credentials (private key and certificate) based on a given role using the PKI backend.
PkiResponse	Pki.issue(String roleName, String commonName, List<String> altNames, List<String> ipSans, String ttl, CredentialFormat format, String csr, PrivateKeyFormat privateKeyFormat)	Operation to generate a new set of credentials or sign the embedded CSR, in the PKI backend.
PkiResponse	Pki.revoke(String serialNumber)	Operation to revike a certificate in the vault using the PKI backend.

Uses of VaultException in io.github.jopenlibs.vault.api.sys

Methods in io.github.jopenlibs.vault.api.sys that throw VaultException

Modifier and Type	Method	Description
LogicalResponse	Wrapping.lookupWrap()	Returns information about the current client token for a wrapped token, for which the lookup endpoint is at "sys/wrapping/lookup".
LogicalResponse	Wrapping.lookupWrap(String wrappedToken)	Returns information about the a wrapped token when authorization is needed for lookup, for which the lookup endpoint is at "sys/wrapping/lookup".
LogicalResponse	Wrapping.lookupWrap(String wrappedToken, boolean inBody)	Returns information about the a wrapped token, for which the lookup endpoint is at "sys/wrapping/lookup".
VaultResponse	Leases.renew(String leaseId, long increment)	Renews a given secret lease.
VaultResponse	Leases.revoke(String leaseId)	Immediately revokes a secret associated with a given lease.
VaultResponse	Leases.revokeForce(String prefix)	Revokes all secrets or tokens generated under a given prefix immediately.
VaultResponse	Leases.revokePrefix(String prefix)	Revokes all secrets (via a lease ID prefix) or tokens (via the tokens' path property) generated under a given prefix immediately.
WrapResponse	Wrapping.rewrap(String wrappedToken)	Provide access to the /sys/wrapping/rewrap endpoint.
SealResponse	Seal.seal()	Seal the Vault.
SealResponse	Seal.sealStatus()	Check progress of unsealing the Vault.
SealResponse	Seal.unseal(String key)	Enter a single master key share to progress the unsealing of the Vault.
SealResponse	Seal.unseal(String key, Boolean reset)	Enter a single master key share to progress the unsealing of the Vault.
UnwrapResponse	Wrapping.unwrap()	Returns the original response inside the wrapped auth token.
UnwrapResponse	Wrapping.unwrap(String wrappedToken)	Provide access to the /sys/wrapping/unwrap endpoint.
UnwrapResponse	Wrapping.unwrap(String wrappedToken, boolean inBody)	Provide access to the /sys/wrapping/unwrap endpoint.
WrapResponse	Wrapping.wrap(JsonObject jsonObject, int ttlInSec)	Provide access to the /sys/wrapping/wrap endpoint.

Uses of VaultException in io.github.jopenlibs.vault.api.sys.mounts

Methods in io.github.jopenlibs.vault.api.sys.mounts that throw VaultException

Modifier and Type	Method	Description
MountResponse	Mounts.disable(String path)	Operation to disable secrets engine mount point of given path.
MountResponse	Mounts.enable(String path, MountType type, MountPayload payload)	Operation to enable secrets engine at given path.
MountResponse	Mounts.list()	Operation to list all the mounted secrets engines.
MountResponse	Mounts.read(String path)	Operation to read secrets engine mount point's configuration of given path.
MountResponse	Mounts.tune(String path, MountPayload payload)	Operation to tune secrets engine mount point's configuration of given path.

Uses of VaultException in io.github.jopenlibs.vault.response

Constructors in io.github.jopenlibs.vault.response that throw VaultException

Modifier	Constructor	Description
	HealthResponse(RestResponse restResponse, int retries)	Constructs a HealthResponse object from the data received in a health check operation.