Package com.atlassian.secrets.api

Interface SecretService

public interface SecretService

An API for managing secrets.

Since:

5.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	SecretService.SecretServiceManagement	An API for managing the SecretService.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SECRET_SERVICE_STATE_SYSTEM_PROP

Method Summary

Modifier and Type	Method	Description
void	delete(String identifier)	Deletes the secret data associated with a unique identifier.
default void	delete(Set<String> identifiers)	Deletes multiple secrets associated with their unique identifiers.
Optional<String>	get(String identifier)	Retrieves the secret data associated with a unique identifier.
default Map<String,Optional<String>>	get(Set<String> identifiers)	Retrieves multiple secrets associated with their unique identifiers.
SecretServiceConfiguration	getConfiguration()	Returns a record describing the current configuration of the SecretService which can be used for analytics within a product.
default SecretService.SecretServiceManagement	getManagement()	Returns an API for managing the configuration of this SecretService.
static SecretServiceState	getState()	Retrieves the current state of the Secret Service based on a system property.
void	put(String identifier, String secretData)	Stores a secret associated with a unique identifier.
default void	put(Map<String,String> secrets)	Stores multiple secrets associated with their unique identifiers.

Field Details

SECRET_SERVICE_STATE_SYSTEM_PROP

static final String SECRET_SERVICE_STATE_SYSTEM_PROP

See Also:

• Constant Field Values

Method Details

put

void put(String identifier,
 String secretData)
  throws SecretServiceException

Stores a secret associated with a unique identifier.

Parameters:

identifier - The unique identifier for the secret data.

secretData - The secret data to be stored.

Throws:

SecretServiceException - If an error occurs

put

default void put(Map<String,String> secrets)
          throws SecretServiceException

Stores multiple secrets associated with their unique identifiers.

Parameters:

secrets - A map of unique identifiers to their corresponding secret data.

Throws:

SecretServiceException - If an error occurs

get

Optional<String> get(String identifier)
              throws SecretServiceException

Retrieves the secret data associated with a unique identifier.

Parameters:

identifier - The unique identifier for the secret data.

Returns:

An Optional containing the secret data if found, or an empty Optional if no secret data is associated with the identifier.

Throws:

SecretServiceException - If an error occurs

get

default Map<String,Optional<String>> get(Set<String> identifiers)
                                  throws SecretServiceException

Retrieves multiple secrets associated with their unique identifiers.

Parameters:

identifiers - A set of unique identifiers for the secret data.

Returns:

A map where each key is a unique identifier and the corresponding value is an Optional containing the secret data if found, or an empty Optional if no secret data is associated with that identifier.

Throws:

SecretServiceException - If an error occurs

delete

void delete(String identifier)
     throws SecretServiceException

Deletes the secret data associated with a unique identifier.

Parameters:

identifier - The unique identifier for the secret data to be deleted.

Throws:

SecretServiceException - If an error occurs

delete

default void delete(Set<String> identifiers)
             throws SecretServiceException

Deletes multiple secrets associated with their unique identifiers.

Parameters:

identifiers - A set of unique identifiers for the secret data to be deleted.

Throws:

SecretServiceException - If an error occurs

getManagement

default SecretService.SecretServiceManagement getManagement()

Returns an API for managing the configuration of this SecretService. A default implementation is included so the interface is API compatible with existing implementations. The default implementation will throw an UnsupportedOperationException.

Returns:

The SecretService.SecretServiceManagement instance which can be used to manage this SecretService

getConfiguration

SecretServiceConfiguration getConfiguration()
                                     throws SecretServiceDisabledException

Returns a record describing the current configuration of the SecretService which can be used for analytics within a product.

Returns:

An SecretServiceConfiguration record

Throws:

SecretServiceDisabledException - If SecretService is disabled

getState

static SecretServiceState getState()
                            throws SecretServiceException

Retrieves the current state of the Secret Service based on a system property.

This method checks the value of a system property defined by SECRET_SERVICE_STATE_SYSTEM_PROP. The method attempts to obtain a corresponding SecretServiceState. If the property is not set or is empty, the method defaults to returning SecretServiceState.ENABLED.

Returns:

the current SecretServiceState as determined by the system property or SecretServiceState.ENABLED if the property is not set or empty.

Throws:

SecretServiceException