org.springframework.credhub.support

Class CredHubRequest.CredHubRequestBuilder<T,R extends CredHubRequest<T>,B extends CredHubRequest.CredHubRequestBuilder<T,R,B>>

java.lang.Object

org.springframework.credhub.support.CredHubRequest.CredHubRequestBuilder<T,R,B>

Type Parameters:

T - the type of CredHub credential

R - the type of the concrete CredHubRequest

B - the type of the concrete builder

Direct Known Subclasses:

CertificateCredentialRequest.CertificateCredentialRequestBuilder, CertificateParametersRequest.CertificateParametersRequestBuilder, JsonCredentialRequest.JsonCredentialRequestBuilder, PasswordCredentialRequest.PasswordCredentialRequestBuilder, PasswordParametersRequest.PasswordParametersRequestBuilder, RsaCredentialRequest.RsaCredentialRequestBuilder, RsaParametersRequest.RsaParametersRequestBuilder, SshCredentialRequest.SshCredentialRequestBuilder, SshParametersRequest.SshParametersRequestBuilder, UserCredentialRequest.UserCredentialRequestBuilder, UserParametersRequest.UserParametersRequestBuilder, ValueCredentialRequest.ValueCredentialRequestBuilder

Enclosing class:

CredHubRequest<T>

protected abstract static class CredHubRequest.CredHubRequestBuilder<T,R extends CredHubRequest<T>,B extends CredHubRequest.CredHubRequestBuilder<T,R,B>>
extends Object

A builder that provides a fluent API for constructing CredHubRequests.

Field Summary

Fields

Modifier and Type	Field and Description
protected R	targetObj

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CredHubRequestBuilder() Create a CredHubRequest.CredHubRequestBuilder.

Method Summary

Modifier and Type	Method and Description
R	build() Create a CredHubRequest from the provided values.
protected abstract B	createBuilder() Provide the concrete builder.
protected abstract R	createTarget() Provide the concrete object to build.
B	mode(WriteMode mode) Sets a value indicating the action CredHub should take when a credential being written or generated already exists.
B	name(CredentialName name) Set the CredentialName for the credential.
B	overwrite(boolean overwrite) Deprecated. as of CredHub 1.6, use mode(WriteMode)
B	permission(Permission permission) Deprecated. as of CredHub 2.0, use CredHubPermissionOperations to assign permissions to a credential after it is created
B	permissions(Collection<? extends Permission> permissions) Deprecated. as of CredHub 2.0, use CredHubPermissionOperations to assign permissions to a credential after it is created
B	permissions(Permission... permissions) Deprecated. as of CredHub 2.0, use CredHubPermissionOperations to assign permissions to a credential after it is created

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

targetObj

protected final R extends CredHubRequest<T> targetObj

Constructor Detail

CredHubRequestBuilder

protected CredHubRequestBuilder()

Create a CredHubRequest.CredHubRequestBuilder. Intended for internal use.

Method Detail

createTarget

protected abstract R createTarget()

Provide the concrete object to build.

Returns:

the target object

createBuilder

protected abstract B createBuilder()

Provide the concrete builder.

Returns:

the builder

name

public B name(CredentialName name)

Set the CredentialName for the credential.

Parameters:

name - the credential name; must not be null

Returns:

the builder

overwrite

public B overwrite(boolean overwrite)

Deprecated. as of CredHub 1.6, use mode(WriteMode)

Sets a boolean value indicating whether CredHub should create a new credential or update and existing credential.

Parameters:

overwrite - false to create a new credential, or true to update and existing credential

Returns:

the builder

mode

public B mode(WriteMode mode)

Sets a value indicating the action CredHub should take when a credential being written or generated already exists. As of CredHub 2.0, this value must not be set on write requests (write requests always overwrite the credential that already exists) but may be set on generate requests.

Parameters:

mode - the WriteMode to use when a credential exists

Returns:

the builder

permission

public B permission(Permission permission)

Deprecated. as of CredHub 2.0, use CredHubPermissionOperations to assign permissions to a credential after it is created

Add an Permission to the permissions that will be assigned to the credential.

Parameters:

permission - a Permission to assign to the credential

Returns:

the builder

permissions

public B permissions(Collection<? extends Permission> permissions)

Deprecated. as of CredHub 2.0, use CredHubPermissionOperations to assign permissions to a credential after it is created

Add a collection of Permissions to the controls that will be assigned to the credential.

Parameters:

permissions - a collection of Permissions to assign to the credential

Returns:

the builder

permissions

public B permissions(Permission... permissions)

Deprecated. as of CredHub 2.0, use CredHubPermissionOperations to assign permissions to a credential after it is created

Add a collection of Permissions to the controls that will be assigned to the credential.

Parameters:

permissions - a collection of Permissions to assign to the credential

Returns:

the builder

build

public R build()

Create a CredHubRequest from the provided values.

Returns:

a CredHubRequest