Index (atlassian-secrets-api 6.0.6 API)

A B C D E F G H I M N P R S T V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AES - Enum constant in enum class com.atlassian.secrets.api.SecretServiceType
ATLASSIAN_PASSWORD_CIPHER_PROVIDER_PROPERTY_KEY - Static variable in interface com.atlassian.secrets.api.SecretStoreProvider: Deprecated.

properties key that stores the cipher class
ATLASSIAN_PASSWORD_CIPHER_PROVIDER_XML_KEY - Static variable in interface com.atlassian.secrets.api.SecretStoreProvider: Deprecated.

xml key which can be used by products to store canonical class name
AWS - Enum constant in enum class com.atlassian.secrets.api.SecretServiceType

B

backendTypes() - Method in record class com.atlassian.secrets.api.SecretServiceConfiguration: Returns the value of the backendTypes record component.

C

Cipher - Interface in com.atlassian.db.config.password: Deprecated.
since 2.0
com.atlassian.db.config.password - package com.atlassian.db.config.password
com.atlassian.secrets.api - package com.atlassian.secrets.api
COMPLETED - Enum constant in enum class com.atlassian.secrets.api.RotationState

D

decrypt(String) - Method in interface com.atlassian.db.config.password.Cipher: Deprecated.
defaultBackend() - Method in record class com.atlassian.secrets.api.SecretServiceConfiguration: Returns the value of the defaultBackend record component.
delete(String) - Method in interface com.atlassian.secrets.api.SecretDao: Deletes a sealed secret by its identifier.
delete(String) - Method in interface com.atlassian.secrets.api.SecretService: Deletes the secret data associated with a unique identifier.
delete(Set<String>) - Method in interface com.atlassian.secrets.api.SecretDao: Deletes multiple sealed secrets by their identifiers.
delete(Set<String>) - Method in interface com.atlassian.secrets.api.SecretService: Deletes multiple secrets associated with their unique identifiers.
DISABLED - Enum constant in enum class com.atlassian.secrets.api.SecretServiceState

E

ENABLED - Enum constant in enum class com.atlassian.secrets.api.SecretServiceState
encrypt(String) - Method in interface com.atlassian.db.config.password.Cipher: Deprecated.
ENCRYPTED - Enum constant in enum class com.atlassian.secrets.api.SealedSecretFormat.SecretType
equals(Object) - Method in record class com.atlassian.secrets.api.RotationStatus: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.atlassian.secrets.api.SecretKey: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.atlassian.secrets.api.SecretServiceConfiguration: Indicates whether some other object is "equal to" this one.

F

FAILED - Enum constant in enum class com.atlassian.secrets.api.RotationState
from(String) - Static method in interface com.atlassian.secrets.api.SealedSecret: Deserializes a String which was generated using the SealedSecret.toString() method.
fromString(String) - Method in interface com.atlassian.secrets.api.SealedSecretFormat.SerializationFormat: Convert a String to a SealedSecret object.
fromTextValue(String) - Static method in enum class com.atlassian.secrets.api.SecretServiceState: Returns the SecretServiceState corresponding to the specified text value.

G

get(String) - Method in interface com.atlassian.secrets.api.SecretDao: Retrieves a SealedSecret by its identifier.
get(String) - Method in interface com.atlassian.secrets.api.SecretService: Retrieves the secret data associated with a unique identifier.
get(String) - Method in interface com.atlassian.secrets.api.SecretStore: Deprecated.

Used to load secrets saved by SecretStore.store(String)
get(Set<String>) - Method in interface com.atlassian.secrets.api.SecretDao: Retrieves multiple SealedSecret objects by their identifiers.
get(Set<String>) - Method in interface com.atlassian.secrets.api.SecretService: Retrieves multiple secrets associated with their unique identifiers.
getBackendId() - Method in interface com.atlassian.secrets.api.SealedSecret: Returns the identifier of the backend used to seal the secret originally.
getConfiguration() - Method in interface com.atlassian.secrets.api.SecretService: Returns a record describing the current configuration of the SecretService which can be used for analytics within a product.
getDefaultSecretStoreClassName() - Method in interface com.atlassian.secrets.api.SecretStoreProvider: Deprecated.
getFormat() - Static method in class com.atlassian.secrets.api.SealedSecretFormat
getIdentifier() - Method in interface com.atlassian.secrets.api.SealedSecret: Returns the identifier of a secret originally sealed by the SecretServiceBackend.seal(String, String) method
getIdsForBackend(String) - Method in interface com.atlassian.secrets.api.SecretDao: Retrieves a set of secret identifiers for all SealedSecret objects store within a specific backend.
getInactiveKeys() - Method in interface com.atlassian.secrets.api.SecretService.SecretServiceManagement: Retrieves a set of inactive AES keys from the key directory.
getInstance(String) - Method in interface com.atlassian.secrets.api.SecretStoreProvider: Deprecated.

Creates a new instance of SecretStore every time it's called.
getManagement() - Method in interface com.atlassian.secrets.api.SecretService: Returns an API for managing the configuration of this SecretService.
getPrefix() - Method in enum class com.atlassian.secrets.api.SealedSecretFormat.SecretType
getState() - Static method in interface com.atlassian.secrets.api.SecretService: Retrieves the current state of the Secret Service based on a system property.

H

hashCode() - Method in record class com.atlassian.secrets.api.RotationStatus: Returns a hash code value for this object.
hashCode() - Method in record class com.atlassian.secrets.api.SecretKey: Returns a hash code value for this object.
hashCode() - Method in record class com.atlassian.secrets.api.SecretServiceConfiguration: Returns a hash code value for this object.

I

ID - Enum constant in enum class com.atlassian.secrets.api.SealedSecretFormat.SecretType
isSealedSecret(String) - Static method in interface com.atlassian.secrets.api.SealedSecret: Examines a String to check whether it has a SealedSecret prefix and would be expected to be a serialized SealedSecret.

M

message() - Method in record class com.atlassian.secrets.api.RotationStatus: Returns the value of the message record component.

N

NOT_IMPLEMENTED - Enum constant in enum class com.atlassian.secrets.api.RotationState
NOT_STARTED - Enum constant in enum class com.atlassian.secrets.api.RotationState

P

path() - Method in record class com.atlassian.secrets.api.SecretKey: Returns the value of the path record component.
PREFIX_FORMAT - Static variable in enum class com.atlassian.secrets.api.SealedSecretFormat.SecretType
PREFIX_PATTERN - Static variable in class com.atlassian.secrets.api.SealedSecretFormat
put(String, String) - Method in interface com.atlassian.secrets.api.SecretService: Stores a secret associated with a unique identifier.
put(Map<String, String>) - Method in interface com.atlassian.secrets.api.SecretService: Stores multiple secrets associated with their unique identifiers.
put(Set<SealedSecret>) - Method in interface com.atlassian.secrets.api.SecretDao: Stores a Set of SealedSecret objects.

R

reloadConfiguration() - Method in interface com.atlassian.secrets.api.SecretService.SecretServiceManagement: Ensures that the current SecretService configuration is in sync with the configuration in the persistent data storage (secrets-config.yaml)
rotateAESKey() - Method in interface com.atlassian.secrets.api.SecretService.SecretServiceManagement: Rotates the AES encryption key if applicable to the current SecretService configuration.
RotationState - Enum Class in com.atlassian.secrets.api: An enum representing the final state of an AES key rotation
RotationStatus - Record Class in com.atlassian.secrets.api: A record representing the status of an AES key rotation.
RotationStatus(RotationState, Optional<String>) - Constructor for record class com.atlassian.secrets.api.RotationStatus: Creates an instance of a RotationStatus record class.

S

SealedSecret - Interface in com.atlassian.secrets.api: An object which represents the information required to unseal a secret which has previously been sealed by a SecretServiceBackend implementation.
SealedSecretFormat - Class in com.atlassian.secrets.api: Class to manage the serialization format for SealedSecret objects.
SealedSecretFormat() - Constructor for class com.atlassian.secrets.api.SealedSecretFormat
SealedSecretFormat.SecretType - Enum Class in com.atlassian.secrets.api
SealedSecretFormat.SerializationFormat - Interface in com.atlassian.secrets.api: An interface which is used to convert between SealedSecret objects and Strings.
SECRET_SERVICE_STATE_SYSTEM_PROP - Static variable in interface com.atlassian.secrets.api.SecretService
SecretDao - Interface in com.atlassian.secrets.api: An interface for managing SealedSecret objects.
SecretKey - Record Class in com.atlassian.secrets.api: Represents a secret key with its associated file path.
SecretKey(Path) - Constructor for record class com.atlassian.secrets.api.SecretKey: Creates an instance of a SecretKey record class.
SecretService - Interface in com.atlassian.secrets.api: An API for managing secrets.
SecretService.SecretServiceManagement - Interface in com.atlassian.secrets.api: An API for managing the SecretService.
SecretServiceConfiguration - Record Class in com.atlassian.secrets.api: A record for a simplified representation of the current configuration of a SecretService.
SecretServiceConfiguration(SecretServiceType, Set<SecretServiceType>) - Constructor for record class com.atlassian.secrets.api.SecretServiceConfiguration: Creates an instance of a SecretServiceConfiguration record class.
SecretServiceDisabledException - Exception Class in com.atlassian.secrets.api: A RuntimeException that is thrown when SecretService is unexpectedly used while configured in disabled.
SecretServiceDisabledException(String) - Constructor for exception class com.atlassian.secrets.api.SecretServiceDisabledException
SecretServiceDisabledException(String, Throwable) - Constructor for exception class com.atlassian.secrets.api.SecretServiceDisabledException
SecretServiceDisabledException(Throwable) - Constructor for exception class com.atlassian.secrets.api.SecretServiceDisabledException
SecretServiceException - Exception Class in com.atlassian.secrets.api: A RuntimeException exception type that is thrown when there is a problem interacting with the SecretService API.
SecretServiceException(String) - Constructor for exception class com.atlassian.secrets.api.SecretServiceException
SecretServiceException(String, Throwable) - Constructor for exception class com.atlassian.secrets.api.SecretServiceException
SecretServiceException(Throwable) - Constructor for exception class com.atlassian.secrets.api.SecretServiceException
SecretServiceState - Enum Class in com.atlassian.secrets.api: Enum representing the state of a Secret Service.
SecretServiceType - Enum Class in com.atlassian.secrets.api: This enum represents the different types of secret services that can be used.
SecretStore - Interface in com.atlassian.secrets.api: Deprecated.
4.0.0
SecretStoreException - Exception Class in com.atlassian.secrets.api: Deprecated.
since 4.0.0
SecretStoreException(String) - Constructor for exception class com.atlassian.secrets.api.SecretStoreException: Deprecated.
SecretStoreException(String, Throwable) - Constructor for exception class com.atlassian.secrets.api.SecretStoreException: Deprecated.
SecretStoreException(Throwable) - Constructor for exception class com.atlassian.secrets.api.SecretStoreException: Deprecated.
SecretStoreProvider - Interface in com.atlassian.secrets.api: Deprecated.
since 4.0.0
setFormat(SealedSecretFormat.SerializationFormat) - Static method in class com.atlassian.secrets.api.SealedSecretFormat: Set the serialization format to use across the application.
status() - Method in record class com.atlassian.secrets.api.RotationStatus: Returns the value of the status record component.
store(String) - Method in interface com.atlassian.secrets.api.SecretStore: Deprecated.

Used to store data in plain text.

T

toString() - Method in record class com.atlassian.secrets.api.RotationStatus: Returns a string representation of this record class.
toString() - Method in interface com.atlassian.secrets.api.SealedSecret: Serializes a SealedSecret to a String format so that it can be stored.
toString() - Method in record class com.atlassian.secrets.api.SecretKey: Returns a string representation of this record class.
toString() - Method in record class com.atlassian.secrets.api.SecretServiceConfiguration: Returns a string representation of this record class.
toString(SealedSecretFormat.SecretType, SealedSecret) - Method in interface com.atlassian.secrets.api.SealedSecretFormat.SerializationFormat: Convert a SealedSecret object to a String.

V

valueOf(String) - Static method in enum class com.atlassian.secrets.api.RotationState: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.atlassian.secrets.api.SealedSecretFormat.SecretType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.atlassian.secrets.api.SecretServiceState: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.atlassian.secrets.api.SecretServiceType: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.atlassian.secrets.api.RotationState: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.atlassian.secrets.api.SealedSecretFormat.SecretType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.atlassian.secrets.api.SecretServiceState: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.atlassian.secrets.api.SecretServiceType: Returns an array containing the constants of this enum class, in the order they are declared.
VAULT - Enum constant in enum class com.atlassian.secrets.api.SecretServiceType

A B C D E F G H I M N P R S T V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form