Package com.atlassian.secrets.api

Interface SecretService

public interface SecretService

An API for managing secrets.

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.
Optional<String>	get(String identifier)	Retrieves the secret data associated with a unique identifier.
SecretServiceConfiguration	getConfiguration()	Returns a record describing the current configuration of the SecretService which can be used for analytics within a product.
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.

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

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

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

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