org.apache.ambari.server.agent

Class AlertDefinitionCommand

java.lang.Object

org.apache.ambari.server.agent.AgentCommand

org.apache.ambari.server.agent.AlertDefinitionCommand

public class AlertDefinitionCommand
extends AgentCommand

The AlertDefinitionCommand class is used to encapsulate the AlertDefinitions that will be returned to an agent given a requested hash.

Commands must have addConfigs(ConfigHelper, Cluster) invoked before being sent to the agent so that the definitions will have the required configuration data when they run. Failure to do this will cause the alerts to be scheduled and run, but the result will always be a failure since the parameterized properties they depend on will not be available.

Nested Class Summary

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

AgentCommand.AgentCommandType

Constructor Summary

Constructors

Constructor and Description
AlertDefinitionCommand(String clusterName, String hostName, String publicHostName, String hash, List<AlertDefinition> definitions) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addConfigs(ConfigHelper configHelper, Cluster cluster) Adds cluster configuration properties as required by commands sent to agent.
List<AlertDefinition>	getAlertDefinitions() Gets the alert definitions
String	getClusterName() Gets the name of the cluster.
AgentCommand.AgentCommandType	getCommandType()
String	getHash() Gets the global hash for all alert definitions for a given host.
String	getHostName() Gets the host name.

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

setCommandType, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

AlertDefinitionCommand

public AlertDefinitionCommand(String clusterName,
                              String hostName,
                              String publicHostName,
                              String hash,
                              List<AlertDefinition> definitions)

Constructor.

Parameters:

clusterName - the name of the cluster this response is for (

hostName -

publicHostName -

hash -

definitions -

See Also:

AlertDefinitionHash

Method Detail

getCommandType

public AgentCommand.AgentCommandType getCommandType()

Overrides:

getCommandType in class AgentCommand

getHash

public String getHash()

Gets the global hash for all alert definitions for a given host.

Returns:

the hash (never null).

getAlertDefinitions

public List<AlertDefinition> getAlertDefinitions()

Gets the alert definitions

Returns:

getClusterName

public String getClusterName()

Gets the name of the cluster.

Returns:

the cluster name (not null).

getHostName

public String getHostName()

Gets the host name.

Returns:

the host name (not null).

addConfigs

public void addConfigs(ConfigHelper configHelper,
                       Cluster cluster)
                throws org.apache.ambari.server.AmbariException

Adds cluster configuration properties as required by commands sent to agent.

Parameters:

configHelper - the helper

cluster - the cluster, matching the cluster name specified by the command

Throws:

org.apache.ambari.server.AmbariException