com.atlassian.bamboo.credentials

Class CredentialsManagerImpl

java.lang.Object

com.atlassian.bamboo.credentials.CredentialsManagerImpl

All Implemented Interfaces:

CredentialsAccessor, CredentialsManager

public class CredentialsManagerImpl
extends Object
implements CredentialsManager

Nested Class Summary

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

CredentialsAccessor.IsCredentialsOfType

Constructor Summary

Constructors

Constructor and Description
CredentialsManagerImpl()

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.
Iterable<CredentialsData>	getAllCredentials()
Iterable<CredentialsData>	getAllCredentials(String pluginKey)
CredentialsData	getCredentials(long id) Gets the Shared Credentials by id
CredentialsData	getCredentialsByName(String name) Find shared credentials by name
CredentialsData	getCredentialsByOid(BambooEntityOid oid) Find shared credentials by BambooEntityOid
CredentialTypeModuleDescriptor	getCredentialTypeDescriptor(String pluginKey)
List<CredentialTypeModuleDescriptor>	getCredentialTypeDescriptors()
boolean	hasAnyCredentials(String pluginKey)
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 class java.lang.Object

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

Constructor Detail

CredentialsManagerImpl

public CredentialsManagerImpl()

Method Detail

getCredentialTypeDescriptors

@NotNull
public List<CredentialTypeModuleDescriptor> getCredentialTypeDescriptors()

Specified by:

getCredentialTypeDescriptors in interface CredentialsManager

Returns:

Provides a list of available shared credential types

getCredentialTypeDescriptor

@Nullable
public CredentialTypeModuleDescriptor getCredentialTypeDescriptor(@Nullable
                                                                            String pluginKey)

Specified by:

getCredentialTypeDescriptor in interface CredentialsManager

Returns:

The shared credential type for the given key

updateCredentialsName

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

Description copied from interface: CredentialsManager

Updates shared credentials name

Specified by:

updateCredentialsName in interface CredentialsManager

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
public CredentialsData createOrUpdateCredentials(@NotNull
                                                          CredentialsData credentials)

Description copied from interface: CredentialsManager

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.

Specified by:

createOrUpdateCredentials in interface CredentialsManager

Parameters:

credentials - The object representation with the data to save.

Returns:

Returns the persisted object for the credentials

createCredentials

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

Description copied from interface: CredentialsManager

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.

Specified by:

createCredentials in interface CredentialsManager

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
public CredentialsData editCredentials(long credentialsId,
                                                @NotNull
                                                String credentialsName,
                                                @NotNull
                                                Map<String,String> credentialsConfig)

Description copied from interface: CredentialsManager

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.

Specified by:

editCredentials in interface CredentialsManager

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.

getCredentials

public CredentialsData getCredentials(long id)

Description copied from interface: CredentialsAccessor

Gets the Shared Credentials by id

Specified by:

getCredentials in interface CredentialsAccessor

Returns:

Returns the object representation of the credentials

getCredentialsByOid

public CredentialsData getCredentialsByOid(BambooEntityOid oid)

Description copied from interface: CredentialsAccessor

Find shared credentials by BambooEntityOid

Specified by:

getCredentialsByOid in interface CredentialsAccessor

Returns:

getCredentialsByName

public CredentialsData getCredentialsByName(String name)

Description copied from interface: CredentialsAccessor

Find shared credentials by name

Specified by:

getCredentialsByName in interface CredentialsAccessor

Returns:

getAllCredentials

@NotNull
public Iterable<CredentialsData> getAllCredentials()

Specified by:

getAllCredentials in interface CredentialsAccessor

Returns:

A list of all known credentials

getAllCredentials

@NotNull
public Iterable<CredentialsData> getAllCredentials(@NotNull
                                                            String pluginKey)

Specified by:

getAllCredentials in interface CredentialsAccessor

Returns:

A list of all known credentials that match the given plugin key

hasAnyCredentials

public boolean hasAnyCredentials(@NotNull
                                 String pluginKey)

Specified by:

hasAnyCredentials in interface CredentialsAccessor

Returns:

true if any credentials that match the given plugin key exist.

deleteCredentials

public void deleteCredentials(long id)

Description copied from interface: CredentialsManager

Deletes credentials based on Id

Specified by:

deleteCredentials in interface CredentialsManager

Parameters:

id - id of the object to delete

validate

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

Description copied from interface: CredentialsManager

Validate entity before saving it in database.

Specified by:

validate in interface CredentialsManager

Parameters:

importedEntity - imported entity

Throws:

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

retrieveCredentialTypeExporter

@NotNull
public CredentialTypeExporter retrieveCredentialTypeExporter(@Nullable
                                                                      String pluginKey)

Description copied from interface: CredentialsManager

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

Specified by:

retrieveCredentialTypeExporter in interface CredentialsManager

mergeImportedEntity

@NotNull
public CredentialsData mergeImportedEntity(@NotNull
                                                    CredentialsData importedEntity)

Description copied from interface: CredentialsManager

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.

Specified by:

mergeImportedEntity in interface CredentialsManager

Parameters:

importedEntity - imported entity

Returns:

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