com.atlassian.bamboo.builder
Class CustomCommandBuilder

java.lang.Object
  com.atlassian.bamboo.command.Command
      com.atlassian.bamboo.builder.AbstractBuilder
          com.atlassian.bamboo.builder.CustomCommandBuilder

All Implemented Interfaces:

Builder, EnvironmentVariablesAwareBuilder, MutableEnvironmentVariablesAwareBuilder, InitablePluginModule, BambooPluginModule, BuildConfigurationAwarePlugin, BuilderV2, ConfigurablePlugin, java.io.Serializable

public class CustomCommandBuilder
extends AbstractBuilder

See Also:

Serialized Form

Field Summary

static java.lang.String

PARAM_ARG

Fields inherited from class com.atlassian.bamboo.builder.AbstractBuilder

BUILD_FAILED_MARKER, BUILD_SUCCESSFUL_MARKER, buildDirectoryManager, DEFAULT_TEST_REPORTS_XML, errorUpdateHandler, FIND_FAILURE_MESSAGE_IN_LAST, FIND_SUCCESS_MESSAGE_IN_LAST, PARAM_BUILD_LABEL, PARAM_BUILDJDK, PARAM_ENV_VAR, PARAM_HASTESTS, PARAM_HOME, PARAM_PROJECT_FILE, PARAM_TEST_RESULTS_DIRECTORY, PARAM_WORKING_SUB_DIR, SEARCH_BUILD_SUCCESS_FAIL_MESSAGE_EVERYWHERE, templateRenderer

Fields inherited from class com.atlassian.bamboo.command.Command

buildLoggerManager, CBD_BUILD_COMMANDLINE, substitutionBean

Fields inherited from interface com.atlassian.bamboo.builder.Builder

CAPABILITY_BUILDER_PREFIX, CAPABILITY_BUILDER_TYPE

Constructor Summary

CustomCommandBuilder()

Method Summary

java.util.Map<java.lang.String,LabelPathMap>	addDefaultLabelPathMaps(java.util.Map<java.lang.String,LabelPathMap> labelPathMaps)
void	addDefaultValues(BuildConfiguration configuration) Extension point for adding default values to the form for BuildConfigurationAwarePlugin.getEditHtml(com.atlassian.bamboo.ww2.actions.build.admin.create.BuildConfiguration, com.atlassian.bamboo.plan.Plan)
protected boolean	bashExists()
java.lang.String	getArgument()
java.lang.String[]	getCommandArguments(ReadOnlyCapabilitySet capabilitySet) What are the arguments for the command line to execute
java.lang.String	getCommandExecutable(ReadOnlyCapabilitySet capabilitySet) What is the executable for the command line to execute
java.util.Map<java.lang.String,java.lang.String>	getFullParams() Gets the full params that's used to persist.
java.lang.String	getName() Returns a human readable version of the current Builder type
java.lang.String	getPathHelp() Help text for the builder type
java.lang.String	getUrl()
boolean	isPathValid(java.lang.String path) Returns true if the passed path is valid for this builder.
void	setArgument(java.lang.String argument)
void	setParams(FilteredMap filteredParams) Updates the current builder object with
ErrorCollection	validate(BuildConfiguration buildConfiguration) Validates the properties in the BuildConfiguration object.
ErrorCollection	validate(FilteredMap filteredParams)

Methods inherited from class com.atlassian.bamboo.builder.AbstractBuilder

collateTestResults, customiseLabelTypeMap, customizeBuildRequirements, executeBuild, getBuildDir, getBuildDirectoryManager, getBuildJdk, getCompleteKey, getEditHtml, getEnvironmentVariables, getFilteredParams, getKey, getKeyPrefix, getLabel, getPath, getProjectFile, getTemplateContext, getTestChecked, getTestResultsDirectory, getViewHtml, getWorkingDirectory, getWorkingSubDirectory, hasPassed, hasTests, init, isJdkValid, isLabelPathMapConfigurable, outputEndsWith, populateBuildErrors, prepareConfigObject, removeAllSystemJdkRequirements, removeBuildRequirements, runBuild, setAdministrationConfiguration, setBuildDir, setBuildDirectoryManager, setBuildJdk, setBuildLogFileAccessorFactory, setEnvironmentVariables, setErrorUpdateHandler, setHasTests, setJdkManager, setKey, setLabel, setProjectFile, setTemplateRenderer, setTestChecked, setTestResultsDirectory, setWorkingSubDirectory, toString, validate

Methods inherited from class com.atlassian.bamboo.command.Command

decorateCommandLine, executeCommand, getBuildLoggerManager, getCommandLine, getCustomEnvironmentVars, getEnvironmentSetting, getSubstitutedCommandLine, getVariableSubstitutionBean, isWindowsPlatform, setBuildLoggerManager, setPluginAccessor, setVariableSubstitutionBean

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_ARG

public static final java.lang.String PARAM_ARG

See Also:

Constant Field Values

Constructor Detail

CustomCommandBuilder

public CustomCommandBuilder()

Method Detail

getName

@NotNull
public java.lang.String getName()

Description copied from interface: Builder

Returns a human readable version of the current Builder type

Returns:

getPathHelp

@NotNull
public java.lang.String getPathHelp()

Description copied from interface: Builder

Help text for the builder type

Specified by:

getPathHelp in interface Builder

Overrides:

getPathHelp in class AbstractBuilder

Returns:

getUrl

public java.lang.String getUrl()

getCommandExecutable

@NotNull
public java.lang.String getCommandExecutable(ReadOnlyCapabilitySet capabilitySet)

What is the executable for the command line to execute

Overrides:

getCommandExecutable in class Command

Parameters:

capabilitySet -

Returns:

the executable as a string

getCommandArguments

@NotNull
public java.lang.String[] getCommandArguments(ReadOnlyCapabilitySet capabilitySet)

What are the arguments for the command line to execute

Overrides:

getCommandArguments in class Command

Parameters:

capabilitySet -

Returns:

the executable as a string[]. Spaces/division of strings in the array should not matter etc should not matter.

validate

public ErrorCollection validate(FilteredMap filteredParams)

Specified by:

validate in class AbstractBuilder

validate

@NotNull
public ErrorCollection validate(@NotNull
                                        BuildConfiguration buildConfiguration)

Description copied from interface: BuildConfigurationAwarePlugin

Validates the properties in the BuildConfiguration object. The name of the properties match those passed in through the form fragments in BuildConfigurationAwarePlugin.getEditHtml(com.atlassian.bamboo.ww2.actions.build.admin.create.BuildConfiguration, com.atlassian.bamboo.plan.Plan) template.

Parameters:

buildConfiguration - - @NotNull

Returns:

ErrorCollection keyed by the field name. @NotNull

addDefaultValues

public void addDefaultValues(@NotNull
                             BuildConfiguration configuration)

Description copied from interface: BuildConfigurationAwarePlugin

Extension point for adding default values to the form for BuildConfigurationAwarePlugin.getEditHtml(com.atlassian.bamboo.ww2.actions.build.admin.create.BuildConfiguration, com.atlassian.bamboo.plan.Plan)

Parameters:

configuration - - @NotNull

isPathValid

public boolean isPathValid(@Nullable
                           java.lang.String path)

Description copied from interface: Builder

Returns true if the passed path is valid for this builder. The definition of a path depends on the builder itself. It could be the path to the executable (e.g script builder) or just the home directory (e.g. Ant builder)

Returns:

true if valid

getFullParams

@NotNull
public java.util.Map<java.lang.String,java.lang.String> getFullParams()

Description copied from interface: Builder

Gets the full params that's used to persist.

Specified by:

getFullParams in interface Builder

Overrides:

getFullParams in class AbstractBuilder

Returns:

Map key by the full param key (e.g. builder.ant.label). Never null

setParams

public void setParams(@NotNull
                      FilteredMap filteredParams)

Description copied from interface: Builder

Updates the current builder object with

Specified by:

setParams in interface Builder

Overrides:

setParams in class AbstractBuilder

Parameters:

filteredParams - - Filtered Map with the prefix builder key stripped out

addDefaultLabelPathMaps

public java.util.Map<java.lang.String,LabelPathMap> addDefaultLabelPathMaps(java.util.Map<java.lang.String,LabelPathMap> labelPathMaps)

Returns:

bashExists

protected boolean bashExists()

getArgument

public java.lang.String getArgument()

setArgument

public void setArgument(java.lang.String argument)