org.apache.ambari.server.agent

Class ExecutionCommand

java.lang.Object

org.apache.ambari.server.agent.AgentCommand

org.apache.ambari.server.agent.ExecutionCommand

public class ExecutionCommand
extends AgentCommand

Execution commands are scheduled by action manager, and these are persisted in the database for recovery.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ExecutionCommand.KeyNames Contains key name strings.

Nested classes/interfaces inherited from class org.apache.ambari.server.agent.AgentCommand

AgentCommand.AgentCommandType

Constructor Summary

Constructors

Constructor and Description
ExecutionCommand()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
Map<String,Set<String>>	getClusterHostInfo()
String	getClusterId()
Map<String,String>	getClusterLevelParams()
String	getClusterName()
String	getCommandId()
Map<String,String>	getCommandParams()
String	getComponentName()
Map<String,Map<String,String>>	getComponentVersionMap()
Map<String,Map<String,String>>	getConfigurationCredentials()
Map<String,Map<String,String>>	getConfigurations()
String	getCredentialStoreEnabled() Get a value indicating whether this service is enabled for credential store use.
Map<String,String>	getHostLevelParams()
String	getHostname()
List<Map<String,String>>	getKerberosCommandParams() Returns parameters for kerberos commands
Set<String>	getLocalComponents()
CommandRepository	getRepositoryFile() Gets the repository file which was set on this command.
String	getRole()
RoleCommand	getRoleCommand()
Map<String,Object>	getRoleParameters() Gets the object-based role parameters for the command.
Map<String,String>	getRoleParams()
String	getServiceName()
String	getServiceType()
long	getTaskId()
UpgradeSummary	getUpgradeSummary() Gets the upgrade summary if there is an active upgrade in the cluster.
Boolean	getUseLatestConfigs()
int	hashCode()
boolean	isOverrideConfigs() Gets whether configuration tags shoudl be refreshed right before the command is scheduled.
void	setClusterHostInfo(Map<String,Set<String>> clusterHostInfo)
void	setClusterId(String clusterId)
void	setClusterLevelParams(Map<String,String> clusterLevelParams)
void	setClusterName(String clusterName)
void	setCommandParams(Map<String,String> commandParams)
void	setComponentName(String componentName)
void	setComponentVersions(Cluster cluster) Used to set a map of {service -> { component -> version}}.
void	setConfigurationCredentials(Map<String,Map<String,String>> configurationCredentials)
void	setConfigurations(Map<String,Map<String,String>> configurations)
void	setCredentialStoreEnabled(String credentialStoreEnabled) Set a value indicating whether this service is enabled for credential store use.
void	setHostLevelParams(Map<String,String> params)
void	setHostname(String hostname)
void	setKerberosCommandParams(List<Map<String,String>> params) Sets parameters for kerberos commands
void	setLocalComponents(Set<String> localComponents)
void	setOverrideConfigs(boolean overrideConfigs)
void	setRepositoryFile(CommandRepository repository) Sets the CommandRepository which will be sent down to the agent instructing it on which repository file to create on the host.
void	setRequestAndStage(long requestId, long stageId) Sets the request and stage on this command.
void	setRole(String role)
void	setRoleCommand(RoleCommand cmd)
void	setRoleParameters(Map<String,Object> params) Sets the role parameters for the command.
void	setRoleParams(Map<String,String> roleParams) Sets the roleParams for the command.
void	setServiceName(String serviceName)
void	setServiceType(String serviceType)
void	setTaskId(long taskId)
void	setUpgradeSummary(UpgradeSummary upgradeSummary) Sets the upgrade summary if there is an active upgrade in the cluster.
void	setUseLatestConfigs(Boolean useLatestConfigs)
String	toString()

Methods inherited from class org.apache.ambari.server.agent.AgentCommand

getCommandType, setCommandType

Methods inherited from class java.lang.Object

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

Constructor Detail

ExecutionCommand

public ExecutionCommand()

Method Detail

setConfigurationCredentials

public void setConfigurationCredentials(Map<String,Map<String,String>> configurationCredentials)

getConfigurationCredentials

public Map<String,Map<String,String>> getConfigurationCredentials()

getCommandId

public String getCommandId()

setRequestAndStage

public void setRequestAndStage(long requestId,
                               long stageId)

Sets the request and stage on this command. The commandId field is automatically constructed from these as requestId-stageId.

Parameters:

requestId - the ID of the execution request.

stageId - the ID of the stage request.

equals

public boolean equals(Object other)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class AgentCommand

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getTaskId

public long getTaskId()

setTaskId

public void setTaskId(long taskId)

getRole

public String getRole()

setRole

public void setRole(String role)

getRoleParams

public Map<String,String> getRoleParams()

setRoleParams

public void setRoleParams(Map<String,String> roleParams)

Sets the roleParams for the command. Consider instead using setRoleParameters(java.util.Map<java.lang.String, java.lang.Object>)

Parameters:

roleParams -

getRoleCommand

public RoleCommand getRoleCommand()

setRoleCommand

public void setRoleCommand(RoleCommand cmd)

getClusterName

public String getClusterName()

setClusterName

public void setClusterName(String clusterName)

getHostname

public String getHostname()

setHostname

public void setHostname(String hostname)

getHostLevelParams

public Map<String,String> getHostLevelParams()

setHostLevelParams

public void setHostLevelParams(Map<String,String> params)

getClusterLevelParams

public Map<String,String> getClusterLevelParams()

setClusterLevelParams

public void setClusterLevelParams(Map<String,String> clusterLevelParams)

getClusterHostInfo

public Map<String,Set<String>> getClusterHostInfo()

setClusterHostInfo

public void setClusterHostInfo(Map<String,Set<String>> clusterHostInfo)

getConfigurations

public Map<String,Map<String,String>> getConfigurations()

setConfigurations

public void setConfigurations(Map<String,Map<String,String>> configurations)

isOverrideConfigs

public boolean isOverrideConfigs()

Gets whether configuration tags shoudl be refreshed right before the command is scheduled.

setOverrideConfigs

public void setOverrideConfigs(boolean overrideConfigs)

getLocalComponents

public Set<String> getLocalComponents()

setLocalComponents

public void setLocalComponents(Set<String> localComponents)

getCommandParams

public Map<String,String> getCommandParams()

setCommandParams

public void setCommandParams(Map<String,String> commandParams)

getServiceName

public String getServiceName()

setServiceName

public void setServiceName(String serviceName)

getServiceType

public String getServiceType()

setServiceType

public void setServiceType(String serviceType)

getCredentialStoreEnabled

public String getCredentialStoreEnabled()

Get a value indicating whether this service is enabled for credential store use.

Returns:

"true" or "false", any other value is considered as "false"

setCredentialStoreEnabled

public void setCredentialStoreEnabled(String credentialStoreEnabled)

Set a value indicating whether this service is enabled for credential store use.

Parameters:

credentialStoreEnabled -

getComponentName

public String getComponentName()

setComponentName

public void setComponentName(String componentName)

getKerberosCommandParams

public List<Map<String,String>> getKerberosCommandParams()

Returns parameters for kerberos commands

Returns:

parameters for kerberos commands

setKerberosCommandParams

public void setKerberosCommandParams(List<Map<String,String>> params)

Sets parameters for kerberos commands

Parameters:

params - for kerberos commands

getClusterId

public String getClusterId()

setClusterId

public void setClusterId(String clusterId)

getRepositoryFile

public CommandRepository getRepositoryFile()

Gets the repository file which was set on this command. The repository can be set either by the creator of the command or by the ExecutionCommandWrapper when it is about to execute the command.

Returns:

the repository file that is to be written.

See Also:

setRepositoryFile(CommandRepository)

setRepositoryFile

public void setRepositoryFile(CommandRepository repository)

Sets the CommandRepository which will be sent down to the agent instructing it on which repository file to create on the host. In most cases, it is not necessary to set this file since the ExecutionCommandWrapper will set it in the event that it is missing. In fact, it is only appropriate to set this file in the following cases:

• When distributing a repository to hosts in preparation for upgrade. This is because the service/component desired stack is not pointing to the new repository yet
• If the command does not contain a host or service/component>

Parameters:

repository - the command repository instance.

getRoleParameters

public Map<String,Object> getRoleParameters()

Gets the object-based role parameters for the command.

setRoleParameters

public void setRoleParameters(Map<String,Object> params)

Sets the role parameters for the command. This is preferred over setRoleParams(Map), as this form will pass values as structured data, as opposed to unstructured, escaped json.

Parameters:

params -

getUseLatestConfigs

public Boolean getUseLatestConfigs()

setUseLatestConfigs

public void setUseLatestConfigs(Boolean useLatestConfigs)

getComponentVersionMap

public Map<String,Map<String,String>> getComponentVersionMap()

Returns:

setComponentVersions

public void setComponentVersions(Cluster cluster)
                          throws org.apache.ambari.server.AmbariException

Used to set a map of {service -> { component -> version}}. This is necessary when performing an upgrade to correct build paths of required binaries. This method will only set the version information for a component if:

• The component advertises a version
• The repository for the component has been resolved and the version can be trusted

Parameters:

cluster - the cluster from which to build the map

Throws:

org.apache.ambari.server.AmbariException

setUpgradeSummary

public void setUpgradeSummary(UpgradeSummary upgradeSummary)

Sets the upgrade summary if there is an active upgrade in the cluster.

Parameters:

upgradeSummary - the upgrade or null for none.

getUpgradeSummary

public UpgradeSummary getUpgradeSummary()

Gets the upgrade summary if there is an active upgrade in the cluster.

Returns:

the upgrade or null for none.