Package com.atlassian.jira.security.secrets

Class DefaultInternalJiraSecretsStorage

java.lang.Object

com.atlassian.jira.security.secrets.DefaultInternalJiraSecretsStorage

All Implemented Interfaces:

InternalJiraSecretsStorage

public class DefaultInternalJiraSecretsStorage
extends Object
implements InternalJiraSecretsStorage

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JIRA_SECRET_STORAGE_MIGRATION_STATE
static final String	REPLACEMENT_FOR_TRANSFERRED_SECRET

Constructor Summary

Constructors

Constructor	Description
DefaultInternalJiraSecretsStorage(ApplicationPropertiesDao propertiesDao, ClusterNodeProperties clusterNodeProperties, JiraHome jiraHome, com.atlassian.secrets.api.SecretDao secretDao, SecretStorageHandler auditHandler)

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.
com.atlassian.secrets.api.SecretServiceConfiguration	getConfiguration()	Returns a record describing the current configuration of the SecretService which can be used for analytics within a product.
com.atlassian.secrets.api.SecretService.SecretServiceManagement	getManagement()
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.

Methods inherited from class java.lang.Object

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

Field Details

JIRA_SECRET_STORAGE_MIGRATION_STATE

public static final String JIRA_SECRET_STORAGE_MIGRATION_STATE

See Also:

• Constant Field Values

REPLACEMENT_FOR_TRANSFERRED_SECRET

public static final String REPLACEMENT_FOR_TRANSFERRED_SECRET

See Also:

• Constant Field Values

Constructor Details

DefaultInternalJiraSecretsStorage

public DefaultInternalJiraSecretsStorage(ApplicationPropertiesDao propertiesDao,
 ClusterNodeProperties clusterNodeProperties,
 JiraHome jiraHome,
 com.atlassian.secrets.api.SecretDao secretDao,
 SecretStorageHandler auditHandler)

Method Details

put

public void put(String identifier,
 String secret)

Description copied from interface: InternalJiraSecretsStorage

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

Specified by:

put in interface InternalJiraSecretsStorage

Parameters:

identifier - The identifier for the secret . The maximum size is 255 characters.

secret - The secret to store.

get

public Optional<String> get(String identifier)

Description copied from interface: InternalJiraSecretsStorage

Retrieves the secret for the given identifier.

Specified by:

get in interface InternalJiraSecretsStorage

Parameters:

identifier - The identifier for the secret .

Returns:

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

delete

public void delete(String identifier)

Description copied from interface: InternalJiraSecretsStorage

Removes the secret for the given identifier.

Specified by:

delete in interface InternalJiraSecretsStorage

Parameters:

identifier - The identifier for the secret .

getMigrationState

public SecretMigrationState getMigrationState()

Description copied from interface: InternalJiraSecretsStorage

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.

Specified by:

getMigrationState in interface InternalJiraSecretsStorage

Returns:

The current migration state of the secrets storage.

getConfiguration

public com.atlassian.secrets.api.SecretServiceConfiguration getConfiguration()

Description copied from interface: InternalJiraSecretsStorage

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

Specified by:

getConfiguration in interface InternalJiraSecretsStorage

Returns:

An SecretServiceConfiguration record

getManagement

public com.atlassian.secrets.api.SecretService.SecretServiceManagement getManagement()

Specified by:

getManagement in interface InternalJiraSecretsStorage