Package com.atlassian.bamboo.v2.build.agent.capability

Class AbstractExecutableCapabilityTypeModule

java.lang.Object

com.atlassian.bamboo.v2.build.agent.capability.AbstractCapabilityType

com.atlassian.bamboo.v2.build.agent.capability.AbstractCapabilityTypeModule

com.atlassian.bamboo.v2.build.agent.capability.AbstractExecutableCapabilityTypeModule

All Implemented Interfaces:

InitablePluginModule, BambooPluginModule, CapabilityDefaultsHelper, CapabilityType, CapabilityTypeModule, com.atlassian.core.i18n.I18nTextProvider, Comparable<CapabilityType>

Direct Known Subclasses:

AbstractMultipleExecutableCapabilityTypeModule, SshCapabilityTypeModule

public abstract class AbstractExecutableCapabilityTypeModule
extends AbstractCapabilityTypeModule
implements CapabilityDefaultsHelper, com.atlassian.core.i18n.I18nTextProvider

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	AGENT_CAPABILITY_TYPE_PREFIX

Fields inherited from interface com.atlassian.bamboo.v2.build.agent.capability.CapabilityDefaultsHelper

CAPABILITY_AGENT_ENVIRONMENT_PREFIX, CAPABILITY_BUILDER_PREFIX, CAPABILITY_BUILDER_TYPE

Constructor Summary

Constructors

Constructor	Description
AbstractExecutableCapabilityTypeModule()

Method Summary

Modifier and Type	Method	Description
@NotNull CapabilitySet	addDefaultCapabilities(@NotNull CapabilitySet capabilitySet)	Adds default Capabilities for this module.
@NotNull Capability	getCapability(@NotNull Map<String,String[]> params)	Returns a new capability given the action params map
abstract String	getCapabilityUndefinedKey()
abstract List<String>	getDefaultWindowPaths()
abstract String	getExecutableFilename()
abstract String	getExecutableKey()
@NotNull String	getLabel(@NotNull String key)	The display label
abstract String	getMandatoryCapabilityKey()
static @Nullable String	getParamValue(@NotNull Map<String,String[]> params, String field)
String	getText(String key)
String	getText(String s, Object[] objects)
String	getText(String key, String[] args)
protected com.opensymphony.xwork2.TextProvider	getTextProvider()	Deprecated. since 6.8 inject your own
void	setTextProvider(com.opensymphony.xwork2.TextProvider textProvider)	Deprecated. since 6.8 use constructor injection or annotation injection
@NotNull Map<String,String>	validate(@NotNull Map<String,String[]> params)	Validate given an action params map.

Methods inherited from class com.atlassian.bamboo.v2.build.agent.capability.AbstractCapabilityTypeModule

getCapabilityTypeKey, getCapabilityTypeLabel, getEditHtml, getExtraInfo, getNewKeyFromLabel, getSortOrder, getValueDescriptionKey, init, isAllowRename, setTemplateRenderer

Methods inherited from class com.atlassian.bamboo.v2.build.agent.capability.AbstractCapabilityType

compareTo, equals, getViewTypeAction, hashCode, toString, updatePlanForNewLabel, updateTasksForNewLabel

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.atlassian.bamboo.v2.build.agent.capability.CapabilityType

getCapabilityTypeSpecificTaskConfigurationKey, getViewTypeAction, updatePlanForNewLabel

Methods inherited from interface java.lang.Comparable

compareTo

Field Details

AGENT_CAPABILITY_TYPE_PREFIX

protected static final String AGENT_CAPABILITY_TYPE_PREFIX

See Also:

• Constant Field Values

Constructor Details

AbstractExecutableCapabilityTypeModule

public AbstractExecutableCapabilityTypeModule()

Method Details

getMandatoryCapabilityKey

public abstract String getMandatoryCapabilityKey()

getExecutableKey

public abstract String getExecutableKey()

getCapabilityUndefinedKey

public abstract String getCapabilityUndefinedKey()

getDefaultWindowPaths

public abstract List<String> getDefaultWindowPaths()

getExecutableFilename

public abstract String getExecutableFilename()

getLabel

@NotNull
public @NotNull String getLabel(@NotNull
 @NotNull String key)

Description copied from interface: CapabilityType

The display label

Specified by:

getLabel in interface CapabilityType

Returns:

validate

@NotNull
public @NotNull Map<String,String> validate(@NotNull
 @NotNull Map<String,String[]> params)

Description copied from interface: CapabilityType

Validate given an action params map.

Specified by:

validate in interface CapabilityType

Returns:

Map with errors. key = field name, value = error message

getParamValue

@Nullable
public static @Nullable String getParamValue(@NotNull
 @NotNull Map<String,String[]> params,
 String field)

getCapability

@NotNull
public @NotNull Capability getCapability(@NotNull
 @NotNull Map<String,String[]> params)

Description copied from interface: CapabilityType

Returns a new capability given the action params map

Specified by:

getCapability in interface CapabilityType

addDefaultCapabilities

@NotNull
public @NotNull CapabilitySet addDefaultCapabilities(@NotNull
 @NotNull CapabilitySet capabilitySet)

Description copied from interface: CapabilityDefaultsHelper

Adds default Capabilities for this module. Used during auto-detecting server capabilities.

Specified by:

addDefaultCapabilities in interface CapabilityDefaultsHelper

Parameters:

capabilitySet - to add the capability to

Returns:

the supplied capabilitySet with the new capabilities included if found, else the given capabilitySet

getTextProvider

@Deprecated
protected com.opensymphony.xwork2.TextProvider getTextProvider()

Deprecated.

since 6.8 inject your own

getText

public String getText(String key)

Specified by:

getText in interface com.atlassian.core.i18n.I18nTextProvider

getText

public String getText(String s,
 Object[] objects)

Specified by:

getText in interface com.atlassian.core.i18n.I18nTextProvider

getText

public String getText(String key,
 String[] args)

setTextProvider

@Deprecated
public void setTextProvider(com.opensymphony.xwork2.TextProvider textProvider)

Deprecated.

since 6.8 use constructor injection or annotation injection