Package com.atlassian.jira.security.secrets

Interface JiraSecretStorage

All Known Implementing Classes:

DefaultJiraSecretStorage

@ExperimentalApi
public interface JiraSecretStorage

Allows storing and retrieving secrets from secure vaults.

Method Summary

Modifier and Type	Method	Description
void	delete(String identifier)	Removes the secret for the given identifier.
Optional<String>	get(String identifier)	Retrieves the secret for the given identifier.
SecretMigrationState	getMigrationState()	Retrieves the current migration state for the initial upgrade task.
void	put(String identifier, String secret)	Stores the secret for the given identifier.

Method Details

put

void put(String identifier,
 String secret)

Stores the secret for the given identifier. If a secret already exists for the given identifier, it will be overwritten.

Parameters:

identifier - The identifier for the secret .

secret - The secret to store.

get

Optional<String> get(String identifier)

Retrieves the secret for the given identifier.

Parameters:

identifier - The identifier for the secret .

Returns:

The secret for the given identifier, or Optional.empty() if the secret does not exist.

delete

void delete(String identifier)

Removes the secret for the given identifier. Note that this method does not do any security checks, and it is up to the caller to ensure that the user has the necessary permissions.

Parameters:

identifier - The identifier for the secret .

getMigrationState

SecretMigrationState getMigrationState()

Retrieves the current migration state for the initial upgrade task. See for a detailed description of the possible states. To be removed in Jira 11.0.

Returns:

The current migration state of the secrets storage.