Package org.springframework.credhub.core

Class CredHubTemplate

java.lang.Object

org.springframework.credhub.core.CredHubTemplate

All Implemented Interfaces:

CredHubOperations

public class CredHubTemplate
extends Object
implements CredHubOperations

Implements the main interaction with CredHub.

Author:

Scott Frederick

Constructor Summary

Constructors

Constructor	Description
CredHubTemplate(CredHubProperties properties, ClientHttpRequestFactory clientHttpRequestFactory)	Create a new CredHubTemplate using the provided connection properties and ClientHttpRequestFactory.
CredHubTemplate(CredHubProperties properties, ClientHttpRequestFactory clientHttpRequestFactory, org.springframework.security.oauth2.client.registration.ClientRegistrationRepository clientRegistrationRepository, org.springframework.security.oauth2.client.OAuth2AuthorizedClientManager clientManager)	Create a new CredHubTemplate using the provided connection properties, ClientHttpRequestFactory, and OAuth2 support.
CredHubTemplate(CredHubProperties properties, ClientHttpRequestFactory clientHttpRequestFactory, org.springframework.security.oauth2.client.registration.ClientRegistrationRepository clientRegistrationRepository, org.springframework.security.oauth2.client.web.OAuth2AuthorizedClientRepository authorizedClientRepository)	Create a new CredHubTemplate using the provided connection properties, ClientHttpRequestFactory, and OAuth2 support.
CredHubTemplate(RestTemplate restTemplate)	Create a new CredHubTemplate using the provided RestTemplate.

Method Summary

Modifier and Type	Method	Description
CredHubCertificateOperations	certificates()	Get the operations for retrieving, regenerating, and updating certificates.
CredHubCredentialOperations	credentials()	Get the operations for saving, retrieving, and deleting credentials.
<T> T	doWithRest(RestOperationsCallback<T> callback)	Allow interaction with the configured RestTemplate not provided by other methods.
CredHubInfoOperations	info()	Get the operations for retrieving CredHub server information.
CredHubInterpolationOperations	interpolation()	Get the operations for interpolating service binding credentials.
boolean	isUsingOAuth2()
CredHubPermissionOperations	permissions()	Get the operations for adding, retrieving, and deleting permissions from a credential.
CredHubPermissionV2Operations	permissionsV2()	Get the operations for adding, retrieving, and deleting permissions from a credential.

Methods inherited from class java.lang.Object

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

Constructor Details

CredHubTemplate

public CredHubTemplate(RestTemplate restTemplate)

Create a new CredHubTemplate using the provided RestTemplate. Intended for internal testing only.

Parameters:

restTemplate - the RestTemplate to use for interactions with CredHub

CredHubTemplate

public CredHubTemplate(CredHubProperties properties,
 ClientHttpRequestFactory clientHttpRequestFactory)

Create a new CredHubTemplate using the provided connection properties and ClientHttpRequestFactory.

Parameters:

properties - the CredHub connection properties; must not be null

clientHttpRequestFactory - the ClientHttpRequestFactory to use when creating new connections

CredHubTemplate

public CredHubTemplate(CredHubProperties properties,
 ClientHttpRequestFactory clientHttpRequestFactory,
 org.springframework.security.oauth2.client.registration.ClientRegistrationRepository clientRegistrationRepository,
 org.springframework.security.oauth2.client.web.OAuth2AuthorizedClientRepository authorizedClientRepository)

Create a new CredHubTemplate using the provided connection properties, ClientHttpRequestFactory, and OAuth2 support.

Parameters:

properties - the CredHub connection properties; must not be null

clientHttpRequestFactory - the ClientHttpRequestFactory to use when creating new connections

clientRegistrationRepository - a repository of OAuth2 client registrations

authorizedClientRepository - a repository of authorized OAuth2 clients

CredHubTemplate

public CredHubTemplate(CredHubProperties properties,
 ClientHttpRequestFactory clientHttpRequestFactory,
 org.springframework.security.oauth2.client.registration.ClientRegistrationRepository clientRegistrationRepository,
 org.springframework.security.oauth2.client.OAuth2AuthorizedClientManager clientManager)

Create a new CredHubTemplate using the provided connection properties, ClientHttpRequestFactory, and OAuth2 support.

Parameters:

properties - the CredHub connection properties; must not be null

clientHttpRequestFactory - the ClientHttpRequestFactory to use when creating new connections

clientRegistrationRepository - a repository of OAuth2 client registrations

clientManager - an OAuth2 authorization client manager

Method Details

credentials

public CredHubCredentialOperations credentials()

Get the operations for saving, retrieving, and deleting credentials.

Specified by:

credentials in interface CredHubOperations

Returns:

the credentials operations

permissions

public CredHubPermissionOperations permissions()

Get the operations for adding, retrieving, and deleting permissions from a credential.

Specified by:

permissions in interface CredHubOperations

Returns:

the permissions operations

permissionsV2

public CredHubPermissionV2Operations permissionsV2()

Get the operations for adding, retrieving, and deleting permissions from a credential.

Specified by:

permissionsV2 in interface CredHubOperations

Returns:

the permissions operations

certificates

public CredHubCertificateOperations certificates()

Get the operations for retrieving, regenerating, and updating certificates.

Specified by:

certificates in interface CredHubOperations

Returns:

the certificates operations

interpolation

public CredHubInterpolationOperations interpolation()

Get the operations for interpolating service binding credentials.

Specified by:

interpolation in interface CredHubOperations

Returns:

the interpolation operations

info

public CredHubInfoOperations info()

Get the operations for retrieving CredHub server information.

Specified by:

info in interface CredHubOperations

Returns:

the info operations

doWithRest

public <T> T doWithRest(RestOperationsCallback<T> callback)

Allow interaction with the configured RestTemplate not provided by other methods.

Specified by:

doWithRest in interface CredHubOperations

Type Parameters:

T - the credential implementation type

Parameters:

callback - wrapper for the callback method

Returns:

the return value from the callback method

isUsingOAuth2

public boolean isUsingOAuth2()