com.atlassian.bamboo.credentials

Interface CredentialsManager

All Superinterfaces:

CredentialsAccessor

All Known Implementing Classes:

CredentialsManagerImpl

public interface CredentialsManager
extends CredentialsAccessor

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.bamboo.credentials.CredentialsAccessor

CredentialsAccessor.IsCredentialsOfType

Method Summary

Modifier and Type	Method and Description
CredentialsData	createCredentials(CredentialTypeModuleDescriptor credentialDescriptor, String credentialsName, Map<String,String> credentialsConfig) Creates Credentials from the configuration map and stores them in the database.
CredentialsData	createOrUpdateCredentials(CredentialsData credentials) Creates credentials based on the object representation.
void	deleteCredentials(long id) Deletes credentials based on Id
CredentialsData	editCredentials(long credentialsId, String credentialsName, Map<String,String> credentialsConfig) Updates Credentials with values in the configuration map.
CredentialTypeModuleDescriptor	getCredentialTypeDescriptor(String pluginKey)
List<CredentialTypeModuleDescriptor>	getCredentialTypeDescriptors()
CredentialsData	mergeImportedEntity(CredentialsData importedEntity) Merges the state of the given imported entity into the database.
CredentialTypeExporter	retrieveCredentialTypeExporter(String pluginKey) Find credential type exporter for given plugin key.
CredentialsData	updateCredentialsName(long id, String name) Updates shared credentials name
void	validate(CredentialsData importedEntity) Validate entity before saving it in database.

Methods inherited from interface com.atlassian.bamboo.credentials.CredentialsAccessor

getAllCredentials, getAllCredentials, getCredentials, getCredentialsByName, getCredentialsByOid, hasAnyCredentials

Method Detail

getCredentialTypeDescriptors

@NotNull
List<CredentialTypeModuleDescriptor> getCredentialTypeDescriptors()

Returns:

Provides a list of available shared credential types

getCredentialTypeDescriptor

@Nullable
CredentialTypeModuleDescriptor getCredentialTypeDescriptor(@Nullable
                                                                     String pluginKey)

Returns:

The shared credential type for the given key

updateCredentialsName

@Nullable
CredentialsData updateCredentialsName(long id,
                                                @NotNull
                                                String name)
                                         throws WebValidationException

Updates shared credentials name

Parameters:

id - The id of the object to update

name - The new name to identify the credentials

Returns:

Returns the object updated

Throws:

WebValidationException

createOrUpdateCredentials

@NotNull
CredentialsData createOrUpdateCredentials(@NotNull
                                                   CredentialsData credentials)

Creates credentials based on the object representation. If the object has ID set, then an update will be executed.

This method encrypts the values of the credentials, for example for ssh encrypts the ssh key and ssh passphrase.

Parameters:

credentials - The object representation with the data to save.

Returns:

Returns the persisted object for the credentials

createCredentials

@NotNull
CredentialsData createCredentials(@NotNull
                                           CredentialTypeModuleDescriptor credentialDescriptor,
                                           @NotNull
                                           String credentialsName,
                                           @NotNull
                                           Map<String,String> credentialsConfig)

Creates Credentials from the configuration map and stores them in the database.

This method encrypts the values of the credentials, for example for ssh encrypts the ssh key and ssh passphrase.

Parameters:

credentialDescriptor - The plugin module descriptor for the credential type being created.

credentialsName - The name for the credentials.

credentialsConfig - The configuration map containing the credential values as defined by the plugin for this credential type.

Returns:

Returns the CredentialsData object representation of the credentials after creation.

editCredentials

@NotNull
CredentialsData editCredentials(long credentialsId,
                                         @NotNull
                                         String credentialsName,
                                         @NotNull
                                         Map<String,String> credentialsConfig)

Updates Credentials with values in the configuration map.

This method encrypts the values of the credentials, for example for ssh encrypts the ssh key and ssh passphrase.

Parameters:

credentialsId - The ID of the credentials to update.

credentialsName - The name for the credentials.

credentialsConfig - The configuration map containing the credential values as defined by the plugin for this credential type.

Returns:

Returns the CredentialsData object representation of the credentials.

deleteCredentials

void deleteCredentials(long id)

Deletes credentials based on Id

Parameters:

id - id of the object to delete

validate

void validate(@NotNull
              CredentialsData importedEntity)
       throws com.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException

Validate entity before saving it in database.

Parameters:

importedEntity - imported entity

Throws:

com.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException

retrieveCredentialTypeExporter

@NotNull
CredentialTypeExporter retrieveCredentialTypeExporter(@Nullable
                                                               String pluginKey)

Find credential type exporter for given plugin key. Returns null if couldn't find it.

mergeImportedEntity

@NotNull
CredentialsData mergeImportedEntity(@NotNull
                                             CredentialsData importedEntity)

Merges the state of the given imported entity into the database.

This service will attempt to merge the entity based on ImmutableEntityWithOid.getOid(), and if there's no match, based on CredentialsData.getName(). If an existing entity is found, then it will be updated. Otherwise, a new database entity will be created. It's assumed that this method is used in specs import only as it's sending analytic event.

Parameters:

importedEntity - imported entity

Returns:

an object after persisting to the database - either the newly created or updated database object