Package org.springframework.credhub.core.credential

Class CredHubCredentialTemplate

java.lang.Object

org.springframework.credhub.core.credential.CredHubCredentialTemplate

All Implemented Interfaces:

CredHubCredentialOperations

public class CredHubCredentialTemplate
extends Object
implements CredHubCredentialOperations

Implements the interactions with CredHub to save, retrieve, and delete credentials.

Author:

Scott Frederick

Constructor Summary

Constructors

Constructor	Description
CredHubCredentialTemplate(CredHubOperations credHubOperations)	Create a new CredHubCredentialTemplate.

Method Summary

Modifier and Type	Method	Description
void	deleteByName(CredentialName name)	Delete a credential by its full name.
List<CredentialSummary>	findByName(CredentialName name)	Find a credential using a full or partial name.
List<CredentialSummary>	findByPath(String path)	Find a credential using a path.
<T, P> CredentialDetails<T>	generate(ParametersRequest<P> parametersRequest)	Generate a new credential in CredHub, or overwrite an existing credential with a new generated value.
<T> CredentialDetails<T>	getById(String id, Class<T> credentialType)	Retrieve a credential using its ID, as returned in a write request.
<T> CredentialDetails<T>	getByName(CredentialName name, Class<T> credentialType)	Retrieve a credential using its name, as passed to a write request.
<T> List<CredentialDetails<T>>	getByNameWithHistory(CredentialName name, int versions, Class<T> credentialType)	Retrieve a credential using its name, as passed to a write request.
<T> List<CredentialDetails<T>>	getByNameWithHistory(CredentialName name, Class<T> credentialType)	Retrieve a credential using its name, as passed to a write request.
<T> CredentialDetails<T>	regenerate(CredentialName name, Class<T> credentialType)	Regenerate a credential in CredHub.
<T> CredentialDetails<T>	write(CredentialRequest<T> credentialRequest)	Write a new credential to CredHub, or overwrite an existing credential with a new value.

Methods inherited from class java.lang.Object

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

Constructor Details

CredHubCredentialTemplate

public CredHubCredentialTemplate(CredHubOperations credHubOperations)

Create a new CredHubCredentialTemplate.

Parameters:

credHubOperations - the CredHubOperations to use for interactions with CredHub

Method Details

write

public <T> CredentialDetails<T> write(CredentialRequest<T> credentialRequest)

Description copied from interface: CredHubCredentialOperations

Write a new credential to CredHub, or overwrite an existing credential with a new value.

Specified by:

write in interface CredHubCredentialOperations

Type Parameters:

T - the credential implementation type

Parameters:

credentialRequest - the credential to write to CredHub; must not be null

Returns:

the details of the written credential

generate

public <T,
P> CredentialDetails<T> generate(ParametersRequest<P> parametersRequest)

Description copied from interface: CredHubCredentialOperations

Generate a new credential in CredHub, or overwrite an existing credential with a new generated value.

Specified by:

generate in interface CredHubCredentialOperations

Type Parameters:

T - the credential implementation type

P - the credential parameter implementation type

Parameters:

parametersRequest - the parameters of the new credential to generate in CredHub; must not be null

Returns:

the details of the generated credential

regenerate

public <T> CredentialDetails<T> regenerate(CredentialName name,
 Class<T> credentialType)

Description copied from interface: CredHubCredentialOperations

Regenerate a credential in CredHub. Only credentials that were previously generated can be re-generated.

Specified by:

regenerate in interface CredHubCredentialOperations

Type Parameters:

T - the credential implementation type

Parameters:

name - the name of the credential; must not be null

credentialType - the type of the credential to be regenerated; must not be null

Returns:

the details of the regenerated credential

getById

public <T> CredentialDetails<T> getById(String id,
 Class<T> credentialType)

Description copied from interface: CredHubCredentialOperations

Retrieve a credential using its ID, as returned in a write request.

Specified by:

getById in interface CredHubCredentialOperations

Type Parameters:

T - the credential implementation type

Parameters:

id - the ID of the credential; must not be null

credentialType - the type of the credential to be retrieved; must not be null

Returns:

the details of the retrieved credential

getByName

public <T> CredentialDetails<T> getByName(CredentialName name,
 Class<T> credentialType)

Description copied from interface: CredHubCredentialOperations

Retrieve a credential using its name, as passed to a write request. Only the current credential value will be returned.

Specified by:

getByName in interface CredHubCredentialOperations

Type Parameters:

T - the credential implementation type

Parameters:

name - the name of the credential; must not be null

credentialType - the type of credential expected to be returned

Returns:

the details of the retrieved credential

getByNameWithHistory

public <T> List<CredentialDetails<T>> getByNameWithHistory(CredentialName name,
 Class<T> credentialType)

Description copied from interface: CredHubCredentialOperations

Retrieve a credential using its name, as passed to a write request. A collection of all stored values for the named credential will be returned, including historical values.

Specified by:

getByNameWithHistory in interface CredHubCredentialOperations

Type Parameters:

T - the credential implementation type

Parameters:

name - the name of the credential; must not be null

credentialType - the type of credential expected to be returned

Returns:

the details of the retrieved credential, including history

getByNameWithHistory

public <T> List<CredentialDetails<T>> getByNameWithHistory(CredentialName name,
 int versions,
 Class<T> credentialType)

Description copied from interface: CredHubCredentialOperations

Retrieve a credential using its name, as passed to a write request. A collection of stored values for the named credential will be returned, with the specified number of historical values.

Specified by:

getByNameWithHistory in interface CredHubCredentialOperations

Type Parameters:

T - the credential implementation type

Parameters:

name - the name of the credential; must not be null

versions - the number of historical versions to retrieve

credentialType - the type of credential expected to be returned

Returns:

the details of the retrieved credential, including history

findByName

public List<CredentialSummary> findByName(CredentialName name)

Description copied from interface: CredHubCredentialOperations

Find a credential using a full or partial name.

Specified by:

findByName in interface CredHubCredentialOperations

Parameters:

name - the name of the credential; must not be null

Returns:

a summary of the credential search results

findByPath

public List<CredentialSummary> findByPath(String path)

Description copied from interface: CredHubCredentialOperations

Find a credential using a path.

Specified by:

findByPath in interface CredHubCredentialOperations

Parameters:

path - the path to the credential; must not be null

Returns:

a summary of the credential search results

deleteByName

public void deleteByName(CredentialName name)

Description copied from interface: CredHubCredentialOperations

Delete a credential by its full name.

Specified by:

deleteByName in interface CredHubCredentialOperations

Parameters:

name - the name of the credential; must not be null