Index
All Classes and Interfaces|All Packages|Serialized Form
A
- Actor - Class in org.springframework.credhub.support.permissions
-
Identifies an entity that is authorized to perform operations on a CredHub credential.
- ActorType - Enum Class in org.springframework.credhub.support.permissions
-
The types of entities that can be authorized to perform operations on CredHub credentials.
- addPermissions(CredentialName, Permission) - Method in interface org.springframework.credhub.core.permissionV2.CredHubPermissionV2Operations
-
Add permissions to an credential path.
- addPermissions(CredentialName, Permission) - Method in class org.springframework.credhub.core.permissionV2.CredHubPermissionV2Template
- addPermissions(CredentialName, Permission) - Method in interface org.springframework.credhub.core.permissionV2.ReactiveCredHubPermissionV2Operations
-
Add permissions to an credential path.
- addPermissions(CredentialName, Permission) - Method in class org.springframework.credhub.core.permissionV2.ReactiveCredHubPermissionV2Template
- addPermissions(CredentialName, Permission...) - Method in interface org.springframework.credhub.core.permission.CredHubPermissionOperations
-
Add permissions to an existing credential.
- addPermissions(CredentialName, Permission...) - Method in class org.springframework.credhub.core.permission.CredHubPermissionTemplate
- addPermissions(CredentialName, Permission...) - Method in interface org.springframework.credhub.core.permission.ReactiveCredHubPermissionOperations
-
Add permissions to an existing credential.
- addPermissions(CredentialName, Permission...) - Method in class org.springframework.credhub.core.permission.ReactiveCredHubPermissionTemplate
- alternateNames(String...) - Method in class org.springframework.credhub.support.certificate.CertificateParameters.CertificateParametersBuilder
-
Set the Alternative Names (SAN) field to be used for the generated certificate.
- app(String) - Static method in class org.springframework.credhub.support.permissions.Actor
-
Create an application identifier.
- app(String) - Method in class org.springframework.credhub.support.permissions.Permission.CredentialPermissionBuilder
-
Set the ID of an application that will be assigned permissions on a credential.
- APP - Enum constant in enum class org.springframework.credhub.support.permissions.ActorType
-
A Cloud Foundry application entity.
B
- build() - Method in class org.springframework.credhub.support.certificate.CertificateParameters.CertificateParametersBuilder
-
Create a
CertificateParameters
from the provided values. - build() - Method in class org.springframework.credhub.support.CredHubRequest.CredHubRequestBuilder
-
Create a
CredHubRequest
from the provided values. - build() - Method in class org.springframework.credhub.support.password.PasswordParameters.PasswordParametersBuilder
-
Create a
PasswordParameters
from the provided values. - build() - Method in class org.springframework.credhub.support.permissions.Permission.CredentialPermissionBuilder
-
Construct a
Permission
with the provided values. - build() - Method in class org.springframework.credhub.support.ServiceInstanceCredentialName.ServiceInstanceCredentialNameBuilder
-
Create a
ServiceInstanceCredentialName
from the provided values. - builder() - Static method in class org.springframework.credhub.support.certificate.CertificateCredentialRequest
-
Create a builder that provides a fluent API for providing the values required to construct a
CertificateCredentialRequest
. - builder() - Static method in class org.springframework.credhub.support.certificate.CertificateParameters
-
Create a builder that provides a fluent API for providing the values required to construct a
CertificateParameters
. - builder() - Static method in class org.springframework.credhub.support.certificate.CertificateParametersRequest
-
Create a builder that provides a fluent API for providing the values required to construct a
CertificateParametersRequest
. - builder() - Static method in class org.springframework.credhub.support.json.JsonCredentialRequest
-
Create a builder that provides a fluent API for providing the values required to construct a
JsonCredentialRequest
. - builder() - Static method in class org.springframework.credhub.support.password.PasswordCredentialRequest
-
Create a builder that provides a fluent API for providing the values required to construct a
PasswordCredentialRequest
. - builder() - Static method in class org.springframework.credhub.support.password.PasswordParameters
-
Create a builder that provides a fluent API for providing the values required to construct a
PasswordParameters
. - builder() - Static method in class org.springframework.credhub.support.password.PasswordParametersRequest
-
Create a builder that provides a fluent API for providing the values required to construct a
PasswordParametersRequest
. - builder() - Static method in class org.springframework.credhub.support.permissions.Permission
-
Create a builder that provides a fluent API for providing the values required to construct a
Permission
. - builder() - Static method in class org.springframework.credhub.support.rsa.RsaCredentialRequest
-
Create a builder that provides a fluent API for providing the values required to construct a
RsaCredentialRequest
. - builder() - Static method in class org.springframework.credhub.support.rsa.RsaParametersRequest
-
Create a builder that provides a fluent API for providing the values required to construct a
RsaParametersRequest
. - builder() - Static method in class org.springframework.credhub.support.ServiceInstanceCredentialName
-
Create a builder that provides a fluent API for providing the values required to construct a
ServiceInstanceCredentialName
. - builder() - Static method in class org.springframework.credhub.support.ssh.SshCredentialRequest
-
Create a builder that provides a fluent API for providing the values required to construct a
SshCredentialRequest
. - builder() - Static method in class org.springframework.credhub.support.ssh.SshParametersRequest
-
Create a builder that provides a fluent API for providing the values required to construct a
SshParametersRequest
. - builder() - Static method in class org.springframework.credhub.support.user.UserCredentialRequest
-
Create a builder that provides a fluent API for providing the values required to construct a
UserCredentialRequest
. - builder() - Static method in class org.springframework.credhub.support.user.UserParametersRequest
-
Create a builder that provides a fluent API for providing the values required to construct a
UserParametersRequest
. - builder() - Static method in class org.springframework.credhub.support.value.ValueCredentialRequest
-
Create a builder that provides a fluent API for providing the values required to construct a
ValueCredentialRequest
. - buildError(ClientResponse) - Static method in class org.springframework.credhub.core.ExceptionUtils
-
Helper method to return an appropriate error if a request to CredHub returns with an error code.
- buildObjectMapper() - Static method in class org.springframework.credhub.support.utils.JsonUtils
-
Create and configure the
ObjectMapper
used for serializing and deserializing JSON requests and responses.
C
- CERTIFICATE - Enum constant in enum class org.springframework.credhub.support.CredentialType
-
Indicates a credential of type
CertificateCredential
. - certificateAuthority(boolean) - Method in class org.springframework.credhub.support.certificate.CertificateParameters.CertificateParametersBuilder
-
Set the value of the flag that indicates whether the generated certificate is a certificate authority.
- certificateAuthorityCredential(String) - Method in class org.springframework.credhub.support.certificate.CertificateParameters.CertificateParametersBuilder
-
Set the name of a certificate authority credential in CredHub to sign the generated certificate with.
- certificateAuthorityCredential(CredentialName) - Method in class org.springframework.credhub.support.certificate.CertificateParameters.CertificateParametersBuilder
-
Set the name of a certificate authority credential in CredHub to sign the generated certificate with.
- CertificateCredential - Class in org.springframework.credhub.support.certificate
-
A certificate credential consists of a certificate, a certificate authority, and a private key.
- CertificateCredential(String, String, String) - Constructor for class org.springframework.credhub.support.certificate.CertificateCredential
-
Create an
CertificateCredential
from the provided public and private key. - CertificateCredentialDetails - Class in org.springframework.credhub.support.certificate
-
The details of a certificate credential that has been written to CredHub.
- CertificateCredentialDetails(String, CredentialName, CredentialType, boolean, CertificateCredential) - Constructor for class org.springframework.credhub.support.certificate.CertificateCredentialDetails
-
Create a
CertificateCredentialDetails
from the provided parameters. - CertificateCredentialRequest - Class in org.springframework.credhub.support.certificate
-
The details of a request to write a new or update an existing
CertificateCredential
in CredHub. - CertificateCredentialRequest.CertificateCredentialRequestBuilder - Class in org.springframework.credhub.support.certificate
-
A builder that provides a fluent API for constructing
CertificateCredentialRequest
s. - CertificateCredentialRequestBuilder() - Constructor for class org.springframework.credhub.support.certificate.CertificateCredentialRequest.CertificateCredentialRequestBuilder
- CertificateParameters - Class in org.springframework.credhub.support.certificate
-
Parameters for generating a new certificate credential.
- CertificateParameters.CertificateParametersBuilder - Class in org.springframework.credhub.support.certificate
-
A builder that provides a fluent API for constructing
CertificateParameters.CertificateParametersBuilder
s. - CertificateParametersBuilder() - Constructor for class org.springframework.credhub.support.certificate.CertificateParameters.CertificateParametersBuilder
- CertificateParametersRequest - Class in org.springframework.credhub.support.certificate
-
The details of a request to generate a new
CertificateCredential
in CredHub. - CertificateParametersRequest.CertificateParametersRequestBuilder - Class in org.springframework.credhub.support.certificate
-
A builder that provides a fluent API for constructing
CertificateParametersRequest
s. - CertificateParametersRequestBuilder() - Constructor for class org.springframework.credhub.support.certificate.CertificateParametersRequest.CertificateParametersRequestBuilder
- certificates() - Method in interface org.springframework.credhub.core.CredHubOperations
-
Get the operations for retrieving, regenerating, and updating certificates.
- certificates() - Method in class org.springframework.credhub.core.CredHubTemplate
-
Get the operations for retrieving, regenerating, and updating certificates.
- certificates() - Method in interface org.springframework.credhub.core.ReactiveCredHubOperations
-
Get the operations for retrieving, regenerating, and updating certificates.
- certificates() - Method in class org.springframework.credhub.core.ReactiveCredHubTemplate
-
Get the operations for retrieving, regenerating, and updating certificates.
- CertificateSummary - Class in org.springframework.credhub.support.certificate
-
A summary of a certificate that has been stored to CredHub.
- CertificateSummary(String, String) - Constructor for class org.springframework.credhub.support.certificate.CertificateSummary
-
Create a
CertificateSummary
from the provided parameters. - CertificateSummaryData - Class in org.springframework.credhub.support.certificate
-
A collection of
CertificateSummary
s. - CertificateSummaryData(CertificateSummary...) - Constructor for class org.springframework.credhub.support.certificate.CertificateSummaryData
-
Create a
CertificateSummaryData
from the provided parameters. - client(String) - Static method in class org.springframework.credhub.support.permissions.Actor
-
Create an OAuth2 client identifier.
- client(String) - Method in class org.springframework.credhub.support.permissions.Permission.CredentialPermissionBuilder
-
Set the ID of an OAuth2 client that will be assigned permissions on a credential.
- client(String, String) - Static method in class org.springframework.credhub.support.permissions.Actor
-
Create an OAuth2 client identifier.
- client(String, String) - Method in class org.springframework.credhub.support.permissions.Permission.CredentialPermissionBuilder
-
Set the ID of an OAuth2 client that will be assigned permissions on a credential.
- CLIENT_AUTH - Enum constant in enum class org.springframework.credhub.support.certificate.ExtendedKeyUsage
-
Client authentication.
- ClientHttpConnectorFactory - Class in org.springframework.credhub.configuration
-
Factory for
ClientHttpConnector
that supportsReactorClientHttpConnector
. - ClientHttpRequestFactoryFactory - Class in org.springframework.credhub.configuration
-
Factory for
ClientHttpRequestFactory
that supports Apache HTTP Components, OkHttp the JDK HTTP client (in that order). - clientOptions() - Method in class org.springframework.credhub.autoconfig.CredHubAutoConfiguration
-
Create a
ClientOptions
bean and populate it from properties. - ClientOptions - Class in org.springframework.credhub.support
-
Client options for CredHub connectivity.
- ClientOptions() - Constructor for class org.springframework.credhub.support.ClientOptions
-
Create new
ClientOptions
with default values. - ClientOptions(Duration, Duration, String[]) - Constructor for class org.springframework.credhub.support.ClientOptions
-
Create a
ClientOptions
with the provided values. - CODE_SIGNING - Enum constant in enum class org.springframework.credhub.support.certificate.ExtendedKeyUsage
-
Code signing.
- commonName(String) - Method in class org.springframework.credhub.support.certificate.CertificateParameters.CertificateParametersBuilder
-
Set the Common Name (CN) field to be used for the generated certificate.
- CONVERGE - Enum constant in enum class org.springframework.credhub.support.WriteMode
-
Indicates that CredHub should replace any existing credential value with a new value only if generation parameters are different from the original generation parameters.
- country(String) - Method in class org.springframework.credhub.support.certificate.CertificateParameters.CertificateParametersBuilder
-
Set the Country (C) field to be used for the generated certificate.
- create(ClientOptions) - Static method in class org.springframework.credhub.configuration.ClientHttpConnectorFactory
-
Create a
ClientHttpConnector
for the givenClientOptions
. - create(ClientOptions) - Static method in class org.springframework.credhub.configuration.ClientHttpRequestFactoryFactory
-
Create a
ClientHttpRequestFactory
for the givenClientOptions
. - createBuilder() - Method in class org.springframework.credhub.support.certificate.CertificateCredentialRequest.CertificateCredentialRequestBuilder
- createBuilder() - Method in class org.springframework.credhub.support.certificate.CertificateParametersRequest.CertificateParametersRequestBuilder
- createBuilder() - Method in class org.springframework.credhub.support.CredHubRequest.CredHubRequestBuilder
-
Provide the concrete builder.
- createBuilder() - Method in class org.springframework.credhub.support.json.JsonCredentialRequest.JsonCredentialRequestBuilder
- createBuilder() - Method in class org.springframework.credhub.support.password.PasswordCredentialRequest.PasswordCredentialRequestBuilder
- createBuilder() - Method in class org.springframework.credhub.support.password.PasswordParametersRequest.PasswordParametersRequestBuilder
- createBuilder() - Method in class org.springframework.credhub.support.rsa.RsaCredentialRequest.RsaCredentialRequestBuilder
- createBuilder() - Method in class org.springframework.credhub.support.rsa.RsaParametersRequest.RsaParametersRequestBuilder
- createBuilder() - Method in class org.springframework.credhub.support.ssh.SshCredentialRequest.SshCredentialRequestBuilder
- createBuilder() - Method in class org.springframework.credhub.support.ssh.SshParametersRequest.SshParametersRequestBuilder
- createBuilder() - Method in class org.springframework.credhub.support.user.UserCredentialRequest.UserCredentialRequestBuilder
- createBuilder() - Method in class org.springframework.credhub.support.user.UserParametersRequest.UserParametersRequestBuilder
- createBuilder() - Method in class org.springframework.credhub.support.value.ValueCredentialRequest.ValueCredentialRequestBuilder
- createTarget() - Method in class org.springframework.credhub.support.certificate.CertificateCredentialRequest.CertificateCredentialRequestBuilder
- createTarget() - Method in class org.springframework.credhub.support.certificate.CertificateParametersRequest.CertificateParametersRequestBuilder
- createTarget() - Method in class org.springframework.credhub.support.CredHubRequest.CredHubRequestBuilder
-
Provide the concrete object to build.
- createTarget() - Method in class org.springframework.credhub.support.json.JsonCredentialRequest.JsonCredentialRequestBuilder
- createTarget() - Method in class org.springframework.credhub.support.password.PasswordCredentialRequest.PasswordCredentialRequestBuilder
- createTarget() - Method in class org.springframework.credhub.support.password.PasswordParametersRequest.PasswordParametersRequestBuilder
- createTarget() - Method in class org.springframework.credhub.support.rsa.RsaCredentialRequest.RsaCredentialRequestBuilder
- createTarget() - Method in class org.springframework.credhub.support.rsa.RsaParametersRequest.RsaParametersRequestBuilder
- createTarget() - Method in class org.springframework.credhub.support.ssh.SshCredentialRequest.SshCredentialRequestBuilder
- createTarget() - Method in class org.springframework.credhub.support.ssh.SshParametersRequest.SshParametersRequestBuilder
- createTarget() - Method in class org.springframework.credhub.support.user.UserCredentialRequest.UserCredentialRequestBuilder
- createTarget() - Method in class org.springframework.credhub.support.user.UserParametersRequest.UserParametersRequestBuilder
- createTarget() - Method in class org.springframework.credhub.support.value.ValueCredentialRequest.ValueCredentialRequestBuilder
- CredentialDetails<T> - Class in org.springframework.credhub.support
-
The details of a credential that has been written to CredHub.
- CredentialDetails() - Constructor for class org.springframework.credhub.support.CredentialDetails
-
Create a
CredentialDetails
. - CredentialDetails(String, CredentialName, CredentialType, T) - Constructor for class org.springframework.credhub.support.CredentialDetails
-
Create a
CredentialDetails
from the provided parameters. - CredentialDetailsData<T> - Class in org.springframework.credhub.support
-
A collection of
CredentialDetails
. - CredentialDetailsData() - Constructor for class org.springframework.credhub.support.CredentialDetailsData
-
Create a
CredentialDetailsData
. - CredentialDetailsData(CredentialDetails<T>...) - Constructor for class org.springframework.credhub.support.CredentialDetailsData
-
Create a
CredentialDetailsData
from the provided parameters. - credentialName(String) - Method in class org.springframework.credhub.support.ServiceInstanceCredentialName.ServiceInstanceCredentialNameBuilder
-
Set the credential name segment of the full credential name.
- CredentialName - Class in org.springframework.credhub.support
-
The client-provided name of a credential stored in CredHub.
- CredentialPermission - Class in org.springframework.credhub.support
-
A
Permission
associated with a credential. - CredentialPermission(CredentialName, Permission) - Constructor for class org.springframework.credhub.support.CredentialPermission
-
Create a
CredentialPermission
from the provided parameters. - CredentialPermissions - Class in org.springframework.credhub.support
-
A collection of
Permission
s associated with a credential. - CredentialPermissions(CredentialName, Permission...) - Constructor for class org.springframework.credhub.support.CredentialPermissions
-
Create a
CredentialPermissions
from the provided parameters. - CredentialRequest<T> - Class in org.springframework.credhub.support
-
The details of a request to write a new or update an existing credential in CredHub.
- CredentialRequest(CredentialType) - Constructor for class org.springframework.credhub.support.CredentialRequest
-
Initialize a
CredentialRequest
. - credentials() - Method in interface org.springframework.credhub.core.CredHubOperations
-
Get the operations for saving, retrieving, and deleting credentials.
- credentials() - Method in class org.springframework.credhub.core.CredHubTemplate
-
Get the operations for saving, retrieving, and deleting credentials.
- credentials() - Method in interface org.springframework.credhub.core.ReactiveCredHubOperations
-
Get the operations for saving, retrieving, and deleting credentials.
- credentials() - Method in class org.springframework.credhub.core.ReactiveCredHubTemplate
-
Get the operations for saving, retrieving, and deleting credentials.
- CredentialSummary - Class in org.springframework.credhub.support
-
A summary of a credential that has been written to CredHub.
- CredentialSummary(CredentialName) - Constructor for class org.springframework.credhub.support.CredentialSummary
-
Create a
CredentialSummary
from the provided parameters. - CredentialSummaryData - Class in org.springframework.credhub.support
-
A collection of
CredentialSummary
s. - CredentialSummaryData(CredentialSummary...) - Constructor for class org.springframework.credhub.support.CredentialSummaryData
-
Create a
CredentialSummaryData
from the provided parameters. - credentialType - Variable in class org.springframework.credhub.support.CredHubRequest
- CredentialType - Enum Class in org.springframework.credhub.support
-
The types of credentials that can be written to CredHub.
- credHubAuthorizedClientRepository(ClientRegistrationRepository) - Method in class org.springframework.credhub.autoconfig.CredHubOAuth2AutoConfiguration
-
Create an
OAuth2AuthorizedClientRepository
bean for use with an OAuth2-enabledCredHubTemplate
. - CredHubAutoConfiguration - Class in org.springframework.credhub.autoconfig
-
Auto-configuration
for Spring CredHub support beans. - CredHubAutoConfiguration() - Constructor for class org.springframework.credhub.autoconfig.CredHubAutoConfiguration
- CredHubCertificateOperations - Interface in org.springframework.credhub.core.certificate
-
Specifies the interactions with CredHub to retrieve, regenerate, and update certificates.
- CredHubCertificateTemplate - Class in org.springframework.credhub.core.certificate
-
Implements the interactions with CredHub to retrieve, regenerate, and update certificates.
- CredHubCertificateTemplate(CredHubOperations) - Constructor for class org.springframework.credhub.core.certificate.CredHubCertificateTemplate
-
Create a new
CredHubCertificateTemplate
. - credHubClientRegistrationRepository() - Method in class org.springframework.credhub.autoconfig.CredHubOAuth2AutoConfiguration
-
Create a
ClientRegistrationRepository
bean for use with an OAuth2-enabledCredHubTemplate
. - CredHubCredentialOperations - Interface in org.springframework.credhub.core.credential
-
Specifies the interactions with CredHub to save, generate, retrieve, and delete credentials.
- CredHubCredentialTemplate - Class in org.springframework.credhub.core.credential
-
Implements the interactions with CredHub to save, retrieve, and delete credentials.
- CredHubCredentialTemplate(CredHubOperations) - Constructor for class org.springframework.credhub.core.credential.CredHubCredentialTemplate
-
Create a new
CredHubCredentialTemplate
. - CredHubException - Exception in org.springframework.credhub.core
-
Exception class to capture errors specific to CredHub communication.
- CredHubException(HttpStatusCode) - Constructor for exception org.springframework.credhub.core.CredHubException
-
Create a new exception with the provided error status code.
- CredHubException(HttpStatusCodeException) - Constructor for exception org.springframework.credhub.core.CredHubException
-
Create a new exception with the provided root cause.
- CredHubInfoOperations - Interface in org.springframework.credhub.core.info
-
Specifies the interactions with CredHub for retrieving server information.
- CredHubInfoTemplate - Class in org.springframework.credhub.core.info
-
Implements the interaction with CredHub retrieve server information.
- CredHubInfoTemplate(CredHubOperations) - Constructor for class org.springframework.credhub.core.info.CredHubInfoTemplate
-
Create a new
CredHubInfoTemplate
. - CredHubInterpolationOperations - Interface in org.springframework.credhub.core.interpolation
-
Specifies the interactions with CredHub to interpolate service binding credentials.
- CredHubInterpolationTemplate - Class in org.springframework.credhub.core.interpolation
-
Implements the main interaction with CredHub to interpolate service binding credentials.
- CredHubInterpolationTemplate(CredHubOperations) - Constructor for class org.springframework.credhub.core.interpolation.CredHubInterpolationTemplate
-
Create a new
CredHubInterpolationTemplate
. - CredHubOAuth2AutoConfiguration - Class in org.springframework.credhub.autoconfig
-
Auto-configuration
for Spring CredHub OAuth2 support beans. - CredHubOperations - Interface in org.springframework.credhub.core
-
Specifies the main interaction with CredHub.
- CredHubPermissionOperations - Interface in org.springframework.credhub.core.permission
-
Specifies the interactions with CredHub to add, retrieve, and delete permissions.
- CredHubPermissionTemplate - Class in org.springframework.credhub.core.permission
-
Implements the main interaction with CredHub to add, retrieve, and delete permissions.
- CredHubPermissionTemplate(CredHubOperations) - Constructor for class org.springframework.credhub.core.permission.CredHubPermissionTemplate
-
Create a new
CredHubPermissionTemplate
. - CredHubPermissionV2Operations - Interface in org.springframework.credhub.core.permissionV2
-
Specifies the interactions with CredHub to add, retrieve, and delete permissions.
- CredHubPermissionV2Template - Class in org.springframework.credhub.core.permissionV2
-
Implements the main interaction with CredHub to add, retrieve, and delete permissions.
- CredHubPermissionV2Template(CredHubOperations) - Constructor for class org.springframework.credhub.core.permissionV2.CredHubPermissionV2Template
-
Create a new
CredHubPermissionV2Template
. - credHubProperties() - Method in class org.springframework.credhub.autoconfig.CredHubAutoConfiguration
-
Create a
CredHubProperties
bean and populate it from properties. - CredHubProperties - Class in org.springframework.credhub.core
-
Properties containing information about a CredHub server.
- CredHubProperties() - Constructor for class org.springframework.credhub.core.CredHubProperties
-
Create a new instance without initializing properties.
- CredHubProperties.OAuth2 - Class in org.springframework.credhub.core
-
Properties containing OAuth2 credentials for CredHub connectivity.
- credHubReactiveAuthorizedClientManager(ReactiveClientRegistrationRepository, ReactiveOAuth2AuthorizedClientService) - Method in class org.springframework.credhub.autoconfig.CredHubOAuth2AutoConfiguration
-
Create a
ReactiveOAuth2AuthorizedClientManager
bean for use with an OAuth2-enabledReactiveCredHubTemplate
, to override the default provided byReactiveOAuth2ClientAutoConfiguration
. - credHubReactiveAuthorizedClientService(ReactiveClientRegistrationRepository) - Method in class org.springframework.credhub.autoconfig.CredHubOAuth2AutoConfiguration
-
Create a
ReactiveOAuth2AuthorizedClientService
bean for use with an OAuth2-enabledReactiveCredHubTemplate
, to override the default provided byReactiveOAuth2ClientAutoConfiguration
. - credHubReactiveClientRegistrationRepository() - Method in class org.springframework.credhub.autoconfig.CredHubOAuth2AutoConfiguration
-
Create a
ReactiveClientRegistrationRepository
bean for use with an OAuth2-enabledReactiveCredHubTemplate
, in caseReactiveOAuth2ClientAutoConfiguration
doesn't configure one. - CredHubRequest<T> - Class in org.springframework.credhub.support
-
Fields common to all types of CredHub requests.
- CredHubRequest() - Constructor for class org.springframework.credhub.support.CredHubRequest
- CredHubRequest.CredHubRequestBuilder<T,
R extends CredHubRequest<T>, B extends CredHubRequest.CredHubRequestBuilder<T, R, B>> - Class in org.springframework.credhub.support -
A builder that provides a fluent API for constructing
CredHubRequest
s. - CredHubRequestBuilder() - Constructor for class org.springframework.credhub.support.CredHubRequest.CredHubRequestBuilder
-
Create a
CredHubRequest.CredHubRequestBuilder
. - credHubTemplate(CredHubProperties, ClientOptions) - Method in class org.springframework.credhub.configuration.CredHubTemplateFactory
-
Create a
CredHubTemplate
for interaction with a CredHub server. - credHubTemplate(CredHubProperties, ClientOptions, ClientRegistrationRepository, OAuth2AuthorizedClientManager) - Method in class org.springframework.credhub.configuration.CredHubTemplateFactory
-
Create a
CredHubTemplate
for interaction with a CredHub server using OAuth2 for authentication. - credHubTemplate(CredHubProperties, ClientOptions, ClientRegistrationRepository, OAuth2AuthorizedClientRepository) - Method in class org.springframework.credhub.configuration.CredHubTemplateFactory
-
Create a
CredHubTemplate
for interaction with a CredHub server using OAuth2 for authentication. - CredHubTemplate - Class in org.springframework.credhub.core
-
Implements the main interaction with CredHub.
- CredHubTemplate(CredHubProperties, ClientHttpRequestFactory) - Constructor for class org.springframework.credhub.core.CredHubTemplate
-
Create a new
CredHubTemplate
using the provided connection properties andClientHttpRequestFactory
. - CredHubTemplate(CredHubProperties, ClientHttpRequestFactory, ClientRegistrationRepository, OAuth2AuthorizedClientManager) - Constructor for class org.springframework.credhub.core.CredHubTemplate
-
Create a new
CredHubTemplate
using the provided connection properties,ClientHttpRequestFactory
, and OAuth2 support. - CredHubTemplate(CredHubProperties, ClientHttpRequestFactory, ClientRegistrationRepository, OAuth2AuthorizedClientRepository) - Constructor for class org.springframework.credhub.core.CredHubTemplate
-
Create a new
CredHubTemplate
using the provided connection properties,ClientHttpRequestFactory
, and OAuth2 support. - CredHubTemplate(RestTemplate) - Constructor for class org.springframework.credhub.core.CredHubTemplate
-
Create a new
CredHubTemplate
using the providedRestTemplate
. - CredHubTemplateAutoConfiguration - Class in org.springframework.credhub.autoconfig
-
Auto-configuration
forCredHubTemplate
. - CredHubTemplateAutoConfiguration() - Constructor for class org.springframework.credhub.autoconfig.CredHubTemplateAutoConfiguration
- CredHubTemplateConfiguration - Class in org.springframework.credhub.autoconfig
-
Configuration for
CredHubTemplate
. - CredHubTemplateConfiguration() - Constructor for class org.springframework.credhub.autoconfig.CredHubTemplateConfiguration
- CredHubTemplateFactory - Class in org.springframework.credhub.configuration
-
Factory for
CredHubTemplate
used to communicate with CredHub. - CredHubTemplateFactory() - Constructor for class org.springframework.credhub.configuration.CredHubTemplateFactory
- CRL_SIGN - Enum constant in enum class org.springframework.credhub.support.certificate.KeyUsage
-
CRL signing key.
D
- DATA_ENCIPHERMENT - Enum constant in enum class org.springframework.credhub.support.certificate.KeyUsage
-
Data encipherment key.
- DECIPHER_ONLY - Enum constant in enum class org.springframework.credhub.support.certificate.KeyUsage
-
Decipher only key.
- DELETE - Enum constant in enum class org.springframework.credhub.support.permissions.Operation
-
Allows a credential to be deleted.
- deleteByName(CredentialName) - Method in interface org.springframework.credhub.core.credential.CredHubCredentialOperations
-
Delete a credential by its full name.
- deleteByName(CredentialName) - Method in class org.springframework.credhub.core.credential.CredHubCredentialTemplate
- deleteByName(CredentialName) - Method in interface org.springframework.credhub.core.credential.ReactiveCredHubCredentialOperations
-
Delete a credential by its full name.
- deleteByName(CredentialName) - Method in class org.springframework.credhub.core.credential.ReactiveCredHubCredentialTemplate
- deletePermission(String) - Method in interface org.springframework.credhub.core.permissionV2.CredHubPermissionV2Operations
-
Delete a permission.
- deletePermission(String) - Method in class org.springframework.credhub.core.permissionV2.CredHubPermissionV2Template
- deletePermission(String) - Method in interface org.springframework.credhub.core.permissionV2.ReactiveCredHubPermissionV2Operations
-
Delete a permission.
- deletePermission(String) - Method in class org.springframework.credhub.core.permissionV2.ReactiveCredHubPermissionV2Template
- deletePermission(CredentialName, Actor) - Method in interface org.springframework.credhub.core.permission.CredHubPermissionOperations
-
Delete a permission associated with a credential.
- deletePermission(CredentialName, Actor) - Method in class org.springframework.credhub.core.permission.CredHubPermissionTemplate
- deletePermission(CredentialName, Actor) - Method in interface org.springframework.credhub.core.permission.ReactiveCredHubPermissionOperations
-
Delete a permission associated with a credential.
- deletePermission(CredentialName, Actor) - Method in class org.springframework.credhub.core.permission.ReactiveCredHubPermissionTemplate
- details - Variable in class org.springframework.credhub.support.CredHubRequest
- DIGITAL_SIGNATURE - Enum constant in enum class org.springframework.credhub.support.certificate.KeyUsage
-
Digital signature key.
- doWithRest(RestOperationsCallback<T>) - Method in interface org.springframework.credhub.core.CredHubOperations
-
Allow interaction with the configured
RestTemplate
not provided by other methods. - doWithRest(RestOperationsCallback<T>) - Method in class org.springframework.credhub.core.CredHubTemplate
-
Allow interaction with the configured
RestTemplate
not provided by other methods. - doWithRestOperations(RestOperations) - Method in interface org.springframework.credhub.core.RestOperationsCallback
-
Callback method providing a
RestOperations
that is configured to interact with the CredHub server. - doWithWebClient(Function<WebClient, ? extends T>) - Method in interface org.springframework.credhub.core.ReactiveCredHubOperations
-
Allow interaction with the configured
WebClient
not provided by other methods. - doWithWebClient(Function<WebClient, ? extends T>) - Method in class org.springframework.credhub.core.ReactiveCredHubTemplate
-
Allow interaction with the configured
WebClient
not provided by other methods. - duration(int) - Method in class org.springframework.credhub.support.certificate.CertificateParameters.CertificateParametersBuilder
-
Set the duration in days that the generated certificate should be valid.
E
- EMAIL_PROTECTION - Enum constant in enum class org.springframework.credhub.support.certificate.ExtendedKeyUsage
-
Email protection.
- ENCIPHER_ONLY - Enum constant in enum class org.springframework.credhub.support.certificate.KeyUsage
-
Encipher only key.
- equals(Object) - Method in class org.springframework.credhub.support.certificate.CertificateSummary
- equals(Object) - Method in class org.springframework.credhub.support.certificate.CertificateSummaryData
- equals(Object) - Method in class org.springframework.credhub.support.CredentialDetails
- equals(Object) - Method in class org.springframework.credhub.support.CredentialDetailsData
- equals(Object) - Method in class org.springframework.credhub.support.CredentialName
- equals(Object) - Method in class org.springframework.credhub.support.CredentialPermission
- equals(Object) - Method in class org.springframework.credhub.support.CredentialPermissions
- equals(Object) - Method in class org.springframework.credhub.support.CredentialSummary
- equals(Object) - Method in class org.springframework.credhub.support.CredentialSummaryData
- equals(Object) - Method in class org.springframework.credhub.support.CredHubRequest
- equals(Object) - Method in class org.springframework.credhub.support.permissions.Actor
- equals(Object) - Method in class org.springframework.credhub.support.permissions.Permission
- equals(Object) - Method in class org.springframework.credhub.support.StringCredential
- ExceptionUtils - Class in org.springframework.credhub.core
- excludeLower(boolean) - Method in class org.springframework.credhub.support.password.PasswordParameters.PasswordParametersBuilder
-
Set the value of the exclude lower case characters parameter.
- excludeNumber(boolean) - Method in class org.springframework.credhub.support.password.PasswordParameters.PasswordParametersBuilder
-
Set the value of the exclude numeric characters parameter.
- excludeUpper(boolean) - Method in class org.springframework.credhub.support.password.PasswordParameters.PasswordParametersBuilder
-
Set the value of the exclude upper case characters parameter.
- extendedKeyUsage(ExtendedKeyUsage...) - Method in class org.springframework.credhub.support.certificate.CertificateParameters.CertificateParametersBuilder
-
Set the value of the extended key usage extensions for the generated certificate.
- ExtendedKeyUsage - Enum Class in org.springframework.credhub.support.certificate
-
The types of extended key usage extensions that can be assigned to a generated certificate.
F
- findByName(CredentialName) - Method in interface org.springframework.credhub.core.credential.CredHubCredentialOperations
-
Find a credential using a full or partial name.
- findByName(CredentialName) - Method in class org.springframework.credhub.core.credential.CredHubCredentialTemplate
- findByName(CredentialName) - Method in interface org.springframework.credhub.core.credential.ReactiveCredHubCredentialOperations
-
Find a credential using a full or partial name.
- findByName(CredentialName) - Method in class org.springframework.credhub.core.credential.ReactiveCredHubCredentialTemplate
- findByPath(String) - Method in interface org.springframework.credhub.core.credential.CredHubCredentialOperations
-
Find a credential using a path.
- findByPath(String) - Method in class org.springframework.credhub.core.credential.CredHubCredentialTemplate
- findByPath(String) - Method in interface org.springframework.credhub.core.credential.ReactiveCredHubCredentialOperations
-
Find a credential using a path.
- findByPath(String) - Method in class org.springframework.credhub.core.credential.ReactiveCredHubCredentialTemplate
G
- generate(ParametersRequest<P>) - Method in interface org.springframework.credhub.core.credential.CredHubCredentialOperations
-
Generate a new credential in CredHub, or overwrite an existing credential with a new generated value.
- generate(ParametersRequest<P>) - Method in class org.springframework.credhub.core.credential.CredHubCredentialTemplate
- generate(ParametersRequest<P>, Class<T>) - Method in interface org.springframework.credhub.core.credential.ReactiveCredHubCredentialOperations
-
Generate a new credential in CredHub, or overwrite an existing credential with a new generated value.
- generate(ParametersRequest<P>, Class<T>) - Method in class org.springframework.credhub.core.credential.ReactiveCredHubCredentialTemplate
- getActor() - Method in class org.springframework.credhub.support.permissions.Permission
-
Get the ID of the entity that will be allowed to access the credential.
- getAll() - Method in interface org.springframework.credhub.core.certificate.CredHubCertificateOperations
-
Retrieve all certificates from CredHub.
- getAll() - Method in class org.springframework.credhub.core.certificate.CredHubCertificateTemplate
- getAll() - Method in interface org.springframework.credhub.core.certificate.ReactiveCredHubCertificateOperations
-
Retrieve all certificates from CredHub.
- getAll() - Method in class org.springframework.credhub.core.certificate.ReactiveCredHubCertificateTemplate
- getAlternativeNames() - Method in class org.springframework.credhub.support.certificate.CertificateParameters
-
Get the value of the alternative names parameter that will be used when generating the certificate.
- getAuthType() - Method in class org.springframework.credhub.support.permissions.Actor
-
Get the type of the authorized entity.
- getById(String, Class<T>) - Method in interface org.springframework.credhub.core.credential.CredHubCredentialOperations
-
Retrieve a credential using its ID, as returned in a write request.
- getById(String, Class<T>) - Method in class org.springframework.credhub.core.credential.CredHubCredentialTemplate
- getById(String, Class<T>) - Method in interface org.springframework.credhub.core.credential.ReactiveCredHubCredentialOperations
-
Retrieve a credential using its ID, as returned in a write request.
- getById(String, Class<T>) - Method in class org.springframework.credhub.core.credential.ReactiveCredHubCredentialTemplate
- getByName(CredentialName) - Method in interface org.springframework.credhub.core.certificate.CredHubCertificateOperations
-
Retrieve a certificate using its name.
- getByName(CredentialName) - Method in class org.springframework.credhub.core.certificate.CredHubCertificateTemplate
- getByName(CredentialName) - Method in interface org.springframework.credhub.core.certificate.ReactiveCredHubCertificateOperations
-
Retrieve a certificate using its name.
- getByName(CredentialName) - Method in class org.springframework.credhub.core.certificate.ReactiveCredHubCertificateTemplate
- getByName(CredentialName, Class<T>) - Method in interface org.springframework.credhub.core.credential.CredHubCredentialOperations
-
Retrieve a credential using its name, as passed to a write request.
- getByName(CredentialName, Class<T>) - Method in class org.springframework.credhub.core.credential.CredHubCredentialTemplate
- getByName(CredentialName, Class<T>) - Method in interface org.springframework.credhub.core.credential.ReactiveCredHubCredentialOperations
-
Retrieve a credential using its name, as passed to a write request.
- getByName(CredentialName, Class<T>) - Method in class org.springframework.credhub.core.credential.ReactiveCredHubCredentialTemplate
- getByNameWithHistory(CredentialName, int, Class<T>) - Method in interface org.springframework.credhub.core.credential.CredHubCredentialOperations
-
Retrieve a credential using its name, as passed to a write request.
- getByNameWithHistory(CredentialName, int, Class<T>) - Method in class org.springframework.credhub.core.credential.CredHubCredentialTemplate
- getByNameWithHistory(CredentialName, int, Class<T>) - Method in interface org.springframework.credhub.core.credential.ReactiveCredHubCredentialOperations
-
Retrieve a credential using its name, as passed to a write request.
- getByNameWithHistory(CredentialName, int, Class<T>) - Method in class org.springframework.credhub.core.credential.ReactiveCredHubCredentialTemplate
- getByNameWithHistory(CredentialName, Class<T>) - Method in interface org.springframework.credhub.core.credential.CredHubCredentialOperations
-
Retrieve a credential using its name, as passed to a write request.
- getByNameWithHistory(CredentialName, Class<T>) - Method in class org.springframework.credhub.core.credential.CredHubCredentialTemplate
- getByNameWithHistory(CredentialName, Class<T>) - Method in interface org.springframework.credhub.core.credential.ReactiveCredHubCredentialOperations
-
Retrieve a credential using its name, as passed to a write request.
- getByNameWithHistory(CredentialName, Class<T>) - Method in class org.springframework.credhub.core.credential.ReactiveCredHubCredentialTemplate
- getCa() - Method in class org.springframework.credhub.support.certificate.CertificateParameters
-
Get the value of the certificate authority parameter that will be used when generating the certificate.
- getCaCertFiles() - Method in class org.springframework.credhub.support.ClientOptions
- getCertificate() - Method in class org.springframework.credhub.support.certificate.CertificateCredential
-
Get the certificate value.
- getCertificateAuthority() - Method in class org.springframework.credhub.support.certificate.CertificateCredential
-
Get the certificate authority value.
- getCertificates() - Method in class org.springframework.credhub.support.certificate.CertificateSummaryData
-
Get the collection of
CertificateSummary
s. - getCommonName() - Method in class org.springframework.credhub.support.certificate.CertificateParameters
-
Get the value of the common name parameter that will be used when generating the certificate.
- getConnectionTimeout() - Method in class org.springframework.credhub.support.ClientOptions
-
Get the connection timeout in
TimeUnit.MILLISECONDS
. - getConnectionTimeoutMillis() - Method in class org.springframework.credhub.support.ClientOptions
-
Get the connection timeout in
TimeUnit.MILLISECONDS
. - getCountry() - Method in class org.springframework.credhub.support.certificate.CertificateParameters
-
Get the value of the country parameter that will be used when generating the certificate.
- getCredentialName() - Method in class org.springframework.credhub.support.CredentialPermissions
-
Get the name of the credential that the permissions apply to.
- getCredentials() - Method in class org.springframework.credhub.support.CredentialSummaryData
-
Get the collection of
CredentialSummary
s. - getCredentialType() - Method in class org.springframework.credhub.support.CredentialDetails
-
Get the client-provided
CredentialType
of the credential. - getData() - Method in class org.springframework.credhub.support.CredentialDetailsData
-
Get the collection of
CredentialDetails
. - getDuration() - Method in class org.springframework.credhub.support.certificate.CertificateParameters
-
Get the value of the duration (in days) parameter that will be used when generating the certificate.
- getExcludeLower() - Method in class org.springframework.credhub.support.password.PasswordParameters
-
Get the value of the exclude lower case characters parameter.
- getExcludeNumber() - Method in class org.springframework.credhub.support.password.PasswordParameters
-
Get the value of the exclude numeric characters parameter.
- getExcludeUpper() - Method in class org.springframework.credhub.support.password.PasswordParameters
-
Get the value of the exclude upper case characters parameter.
- getExtendedKeyUsage() - Method in class org.springframework.credhub.support.certificate.CertificateParameters
-
Get the value of the extended key usage extensions that will be used when generating the certificate.
- getId() - Method in class org.springframework.credhub.support.certificate.CertificateSummary
-
Get the CredHub-generated ID of the certificate credential.
- getId() - Method in class org.springframework.credhub.support.CredentialDetails
-
Get the the CredHub-generated unique ID of the credential.
- getId() - Method in class org.springframework.credhub.support.CredentialPermission
-
Get the CredHub-assigned ID of the permission.
- getIdentity() - Method in class org.springframework.credhub.support.permissions.Actor
-
Get the full identifier for the authorized entity, which is a combination of the type and identity.
- getIncludeSpecial() - Method in class org.springframework.credhub.support.password.PasswordParameters
-
Get the value of the include non-alphanumeric characters parameter.
- getIsCa() - Method in class org.springframework.credhub.support.certificate.CertificateParameters
-
Get the value of the flag that indicates whether the generated certificate is a certificate authority.
- getKeyLength() - Method in class org.springframework.credhub.support.KeyParameters
-
Get the value of the key length parameter.
- getKeyUsage() - Method in class org.springframework.credhub.support.certificate.CertificateParameters
-
Get the value of the key usage extensions that will be used when generating the certificate.
- getLength() - Method in enum class org.springframework.credhub.support.KeyLength
- getLength() - Method in class org.springframework.credhub.support.password.PasswordParameters
-
Get the value of the length parameter.
- getLocality() - Method in class org.springframework.credhub.support.certificate.CertificateParameters
-
Get the value of the locality parameter that will be used when generating the certificate.
- getMode() - Method in class org.springframework.credhub.support.CredHubRequest
-
Get the value of the write mode indicator.
- getMode() - Method in enum class org.springframework.credhub.support.WriteMode
-
Get the
mode
value as aString
. - getModelClass() - Method in enum class org.springframework.credhub.support.CredentialType
-
Get the class that models requests of the credential type.
- getName() - Method in class org.springframework.credhub.support.certificate.CertificateSummary
-
Get the client-provided name of the certificate credential.
- getName() - Method in class org.springframework.credhub.support.CredentialName
-
Builds a name from the provided segments.
- getName() - Method in class org.springframework.credhub.support.CredentialSummary
-
Get the client-provided name of the credential.
- getName() - Method in class org.springframework.credhub.support.CredHubRequest
-
Get the
CredentialName
of the credential. - getOauth2() - Method in class org.springframework.credhub.core.CredHubProperties
-
Get the OAuth2 properties.
- getOperations() - Method in class org.springframework.credhub.support.permissions.Permission
-
Get the set of operations that the actor will be allowed to perform on the credential.
- getOrganization() - Method in class org.springframework.credhub.support.certificate.CertificateParameters
-
Get the value of the organization parameter that will be used when generating the certificate.
- getOrganizationUnit() - Method in class org.springframework.credhub.support.certificate.CertificateParameters
-
Get the value of the organization unit parameter that will be used when generating the certificate.
- getParameters() - Method in class org.springframework.credhub.support.ParametersRequest
-
Get the parameters of the credential.
- getPassword() - Method in class org.springframework.credhub.support.password.PasswordCredential
-
Get the password value.
- getPassword() - Method in class org.springframework.credhub.support.user.UserCredential
-
Get the user password.
- getPasswordHash() - Method in class org.springframework.credhub.support.user.UserCredential
-
Get the SHA-512 hash of the user password.
- getPath() - Method in class org.springframework.credhub.support.CredentialPermission
-
Get the name of the credential that the permission apply to.
- getPermission() - Method in class org.springframework.credhub.support.CredentialPermission
-
Get the collection of
Permission
s. - getPermissions() - Method in class org.springframework.credhub.support.CredentialPermissions
-
Get the collection of
Permission
s. - getPermissions(String) - Method in interface org.springframework.credhub.core.permissionV2.CredHubPermissionV2Operations
-
Get a permission.
- getPermissions(String) - Method in class org.springframework.credhub.core.permissionV2.CredHubPermissionV2Template
- getPermissions(String) - Method in interface org.springframework.credhub.core.permissionV2.ReactiveCredHubPermissionV2Operations
-
Get a permission.
- getPermissions(String) - Method in class org.springframework.credhub.core.permissionV2.ReactiveCredHubPermissionV2Template
- getPermissions(CredentialName) - Method in interface org.springframework.credhub.core.permission.CredHubPermissionOperations
-
Get the permissions associated with a credential.
- getPermissions(CredentialName) - Method in class org.springframework.credhub.core.permission.CredHubPermissionTemplate
- getPermissions(CredentialName) - Method in interface org.springframework.credhub.core.permission.ReactiveCredHubPermissionOperations
-
Get the permissions associated with a credential.
- getPermissions(CredentialName) - Method in class org.springframework.credhub.core.permission.ReactiveCredHubPermissionTemplate
- getPermissionsByPathAndActor(CredentialName, Actor) - Method in interface org.springframework.credhub.core.permissionV2.CredHubPermissionV2Operations
-
Get a permission by path and actor.
- getPermissionsByPathAndActor(CredentialName, Actor) - Method in class org.springframework.credhub.core.permissionV2.CredHubPermissionV2Template
- getPermissionsByPathAndActor(CredentialName, Actor) - Method in interface org.springframework.credhub.core.permissionV2.ReactiveCredHubPermissionV2Operations
-
Get a permission by path and actor.
- getPermissionsByPathAndActor(CredentialName, Actor) - Method in class org.springframework.credhub.core.permissionV2.ReactiveCredHubPermissionV2Template
- getPrimaryIdentifier() - Method in class org.springframework.credhub.support.permissions.Actor
-
Get the identity of the authorized entity.
- getPrivateKey() - Method in class org.springframework.credhub.support.certificate.CertificateCredential
-
Get the private key value.
- getPrivateKey() - Method in class org.springframework.credhub.support.KeyPairCredential
-
Get the value of the private key.
- getPublicKey() - Method in class org.springframework.credhub.support.KeyPairCredential
-
Get the value of the public key.
- getPublicKeyFingerprint() - Method in class org.springframework.credhub.support.ssh.SshCredential
-
Get the fingerprint of the public key associated with the credential.
- getReadTimeout() - Method in class org.springframework.credhub.support.ClientOptions
-
Get the read timeout in
TimeUnit.MILLISECONDS
. - getReadTimeoutMillis() - Method in class org.springframework.credhub.support.ClientOptions
-
Get the read timeout in
TimeUnit.MILLISECONDS
. - getRegistrationId() - Method in class org.springframework.credhub.core.CredHubProperties.OAuth2
-
Get the OAuth2 client registration ID used to authenticate with CredHub.
- getSelfSign() - Method in class org.springframework.credhub.support.certificate.CertificateParameters
-
Get the value of the flag that indicates whether the generated certificate is self-signed.
- getSshComment() - Method in class org.springframework.credhub.support.ssh.SshParameters
-
Get the value of the ssh comment parameter.
- getState() - Method in class org.springframework.credhub.support.certificate.CertificateParameters
-
Get the value of the state parameter that will be used when generating the certificate.
- getType() - Method in class org.springframework.credhub.support.CredHubRequest
-
Get the
CredentialType
of the credential. - getType() - Method in enum class org.springframework.credhub.support.permissions.ActorType
-
Get the entity type.
- getTypeByString(int) - Static method in enum class org.springframework.credhub.support.KeyLength
-
Convert an integer value to its enum value.
- getUrl() - Method in class org.springframework.credhub.core.CredHubProperties
-
Get the base URI for the CredHub server (scheme, host, and port).
- getUsername() - Method in class org.springframework.credhub.support.user.UserCredential
-
Get the user name.
- getUsername() - Method in class org.springframework.credhub.support.user.UserParametersRequest.UserValue
- getValue() - Method in enum class org.springframework.credhub.support.certificate.ExtendedKeyUsage
-
Get the value as a
String
. - getValue() - Method in enum class org.springframework.credhub.support.certificate.KeyUsage
-
Get the value as a
String
. - getValue() - Method in class org.springframework.credhub.support.CredentialDetails
-
Get the client-provided value for the credential.
- getValue() - Method in class org.springframework.credhub.support.CredentialRequest
-
Get the value of the credential.
- getValue() - Method in class org.springframework.credhub.support.user.UserParametersRequest
-
Get the value of the username parameter.
- getValue() - Method in class org.springframework.credhub.support.value.ValueCredential
-
Get the credential value.
- getValueType() - Method in enum class org.springframework.credhub.support.CredentialType
-
Get the type value that will be used in requests to CredHub.
- getVersion() - Method in class org.springframework.credhub.support.info.VersionInfo
-
Get the value of the version string returned from the CredHub server.
- getVersionCreatedAt() - Method in class org.springframework.credhub.support.CredentialSummary
-
Get the CredHub-generated
Date
when this version of the credential was created.
H
- hashCode() - Method in class org.springframework.credhub.support.certificate.CertificateSummary
- hashCode() - Method in class org.springframework.credhub.support.certificate.CertificateSummaryData
- hashCode() - Method in class org.springframework.credhub.support.CredentialDetails
- hashCode() - Method in class org.springframework.credhub.support.CredentialDetailsData
- hashCode() - Method in class org.springframework.credhub.support.CredentialName
- hashCode() - Method in class org.springframework.credhub.support.CredentialPermission
- hashCode() - Method in class org.springframework.credhub.support.CredentialPermissions
- hashCode() - Method in class org.springframework.credhub.support.CredentialSummary
- hashCode() - Method in class org.springframework.credhub.support.CredentialSummaryData
- hashCode() - Method in class org.springframework.credhub.support.CredHubRequest
- hashCode() - Method in class org.springframework.credhub.support.permissions.Actor
- hashCode() - Method in class org.springframework.credhub.support.permissions.Permission
- hashCode() - Method in class org.springframework.credhub.support.StringCredential
I
- includeSpecial(boolean) - Method in class org.springframework.credhub.support.password.PasswordParameters.PasswordParametersBuilder
-
Set the value of the include special characters parameter.
- info() - Method in interface org.springframework.credhub.core.CredHubOperations
-
Get the operations for retrieving CredHub server information.
- info() - Method in class org.springframework.credhub.core.CredHubTemplate
-
Get the operations for retrieving CredHub server information.
- info() - Method in interface org.springframework.credhub.core.ReactiveCredHubOperations
-
Get the operations for retrieving CredHub server information.
- info() - Method in class org.springframework.credhub.core.ReactiveCredHubTemplate
-
Get the operations for retrieving CredHub server information.
- interpolateServiceData(ServicesData) - Method in interface org.springframework.credhub.core.interpolation.CredHubInterpolationOperations
-
Search the provided data structure of bound service credentials, looking for references to CredHub credentials.
- interpolateServiceData(ServicesData) - Method in class org.springframework.credhub.core.interpolation.CredHubInterpolationTemplate
- interpolateServiceData(ServicesData) - Method in interface org.springframework.credhub.core.interpolation.ReactiveCredHubInterpolationOperations
-
Search the provided data structure of bound service credentials, looking for references to CredHub credentials.
- interpolateServiceData(ServicesData) - Method in class org.springframework.credhub.core.interpolation.ReactiveCredHubInterpolationTemplate
- interpolation() - Method in interface org.springframework.credhub.core.CredHubOperations
-
Get the operations for interpolating service binding credentials.
- interpolation() - Method in class org.springframework.credhub.core.CredHubTemplate
-
Get the operations for interpolating service binding credentials.
- interpolation() - Method in interface org.springframework.credhub.core.ReactiveCredHubOperations
-
Get the operations for interpolating service binding credentials.
- interpolation() - Method in class org.springframework.credhub.core.ReactiveCredHubTemplate
-
Get the operations for interpolating service binding credentials.
- isTransitional() - Method in class org.springframework.credhub.support.certificate.CertificateCredentialDetails
-
Get the value of the flag indicating whether the certificate is currently being used for signing or if it is being staged.
- isUsingOAuth2() - Method in class org.springframework.credhub.core.CredHubTemplate
- isUsingOAuth2() - Method in class org.springframework.credhub.core.ReactiveCredHubTemplate
- isVersion1() - Method in class org.springframework.credhub.support.info.VersionInfo
-
Determine if the CredHub server implements the v1 API.
- isVersion2() - Method in class org.springframework.credhub.support.info.VersionInfo
-
Determine if the CredHub server implements the v2 API.
- isVersion2_0() - Method in class org.springframework.credhub.support.info.VersionInfo
-
Determine if the CredHub server implements the v2.0 API.
- isVersion2_1() - Method in class org.springframework.credhub.support.info.VersionInfo
-
Determine if the CredHub server implements the v2.1 API.
J
- JSON - Enum constant in enum class org.springframework.credhub.support.CredentialType
-
Indicates a credential of type
JsonCredential
. - JsonCredential - Class in org.springframework.credhub.support.json
-
A JSON credential consists of one or more fields in a JSON document.
- JsonCredential() - Constructor for class org.springframework.credhub.support.json.JsonCredential
-
Create a
JsonCredential
. - JsonCredential(int) - Constructor for class org.springframework.credhub.support.json.JsonCredential
-
Create a
JsonCredential
with the specified initial capacity. - JsonCredential(int, float) - Constructor for class org.springframework.credhub.support.json.JsonCredential
-
Create a
JsonCredential
with the specified initial capacity and load factor. - JsonCredential(Map<? extends String, ?>) - Constructor for class org.springframework.credhub.support.json.JsonCredential
-
Create a
JsonCredential
from the provided Map. - JsonCredentialRequest - Class in org.springframework.credhub.support.json
-
The details of a request to write a new or update an existing
JsonCredential
in CredHub. - JsonCredentialRequest.JsonCredentialRequestBuilder - Class in org.springframework.credhub.support.json
-
A builder that provides a fluent API for constructing
JsonCredentialRequest
s. - JsonCredentialRequestBuilder() - Constructor for class org.springframework.credhub.support.json.JsonCredentialRequest.JsonCredentialRequestBuilder
- JsonUtils - Class in org.springframework.credhub.support.utils
-
Utility methods for configuring JSON serialization and deserialization.
K
- KEY_AGREEMENT - Enum constant in enum class org.springframework.credhub.support.certificate.KeyUsage
-
Key agreement key.
- KEY_CERT_SIGN - Enum constant in enum class org.springframework.credhub.support.certificate.KeyUsage
-
Key certificate signing key.
- KEY_ENCIPHERMENT - Enum constant in enum class org.springframework.credhub.support.certificate.KeyUsage
-
Key encipherment key.
- keyLength - Variable in class org.springframework.credhub.support.KeyParameters
- keyLength(KeyLength) - Method in class org.springframework.credhub.support.certificate.CertificateParameters.CertificateParametersBuilder
-
Set the length of the key for the generated certificate.
- KeyLength - Enum Class in org.springframework.credhub.support
- KeyPairCredential - Class in org.springframework.credhub.support
-
Base class for credentials types that contain a public/private key pair.
- KeyPairCredential() - Constructor for class org.springframework.credhub.support.KeyPairCredential
-
Create an empty
KeyPairCredential
. - KeyPairCredential(String, String) - Constructor for class org.springframework.credhub.support.KeyPairCredential
-
Create a
KeyPairCredential
from the provided parameters. - KeyParameters - Class in org.springframework.credhub.support
-
Base class for parameter types that contain specifications for key generation.
- KeyParameters() - Constructor for class org.springframework.credhub.support.KeyParameters
-
Create an empty
KeyParameters
. - KeyParameters(KeyLength) - Constructor for class org.springframework.credhub.support.KeyParameters
-
Create a
KeyParameters
with the specified key length. - keyUsage(KeyUsage...) - Method in class org.springframework.credhub.support.certificate.CertificateParameters.CertificateParametersBuilder
-
Set the value of the key usage extensions for the generated certificate.
- KeyUsage - Enum Class in org.springframework.credhub.support.certificate
-
The types of key usage extensions that can be assigned to a generated certificate.
L
- length(int) - Method in class org.springframework.credhub.support.password.PasswordParameters.PasswordParametersBuilder
-
Set the value of the password length parameter.
- LENGTH_2048 - Enum constant in enum class org.springframework.credhub.support.KeyLength
-
2048 bit key.
- LENGTH_3072 - Enum constant in enum class org.springframework.credhub.support.KeyLength
-
3072 bit key.
- LENGTH_4096 - Enum constant in enum class org.springframework.credhub.support.KeyLength
-
4096 bit key.
- locality(String) - Method in class org.springframework.credhub.support.certificate.CertificateParameters.CertificateParametersBuilder
-
Set the Locality (L) field to be used for the generated certificate.
M
- mode - Variable in class org.springframework.credhub.support.CredHubRequest
- mode(WriteMode) - Method in class org.springframework.credhub.support.CredHubRequest.CredHubRequestBuilder
-
Sets a value indicating the action CredHub should take when a credential being written or generated already exists.
N
- name - Variable in class org.springframework.credhub.support.CredentialSummary
- name - Variable in class org.springframework.credhub.support.CredHubRequest
- name(CredentialName) - Method in class org.springframework.credhub.support.CredHubRequest.CredHubRequestBuilder
-
Set the
CredentialName
for the credential. - NO_OVERWRITE - Enum constant in enum class org.springframework.credhub.support.WriteMode
-
Indicates that CredHub should not replace the value of a credential if the credential exists.
- NON_REPUDIATION - Enum constant in enum class org.springframework.credhub.support.certificate.KeyUsage
-
Non-repudiation key.
O
- OAUTH_CLIENT - Enum constant in enum class org.springframework.credhub.support.permissions.ActorType
-
A UAA client entity, as can be used with a client credentials grant.
- OAuth2() - Constructor for class org.springframework.credhub.core.CredHubProperties.OAuth2
-
Create a new instance without initializing properties.
- operation() - Method in enum class org.springframework.credhub.support.permissions.Operation
-
Get the value of the operation.
- operation(Operation) - Method in class org.springframework.credhub.support.permissions.Permission.CredentialPermissionBuilder
-
Set an
Operation
that the actor will be allowed to perform on the credential. - Operation - Enum Class in org.springframework.credhub.support.permissions
-
The set of operations that are allowed on a credential.
- operations(Operation...) - Method in class org.springframework.credhub.support.permissions.Permission.CredentialPermissionBuilder
-
Specify a set of
Operation
s that the actor will be allowed to perform on the credential. - org.springframework.credhub.autoconfig - package org.springframework.credhub.autoconfig
-
Spring auto configuration support for Spring CredHub.
- org.springframework.credhub.configuration - package org.springframework.credhub.configuration
-
Spring configuration support for Spring CredHub.
- org.springframework.credhub.core - package org.springframework.credhub.core
-
Core API abstractions for Spring CredHub.
- org.springframework.credhub.core.certificate - package org.springframework.credhub.core.certificate
-
Core API abstractions for certificate operations.
- org.springframework.credhub.core.credential - package org.springframework.credhub.core.credential
-
Core API abstractions for credential operations.
- org.springframework.credhub.core.info - package org.springframework.credhub.core.info
-
Core API abstractions for informational operations.
- org.springframework.credhub.core.interpolation - package org.springframework.credhub.core.interpolation
-
Core API abstractions for interpolation operations.
- org.springframework.credhub.core.permission - package org.springframework.credhub.core.permission
-
Core API abstractions for permission operations.
- org.springframework.credhub.core.permissionV2 - package org.springframework.credhub.core.permissionV2
-
Core API abstractions for permission operations.
- org.springframework.credhub.support - package org.springframework.credhub.support
-
Java representations of CredHub requests and responses.
- org.springframework.credhub.support.certificate - package org.springframework.credhub.support.certificate
-
Java representations of CredHub certificate credentials.
- org.springframework.credhub.support.info - package org.springframework.credhub.support.info
-
Java representations of CredHub server information.
- org.springframework.credhub.support.json - package org.springframework.credhub.support.json
-
Java representations of CredHub JSON credentials.
- org.springframework.credhub.support.password - package org.springframework.credhub.support.password
-
Java representations of CredHub password credentials.
- org.springframework.credhub.support.permissions - package org.springframework.credhub.support.permissions
-
Java representations of CredHub JSON credential permissions.
- org.springframework.credhub.support.rsa - package org.springframework.credhub.support.rsa
-
Java representations of CredHub RSA credentials.
- org.springframework.credhub.support.ssh - package org.springframework.credhub.support.ssh
-
Java representations of CredHub SSH credentials.
- org.springframework.credhub.support.user - package org.springframework.credhub.support.user
-
Java representations of CredHub user credentials.
- org.springframework.credhub.support.utils - package org.springframework.credhub.support.utils
-
Internal CredHub utility classes.
- org.springframework.credhub.support.value - package org.springframework.credhub.support.value
-
Java representations of CredHub value credentials.
- organization(String) - Method in class org.springframework.credhub.support.certificate.CertificateParameters.CertificateParametersBuilder
-
Set the Organization (O) field to be used for the generated certificate.
- organizationUnit(String) - Method in class org.springframework.credhub.support.certificate.CertificateParameters.CertificateParametersBuilder
-
Set the Organization Unit (OU) field to be used for the generated certificate.
- OVERWRITE - Enum constant in enum class org.springframework.credhub.support.WriteMode
-
Indicates that CredHub should replace any existing credential value with a new value.
P
- parameters(CertificateParameters) - Method in class org.springframework.credhub.support.certificate.CertificateParametersRequest.CertificateParametersRequestBuilder
-
Set the parameters for generation of a password credential.
- parameters(PasswordParameters) - Method in class org.springframework.credhub.support.password.PasswordParametersRequest.PasswordParametersRequestBuilder
-
Set the parameters for generation of a password credential.
- parameters(PasswordParameters) - Method in class org.springframework.credhub.support.user.UserParametersRequest.UserParametersRequestBuilder
-
Set the parameters for generation of the password for a user credential.
- parameters(RsaParameters) - Method in class org.springframework.credhub.support.rsa.RsaParametersRequest.RsaParametersRequestBuilder
-
Set the parameters for generation of an RSA credential.
- parameters(SshParameters) - Method in class org.springframework.credhub.support.ssh.SshParametersRequest.SshParametersRequestBuilder
-
Set the parameters for generation of an SSH credential.
- ParametersRequest<T> - Class in org.springframework.credhub.support
-
The details of a request to generate a credential in CredHub.
- ParametersRequest(CredentialType) - Constructor for class org.springframework.credhub.support.ParametersRequest
-
Initialize a
ParametersRequest
. - PASSWORD - Enum constant in enum class org.springframework.credhub.support.CredentialType
-
Indicates a credential of type
PasswordCredential
. - PasswordCredential - Class in org.springframework.credhub.support.password
-
A password credential consists of a single string value.
- PasswordCredential(String) - Constructor for class org.springframework.credhub.support.password.PasswordCredential
-
Create a
PasswordCredential
containing the specified password value. - PasswordCredentialRequest - Class in org.springframework.credhub.support.password
-
The details of a request to write a new or update an existing
PasswordCredential
in CredHub. - PasswordCredentialRequest.PasswordCredentialRequestBuilder - Class in org.springframework.credhub.support.password
-
A builder that provides a fluent API for constructing
PasswordCredentialRequest
s. - PasswordCredentialRequestBuilder() - Constructor for class org.springframework.credhub.support.password.PasswordCredentialRequest.PasswordCredentialRequestBuilder
- PasswordParameters - Class in org.springframework.credhub.support.password
-
Parameters for generating a new password credential.
- PasswordParameters() - Constructor for class org.springframework.credhub.support.password.PasswordParameters
-
Create a
PasswordParameters
using defaults for all parameter values. - PasswordParameters(int, boolean, boolean, boolean, boolean) - Constructor for class org.springframework.credhub.support.password.PasswordParameters
-
Create a
PasswordParameters
using the specified values. - PasswordParameters.PasswordParametersBuilder - Class in org.springframework.credhub.support.password
-
A builder that provides a fluent API for constructing
PasswordParameters.PasswordParametersBuilder
s. - PasswordParametersBuilder() - Constructor for class org.springframework.credhub.support.password.PasswordParameters.PasswordParametersBuilder
- PasswordParametersRequest - Class in org.springframework.credhub.support.password
-
The details of a request to generate a new
PasswordCredential
in CredHub. - PasswordParametersRequest.PasswordParametersRequestBuilder - Class in org.springframework.credhub.support.password
-
A builder that provides a fluent API for constructing
PasswordParametersRequest
s. - PasswordParametersRequestBuilder() - Constructor for class org.springframework.credhub.support.password.PasswordParametersRequest.PasswordParametersRequestBuilder
- Permission - Class in org.springframework.credhub.support.permissions
-
Permissions applied to a credential in CredHub.
- Permission.CredentialPermissionBuilder - Class in org.springframework.credhub.support.permissions
-
A builder that provides a fluent API for constructing
Permission
instances. - permissions() - Method in interface org.springframework.credhub.core.CredHubOperations
-
Get the operations for adding, retrieving, and deleting credential permissions.
- permissions() - Method in class org.springframework.credhub.core.CredHubTemplate
-
Get the operations for adding, retrieving, and deleting permissions from a credential.
- permissions() - Method in interface org.springframework.credhub.core.ReactiveCredHubOperations
-
Get the operations for adding, retrieving, and deleting credential permissions.
- permissions() - Method in class org.springframework.credhub.core.ReactiveCredHubTemplate
-
Get the operations for adding, retrieving, and deleting permissions from a credential.
- permissionsV2() - Method in interface org.springframework.credhub.core.CredHubOperations
-
Get the operations for adding, retrieving, and deleting credential permissions.
- permissionsV2() - Method in class org.springframework.credhub.core.CredHubTemplate
-
Get the operations for adding, retrieving, and deleting permissions from a credential.
- permissionsV2() - Method in interface org.springframework.credhub.core.ReactiveCredHubOperations
-
Get the operations for adding, retrieving, and deleting credential permissions.
- permissionsV2() - Method in class org.springframework.credhub.core.ReactiveCredHubTemplate
-
Get the operations for adding, retrieving, and deleting permissions from a credential.
R
- ReactiveCredHubCertificateOperations - Interface in org.springframework.credhub.core.certificate
-
Specifies the interactions with CredHub to retrieve, regenerate, and update certificates.
- ReactiveCredHubCertificateTemplate - Class in org.springframework.credhub.core.certificate
-
Implements the interactions with CredHub to retrieve, regenerate, and update certificates.
- ReactiveCredHubCertificateTemplate(ReactiveCredHubOperations) - Constructor for class org.springframework.credhub.core.certificate.ReactiveCredHubCertificateTemplate
-
Create a new
ReactiveCredHubCertificateTemplate
. - ReactiveCredHubCredentialOperations - Interface in org.springframework.credhub.core.credential
-
Specifies the interactions with CredHub to save, generate, retrieve, and delete credentials.
- ReactiveCredHubCredentialTemplate - Class in org.springframework.credhub.core.credential
-
Implements the interactions with CredHub to save, retrieve, and delete credentials.
- ReactiveCredHubCredentialTemplate(ReactiveCredHubOperations) - Constructor for class org.springframework.credhub.core.credential.ReactiveCredHubCredentialTemplate
-
Create a new
ReactiveCredHubCredentialTemplate
. - ReactiveCredHubInfoOperations - Interface in org.springframework.credhub.core.info
-
Specifies the interactions with CredHub for retrieving server information.
- ReactiveCredHubInfoTemplate - Class in org.springframework.credhub.core.info
-
Implements the interaction with CredHub retrieve server information.
- ReactiveCredHubInfoTemplate(ReactiveCredHubOperations) - Constructor for class org.springframework.credhub.core.info.ReactiveCredHubInfoTemplate
-
Create a new
ReactiveCredHubInfoTemplate
. - ReactiveCredHubInterpolationOperations - Interface in org.springframework.credhub.core.interpolation
-
Specifies the interactions with CredHub to interpolate service binding credentials.
- ReactiveCredHubInterpolationTemplate - Class in org.springframework.credhub.core.interpolation
-
Implements the main interaction with CredHub to interpolate service binding credentials.
- ReactiveCredHubInterpolationTemplate(ReactiveCredHubOperations) - Constructor for class org.springframework.credhub.core.interpolation.ReactiveCredHubInterpolationTemplate
-
Create a new
ReactiveCredHubInterpolationTemplate
. - ReactiveCredHubOperations - Interface in org.springframework.credhub.core
-
Specifies the main interaction with CredHub.
- ReactiveCredHubPermissionOperations - Interface in org.springframework.credhub.core.permission
-
Specifies the interactions with CredHub to add, retrieve, and delete permissions.
- ReactiveCredHubPermissionTemplate - Class in org.springframework.credhub.core.permission
-
Implements the main interaction with CredHub to add, retrieve, and delete permissions.
- ReactiveCredHubPermissionTemplate(ReactiveCredHubOperations) - Constructor for class org.springframework.credhub.core.permission.ReactiveCredHubPermissionTemplate
-
Create a new
ReactiveCredHubPermissionTemplate
. - ReactiveCredHubPermissionV2Operations - Interface in org.springframework.credhub.core.permissionV2
-
Specifies the interactions with CredHub to add, retrieve, and delete permissions.
- ReactiveCredHubPermissionV2Template - Class in org.springframework.credhub.core.permissionV2
-
Implements the main interaction with CredHub to add, retrieve, and delete permissions.
- ReactiveCredHubPermissionV2Template(ReactiveCredHubOperations) - Constructor for class org.springframework.credhub.core.permissionV2.ReactiveCredHubPermissionV2Template
-
Create a new
ReactiveCredHubPermissionV2Template
. - reactiveCredHubTemplate(CredHubProperties, ClientOptions) - Method in class org.springframework.credhub.configuration.CredHubTemplateFactory
-
Create a
ReactiveCredHubTemplate
for interaction with a CredHub server. - reactiveCredHubTemplate(CredHubProperties, ClientOptions, ReactiveOAuth2AuthorizedClientManager) - Method in class org.springframework.credhub.configuration.CredHubTemplateFactory
-
Create a
ReactiveCredHubTemplate
for interaction with a CredHub server using OAuth2 for authentication. - reactiveCredHubTemplate(CredHubProperties, ClientOptions, ReactiveClientRegistrationRepository, ServerOAuth2AuthorizedClientRepository) - Method in class org.springframework.credhub.configuration.CredHubTemplateFactory
-
Create a
ReactiveCredHubTemplate
for interaction with a CredHub server using OAuth2 for authentication. - ReactiveCredHubTemplate - Class in org.springframework.credhub.core
-
Implements the main interaction with CredHub.
- ReactiveCredHubTemplate(CredHubProperties, ClientHttpConnector) - Constructor for class org.springframework.credhub.core.ReactiveCredHubTemplate
-
Create a new
ReactiveCredHubTemplate
using the provided base URI andClientHttpRequestFactory
. - ReactiveCredHubTemplate(CredHubProperties, ClientHttpConnector, ReactiveOAuth2AuthorizedClientManager) - Constructor for class org.springframework.credhub.core.ReactiveCredHubTemplate
-
Create a new
ReactiveCredHubTemplate
using the provided base URI andClientHttpRequestFactory
. - ReactiveCredHubTemplate(CredHubProperties, ClientHttpConnector, ReactiveClientRegistrationRepository, ServerOAuth2AuthorizedClientRepository) - Constructor for class org.springframework.credhub.core.ReactiveCredHubTemplate
-
Create a new
ReactiveCredHubTemplate
using the provided base URI andClientHttpRequestFactory
. - ReactiveCredHubTemplate(WebClient) - Constructor for class org.springframework.credhub.core.ReactiveCredHubTemplate
-
Create a new
ReactiveCredHubTemplate
using the providedWebClient
. - ReactiveCredHubTemplateConfiguration - Class in org.springframework.credhub.autoconfig
-
Configuration for
ReactiveCredHubTemplate
. - ReactiveCredHubTemplateConfiguration() - Constructor for class org.springframework.credhub.autoconfig.ReactiveCredHubTemplateConfiguration
- READ - Enum constant in enum class org.springframework.credhub.support.permissions.Operation
-
Allows the value of a credential to be read.
- READ_ACL - Enum constant in enum class org.springframework.credhub.support.permissions.Operation
-
Allows the permissions of a credential to be read.
- regenerate(String, boolean) - Method in interface org.springframework.credhub.core.certificate.CredHubCertificateOperations
-
Regenerate a certificate.
- regenerate(String, boolean) - Method in class org.springframework.credhub.core.certificate.CredHubCertificateTemplate
- regenerate(String, boolean) - Method in interface org.springframework.credhub.core.certificate.ReactiveCredHubCertificateOperations
-
Regenerate a certificate.
- regenerate(String, boolean) - Method in class org.springframework.credhub.core.certificate.ReactiveCredHubCertificateTemplate
- regenerate(CredentialName) - Method in interface org.springframework.credhub.core.certificate.CredHubCertificateOperations
-
Regenerate all certificates in CredHub that were signed by the specified certificate.
- regenerate(CredentialName) - Method in class org.springframework.credhub.core.certificate.CredHubCertificateTemplate
- regenerate(CredentialName) - Method in interface org.springframework.credhub.core.certificate.ReactiveCredHubCertificateOperations
-
Regenerate all certificates in CredHub that were signed by the specified certificate.
- regenerate(CredentialName) - Method in class org.springframework.credhub.core.certificate.ReactiveCredHubCertificateTemplate
- regenerate(CredentialName, Class<T>) - Method in interface org.springframework.credhub.core.credential.CredHubCredentialOperations
-
Regenerate a credential in CredHub.
- regenerate(CredentialName, Class<T>) - Method in class org.springframework.credhub.core.credential.CredHubCredentialTemplate
- regenerate(CredentialName, Class<T>) - Method in interface org.springframework.credhub.core.credential.ReactiveCredHubCredentialOperations
-
Regenerate a credential in CredHub.
- regenerate(CredentialName, Class<T>) - Method in class org.springframework.credhub.core.credential.ReactiveCredHubCredentialTemplate
- RestOperationsCallback<T> - Interface in org.springframework.credhub.core
-
A callback for executing arbitrary operations on
RestOperations
. - RSA - Enum constant in enum class org.springframework.credhub.support.CredentialType
-
Indicates a credential of type
RsaCredential
. - RsaCredential - Class in org.springframework.credhub.support.rsa
-
An RSA credential consists of a public and/or private key.
- RsaCredential(String, String) - Constructor for class org.springframework.credhub.support.rsa.RsaCredential
-
Create an
RsaCredential
from the provided public and private key. - RsaCredentialRequest - Class in org.springframework.credhub.support.rsa
-
The details of a request to write a new or update an existing
RsaCredential
in CredHub. - RsaCredentialRequest.RsaCredentialRequestBuilder - Class in org.springframework.credhub.support.rsa
-
A builder that provides a fluent API for constructing
RsaCredentialRequest
s. - RsaCredentialRequestBuilder() - Constructor for class org.springframework.credhub.support.rsa.RsaCredentialRequest.RsaCredentialRequestBuilder
- RsaParameters - Class in org.springframework.credhub.support.rsa
-
Parameters for generating a new RSA credential.
- RsaParameters(KeyLength) - Constructor for class org.springframework.credhub.support.rsa.RsaParameters
-
Create a
RsaParameters
using the specified values. - RsaParametersRequest - Class in org.springframework.credhub.support.rsa
-
The details of a request to generate a new
RsaCredential
in CredHub. - RsaParametersRequest.RsaParametersRequestBuilder - Class in org.springframework.credhub.support.rsa
-
A builder that provides a fluent API for constructing
RsaParametersRequest
s. - RsaParametersRequestBuilder() - Constructor for class org.springframework.credhub.support.rsa.RsaParametersRequest.RsaParametersRequestBuilder
S
- selfSign(boolean) - Method in class org.springframework.credhub.support.certificate.CertificateParameters.CertificateParametersBuilder
-
Set the value of the flag that indicates whether the generated certificate should be self-signed.
- SERVER_AUTH - Enum constant in enum class org.springframework.credhub.support.certificate.ExtendedKeyUsage
-
Server authentication.
- serviceBindingId(String) - Method in class org.springframework.credhub.support.ServiceInstanceCredentialName.ServiceInstanceCredentialNameBuilder
-
Set the service binding ID segment of the credential name.
- serviceBrokerName(String) - Method in class org.springframework.credhub.support.ServiceInstanceCredentialName.ServiceInstanceCredentialNameBuilder
-
Set the service broker name segment of the credential name.
- ServiceInstanceCredentialName - Class in org.springframework.credhub.support
-
The client-provided name of a credential that stores service instance binding credentials.
- ServiceInstanceCredentialName.ServiceInstanceCredentialNameBuilder - Class in org.springframework.credhub.support
-
A builder that provides a fluent API for constructing
ServiceInstanceCredentialName
instances. - serviceOfferingName(String) - Method in class org.springframework.credhub.support.ServiceInstanceCredentialName.ServiceInstanceCredentialNameBuilder
-
Set the service offering name segment of the credential name.
- ServicesData - Class in org.springframework.credhub.support
-
Service data parsed from the VCAP_SERVICES environment variable provided to applications running on Cloud Foundry.
- ServicesData() - Constructor for class org.springframework.credhub.support.ServicesData
- ServicesData(HashMap<String, List<Map<String, Object>>>) - Constructor for class org.springframework.credhub.support.ServicesData
-
Initialize with the provided
HashMap
. - setCaCertFiles(String[]) - Method in class org.springframework.credhub.support.ClientOptions
- setConnectionTimeout(Duration) - Method in class org.springframework.credhub.support.ClientOptions
- setOauth2(CredHubProperties.OAuth2) - Method in class org.springframework.credhub.core.CredHubProperties
-
Set the OAuth2 properties.
- setParameters(T) - Method in class org.springframework.credhub.support.ParametersRequest
- setReadTimeout(Duration) - Method in class org.springframework.credhub.support.ClientOptions
- setRegistrationId(String) - Method in class org.springframework.credhub.core.CredHubProperties.OAuth2
-
Set the OAuth2 client registration ID used to authentiate with CredHub.
- setUrl(String) - Method in class org.springframework.credhub.core.CredHubProperties
-
Set the base URI for the CredHub server (scheme, host, and port).
- setValue(T) - Method in class org.springframework.credhub.support.CredentialRequest
-
Set the value of the credential.
- SimpleCredentialName - Class in org.springframework.credhub.support
-
The client-provided name of a credential.
- SimpleCredentialName(String...) - Constructor for class org.springframework.credhub.support.SimpleCredentialName
-
Create a
SimpleCredentialName
from the provided segments. - SSH - Enum constant in enum class org.springframework.credhub.support.CredentialType
-
Indicates a credential of type
SshCredential
. - SshCredential - Class in org.springframework.credhub.support.ssh
-
An SSH credential consists of a public and/or private key.
- SshCredential(String, String) - Constructor for class org.springframework.credhub.support.ssh.SshCredential
-
Create an
SshCredential
from the provided public and private key. - SshCredentialRequest - Class in org.springframework.credhub.support.ssh
-
The details of a request to write a new or update an existing
SshCredential
in CredHub. - SshCredentialRequest.SshCredentialRequestBuilder - Class in org.springframework.credhub.support.ssh
-
A builder that provides a fluent API for constructing
SshCredentialRequest
s. - SshCredentialRequestBuilder() - Constructor for class org.springframework.credhub.support.ssh.SshCredentialRequest.SshCredentialRequestBuilder
- SshParameters - Class in org.springframework.credhub.support.ssh
-
Parameters for generating a new SSH credential.
- SshParameters(String) - Constructor for class org.springframework.credhub.support.ssh.SshParameters
-
Create a
SshParameters
using the specified values. - SshParameters(KeyLength) - Constructor for class org.springframework.credhub.support.ssh.SshParameters
-
Create a
SshParameters
using the specified values. - SshParameters(KeyLength, String) - Constructor for class org.springframework.credhub.support.ssh.SshParameters
-
Create a
SshParameters
using the specified values. - SshParametersRequest - Class in org.springframework.credhub.support.ssh
-
The details of a request to generate a new
SshCredential
in CredHub. - SshParametersRequest.SshParametersRequestBuilder - Class in org.springframework.credhub.support.ssh
-
A builder that provides a fluent API for constructing
SshParametersRequest
s. - SshParametersRequestBuilder() - Constructor for class org.springframework.credhub.support.ssh.SshParametersRequest.SshParametersRequestBuilder
- state(String) - Method in class org.springframework.credhub.support.certificate.CertificateParameters.CertificateParametersBuilder
-
Set the State (S) field to be used for the generated certificate.
- StringCredential - Class in org.springframework.credhub.support
-
A base type for a credential that contains a single string value.
- StringCredential(String) - Constructor for class org.springframework.credhub.support.StringCredential
-
Create a credential containing the specified value.
T
- targetObj - Variable in class org.springframework.credhub.support.CredHubRequest.CredHubRequestBuilder
- throwExceptionOnError(ResponseEntity<?>) - Static method in class org.springframework.credhub.core.ExceptionUtils
-
Helper method to throw an appropriate exception if a request to CredHub returns with an error code.
- TIMESTAMPING - Enum constant in enum class org.springframework.credhub.support.certificate.ExtendedKeyUsage
-
Time stamping.
- toString() - Method in class org.springframework.credhub.support.certificate.CertificateSummary
- toString() - Method in class org.springframework.credhub.support.certificate.CertificateSummaryData
- toString() - Method in enum class org.springframework.credhub.support.certificate.ExtendedKeyUsage
- toString() - Method in enum class org.springframework.credhub.support.certificate.KeyUsage
- toString() - Method in class org.springframework.credhub.support.CredentialDetails
- toString() - Method in class org.springframework.credhub.support.CredentialDetailsData
- toString() - Method in class org.springframework.credhub.support.CredentialName
- toString() - Method in class org.springframework.credhub.support.CredentialPermission
- toString() - Method in class org.springframework.credhub.support.CredentialPermissions
- toString() - Method in class org.springframework.credhub.support.CredentialSummary
- toString() - Method in class org.springframework.credhub.support.CredentialSummaryData
- toString() - Method in enum class org.springframework.credhub.support.CredentialType
- toString() - Method in class org.springframework.credhub.support.CredHubRequest
- toString() - Method in class org.springframework.credhub.support.permissions.Actor
- toString() - Method in enum class org.springframework.credhub.support.permissions.ActorType
- toString() - Method in enum class org.springframework.credhub.support.permissions.Operation
- toString() - Method in class org.springframework.credhub.support.permissions.Permission
- toString() - Method in class org.springframework.credhub.support.ServiceInstanceCredentialName
- toString() - Method in class org.springframework.credhub.support.SimpleCredentialName
- toString() - Method in class org.springframework.credhub.support.StringCredential
- toString() - Method in enum class org.springframework.credhub.support.WriteMode
U
- updatePermissions(String, CredentialName, Permission) - Method in interface org.springframework.credhub.core.permissionV2.CredHubPermissionV2Operations
-
Add permissions to an existing credential.
- updatePermissions(String, CredentialName, Permission) - Method in class org.springframework.credhub.core.permissionV2.CredHubPermissionV2Template
- updatePermissions(String, CredentialName, Permission) - Method in interface org.springframework.credhub.core.permissionV2.ReactiveCredHubPermissionV2Operations
-
Add permissions to an existing credential.
- updatePermissions(String, CredentialName, Permission) - Method in class org.springframework.credhub.core.permissionV2.ReactiveCredHubPermissionV2Template
- updateTransitionalVersion(String, String) - Method in interface org.springframework.credhub.core.certificate.CredHubCertificateOperations
-
Make the specified version of a certificate the transitional version.
- updateTransitionalVersion(String, String) - Method in class org.springframework.credhub.core.certificate.CredHubCertificateTemplate
- updateTransitionalVersion(String, String) - Method in interface org.springframework.credhub.core.certificate.ReactiveCredHubCertificateOperations
-
Make the specified version of a certificate the transitional version.
- updateTransitionalVersion(String, String) - Method in class org.springframework.credhub.core.certificate.ReactiveCredHubCertificateTemplate
- user(String) - Static method in class org.springframework.credhub.support.permissions.Actor
-
Create a user identifier.
- user(String) - Method in class org.springframework.credhub.support.permissions.Permission.CredentialPermissionBuilder
-
Set the ID of a user that will be assigned permissions on a credential.
- user(String, String) - Static method in class org.springframework.credhub.support.permissions.Actor
-
Create a user identifier.
- user(String, String) - Method in class org.springframework.credhub.support.permissions.Permission.CredentialPermissionBuilder
-
Set the ID of a user that will be assigned permissions on a credential.
- USER - Enum constant in enum class org.springframework.credhub.support.CredentialType
-
Indicates a credential of type
UserCredential
. - USER - Enum constant in enum class org.springframework.credhub.support.permissions.ActorType
-
A UAA user entity, as can be used with a password grant.
- UserCredential - Class in org.springframework.credhub.support.user
-
A user credential consists of an optional username and a password.
- UserCredential(String) - Constructor for class org.springframework.credhub.support.user.UserCredential
-
Create a
UserCredential
with the specified password value. - UserCredential(String, String) - Constructor for class org.springframework.credhub.support.user.UserCredential
-
Create a
UserCredential
with the specified values. - UserCredentialRequest - Class in org.springframework.credhub.support.user
-
The details of a request to write a new or update an existing
UserCredential
in CredHub. - UserCredentialRequest.UserCredentialRequestBuilder - Class in org.springframework.credhub.support.user
-
A builder that provides a fluent API for constructing
UserCredentialRequest
s. - UserCredentialRequestBuilder() - Constructor for class org.springframework.credhub.support.user.UserCredentialRequest.UserCredentialRequestBuilder
- username(String) - Method in class org.springframework.credhub.support.user.UserParametersRequest.UserParametersRequestBuilder
-
Set the username for the generated user.
- UserParametersRequest - Class in org.springframework.credhub.support.user
-
The details of a request to generate a new
UserCredential
in CredHub. - UserParametersRequest.UserParametersRequestBuilder - Class in org.springframework.credhub.support.user
-
A builder that provides a fluent API for constructing
UserParametersRequest
s. - UserParametersRequest.UserValue - Class in org.springframework.credhub.support.user
-
Holds the value of the username parameter.
- UserParametersRequestBuilder() - Constructor for class org.springframework.credhub.support.user.UserParametersRequest.UserParametersRequestBuilder
V
- value - Variable in class org.springframework.credhub.support.StringCredential
- value(String) - Method in class org.springframework.credhub.support.password.PasswordCredentialRequest.PasswordCredentialRequestBuilder
-
Set the value of a password credential.
- value(String) - Method in class org.springframework.credhub.support.value.ValueCredentialRequest.ValueCredentialRequestBuilder
-
Set the value of a value credential.
- value(Map<String, Object>) - Method in class org.springframework.credhub.support.json.JsonCredentialRequest.JsonCredentialRequestBuilder
- value(CertificateCredential) - Method in class org.springframework.credhub.support.certificate.CertificateCredentialRequest.CertificateCredentialRequestBuilder
-
Set the value of a certificate credential.
- value(JsonCredential) - Method in class org.springframework.credhub.support.json.JsonCredentialRequest.JsonCredentialRequestBuilder
-
Set the value of a JSON credential.
- value(PasswordCredential) - Method in class org.springframework.credhub.support.password.PasswordCredentialRequest.PasswordCredentialRequestBuilder
-
Set the value of a password credential.
- value(RsaCredential) - Method in class org.springframework.credhub.support.rsa.RsaCredentialRequest.RsaCredentialRequestBuilder
-
Set the value of an RSA credential.
- value(SshCredential) - Method in class org.springframework.credhub.support.ssh.SshCredentialRequest.SshCredentialRequestBuilder
-
Set the value of an SSH credential.
- value(UserCredential) - Method in class org.springframework.credhub.support.user.UserCredentialRequest.UserCredentialRequestBuilder
-
Set the value of a user credential.
- value(ValueCredential) - Method in class org.springframework.credhub.support.value.ValueCredentialRequest.ValueCredentialRequestBuilder
-
Set the value of a value credential.
- VALUE - Enum constant in enum class org.springframework.credhub.support.CredentialType
-
Indicates a credential of type
ValueCredential
. - ValueCredential - Class in org.springframework.credhub.support.value
-
A password credential consists of a single string value.
- ValueCredential(String) - Constructor for class org.springframework.credhub.support.value.ValueCredential
-
Create a
ValueCredential
containing the specified string value. - ValueCredentialRequest - Class in org.springframework.credhub.support.value
-
The details of a request to write a new or update an existing value credential in CredHub.
- ValueCredentialRequest.ValueCredentialRequestBuilder - Class in org.springframework.credhub.support.value
-
A builder that provides a fluent API for constructing
ValueCredentialRequest
s. - ValueCredentialRequestBuilder() - Constructor for class org.springframework.credhub.support.value.ValueCredentialRequest.ValueCredentialRequestBuilder
- valueOf(String) - Static method in enum class org.springframework.credhub.support.certificate.ExtendedKeyUsage
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.credhub.support.certificate.KeyUsage
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.credhub.support.CredentialType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.credhub.support.KeyLength
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.credhub.support.permissions.ActorType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.credhub.support.permissions.Operation
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.credhub.support.WriteMode
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class org.springframework.credhub.support.certificate.ExtendedKeyUsage
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.credhub.support.certificate.KeyUsage
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.credhub.support.CredentialType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.credhub.support.KeyLength
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.credhub.support.permissions.ActorType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.credhub.support.permissions.Operation
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.credhub.support.WriteMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- version() - Method in interface org.springframework.credhub.core.info.CredHubInfoOperations
-
Retrieve the version information from the CredHub server.
- version() - Method in class org.springframework.credhub.core.info.CredHubInfoTemplate
-
Retrieve the version information from the CredHub server.
- version() - Method in interface org.springframework.credhub.core.info.ReactiveCredHubInfoOperations
-
Retrieve the version information from the CredHub server.
- version() - Method in class org.springframework.credhub.core.info.ReactiveCredHubInfoTemplate
-
Retrieve the version information from the CredHub server.
- versionCreatedAt - Variable in class org.springframework.credhub.support.CredentialSummary
- VersionInfo - Class in org.springframework.credhub.support.info
-
Version information about a CredHub server.
- VersionInfo(String) - Constructor for class org.springframework.credhub.support.info.VersionInfo
-
Create a new VersionInfo containing the specified version string.
W
- write(CredentialRequest<T>) - Method in interface org.springframework.credhub.core.credential.CredHubCredentialOperations
-
Write a new credential to CredHub, or overwrite an existing credential with a new value.
- write(CredentialRequest<T>) - Method in class org.springframework.credhub.core.credential.CredHubCredentialTemplate
- write(CredentialRequest<T>) - Method in interface org.springframework.credhub.core.credential.ReactiveCredHubCredentialOperations
-
Write a new credential to CredHub, or overwrite an existing credential with a new value.
- write(CredentialRequest<T>) - Method in class org.springframework.credhub.core.credential.ReactiveCredHubCredentialTemplate
- WRITE - Enum constant in enum class org.springframework.credhub.support.permissions.Operation
-
Allows the value of a credential to be updated.
- WRITE_ACL - Enum constant in enum class org.springframework.credhub.support.permissions.Operation
-
Allows the permissions of a credential to be updated.
- WriteMode - Enum Class in org.springframework.credhub.support
-
The acceptable values for the
mode
parameter on a set or generate request, indicating the action CredHub should take when the credential being set or generated already exists.
All Classes and Interfaces|All Packages|Serialized Form