Package com.atlassian.bamboo.credentials

Class UsernamePasswordCredentialType

java.lang.Object

com.atlassian.bamboo.credentials.AbstractCredentialType

com.atlassian.bamboo.credentials.UsernamePasswordCredentialType

All Implemented Interfaces:

CredentialType, InitablePluginModule<CredentialTypeModuleDescriptor>, BambooPluginModule

public class UsernamePasswordCredentialType
extends AbstractCredentialType

Field Summary

Fields

Modifier and Type	Field	Description
static String	CFG_PASSWORD
static String	CFG_USERNAME
static String	PLUGIN_KEY

Fields inherited from class com.atlassian.bamboo.credentials.AbstractCredentialType

CFG_CREDENTIALS_NAME, textProvider

Constructor Summary

Constructors

Constructor	Description
UsernamePasswordCredentialType()

Method Summary

Modifier and Type	Method	Description
@NotNull Map<String,String>	generateCredentialsConfigMap(@NotNull ActionParametersMap params, @Nullable CredentialsData previousCredentialsData)	Convert the params from the ui into a config map to be stored in the database.
@NotNull Map<String,String>	generateCredentialsConfigMap(@NotNull Map<String,String> params)	Convert the given map into a config map of the shared credential to be stored in the database.
@NotNull Map<String,String>	getCredentialsConfigurationMap(@NotNull CredentialsData credentialsData)	Convert an existing CredentialsData to a map.
void	populateContextForEdit(@NotNull Map<String,Object> context, @NotNull CredentialsData previousCredentialsData)	Provide any required context to be used when rendering the freemarker template for editing credentials.
void	validate(@NotNull ActionParametersMap params, @Nullable CredentialsData previousCredentialsData, @NotNull ErrorCollection errorCollection)	Validate configuration.

Methods inherited from class com.atlassian.bamboo.credentials.AbstractCredentialType

init, populateContextForCreate, setTextProvider

Methods inherited from class java.lang.Object

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

Field Detail

PLUGIN_KEY

public static final String PLUGIN_KEY

See Also:

Constant Field Values

CFG_USERNAME

public static final String CFG_USERNAME

See Also:

Constant Field Values

CFG_PASSWORD

public static final String CFG_PASSWORD

See Also:

Constant Field Values

Constructor Detail

UsernamePasswordCredentialType

public UsernamePasswordCredentialType()

Method Detail

validate

public void validate(@NotNull
                     @NotNull ActionParametersMap params,
                     @Nullable
                     @Nullable CredentialsData previousCredentialsData,
                     @NotNull
                     @NotNull ErrorCollection errorCollection)

Description copied from interface: CredentialType

Validate configuration.

Specified by:

validate in interface CredentialType

Overrides:

validate in class AbstractCredentialType

Parameters:

params - configuration to be validated

previousCredentialsData - the previous immutable CredentialsData before saving or null if credentials are being created.

errorCollection - error collection to be set on validation failure

generateCredentialsConfigMap

@NotNull
public @NotNull Map<String,String> generateCredentialsConfigMap(@NotNull
                                                                      @NotNull ActionParametersMap params,
                                                                      @Nullable
                                                                      @Nullable CredentialsData previousCredentialsData)

Description copied from interface: CredentialType

Convert the params from the ui into a config map to be stored in the database. Can assume validation has occurred in the #validate method.

Sensitive parameters such as passwords do not have to be encrypted, as they will be secured before being stored in the database.

Parameters:

params - request parameters.

previousCredentialsData - the previous immutable CredentialsData before saving or null if credentials are being created.

Returns:

the configuration map to be stored in the database.

getCredentialsConfigurationMap

@NotNull
public @NotNull Map<String,String> getCredentialsConfigurationMap(@NotNull
                                                                        @NotNull CredentialsData credentialsData)

Description copied from interface: CredentialType

Convert an existing CredentialsData to a map. So that configuration of the credential can used by other component, e.g. the rest plugin. Each implementation of CredentialType should populate different data to the map and encrypt them if necessary.

Specified by:

getCredentialsConfigurationMap in interface CredentialType

Overrides:

getCredentialsConfigurationMap in class AbstractCredentialType

Parameters:

credentialsData - an existing credential

Returns:

Map that stores the credential's configuration

generateCredentialsConfigMap

@NotNull
public @NotNull Map<String,String> generateCredentialsConfigMap(@NotNull
                                                                      @NotNull Map<String,String> params)
                                                               throws WebValidationException

Description copied from interface: CredentialType

Convert the given map into a config map of the shared credential to be stored in the database.

Sensitive parameters such as passwords do not have to be encrypted, as they will be secured before being stored in the database.

Specified by:

generateCredentialsConfigMap in interface CredentialType

Overrides:

generateCredentialsConfigMap in class AbstractCredentialType

Parameters:

params - original map to be converted

Returns:

the configuration map to be stored in the database.

Throws:

WebValidationException - if params contains invalid configuration

populateContextForEdit

public void populateContextForEdit(@NotNull
                                   @NotNull Map<String,Object> context,
                                   @NotNull
                                   @NotNull CredentialsData previousCredentialsData)

Description copied from interface: CredentialType

Provide any required context to be used when rendering the freemarker template for editing credentials.

Specified by:

populateContextForEdit in interface CredentialType

Overrides:

populateContextForEdit in class AbstractCredentialType

Parameters:

context - map to put your context in.

previousCredentialsData - existing credentials