org.apache.ambari.server.stack.upgrade

Class ConfigureTask

java.lang.Object

org.apache.ambari.server.stack.upgrade.Task

org.apache.ambari.server.stack.upgrade.ServerSideActionTask

org.apache.ambari.server.stack.upgrade.ConfigureTask

Direct Known Subclasses:

CreateAndConfigureTask

public class ConfigureTask
extends ServerSideActionTask

The ConfigureTask represents a configuration change. This task contains id of change. Change definitions are located in a separate file (config upgrade pack). IDs of change definitions share the same namespace within all stacks

 
 <task xsi:type="configure" id="hdp_2_3_0_0-UpdateHiveConfig"/>
 
 

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.ambari.server.stack.upgrade.Task

Task.Type

Field Summary

Fields

Modifier and Type	Field and Description
static String	actionVerb
String	associatedService The associated service is the service where this config task is specified
String	id
static String	PARAMETER_ASSOCIATED_SERVICE The associated service for the config task
static String	PARAMETER_CONFIG_TYPE The key that represents the configuration type to change (ie hdfs-site).
static String	PARAMETER_INSERTIONS Insertions can be several per task, so they're passed in as a json-ified list of objects.
static String	PARAMETER_KEY_VALUE_PAIRS Setting key/value pairs can be several per task, so they're passed in as a json-ified list of objects.
static String	PARAMETER_REPLACEMENTS Replacements can be several per task, so they're passed in as a json-ified list of objects.
static String	PARAMETER_TRANSFERS Transfers can be several per task, so they're passed in as a json-ified list of objects.
boolean	supportsPatch

Fields inherited from class org.apache.ambari.server.stack.upgrade.ServerSideActionTask

implClass, messages, parameters

Fields inherited from class org.apache.ambari.server.stack.upgrade.Task

condition, GSON, isSequential, scope, summary, timeoutConfig

Constructor Summary

Constructors

Constructor and Description
ConfigureTask() Constructor.

Method Summary

Modifier and Type	Method and Description
String	getActionVerb()
Map<String,String>	getConfigurationChanges(Cluster cluster, ConfigUpgradePack configUpgradePack) Gets a map containing the following properties pertaining to the configuration value to change: PARAMETER_CONFIG_TYPE - the configuration type (ie hdfs-site) PARAMETER_KEY_VALUE_PAIRS - key/value pairs for the configurations PARAMETER_KEY_VALUE_PAIRS - key/value pairs for the configurations PARAMETER_TRANSFERS - COPY/MOVE/DELETE changes PARAMETER_REPLACEMENTS - value replacements
String	getId() This getter is intended to be used only from tests.
StageWrapper.Type	getStageWrapperType()
String	getSummary(ConfigUpgradePack configUpgradePack) Gets the summary of the task or null.
Task.Type	getType()

Methods inherited from class org.apache.ambari.server.stack.upgrade.ServerSideActionTask

getImplementationClass, getParameters, setImplClass

Methods inherited from class org.apache.ambari.server.stack.upgrade.Task

getSummary, toString

Methods inherited from class java.lang.Object

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

Field Detail

PARAMETER_CONFIG_TYPE

public static final String PARAMETER_CONFIG_TYPE

The key that represents the configuration type to change (ie hdfs-site).

See Also:

Constant Field Values

PARAMETER_KEY_VALUE_PAIRS

public static final String PARAMETER_KEY_VALUE_PAIRS

Setting key/value pairs can be several per task, so they're passed in as a json-ified list of objects.

See Also:

Constant Field Values

PARAMETER_TRANSFERS

public static final String PARAMETER_TRANSFERS

Transfers can be several per task, so they're passed in as a json-ified list of objects.

See Also:

Constant Field Values

PARAMETER_REPLACEMENTS

public static final String PARAMETER_REPLACEMENTS

Replacements can be several per task, so they're passed in as a json-ified list of objects.

See Also:

Constant Field Values

PARAMETER_INSERTIONS

public static final String PARAMETER_INSERTIONS

Insertions can be several per task, so they're passed in as a json-ified list of objects.

See Also:

Constant Field Values

PARAMETER_ASSOCIATED_SERVICE

public static final String PARAMETER_ASSOCIATED_SERVICE

The associated service for the config task

See Also:

Constant Field Values

actionVerb

public static final String actionVerb

See Also:

Constant Field Values

id

public String id

supportsPatch

public boolean supportsPatch

associatedService

public String associatedService

The associated service is the service where this config task is specified

Constructor Detail

ConfigureTask

public ConfigureTask()

Constructor.

Method Detail

getType

public Task.Type getType()

Specified by:

getType in class Task

Returns:

the type of the task

getStageWrapperType

public StageWrapper.Type getStageWrapperType()

Specified by:

getStageWrapperType in class Task

Returns:

when a single Task is constructed, this is the type of stage it should belong to.

getActionVerb

public String getActionVerb()

Overrides:

getActionVerb in class ServerSideActionTask

Returns:

a verb to display that describes the type of task, e.g., "executing".

getId

public String getId()

This getter is intended to be used only from tests. In production, getConfigurationChanges() logic should be used instead

Returns:

id of config upgrade change definition as defined in upgrade pack

getSummary

public String getSummary(ConfigUpgradePack configUpgradePack)

Gets the summary of the task or null.

Returns:

the task summary or null.

getConfigurationChanges

public Map<String,String> getConfigurationChanges(Cluster cluster,
                                                  ConfigUpgradePack configUpgradePack)

Gets a map containing the following properties pertaining to the configuration value to change:

• PARAMETER_CONFIG_TYPE - the configuration type (ie hdfs-site)
• PARAMETER_KEY_VALUE_PAIRS - key/value pairs for the configurations
• PARAMETER_KEY_VALUE_PAIRS - key/value pairs for the configurations
• PARAMETER_TRANSFERS - COPY/MOVE/DELETE changes
• PARAMETER_REPLACEMENTS - value replacements

Parameters:

cluster - the cluster to use when retrieving conditional properties to test against (not null).

Returns:

the a map containing the changes to make. This could potentially be an empty map if no conditions are met. Callers should decide how to handle a configuration task that is unable to set any configuration values.