org.springframework.cloud.gcp.secretmanager

Class SecretManagerTemplate

java.lang.Object

org.springframework.cloud.gcp.secretmanager.SecretManagerTemplate

All Implemented Interfaces:

SecretManagerOperations

public class SecretManagerTemplate
extends Object
implements SecretManagerOperations

Offers convenience methods for performing common operations on Secret Manager including creating and reading secrets.

Since:

1.2.2

Author:

Daniel Zou

Constructor Summary

Constructors

Constructor and Description
SecretManagerTemplate(com.google.cloud.secretmanager.v1beta1.SecretManagerServiceClient secretManagerServiceClient, GcpProjectIdProvider projectIdProvider)

Method Summary

Modifier and Type	Method and Description
void	createSecret(String secretId, byte[] payload) Creates a new secret or a new version of existing secret with the provided payload.
void	createSecret(String secretId, String payload) Creates a new secret or a new version of existing secret with the provided payload.
byte[]	getSecretBytes(String secretId) Gets the secret payload of the specified secretId at the latest version.
byte[]	getSecretBytes(String secretId, String versionName) Gets the secret payload of the specified secretId at version versionName.
com.google.protobuf.ByteString	getSecretByteString(String secretId, String versionName) Gets the secret payload of the specified secretId at version versionName.
String	getSecretString(String secretId) Gets the secret payload of the specified secretId at the latest version.
String	getSecretString(String secretId, String versionName) Gets the secret payload of the specified secretId at version versionName.
boolean	secretExists(String secretId) Returns true if there already exists a secret under the GCP project with the secretId.

Methods inherited from class java.lang.Object

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

Constructor Detail

SecretManagerTemplate

public SecretManagerTemplate(com.google.cloud.secretmanager.v1beta1.SecretManagerServiceClient secretManagerServiceClient,
                             GcpProjectIdProvider projectIdProvider)

Method Detail

createSecret

public void createSecret(String secretId,
                         String payload)

Description copied from interface: SecretManagerOperations

Creates a new secret or a new version of existing secret with the provided payload.

If there is already a secret saved in SecretManager with the specified secretId, then it simply creates a new version under the secret with the secret payload.

Specified by:

createSecret in interface SecretManagerOperations

Parameters:

secretId - the secret ID of the secret to create.

payload - the secret payload string.

createSecret

public void createSecret(String secretId,
                         byte[] payload)

Description copied from interface: SecretManagerOperations

Creates a new secret or a new version of existing secret with the provided payload.

If there is already a secret saved in SecretManager with the specified secretId, then it simply creates a new version under the secret with the secret payload.

Specified by:

createSecret in interface SecretManagerOperations

Parameters:

secretId - the secret ID of the secret to create.

payload - the secret payload as a byte array.

getSecretString

public String getSecretString(String secretId)

Description copied from interface: SecretManagerOperations

Gets the secret payload of the specified secretId at the latest version.

Specified by:

getSecretString in interface SecretManagerOperations

Parameters:

secretId - unique identifier of your secret in Secret Manager.

Returns:

The secret payload as String

getSecretString

public String getSecretString(String secretId,
                              String versionName)

Description copied from interface: SecretManagerOperations

Gets the secret payload of the specified secretId at version versionName.

Specified by:

getSecretString in interface SecretManagerOperations

Parameters:

secretId - unique identifier of your secret in Secret Manager.

versionName - which version of the secret to load. The version can be a version number as a string (e.g. "5") or an alias (e.g. "latest").

Returns:

The secret payload as String

getSecretBytes

public byte[] getSecretBytes(String secretId)

Description copied from interface: SecretManagerOperations

Gets the secret payload of the specified secretId at the latest version.

Specified by:

getSecretBytes in interface SecretManagerOperations

Parameters:

secretId - unique identifier of your secret in Secret Manager.

Returns:

The secret payload as byte[]

getSecretBytes

public byte[] getSecretBytes(String secretId,
                             String versionName)

Description copied from interface: SecretManagerOperations

Gets the secret payload of the specified secretId at version versionName.

Specified by:

getSecretBytes in interface SecretManagerOperations

Parameters:

secretId - unique identifier of your secret in Secret Manager.

versionName - which version of the secret to load. The version can be a version number as a string (e.g. "5") or an alias (e.g. "latest").

Returns:

The secret payload as byte[]

getSecretByteString

public com.google.protobuf.ByteString getSecretByteString(String secretId,
                                                          String versionName)

Description copied from interface: SecretManagerOperations

Gets the secret payload of the specified secretId at version versionName.

Specified by:

getSecretByteString in interface SecretManagerOperations

Parameters:

secretId - unique identifier of your secret in Secret Manager.

versionName - which version of the secret to load. The version can be a version number as a string (e.g. "5") or an alias (e.g. "latest").

Returns:

The secret payload as ByteString

secretExists

public boolean secretExists(String secretId)

Description copied from interface: SecretManagerOperations

Returns true if there already exists a secret under the GCP project with the secretId.

Specified by:

secretExists in interface SecretManagerOperations

Parameters:

secretId - unique identifier of your secret in Secret Manager.

Returns:

true if the secret exists in Secret Manager; false otherwise