A B C D E F G H I J K L M N O P R S T U V W
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- add(boolean) - Method in class com.bettercloud.vault.json.JsonArray
-
Appends the JSON representation of the specified
booleanvalue to the end of this array. - add(double) - Method in class com.bettercloud.vault.json.JsonArray
-
Appends the JSON representation of the specified
doublevalue to the end of this array. - add(float) - Method in class com.bettercloud.vault.json.JsonArray
-
Appends the JSON representation of the specified
floatvalue to the end of this array. - add(int) - Method in class com.bettercloud.vault.json.JsonArray
-
Appends the JSON representation of the specified
intvalue to the end of this array. - add(long) - Method in class com.bettercloud.vault.json.JsonArray
-
Appends the JSON representation of the specified
longvalue to the end of this array. - add(JsonValue) - Method in class com.bettercloud.vault.json.JsonArray
-
Appends the specified JSON value to the end of this array.
- add(String) - Method in class com.bettercloud.vault.json.JsonArray
-
Appends the JSON representation of the specified string to the end of this array.
- add(String, boolean) - Method in class com.bettercloud.vault.json.JsonObject
-
Appends a new member to the end of this object, with the specified name and the JSON representation of the specified
booleanvalue. - add(String, double) - Method in class com.bettercloud.vault.json.JsonObject
-
Appends a new member to the end of this object, with the specified name and the JSON representation of the specified
doublevalue. - add(String, float) - Method in class com.bettercloud.vault.json.JsonObject
-
Appends a new member to the end of this object, with the specified name and the JSON representation of the specified
floatvalue. - add(String, int) - Method in class com.bettercloud.vault.json.JsonObject
-
Appends a new member to the end of this object, with the specified name and the JSON representation of the specified
intvalue. - add(String, int[]) - Method in class com.bettercloud.vault.json.JsonObject
-
Appends a new member to the end of this object, with the specified name and the JSON representation of the specified
int[]value. - add(String, long) - Method in class com.bettercloud.vault.json.JsonObject
-
Appends a new member to the end of this object, with the specified name and the JSON representation of the specified
longvalue. - add(String, JsonValue) - Method in class com.bettercloud.vault.json.JsonObject
-
Appends a new member to the end of this object, with the specified name and the specified JSON value.
- add(String, String) - Method in class com.bettercloud.vault.json.JsonObject
-
Appends a new member to the end of this object, with the specified name and the JSON representation of the specified string.
- addIfNotNull(String, Object) - Method in class com.bettercloud.vault.json.JsonObject
-
Appends a new member to the end of this object, with the specified name and the JSON representation of the specified casted Object only if the value is not null.
- addQualifierToPath(List<String>, int, String) - Static method in class com.bettercloud.vault.api.LogicalUtilities
-
Injects the supplied qualifier (either "data" or "metadata") into the second-from-the-root segment position, for a Vault path to be converted for use with a Version 2 secret engine.
- address(String) - Method in class com.bettercloud.vault.VaultConfig
-
Sets the address (URL) of the Vault server instance to which API calls should be sent.
- adjustPathForDelete(String, int, Logical.logicalOperations) - Static method in class com.bettercloud.vault.api.LogicalUtilities
-
In version 1 style secret engines, the same path is used for all CRUD operations on a secret.
- adjustPathForList(String, int, Logical.logicalOperations) - Static method in class com.bettercloud.vault.api.LogicalUtilities
-
In version 1 style secret engines, the same path is used for all CRUD operations on a secret.
- adjustPathForReadOrWrite(String, int, Logical.logicalOperations) - Static method in class com.bettercloud.vault.api.LogicalUtilities
-
In version 1 style secret engines, the same path is used for all CRUD operations on a secret.
- adjustPathForVersionDelete(String, int) - Static method in class com.bettercloud.vault.api.LogicalUtilities
-
When deleting secret versions, you must inject the path segment "delete" right after the lowest-level path segment.
- adjustPathForVersionDestroy(String, int) - Static method in class com.bettercloud.vault.api.LogicalUtilities
-
When destroying secret versions, you must inject the path segment "destroy" right after the lowest-level path segment.
- adjustPathForVersionUnDelete(String, int) - Static method in class com.bettercloud.vault.api.LogicalUtilities
-
When undeleting secret versions, you must inject the path segment "undelete" right after the lowest-level path segment.
- allowAnyName(Boolean) - Method in class com.bettercloud.vault.api.pki.RoleOptions
- allowBareDomains(Boolean) - Method in class com.bettercloud.vault.api.pki.RoleOptions
- allowedDomains(List<String>) - Method in class com.bettercloud.vault.api.pki.RoleOptions
- allowIpSans(Boolean) - Method in class com.bettercloud.vault.api.pki.RoleOptions
- allowLocalhost(Boolean) - Method in class com.bettercloud.vault.api.pki.RoleOptions
- allowSpiffeName(Boolean) - Method in class com.bettercloud.vault.api.pki.RoleOptions
- allowSubdomains(Boolean) - Method in class com.bettercloud.vault.api.pki.RoleOptions
- array() - Static method in class com.bettercloud.vault.json.Json
-
Creates a new empty JsonArray.
- array(boolean...) - Static method in class com.bettercloud.vault.json.Json
-
Creates a new JsonArray that contains the JSON representations of the given
booleanvalues. - array(double...) - Static method in class com.bettercloud.vault.json.Json
-
Creates a new JsonArray that contains the JSON representations of the given
doublevalues. - array(float...) - Static method in class com.bettercloud.vault.json.Json
-
Creates a new JsonArray that contains the JSON representations of the given
floatvalues. - array(int...) - Static method in class com.bettercloud.vault.json.Json
-
Creates a new JsonArray that contains the JSON representations of the given
intvalues. - array(long...) - Static method in class com.bettercloud.vault.json.Json
-
Creates a new JsonArray that contains the JSON representations of the given
longvalues. - array(String...) - Static method in class com.bettercloud.vault.json.Json
-
Creates a new JsonArray that contains the JSON representations of the given strings.
- asArray() - Method in class com.bettercloud.vault.json.JsonArray
- asArray() - Method in class com.bettercloud.vault.json.JsonValue
-
Returns this JSON value as
JsonArray, assuming that this value represents a JSON array. - asBoolean() - Method in class com.bettercloud.vault.json.JsonValue
-
Returns this JSON value as a
booleanvalue, assuming that this value is eithertrueorfalse. - asDouble() - Method in class com.bettercloud.vault.json.JsonValue
-
Returns this JSON value as a
doublevalue, assuming that this value represents a JSON number. - asFloat() - Method in class com.bettercloud.vault.json.JsonValue
-
Returns this JSON value as a
floatvalue, assuming that this value represents a JSON number. - asInt() - Method in class com.bettercloud.vault.json.JsonValue
-
Returns this JSON value as an
intvalue, assuming that this value represents a JSON number that can be interpreted as Javaint. - asLong() - Method in class com.bettercloud.vault.json.JsonValue
-
Returns this JSON value as a
longvalue, assuming that this value represents a JSON number that can be interpreted as Javalong. - asObject() - Method in class com.bettercloud.vault.json.JsonObject
- asObject() - Method in class com.bettercloud.vault.json.JsonValue
-
Returns this JSON value as
JsonObject, assuming that this value represents a JSON object. - asString() - Method in class com.bettercloud.vault.json.JsonValue
-
Returns this JSON value as String, assuming that this value represents a JSON string.
- auditNonHmacRequestKeys(List<String>) - Method in class com.bettercloud.vault.api.mounts.MountConfig
- auditNonHmacRequestKeys(List<String>) - Method in class com.bettercloud.vault.api.mounts.MountPayload
- auditNonHmacResponseKeys(List<String>) - Method in class com.bettercloud.vault.api.mounts.MountConfig
- auditNonHmacResponseKeys(List<String>) - Method in class com.bettercloud.vault.api.mounts.MountPayload
- auth() - Method in class com.bettercloud.vault.Vault
-
Returns the implementing class for operations on Vault's
/v1/auth/*REST endpoints - Auth - Class in com.bettercloud.vault.api
-
The implementing class for operations on Vault's
/v1/auth/*REST endpoints. - Auth(VaultConfig) - Constructor for class com.bettercloud.vault.api.Auth
- Auth.TokenRequest - Class in com.bettercloud.vault.api
-
A container for all of the options that can be passed to the createToken(TokenRequest) method, to avoid that method having an excessive number of parameters (with
nulltypically passed to most of them). - authentication - com.bettercloud.vault.api.Logical.logicalOperations
- AuthResponse - Class in com.bettercloud.vault.response
-
This class is a container for the information returned by Vault in auth backend operations.
- AuthResponse(RestResponse, int) - Constructor for class com.bettercloud.vault.response.AuthResponse
-
This constructor simply exposes the common base class constructor.
- AWS - com.bettercloud.vault.api.mounts.MountType
B
- body(byte[]) - Method in class com.bettercloud.vault.rest.Rest
-
Sets a binary payload that will be sent as the request body for POST or PUT requests.
- build() - Method in class com.bettercloud.vault.SslConfig
-
This is the terminating method in the builder pattern.
- build() - Method in class com.bettercloud.vault.VaultConfig
-
This is the terminating method in the builder pattern.
C
- certificate(String) - Method in class com.bettercloud.vault.api.pki.Credential
- clientFlag(Boolean) - Method in class com.bettercloud.vault.api.pki.RoleOptions
- clientKeyPemFile(File) - Method in class com.bettercloud.vault.SslConfig
-
An RSA private key, for use with Vault's TLS Certificate auth backend.
- clientKeyPemResource(String) - Method in class com.bettercloud.vault.SslConfig
-
An RSA private key, for use with Vault's TLS Certificate auth backend.
- clientKeyPemUTF8(String) - Method in class com.bettercloud.vault.SslConfig
-
An RSA private key, for use with Vault's TLS Certificate auth backend.
- clientPemFile(File) - Method in class com.bettercloud.vault.SslConfig
-
An X.509 client certificate, for use with Vault's TLS Certificate auth backend.
- clientPemResource(String) - Method in class com.bettercloud.vault.SslConfig
-
An X.509 certificate, for use with Vault's TLS Certificate auth backend.
- clientPemUTF8(String) - Method in class com.bettercloud.vault.SslConfig
-
An X.509 client certificate, for use with Vault's TLS Certificate auth backend.
- codeSigningFlag(Boolean) - Method in class com.bettercloud.vault.api.pki.RoleOptions
- com.bettercloud.vault - package com.bettercloud.vault
-
The root package containing the primary
Vaultdriver class. - com.bettercloud.vault.api - package com.bettercloud.vault.api
-
Classes implementing the various endpoints of the Vault HTTP API.
- com.bettercloud.vault.api.database - package com.bettercloud.vault.api.database
- com.bettercloud.vault.api.mounts - package com.bettercloud.vault.api.mounts
- com.bettercloud.vault.api.pki - package com.bettercloud.vault.api.pki
- com.bettercloud.vault.json - package com.bettercloud.vault.json
-
Intended for internal use by other classes within the Vault driver library.
- com.bettercloud.vault.response - package com.bettercloud.vault.response
-
Containers of data returned by the various Vault API calls.
- com.bettercloud.vault.rest - package com.bettercloud.vault.rest
-
Intended for internal use by other classes within the Vault driver library.
- config(MountConfig) - Method in class com.bettercloud.vault.api.mounts.Mount
- connectTimeoutSeconds(Integer) - Method in class com.bettercloud.vault.rest.Rest
-
The number of seconds to wait before giving up on establishing an HTTP(S) connection.
- CONSUL - com.bettercloud.vault.api.mounts.MountType
- createOrUpdateRole(String) - Method in class com.bettercloud.vault.api.pki.Pki
-
Operation to create an role using the PKI backend.
- createOrUpdateRole(String, DatabaseRoleOptions) - Method in class com.bettercloud.vault.api.database.Database
-
Operation to create or update an role using the Database Secret engine.
- createOrUpdateRole(String, RoleOptions) - Method in class com.bettercloud.vault.api.pki.Pki
-
Operation to create an role using the PKI backend.
- createToken(Auth.TokenRequest) - Method in class com.bettercloud.vault.api.Auth
-
Operation to create an authentication token.
- createToken(Auth.TokenRequest, String) - Method in class com.bettercloud.vault.api.Auth
-
Operation to create an authentication token.
- createWriter(Writer) - Method in class com.bettercloud.vault.json.PrettyPrint
- creationStatements(List<String>) - Method in class com.bettercloud.vault.api.database.DatabaseRoleOptions
- Credential - Class in com.bettercloud.vault.api.pki
-
A container for credential details returned endpoints on the PKI backend.
- Credential() - Constructor for class com.bettercloud.vault.api.pki.Credential
- CredentialFormat - Enum in com.bettercloud.vault.api.pki
-
Possible format options for credentials issued by the PKI backend.
- creds(String) - Method in class com.bettercloud.vault.api.database.Database
-
Operation to generate a new set of credentials using the Database backend.
- CUBBYHOLE - com.bettercloud.vault.api.mounts.MountType
D
- database() - Method in class com.bettercloud.vault.Vault
- database(String) - Method in class com.bettercloud.vault.Vault
- Database - Class in com.bettercloud.vault.api.database
-
The implementing class for operations on Vault's database backend.
- Database(VaultConfig) - Constructor for class com.bettercloud.vault.api.database.Database
-
Constructor for use when the Database backend is mounted on the default path (i.e.
- Database(VaultConfig, String) - Constructor for class com.bettercloud.vault.api.database.Database
-
Constructor for use when the Database backend is mounted on some non-default custom path (e.g.
- DATABASE - com.bettercloud.vault.api.mounts.MountType
- DatabaseCredential - Class in com.bettercloud.vault.api.database
- DatabaseCredential() - Constructor for class com.bettercloud.vault.api.database.DatabaseCredential
- DatabaseResponse - Class in com.bettercloud.vault.response
- DatabaseResponse(RestResponse, int) - Constructor for class com.bettercloud.vault.response.DatabaseResponse
- DatabaseRoleOptions - Class in com.bettercloud.vault.api.database
- DatabaseRoleOptions() - Constructor for class com.bettercloud.vault.api.database.DatabaseRoleOptions
- dbName(String) - Method in class com.bettercloud.vault.api.database.DatabaseRoleOptions
- debug() - Method in class com.bettercloud.vault.Vault
-
Returns the implementing class for Vault's debug operations (e.g.
- Debug - Class in com.bettercloud.vault.api
-
The implementing class for operations on REST endpoints, under the "Debug" section of the Vault HTTP API docs (https://www.vaultproject.io/docs/http/index.html).
- Debug(VaultConfig) - Constructor for class com.bettercloud.vault.api.Debug
- defaultLeaseTtl(TimeToLive) - Method in class com.bettercloud.vault.api.mounts.MountPayload
- defaultLeaseTtl(Integer) - Method in class com.bettercloud.vault.api.mounts.MountConfig
- defaultTtl(String) - Method in class com.bettercloud.vault.api.database.DatabaseRoleOptions
- delete() - Method in class com.bettercloud.vault.rest.Rest
-
Executes an HTTP DELETE request with the settings already configured.
- delete(String) - Method in class com.bettercloud.vault.api.Logical
-
Deletes the key/value pair located at the provided path.
- delete(String, int[]) - Method in class com.bettercloud.vault.api.Logical
-
Soft deletes the specified version of the key/value pair located at the provided path.
- deleteRole(String) - Method in class com.bettercloud.vault.api.database.Database
-
Operation to delete an role using the Database backend.
- deleteRole(String) - Method in class com.bettercloud.vault.api.pki.Pki
-
Operation to delete an role using the PKI backend.
- deleteV1 - com.bettercloud.vault.api.Logical.logicalOperations
- deleteV2 - com.bettercloud.vault.api.Logical.logicalOperations
- DER - com.bettercloud.vault.api.pki.CredentialFormat
- description(String) - Method in class com.bettercloud.vault.api.mounts.Mount
- description(String) - Method in class com.bettercloud.vault.api.mounts.MountConfig
- description(String) - Method in class com.bettercloud.vault.api.mounts.MountPayload
- destroy - com.bettercloud.vault.api.Logical.logicalOperations
- destroy(String, int[]) - Method in class com.bettercloud.vault.api.Logical
-
Performs a hard delete of the specified version of the key/value pair located at the provided path.
- disable(String) - Method in class com.bettercloud.vault.api.mounts.Mounts
-
Operation to disable secrets engine mount point of given path.
- displayName(String) - Method in class com.bettercloud.vault.api.Auth.TokenRequest
E
- emailProtectionFlag(Boolean) - Method in class com.bettercloud.vault.api.pki.RoleOptions
- enable(String, MountType, MountPayload) - Method in class com.bettercloud.vault.api.mounts.Mounts
-
Operation to enable secrets engine at given path.
- enforceHostnames(Boolean) - Method in class com.bettercloud.vault.api.pki.RoleOptions
- engineVersion(Integer) - Method in class com.bettercloud.vault.VaultConfig
-
Sets the KV Secrets Engine version of the Vault server instance.
- entityAlias(String) - Method in class com.bettercloud.vault.api.Auth.TokenRequest
- environmentLoader(EnvironmentLoader) - Method in class com.bettercloud.vault.SslConfig
-
The code used to load environment variables is encapsulated here, so that a mock version of that environment loader can be used by unit tests.
- environmentLoader(EnvironmentLoader) - Method in class com.bettercloud.vault.VaultConfig
-
The code used to load environment variables is encapsulated here, so that a mock version of that environment loader can be used by unit tests.
- EnvironmentLoader - Class in com.bettercloud.vault
-
The code used to load environment variables is encapsulated within an inner class, so that a mock version of that environment loader can be used by unit tests.
- EnvironmentLoader() - Constructor for class com.bettercloud.vault.EnvironmentLoader
- equals(Object) - Method in class com.bettercloud.vault.json.JsonArray
- equals(Object) - Method in class com.bettercloud.vault.json.JsonObject
- equals(Object) - Method in class com.bettercloud.vault.json.JsonObject.Member
- equals(Object) - Method in class com.bettercloud.vault.json.JsonValue
-
Indicates whether some other object is "equal to" this one according to the contract specified in
Object.equals(Object). - explicitMaxTtl(String) - Method in class com.bettercloud.vault.api.Auth.TokenRequest
F
- FALSE - Static variable in class com.bettercloud.vault.json.Json
-
Represents the JSON literal
false. - forceNoCache(Boolean) - Method in class com.bettercloud.vault.api.mounts.MountConfig
- forceNoCache(Boolean) - Method in class com.bettercloud.vault.api.mounts.MountPayload
- fromString(String) - Static method in enum com.bettercloud.vault.api.pki.CredentialFormat
G
- get() - Method in class com.bettercloud.vault.rest.Rest
-
Executes an HTTP GET request with the settings already configured.
- get(int) - Method in class com.bettercloud.vault.json.JsonArray
-
Returns the value of the element at the specified position in this array.
- get(String) - Method in class com.bettercloud.vault.json.JsonObject
-
Returns the value of the member with the specified name in this object.
- getAccessor() - Method in class com.bettercloud.vault.response.LookupResponse
- getAddress() - Method in class com.bettercloud.vault.VaultConfig
- getAllowAnyName() - Method in class com.bettercloud.vault.api.pki.RoleOptions
- getAllowBareDomains() - Method in class com.bettercloud.vault.api.pki.RoleOptions
- getAllowedDomains() - Method in class com.bettercloud.vault.api.pki.RoleOptions
- getAllowIpSans() - Method in class com.bettercloud.vault.api.pki.RoleOptions
- getAllowLocalhost() - Method in class com.bettercloud.vault.api.pki.RoleOptions
- getAllowSpiffename() - Method in class com.bettercloud.vault.api.pki.RoleOptions
- getAllowSubdomains() - Method in class com.bettercloud.vault.api.pki.RoleOptions
- getAppId() - Method in class com.bettercloud.vault.response.AuthResponse
- getAuditNonHmacRequestKeys() - Method in class com.bettercloud.vault.api.mounts.MountConfig
- getAuditNonHmacRequestKeys() - Method in class com.bettercloud.vault.api.mounts.MountPayload
- getAuditNonHmacResponseKeys() - Method in class com.bettercloud.vault.api.mounts.MountConfig
- getAuditNonHmacResponseKeys() - Method in class com.bettercloud.vault.api.mounts.MountPayload
- getAuthClientToken() - Method in class com.bettercloud.vault.response.AuthResponse
- getAuthLeaseDuration() - Method in class com.bettercloud.vault.response.AuthResponse
- getAuthPolicies() - Method in class com.bettercloud.vault.response.AuthResponse
- getBody() - Method in class com.bettercloud.vault.rest.RestResponse
- getBoolean(String) - Method in class com.bettercloud.vault.json.JsonObject
-
Returns the
Booleanvalue of the member with the specified name in this object. - getBoolean(String, boolean) - Method in class com.bettercloud.vault.json.JsonObject
-
Returns the
booleanvalue of the member with the specified name in this object. - getCertificate() - Method in class com.bettercloud.vault.api.pki.Credential
- getClientFlag() - Method in class com.bettercloud.vault.api.pki.RoleOptions
- getCodeSigningFlag() - Method in class com.bettercloud.vault.api.pki.RoleOptions
- getColumn() - Method in exception com.bettercloud.vault.json.ParseException
-
Returns the index of the character at which the error occurred, relative to the line.
- getConfig() - Method in class com.bettercloud.vault.api.mounts.Mount
- getCreationStatements() - Method in class com.bettercloud.vault.api.database.DatabaseRoleOptions
- getCreationTime() - Method in class com.bettercloud.vault.response.LookupResponse
- getCreationTTL() - Method in class com.bettercloud.vault.response.LookupResponse
- getCredential() - Method in class com.bettercloud.vault.response.DatabaseResponse
- getCredential() - Method in class com.bettercloud.vault.response.PkiResponse
- getData() - Method in class com.bettercloud.vault.response.LogicalResponse
- getDataObject() - Method in class com.bettercloud.vault.response.LogicalResponse
- getDbName() - Method in class com.bettercloud.vault.api.database.DatabaseRoleOptions
- getDefaultLeaseTtl() - Method in class com.bettercloud.vault.api.mounts.MountConfig
- getDefaultLeaseTtl() - Method in class com.bettercloud.vault.api.mounts.MountPayload
- getDefaultTtl() - Method in class com.bettercloud.vault.api.database.DatabaseRoleOptions
- getDescription() - Method in class com.bettercloud.vault.api.mounts.Mount
- getDescription() - Method in class com.bettercloud.vault.api.mounts.MountConfig
- getDescription() - Method in class com.bettercloud.vault.api.mounts.MountPayload
- getDisplayName() - Method in class com.bettercloud.vault.api.Auth.TokenRequest
- getDisplayName() - Method in class com.bettercloud.vault.response.LookupResponse
- getDouble(String) - Method in class com.bettercloud.vault.json.JsonObject
-
Returns the
Doublevalue of the member with the specified name in this object. - getDouble(String, double) - Method in class com.bettercloud.vault.json.JsonObject
-
Returns the
doublevalue of the member with the specified name in this object. - getEmailProtectionFlag() - Method in class com.bettercloud.vault.api.pki.RoleOptions
- getEnforceHostnames() - Method in class com.bettercloud.vault.api.pki.RoleOptions
- getEngineVersionForSecretPath(String) - Method in class com.bettercloud.vault.api.Logical
-
Provides the version of the secrets engine of the specified path, e.g.
- getEntityAlias() - Method in class com.bettercloud.vault.api.Auth.TokenRequest
- getExplicitMaxTtl() - Method in class com.bettercloud.vault.api.Auth.TokenRequest
- getExplicitMaxTTL() - Method in class com.bettercloud.vault.response.LookupResponse
- getFloat(String) - Method in class com.bettercloud.vault.json.JsonObject
-
Returns the
Floatvalue of the member with the specified name in this object. - getFloat(String, float) - Method in class com.bettercloud.vault.json.JsonObject
-
Returns the
floatvalue of the member with the specified name in this object. - getForceNoCache() - Method in class com.bettercloud.vault.api.mounts.MountConfig
- getForceNoCache() - Method in class com.bettercloud.vault.api.mounts.MountPayload
- getGlobalEngineVersion() - Method in class com.bettercloud.vault.VaultConfig
- getHttpStatusCode() - Method in exception com.bettercloud.vault.VaultException
-
An HTTP status code, returned from a Vault server, that is the cause of this
VaultException. - getId() - Method in class com.bettercloud.vault.api.Auth.TokenRequest
- getId() - Method in class com.bettercloud.vault.response.LookupResponse
- getInitialized() - Method in class com.bettercloud.vault.response.HealthResponse
- getInt(String) - Method in class com.bettercloud.vault.json.JsonObject
-
Returns the
Integervalue of the member with the specified name in this object. - getInt(String, int) - Method in class com.bettercloud.vault.json.JsonObject
-
Returns the
intvalue of the member with the specified name in this object. - getIssuingCa() - Method in class com.bettercloud.vault.api.pki.Credential
- getKeyBits() - Method in class com.bettercloud.vault.api.pki.RoleOptions
- getKeyType() - Method in class com.bettercloud.vault.api.pki.RoleOptions
- getKeyUsage() - Method in class com.bettercloud.vault.api.pki.RoleOptions
- getLastRenewalTime() - Method in class com.bettercloud.vault.response.LookupResponse
- getLeaseDuration() - Method in class com.bettercloud.vault.response.LogicalResponse
- getLeaseId() - Method in class com.bettercloud.vault.response.LogicalResponse
- getLine() - Method in exception com.bettercloud.vault.json.ParseException
-
Returns the number of the line in which the error occurred.
- getListData() - Method in class com.bettercloud.vault.response.LogicalResponse
- getLocal() - Method in class com.bettercloud.vault.api.mounts.Mount
- getLocal() - Method in class com.bettercloud.vault.api.mounts.MountPayload
- getLong(String) - Method in class com.bettercloud.vault.json.JsonObject
-
Returns the
Longvalue of the member with the specified name in this object. - getLong(String, long) - Method in class com.bettercloud.vault.json.JsonObject
-
Returns the
longvalue of the member with the specified name in this object. - getMaxLeaseTtl() - Method in class com.bettercloud.vault.api.mounts.MountConfig
- getMaxLeaseTtl() - Method in class com.bettercloud.vault.api.mounts.MountPayload
- getMaxRetries() - Method in class com.bettercloud.vault.VaultConfig
- getMaxTtl() - Method in class com.bettercloud.vault.api.database.DatabaseRoleOptions
- getMaxTtl() - Method in class com.bettercloud.vault.api.pki.RoleOptions
- getMeta() - Method in class com.bettercloud.vault.api.Auth.TokenRequest
- getMimeType() - Method in class com.bettercloud.vault.rest.RestResponse
- getMount() - Method in class com.bettercloud.vault.response.MountResponse
- getMounts() - Method in class com.bettercloud.vault.response.MountResponse
- getName() - Method in class com.bettercloud.vault.api.database.DatabaseRoleOptions
- getName() - Method in class com.bettercloud.vault.json.JsonObject.Member
-
Returns the name of this member.
- getNameSpace() - Method in class com.bettercloud.vault.VaultConfig
- getNoDefaultPolicy() - Method in class com.bettercloud.vault.api.Auth.TokenRequest
- getNonce() - Method in class com.bettercloud.vault.response.AuthResponse
- getNoParent() - Method in class com.bettercloud.vault.api.Auth.TokenRequest
- getNumberOfShares() - Method in class com.bettercloud.vault.response.SealResponse
- getNumUses() - Method in class com.bettercloud.vault.api.Auth.TokenRequest
- getNumUses() - Method in class com.bettercloud.vault.response.LookupResponse
- getOffset() - Method in exception com.bettercloud.vault.json.ParseException
-
Returns the absolute index of the character at which the error occurred.
- getOpenTimeout() - Method in class com.bettercloud.vault.VaultConfig
- getPassword() - Method in class com.bettercloud.vault.api.database.DatabaseCredential
- getPath() - Method in class com.bettercloud.vault.response.LookupResponse
- getPemUTF8() - Method in class com.bettercloud.vault.SslConfig
- getPeriod() - Method in class com.bettercloud.vault.api.Auth.TokenRequest
- getPluginName() - Method in class com.bettercloud.vault.api.mounts.MountConfig
- getPluginName() - Method in class com.bettercloud.vault.api.mounts.MountPayload
- getPolices() - Method in class com.bettercloud.vault.api.Auth.TokenRequest
- getPolicies() - Method in class com.bettercloud.vault.response.LookupResponse
- getPrefixPathDepth() - Method in class com.bettercloud.vault.VaultConfig
- getPrivateKey() - Method in class com.bettercloud.vault.api.pki.Credential
- getPrivateKeyType() - Method in class com.bettercloud.vault.api.pki.Credential
- getProgress() - Method in class com.bettercloud.vault.response.SealResponse
- getReadTimeout() - Method in class com.bettercloud.vault.VaultConfig
- getRenewable() - Method in class com.bettercloud.vault.api.Auth.TokenRequest
- getRenewable() - Method in class com.bettercloud.vault.response.AuthResponse
- getRenewable() - Method in class com.bettercloud.vault.response.LogicalResponse
- getRenewStatements() - Method in class com.bettercloud.vault.api.database.DatabaseRoleOptions
- getRestResponse() - Method in class com.bettercloud.vault.response.HealthResponse
- getRestResponse() - Method in class com.bettercloud.vault.response.VaultResponse
- getRetries() - Method in class com.bettercloud.vault.response.HealthResponse
- getRetries() - Method in class com.bettercloud.vault.response.VaultResponse
- getRetryIntervalMilliseconds() - Method in class com.bettercloud.vault.VaultConfig
- getRevocationStatements() - Method in class com.bettercloud.vault.api.database.DatabaseRoleOptions
- getRole() - Method in class com.bettercloud.vault.api.Auth.TokenRequest
- getRole(String) - Method in class com.bettercloud.vault.api.database.Database
-
Operation to retrieve an role using the Database backend.
- getRole(String) - Method in class com.bettercloud.vault.api.pki.Pki
-
Operation to retrieve an role using the PKI backend.
- getRoleOptions() - Method in class com.bettercloud.vault.response.DatabaseResponse
- getRoleOptions() - Method in class com.bettercloud.vault.response.PkiResponse
- getRollbackStatements() - Method in class com.bettercloud.vault.api.database.DatabaseRoleOptions
- getSealed() - Method in class com.bettercloud.vault.response.HealthResponse
- getSealed() - Method in class com.bettercloud.vault.response.SealResponse
- getSealWrap() - Method in class com.bettercloud.vault.api.mounts.Mount
- getSealWrap() - Method in class com.bettercloud.vault.api.mounts.MountPayload
- getSecretEngineVersions() - Method in class com.bettercloud.vault.Vault
- getSecretsEnginePathMap() - Method in class com.bettercloud.vault.VaultConfig
- getSerialNumber() - Method in class com.bettercloud.vault.api.pki.Credential
- getServerFlag() - Method in class com.bettercloud.vault.api.pki.RoleOptions
- getServerTimeUTC() - Method in class com.bettercloud.vault.response.HealthResponse
- getSslConfig() - Method in class com.bettercloud.vault.VaultConfig
- getSslContext() - Method in class com.bettercloud.vault.SslConfig
- getStandby() - Method in class com.bettercloud.vault.response.HealthResponse
- getStatus() - Method in class com.bettercloud.vault.rest.RestResponse
- getString(String) - Method in class com.bettercloud.vault.json.JsonObject
-
Returns the
Stringvalue of the member with the specified name in this object. - getString(String, String) - Method in class com.bettercloud.vault.json.JsonObject
-
Returns the
Stringvalue of the member with the specified name in this object. - getThreshold() - Method in class com.bettercloud.vault.response.SealResponse
- getToken() - Method in class com.bettercloud.vault.VaultConfig
- getTokenAccessor() - Method in class com.bettercloud.vault.response.AuthResponse
- getTtl() - Method in class com.bettercloud.vault.api.Auth.TokenRequest
- getTtl() - Method in class com.bettercloud.vault.api.pki.RoleOptions
- getTTL() - Method in class com.bettercloud.vault.response.LookupResponse
- getType() - Method in class com.bettercloud.vault.api.Auth.TokenRequest
- getType() - Method in class com.bettercloud.vault.api.mounts.Mount
- getUseCsrCommonName() - Method in class com.bettercloud.vault.api.pki.RoleOptions
- getUseCsrSans() - Method in class com.bettercloud.vault.api.pki.RoleOptions
- getUserId() - Method in class com.bettercloud.vault.response.AuthResponse
- getUsername() - Method in class com.bettercloud.vault.api.database.DatabaseCredential
- getUsername() - Method in class com.bettercloud.vault.response.AuthResponse
- getUsername() - Method in class com.bettercloud.vault.response.LookupResponse
- getValue() - Method in class com.bettercloud.vault.json.JsonObject.Member
-
Returns the value of this member.
H
- hashCode() - Method in class com.bettercloud.vault.json.JsonArray
- hashCode() - Method in class com.bettercloud.vault.json.JsonObject
- hashCode() - Method in class com.bettercloud.vault.json.JsonObject.Member
- hashCode() - Method in class com.bettercloud.vault.json.JsonValue
- header(String, String) - Method in class com.bettercloud.vault.rest.Rest
-
Adds a header to be sent with the HTTP request.
- health() - Method in class com.bettercloud.vault.api.Debug
-
Returns the health status of Vault.
- health(Boolean, Integer, Integer, Integer) - Method in class com.bettercloud.vault.api.Debug
-
An overloaded version of
Debug.health()that allows for passing one or more optional parameters. - HealthResponse - Class in com.bettercloud.vault.response
-
This class is a container for the information returned by Vault in
v1/sys/healthoperations. - HealthResponse(RestResponse, int) - Constructor for class com.bettercloud.vault.response.HealthResponse
-
Constructs a
HealthResponseobject from the data received in a health check operation.
I
- id(UUID) - Method in class com.bettercloud.vault.api.Auth.TokenRequest
- IDENTITY - com.bettercloud.vault.api.mounts.MountType
- indentWithSpaces(int) - Static method in class com.bettercloud.vault.json.PrettyPrint
-
Print every value on a separate line.
- indentWithTabs() - Static method in class com.bettercloud.vault.json.PrettyPrint
-
Do not break lines, but still insert whitespace between values.
- isArray() - Method in class com.bettercloud.vault.json.JsonArray
- isArray() - Method in class com.bettercloud.vault.json.JsonValue
-
Detects whether this value represents a JSON array.
- isAuthRenewable() - Method in class com.bettercloud.vault.response.AuthResponse
- isBoolean() - Method in class com.bettercloud.vault.json.JsonValue
-
Detects whether this value represents a boolean value.
- isEmpty() - Method in class com.bettercloud.vault.json.JsonArray
-
Returns
trueif this array contains no elements. - isEmpty() - Method in class com.bettercloud.vault.json.JsonObject
-
Returns
trueif this object contains no members. - isFalse() - Method in class com.bettercloud.vault.json.JsonValue
-
Detects whether this value represents the JSON literal
false. - isNull() - Method in class com.bettercloud.vault.json.JsonValue
-
Detects whether this value represents the JSON literal
null. - isNumber() - Method in class com.bettercloud.vault.json.JsonValue
-
Detects whether this value represents a JSON number.
- isObject() - Method in class com.bettercloud.vault.json.JsonObject
- isObject() - Method in class com.bettercloud.vault.json.JsonValue
-
Detects whether this value represents a JSON object.
- isOrphan() - Method in class com.bettercloud.vault.response.LookupResponse
- isRenewable() - Method in class com.bettercloud.vault.response.LookupResponse
- isString() - Method in class com.bettercloud.vault.json.JsonValue
-
Detects whether this value represents a JSON string.
- issue(String, String, List<String>, List<String>, String, CredentialFormat) - Method in class com.bettercloud.vault.api.pki.Pki
-
Operation to generate a new set of credentials (private key and certificate) based on a given role using the PKI backend.
- issue(String, String, List<String>, List<String>, String, CredentialFormat, String) - Method in class com.bettercloud.vault.api.pki.Pki
-
Operation to generate a new set of credentials or sign the embedded CSR, in the PKI backend.
- issuingCa(String) - Method in class com.bettercloud.vault.api.pki.Credential
- isTrue() - Method in class com.bettercloud.vault.json.JsonValue
-
Detects whether this value represents the JSON literal
true. - isVerify() - Method in class com.bettercloud.vault.SslConfig
- iterator() - Method in class com.bettercloud.vault.json.JsonArray
-
Returns an iterator over the values of this array in document order.
- iterator() - Method in class com.bettercloud.vault.json.JsonObject
-
Returns an iterator over the members of this object in document order.
J
- Json - Class in com.bettercloud.vault.json
-
This class serves as the entry point to the minimal-json API.
- JsonArray - Class in com.bettercloud.vault.json
-
Represents a JSON array, an ordered collection of JSON values.
- JsonArray() - Constructor for class com.bettercloud.vault.json.JsonArray
-
Creates a new empty JsonArray.
- JsonArray(JsonArray) - Constructor for class com.bettercloud.vault.json.JsonArray
-
Creates a new JsonArray with the contents of the specified JSON array.
- JsonObject - Class in com.bettercloud.vault.json
-
Represents a JSON object, a set of name/value pairs, where the names are strings and the values are JSON values.
- JsonObject() - Constructor for class com.bettercloud.vault.json.JsonObject
-
Creates a new empty JsonObject.
- JsonObject(JsonObject) - Constructor for class com.bettercloud.vault.json.JsonObject
-
Creates a new JsonObject, initialized with the contents of the specified JSON object.
- JsonObject.Member - Class in com.bettercloud.vault.json
-
Represents a member of a JSON object, a pair of a name and a value.
- jsonObjectToWriteFromEngineVersion(Logical.logicalOperations, JsonObject) - Static method in class com.bettercloud.vault.api.LogicalUtilities
-
In version two, when writing a secret, the JSONObject must be nested with "data" as the key.
- JsonValue - Class in com.bettercloud.vault.json
-
Represents a JSON value.
K
- KEY_VALUE - com.bettercloud.vault.api.mounts.MountType
- KEY_VALUE_V2 - com.bettercloud.vault.api.mounts.MountType
- keyBits(Long) - Method in class com.bettercloud.vault.api.pki.RoleOptions
- keyStore(KeyStore, String) - Method in class com.bettercloud.vault.SslConfig
-
A Java keystore, containing a client certificate that's registered with Vault's TLS Certificate auth backend.
- keyStoreFile(File, String) - Method in class com.bettercloud.vault.SslConfig
-
A Java keystore, containing a client certificate that's registered with Vault's TLS Certificate auth backend.
- keyStoreResource(String, String) - Method in class com.bettercloud.vault.SslConfig
-
A Java keystore, containing a client certificate that's registered with Vault's TLS Certificate auth backend.
- keyType(String) - Method in class com.bettercloud.vault.api.pki.RoleOptions
- keyUsage(List<String>) - Method in class com.bettercloud.vault.api.pki.RoleOptions
L
- leases() - Method in class com.bettercloud.vault.Vault
-
Returns the implementing class for Vault's lease operations (e.g.
- Leases - Class in com.bettercloud.vault.api
-
The implementing class for operations on REST endpoints, under the "Leases" section of the Vault HTTP API docs (https://www.vaultproject.io/docs/http/index.html).
- Leases(VaultConfig) - Constructor for class com.bettercloud.vault.api.Leases
- list() - Method in class com.bettercloud.vault.api.mounts.Mounts
-
Operation to list all the mounted secrets engines.
- list(String) - Method in class com.bettercloud.vault.api.Logical
-
Retrieve a list of keys corresponding to key/value pairs at a given Vault path.
- listV1 - com.bettercloud.vault.api.Logical.logicalOperations
- listV2 - com.bettercloud.vault.api.Logical.logicalOperations
- loadVariable(String) - Method in class com.bettercloud.vault.EnvironmentLoader
- local(Boolean) - Method in class com.bettercloud.vault.api.mounts.Mount
- local(Boolean) - Method in class com.bettercloud.vault.api.mounts.MountPayload
- logical() - Method in class com.bettercloud.vault.Vault
-
Returns the implementing class for Vault's core/logical operations (e.g.
- Logical - Class in com.bettercloud.vault.api
-
The implementing class for Vault's core/logical operations (e.g.
- Logical(VaultConfig) - Constructor for class com.bettercloud.vault.api.Logical
- Logical.logicalOperations - Enum in com.bettercloud.vault.api
- LogicalResponse - Class in com.bettercloud.vault.response
-
This class is a container for the information returned by Vault in logical API operations (e.g.
- LogicalResponse(RestResponse, int, Logical.logicalOperations) - Constructor for class com.bettercloud.vault.response.LogicalResponse
- LogicalUtilities - Class in com.bettercloud.vault.api
- LogicalUtilities() - Constructor for class com.bettercloud.vault.api.LogicalUtilities
- loginByAppID(String, String, String) - Method in class com.bettercloud.vault.api.Auth
-
Deprecated.
- loginByAppRole(String, String) - Method in class com.bettercloud.vault.api.Auth
-
Basic login operation to authenticate to an app-role backend.
- loginByAppRole(String, String, String) - Method in class com.bettercloud.vault.api.Auth
-
Basic login operation to authenticate to an app-role backend.
- loginByAwsEc2(String, String, String, String) - Method in class com.bettercloud.vault.api.Auth
-
Basic login operation to authenticate to a AWS backend using EC2 authentication.
- loginByAwsEc2(String, String, String, String, String) - Method in class com.bettercloud.vault.api.Auth
-
Basic login operation to authenticate to a AWS backend using EC2 authentication.
- loginByAwsIam(String, String, String, String, String) - Method in class com.bettercloud.vault.api.Auth
-
Basic login operation to authenticate to a AWS backend using IAM authentication.
- loginByCert() - Method in class com.bettercloud.vault.api.Auth
-
Basic login operation to authenticate using Vault's TLS Certificate auth backend.
- loginByCert(String) - Method in class com.bettercloud.vault.api.Auth
-
Basic login operation to authenticate using Vault's TLS Certificate auth backend.
- loginByGCP(String, String) - Method in class com.bettercloud.vault.api.Auth
-
Basic login operation to authenticate to an GCP backend.
- loginByGithub(String) - Method in class com.bettercloud.vault.api.Auth
-
Basic login operation to authenticate to an github backend.
- loginByGithub(String, String) - Method in class com.bettercloud.vault.api.Auth
-
Basic login operation to authenticate to an github backend.
- loginByJwt(String, String, String) - Method in class com.bettercloud.vault.api.Auth
-
Basic login operation to authenticate to an JWT backend.
- loginByKubernetes(String, String) - Method in class com.bettercloud.vault.api.Auth
-
Basic login operation to authenticate to an kubernetes backend.
- loginByLDAP(String, String) - Method in class com.bettercloud.vault.api.Auth
-
Basic login operation to authenticate to a LDAP backend.
- loginByLDAP(String, String, String) - Method in class com.bettercloud.vault.api.Auth
-
Basic login operation to authenticate to a LDAP backend.
- loginByUserPass(String, String) - Method in class com.bettercloud.vault.api.Auth
-
Basic login operation to authenticate to a Username & Password backend.
- loginByUserPass(String, String, String) - Method in class com.bettercloud.vault.api.Auth
-
Basic login operation to authenticate to a Username & Password backend.
- LookupResponse - Class in com.bettercloud.vault.response
-
This class is a container for the information returned by Vault in lookup operations on auth backends.
- LookupResponse(RestResponse, int) - Constructor for class com.bettercloud.vault.response.LookupResponse
-
This constructor simply exposes the common base class constructor.
- lookupSelf() - Method in class com.bettercloud.vault.api.Auth
-
Returns information about the current client token.
- lookupSelf(String) - Method in class com.bettercloud.vault.api.Auth
-
Returns information about the current client token.
- lookupWrap() - Method in class com.bettercloud.vault.api.Auth
-
Returns information about the current client token for a wrapped token, for which the lookup endpoint is different at "sys/wrapping/lookup".
M
- maxLeaseTtl(TimeToLive) - Method in class com.bettercloud.vault.api.mounts.MountPayload
- maxLeaseTtl(Integer) - Method in class com.bettercloud.vault.api.mounts.MountConfig
- maxTtl(String) - Method in class com.bettercloud.vault.api.database.DatabaseRoleOptions
- maxTtl(String) - Method in class com.bettercloud.vault.api.pki.RoleOptions
- merge(JsonObject) - Method in class com.bettercloud.vault.json.JsonObject
-
Copies all members of the specified object into this object.
- meta(Map<String, String>) - Method in class com.bettercloud.vault.api.Auth.TokenRequest
- MINIMAL - Static variable in class com.bettercloud.vault.json.WriterConfig
-
Write JSON in its minimal form, without any additional whitespace.
- mount - com.bettercloud.vault.api.Logical.logicalOperations
- Mount - Class in com.bettercloud.vault.api.mounts
-
A container for options returned by mounts endpoints on the Secret Engine backend.
- Mount() - Constructor for class com.bettercloud.vault.api.mounts.Mount
- MountConfig - Class in com.bettercloud.vault.api.mounts
-
A container for options returned by mounts endpoints on the Secret Engine backend.
- MountConfig() - Constructor for class com.bettercloud.vault.api.mounts.MountConfig
- MountPayload - Class in com.bettercloud.vault.api.mounts
-
A container for options sent to mounts endpoints on the Secret Engine backend as REST payload.
- MountPayload() - Constructor for class com.bettercloud.vault.api.mounts.MountPayload
- MountResponse - Class in com.bettercloud.vault.response
-
This class is a container for the information returned by Vault in /sys/mounts/ API operations (e.g.
- MountResponse(RestResponse, int, boolean) - Constructor for class com.bettercloud.vault.response.MountResponse
- mounts() - Method in class com.bettercloud.vault.Vault
-
Returns the implementing class for Vault's sys mounts operations (i.e.
- Mounts - Class in com.bettercloud.vault.api.mounts
-
The implementing class for operations on Vault's
/v1/sys/mounts/*REST endpoints. - Mounts(VaultConfig) - Constructor for class com.bettercloud.vault.api.mounts.Mounts
- MountType - Enum in com.bettercloud.vault.api.mounts
-
A representation of different available secret engine mount points
N
- name(String) - Method in class com.bettercloud.vault.api.database.DatabaseRoleOptions
- names() - Method in class com.bettercloud.vault.json.JsonObject
-
Returns a list of the names in this object in document order.
- nameSpace(String) - Method in class com.bettercloud.vault.VaultConfig
-
Optional.
- noDefaultPolicy(Boolean) - Method in class com.bettercloud.vault.api.Auth.TokenRequest
- NOMAD - com.bettercloud.vault.api.mounts.MountType
- noParent(Boolean) - Method in class com.bettercloud.vault.api.Auth.TokenRequest
- NULL - Static variable in class com.bettercloud.vault.json.Json
-
Represents the JSON literal
null. - numUses(Long) - Method in class com.bettercloud.vault.api.Auth.TokenRequest
O
- object() - Static method in class com.bettercloud.vault.json.Json
-
Creates a new empty JsonObject.
- of(int, TimeUnit) - Static method in class com.bettercloud.vault.api.mounts.TimeToLive
- of(String) - Static method in enum com.bettercloud.vault.api.mounts.MountType
-
Get the
MountTypeinstance from the providedvaluestring. - openTimeout(Integer) - Method in class com.bettercloud.vault.VaultConfig
-
The number of seconds to wait before giving up on establishing an HTTP(S) connection to the Vault server.
- optionalHeader(String, String) - Method in class com.bettercloud.vault.rest.Rest
-
Deprecated.use
Rest.header(String, String)instead.
P
- parameter(String, String) - Method in class com.bettercloud.vault.rest.Rest
-
Adds a parameter to be sent with the HTTP request.
- parse(Reader) - Static method in class com.bettercloud.vault.json.Json
-
Reads the entire input stream from the given reader and parses it as JSON.
- parse(String) - Static method in class com.bettercloud.vault.json.Json
-
Parses the given input string as JSON.
- ParseException - Exception in com.bettercloud.vault.json
-
An unchecked exception to indicate that an input does not qualify as valid JSON.
- password(String) - Method in class com.bettercloud.vault.api.database.DatabaseCredential
- PEM - com.bettercloud.vault.api.pki.CredentialFormat
- PEM_BUNDLE - com.bettercloud.vault.api.pki.CredentialFormat
- pemFile(File) - Method in class com.bettercloud.vault.SslConfig
-
An X.509 certificate, to use when communicating with Vault over HTTPS.
- pemResource(String) - Method in class com.bettercloud.vault.SslConfig
-
An X.509 certificate, to use when communicating with Vault over HTTPS.
- pemUTF8(String) - Method in class com.bettercloud.vault.SslConfig
-
An X.509 certificate, to use when communicating with Vault over HTTPS.
- period(String) - Method in class com.bettercloud.vault.api.Auth.TokenRequest
- pki() - Method in class com.bettercloud.vault.Vault
-
Returns the implementing class for Vault's PKI secret backend (i.e.
- pki(String) - Method in class com.bettercloud.vault.Vault
-
Returns the implementing class for Vault's PKI secret backend, using a custom path when that backend is mounted on something other than the default (i.e.
- Pki - Class in com.bettercloud.vault.api.pki
-
The implementing class for operations on Vault's PKI backend.
- Pki(VaultConfig) - Constructor for class com.bettercloud.vault.api.pki.Pki
-
Constructor for use when the PKI backend is mounted on the default path (i.e.
- Pki(VaultConfig, String) - Constructor for class com.bettercloud.vault.api.pki.Pki
-
Constructor for use when the PKI backend is mounted on some non-default custom path (e.g.
- PKI - com.bettercloud.vault.api.mounts.MountType
- PkiResponse - Class in com.bettercloud.vault.response
-
This class is a container for the information returned by Vault in PKI backend API operations (e.g.
- PkiResponse(RestResponse, int) - Constructor for class com.bettercloud.vault.response.PkiResponse
- pluginName(String) - Method in class com.bettercloud.vault.api.mounts.MountConfig
- pluginName(String) - Method in class com.bettercloud.vault.api.mounts.MountPayload
- polices(List<String>) - Method in class com.bettercloud.vault.api.Auth.TokenRequest
- post() - Method in class com.bettercloud.vault.rest.Rest
-
Executes an HTTP POST request with the settings already configured.
- prefixPath(String) - Method in class com.bettercloud.vault.VaultConfig
-
Set the "path depth" of the prefix path, by explicitly specifying the prefix path, e.g., "foo/bar/blah" would set the prefix path depth to 3.
- prefixPathDepth(int) - Method in class com.bettercloud.vault.VaultConfig
-
Set the "path depth" of the prefix path.
- PRETTY_PRINT - Static variable in class com.bettercloud.vault.json.WriterConfig
-
Write JSON in pretty-print, with each value on a separate line and an indentation of two spaces.
- PrettyPrint - Class in com.bettercloud.vault.json
-
Enables human readable JSON output by inserting whitespace between values.after commas and colons.
- PrettyPrint(char[]) - Constructor for class com.bettercloud.vault.json.PrettyPrint
- privateKey(String) - Method in class com.bettercloud.vault.api.pki.Credential
- privateKeyType(String) - Method in class com.bettercloud.vault.api.pki.Credential
- put() - Method in class com.bettercloud.vault.rest.Rest
-
Executes an HTTP PUT request with the settings already configured.
- putSecretsEngineVersionForPath(String, String) - Method in class com.bettercloud.vault.VaultConfig
-
Sets the secrets Engine version be used by Vault for the provided path.
R
- RABBITMQ - com.bettercloud.vault.api.mounts.MountType
- read(String) - Method in class com.bettercloud.vault.api.Logical
-
Basic read operation to retrieve a secret.
- read(String) - Method in class com.bettercloud.vault.api.mounts.Mounts
-
Operation to read secrets engine mount point's configuration of given path.
- read(String, Boolean, Integer) - Method in class com.bettercloud.vault.api.Logical
-
Basic read operation to retrieve a specified secret version for KV engine version 2.
- readTimeout(Integer) - Method in class com.bettercloud.vault.VaultConfig
-
After an HTTP(S) connection has already been established, this is the number of seconds to wait for all data to finish downloading.
- readTimeoutSeconds(Integer) - Method in class com.bettercloud.vault.rest.Rest
-
After an HTTP(S) connection has already been established, this is the number of seconds to wait for all data to finish downloading.
- readV1 - com.bettercloud.vault.api.Logical.logicalOperations
- readV2 - com.bettercloud.vault.api.Logical.logicalOperations
- remove(int) - Method in class com.bettercloud.vault.json.JsonArray
-
Removes the element at the specified index from this array.
- remove(String) - Method in class com.bettercloud.vault.json.JsonObject
-
Removes a member with the specified name from this object.
- renew(String, long) - Method in class com.bettercloud.vault.api.Leases
-
Renews a given secret lease.
- renewable(Boolean) - Method in class com.bettercloud.vault.api.Auth.TokenRequest
- renewSelf() - Method in class com.bettercloud.vault.api.Auth
-
Renews the lease associated with the calling token.
- renewSelf(long) - Method in class com.bettercloud.vault.api.Auth
-
Renews the lease associated with the calling token.
- renewSelf(long, String) - Method in class com.bettercloud.vault.api.Auth
-
Renews the lease associated with the calling token.
- renewStatements(List<String>) - Method in class com.bettercloud.vault.api.database.DatabaseRoleOptions
- Rest - Class in com.bettercloud.vault.rest
-
A simple client for issuing HTTP requests.
- Rest() - Constructor for class com.bettercloud.vault.rest.Rest
- RestException - Exception in com.bettercloud.vault.rest
- RestResponse - Class in com.bettercloud.vault.rest
-
This class contains the metadata and data that was downloaded by
Restfrom an HTTP response. - RestResponse(int, String, byte[]) - Constructor for class com.bettercloud.vault.rest.RestResponse
- revocationStatements(List<String>) - Method in class com.bettercloud.vault.api.database.DatabaseRoleOptions
- revoke(String) - Method in class com.bettercloud.vault.api.database.Database
-
Operation to revike a certificate in the vault using the Database backend.
- revoke(String) - Method in class com.bettercloud.vault.api.Leases
-
Immediately revokes a secret associated with a given lease.
- revoke(String) - Method in class com.bettercloud.vault.api.pki.Pki
-
Operation to revike a certificate in the vault using the PKI backend.
- revokeForce(String) - Method in class com.bettercloud.vault.api.Leases
-
Revokes all secrets or tokens generated under a given prefix immediately.
- revokePrefix(String) - Method in class com.bettercloud.vault.api.Leases
-
Revokes all secrets (via a lease ID prefix) or tokens (via the tokens' path property) generated under a given prefix immediately.
- revokeSelf() - Method in class com.bettercloud.vault.api.Auth
-
Revokes current client token.
- revokeSelf(String) - Method in class com.bettercloud.vault.api.Auth
-
Revokes current client token.
- role(String) - Method in class com.bettercloud.vault.api.Auth.TokenRequest
- RoleOptions - Class in com.bettercloud.vault.api.pki
-
A container for options sent to and returned by role-related endpoints on the PKI backend.
- RoleOptions() - Constructor for class com.bettercloud.vault.api.pki.RoleOptions
- rollbackStatements(List<String>) - Method in class com.bettercloud.vault.api.database.DatabaseRoleOptions
S
- seal() - Method in class com.bettercloud.vault.api.Seal
-
Seal the Vault.
- seal() - Method in class com.bettercloud.vault.Vault
-
Returns the implementing class for Vault's seal operations (e.g.
- Seal - Class in com.bettercloud.vault.api
-
The implementing class for operations on REST endpoints, under the "seal/unseal/seal-status" section of the Vault HTTP API docs (https://www.vaultproject.io/api/system/index.html).
- Seal(VaultConfig) - Constructor for class com.bettercloud.vault.api.Seal
- SealResponse - Class in com.bettercloud.vault.response
-
This class is a container for the information returned by Vault in
v1/sys/*seal*operations. - SealResponse(RestResponse, int) - Constructor for class com.bettercloud.vault.response.SealResponse
-
This constructor simply exposes the common base class constructor.
- sealStatus() - Method in class com.bettercloud.vault.api.Seal
-
Check progress of unsealing the Vault.
- sealWrap(Boolean) - Method in class com.bettercloud.vault.api.mounts.Mount
- sealWrap(Boolean) - Method in class com.bettercloud.vault.api.mounts.MountPayload
- secretsEnginePathMap(Map<String, String>) - Method in class com.bettercloud.vault.VaultConfig
-
Sets the secrets Engine paths used by Vault.
- serialNumber(String) - Method in class com.bettercloud.vault.api.pki.Credential
- serverFlag(Boolean) - Method in class com.bettercloud.vault.api.pki.RoleOptions
- set(int, boolean) - Method in class com.bettercloud.vault.json.JsonArray
-
Replaces the element at the specified position in this array with the JSON representation of the specified
booleanvalue. - set(int, double) - Method in class com.bettercloud.vault.json.JsonArray
-
Replaces the element at the specified position in this array with the JSON representation of the specified
doublevalue. - set(int, float) - Method in class com.bettercloud.vault.json.JsonArray
-
Replaces the element at the specified position in this array with the JSON representation of the specified
floatvalue. - set(int, int) - Method in class com.bettercloud.vault.json.JsonArray
-
Replaces the element at the specified position in this array with the JSON representation of the specified
intvalue. - set(int, long) - Method in class com.bettercloud.vault.json.JsonArray
-
Replaces the element at the specified position in this array with the JSON representation of the specified
longvalue. - set(int, JsonValue) - Method in class com.bettercloud.vault.json.JsonArray
-
Replaces the element at the specified position in this array with the specified JSON value.
- set(int, String) - Method in class com.bettercloud.vault.json.JsonArray
-
Replaces the element at the specified position in this array with the JSON representation of the specified string.
- set(String, boolean) - Method in class com.bettercloud.vault.json.JsonObject
-
Sets the value of the member with the specified name to the JSON representation of the specified
booleanvalue. - set(String, double) - Method in class com.bettercloud.vault.json.JsonObject
-
Sets the value of the member with the specified name to the JSON representation of the specified
doublevalue. - set(String, float) - Method in class com.bettercloud.vault.json.JsonObject
-
Sets the value of the member with the specified name to the JSON representation of the specified
floatvalue. - set(String, int) - Method in class com.bettercloud.vault.json.JsonObject
-
Sets the value of the member with the specified name to the JSON representation of the specified
intvalue. - set(String, long) - Method in class com.bettercloud.vault.json.JsonObject
-
Sets the value of the member with the specified name to the JSON representation of the specified
longvalue. - set(String, JsonValue) - Method in class com.bettercloud.vault.json.JsonObject
-
Sets the value of the member with the specified name to the specified JSON value.
- set(String, String) - Method in class com.bettercloud.vault.json.JsonObject
-
Sets the value of the member with the specified name to the JSON representation of the specified string.
- singleLine() - Static method in class com.bettercloud.vault.json.PrettyPrint
-
Print every value on a separate line.
- size() - Method in class com.bettercloud.vault.json.JsonArray
-
Returns the number of elements in this array.
- size() - Method in class com.bettercloud.vault.json.JsonObject
-
Returns the number of members (name/value pairs) in this object.
- SSH - com.bettercloud.vault.api.mounts.MountType
- sslConfig(SslConfig) - Method in class com.bettercloud.vault.VaultConfig
-
A container for SSL-related configuration options (e.g.
- SslConfig - Class in com.bettercloud.vault
-
A container for SSL-related configuration options, meant to be stored within a
VaultConfiginstance. - SslConfig() - Constructor for class com.bettercloud.vault.SslConfig
- sslContext(SSLContext) - Method in class com.bettercloud.vault.rest.Rest
- sslVerification(Boolean) - Method in class com.bettercloud.vault.rest.Rest
-
Whether or not HTTPS connections should verify that the server has a valid SSL certificate.
- SYSTEM - com.bettercloud.vault.api.mounts.MountType
T
- TimeToLive - Class in com.bettercloud.vault.api.mounts
-
A container for Time To Live information sent to mounts endpoints on the Secret Engine backend as REST payload.
- toEnableJson(MountType) - Method in class com.bettercloud.vault.api.mounts.MountPayload
- token(String) - Method in class com.bettercloud.vault.VaultConfig
-
Sets the token used to access Vault.
- TokenRequest() - Constructor for class com.bettercloud.vault.api.Auth.TokenRequest
- toString() - Method in class com.bettercloud.vault.api.mounts.TimeToLive
- toString() - Method in enum com.bettercloud.vault.api.pki.CredentialFormat
- toString() - Method in class com.bettercloud.vault.json.JsonValue
-
Returns the JSON string for this value in its minimal form, without any additional whitespace.
- toString(WriterConfig) - Method in class com.bettercloud.vault.json.JsonValue
-
Returns the JSON string for this value using the given formatting.
- TOTP - com.bettercloud.vault.api.mounts.MountType
- toTuneJson() - Method in class com.bettercloud.vault.api.mounts.MountPayload
- TRANSIT - com.bettercloud.vault.api.mounts.MountType
- TRUE - Static variable in class com.bettercloud.vault.json.Json
-
Represents the JSON literal
true. - trustStore(KeyStore) - Method in class com.bettercloud.vault.SslConfig
-
A Java keystore, containing the X509 certificate used by Vault.
- trustStoreFile(File) - Method in class com.bettercloud.vault.SslConfig
-
A Java keystore, containing the X509 certificate used by Vault.
- trustStoreResource(String) - Method in class com.bettercloud.vault.SslConfig
-
A Java keystore, containing the X509 certificate used by Vault.
- ttl(String) - Method in class com.bettercloud.vault.api.Auth.TokenRequest
- ttl(String) - Method in class com.bettercloud.vault.api.pki.RoleOptions
- tune(String, MountPayload) - Method in class com.bettercloud.vault.api.mounts.Mounts
-
Operation to tune secrets engine mount point's configuration of given path.
- type(MountType) - Method in class com.bettercloud.vault.api.mounts.Mount
- type(String) - Method in class com.bettercloud.vault.api.Auth.TokenRequest
U
- unDelete - com.bettercloud.vault.api.Logical.logicalOperations
- unDelete(String, int[]) - Method in class com.bettercloud.vault.api.Logical
-
Recovers a soft delete of the specified version of the key/value pair located at the provided path.
- unmodifiableArray(JsonArray) - Static method in class com.bettercloud.vault.json.JsonArray
-
Returns an unmodifiable wrapper for the specified JsonArray.
- unmodifiableObject(JsonObject) - Static method in class com.bettercloud.vault.json.JsonObject
-
Returns an unmodifiable JsonObject for the specified one.
- unseal(String) - Method in class com.bettercloud.vault.api.Seal
-
Enter a single master key share to progress the unsealing of the Vault.
- unseal(String, Boolean) - Method in class com.bettercloud.vault.api.Seal
-
Enter a single master key share to progress the unsealing of the Vault.
- unwrap() - Method in class com.bettercloud.vault.api.Auth
-
Returns the original response inside the wrapped auth token.
- unwrap(String) - Method in class com.bettercloud.vault.api.Auth
-
Returns the original response inside the given wrapped auth token.
- upgrade(String) - Method in class com.bettercloud.vault.api.Logical
-
Performs an upgrade of the secrets engine version of the specified KV store to version 2.
- url(String) - Method in class com.bettercloud.vault.rest.Rest
-
Sets the base URL to which the HTTP request will be sent.
- useCsrCommonName(Boolean) - Method in class com.bettercloud.vault.api.pki.RoleOptions
- useCsrSans(Boolean) - Method in class com.bettercloud.vault.api.pki.RoleOptions
- username(String) - Method in class com.bettercloud.vault.api.database.DatabaseCredential
V
- value() - Method in enum com.bettercloud.vault.api.mounts.MountType
- value(boolean) - Static method in class com.bettercloud.vault.json.Json
-
Returns a JsonValue instance that represents the given
booleanvalue. - value(double) - Static method in class com.bettercloud.vault.json.Json
-
Returns a JsonValue instance that represents the given
doublevalue. - value(float) - Static method in class com.bettercloud.vault.json.Json
-
Returns a JsonValue instance that represents the given
floatvalue. - value(int) - Static method in class com.bettercloud.vault.json.Json
-
Returns a JsonValue instance that represents the given
intvalue. - value(int[]) - Static method in class com.bettercloud.vault.json.Json
-
Returns a JsonValue instance that represents the given
int[]value. - value(long) - Static method in class com.bettercloud.vault.json.Json
-
Returns a JsonValue instance that represents the given
longvalue. - value(String) - Static method in class com.bettercloud.vault.json.Json
-
Returns a JsonValue instance that represents the given string.
- valueOf(String) - Static method in enum com.bettercloud.vault.api.Logical.logicalOperations
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.bettercloud.vault.api.mounts.MountType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.bettercloud.vault.api.pki.CredentialFormat
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.bettercloud.vault.api.Logical.logicalOperations
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.bettercloud.vault.api.mounts.MountType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.bettercloud.vault.api.pki.CredentialFormat
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Method in class com.bettercloud.vault.json.JsonArray
-
Returns a list of the values in this array in document order.
- Vault - Class in com.bettercloud.vault
-
The Vault driver class, the primary interface through which dependent applications will access Vault.
- Vault(VaultConfig) - Constructor for class com.bettercloud.vault.Vault
-
Construct a Vault driver instance with the provided config settings.
- Vault(VaultConfig, Boolean, Integer) - Constructor for class com.bettercloud.vault.Vault
-
Construct a Vault driver instance with the provided config settings.
- Vault(VaultConfig, Integer) - Constructor for class com.bettercloud.vault.Vault
-
Construct a Vault driver instance with the provided config settings, and use the provided global KV Engine version for all secrets.
- VAULT_TOKEN - Static variable in class com.bettercloud.vault.VaultConfig
- vault.java.driver - module vault.java.driver
- VaultConfig - Class in com.bettercloud.vault
-
A container for the configuration settings needed to initialize a
Vaultdriver instance. - VaultConfig() - Constructor for class com.bettercloud.vault.VaultConfig
- VaultException - Exception in com.bettercloud.vault
- VaultException(String) - Constructor for exception com.bettercloud.vault.VaultException
- VaultException(String, int) - Constructor for exception com.bettercloud.vault.VaultException
-
Use this constructor to generate a
VaultExceptioninstance that is based on receiving a particular HTTP status code from a Vault server (e.g. - VaultException(Throwable) - Constructor for exception com.bettercloud.vault.VaultException
- VaultException(Throwable, int) - Constructor for exception com.bettercloud.vault.VaultException
-
Use this constructor to generate a
VaultExceptioninstance that is based on receiving a particular HTTP status code from a Vault server (e.g. - VaultResponse - Class in com.bettercloud.vault.response
-
VaultResponseis a common base class for the response objects returned by all API methods. - VaultResponse(RestResponse, int) - Constructor for class com.bettercloud.vault.response.VaultResponse
- verify(Boolean) - Method in class com.bettercloud.vault.SslConfig
-
Whether or not HTTPS connections to the Vault server should verify that a valid SSL certificate is being used.
W
- withNameSpace(String) - Method in class com.bettercloud.vault.api.Auth
- withNameSpace(String) - Method in class com.bettercloud.vault.api.database.Database
- withNameSpace(String) - Method in class com.bettercloud.vault.api.Debug
- withNameSpace(String) - Method in class com.bettercloud.vault.api.Leases
- withNameSpace(String) - Method in class com.bettercloud.vault.api.Logical
-
Adds the requested namespace to the logical operation, which is then passed into the REST headers for said operation.
- withNameSpace(String) - Method in class com.bettercloud.vault.api.pki.Pki
- withNameSpace(String) - Method in class com.bettercloud.vault.api.Seal
- withRetries(int, int) - Method in class com.bettercloud.vault.Vault
-
This method is chained ahead of endpoints (e.g.
- write(String, Map<String, Object>) - Method in class com.bettercloud.vault.api.Logical
-
Basic operation to store secrets.
- WriterConfig - Class in com.bettercloud.vault.json
-
Controls the formatting of the JSON output.
- WriterConfig() - Constructor for class com.bettercloud.vault.json.WriterConfig
- writeTo(Writer) - Method in class com.bettercloud.vault.json.JsonValue
-
Writes the JSON representation of this value to the given writer in its minimal form, without any additional whitespace.
- writeTo(Writer, WriterConfig) - Method in class com.bettercloud.vault.json.JsonValue
-
Writes the JSON representation of this value to the given writer using the given formatting.
- writeV1 - com.bettercloud.vault.api.Logical.logicalOperations
- writeV2 - com.bettercloud.vault.api.Logical.logicalOperations
All Classes All Packages