Hyperic HQ Plugin API v. 4.4.0.2

org.hyperic.hq.measurement.action
Class MetricAlertAction

java.lang.Object
  extended by org.hyperic.hq.measurement.action.MetricAlertAction
All Implemented Interfaces:
ActionConfigInterface, ActionInterface

public class MetricAlertAction
extends java.lang.Object
implements ActionInterface

Log the fact that an alert was generated due to some measurement


Constructor Summary
MetricAlertAction()
           
 
Method Summary
 java.lang.String execute(AlertInterface aIface, ActionExecutionInfo info)
          Execute the action.
 ConfigResponse getConfigResponse()
          Get the configuration response for the action based on its properties
 ConfigSchema getConfigSchema()
          Get the configuration schema for the action
 java.lang.String getImplementor()
          Return the name of the class that implements the action
 void init(ConfigResponse config)
          Initialize the action instance
 void setImplementor(java.lang.String implementor)
          Allow implementor to be overwritten
 void setParentActionConfig(AppdefEntityID aeid, ConfigResponse config)
          Inherit configuration from parent action
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MetricAlertAction

public MetricAlertAction()
Method Detail

execute

public java.lang.String execute(AlertInterface aIface,
                                ActionExecutionInfo info)
                         throws ActionExecuteException
Description copied from interface: ActionInterface
Execute the action.

Specified by:
execute in interface ActionInterface
Returns:
text which will be associated with the action execution logs. AlertActionLog
Throws:
ActionExecuteException

getConfigSchema

public ConfigSchema getConfigSchema()
Description copied from interface: ActionConfigInterface
Get the configuration schema for the action

Specified by:
getConfigSchema in interface ActionConfigInterface
Returns:
a config schema

getConfigResponse

public ConfigResponse getConfigResponse()
                                 throws InvalidOptionException,
                                        InvalidOptionValueException
Description copied from interface: ActionConfigInterface
Get the configuration response for the action based on its properties

Specified by:
getConfigResponse in interface ActionConfigInterface
Returns:
a config schema
Throws:
InvalidOptionException
InvalidOptionValueException

init

public void init(ConfigResponse config)
Description copied from interface: ActionConfigInterface
Initialize the action instance

Specified by:
init in interface ActionConfigInterface
Parameters:
config - configuration properties

getImplementor

public java.lang.String getImplementor()
Description copied from interface: ActionConfigInterface
Return the name of the class that implements the action

Specified by:
getImplementor in interface ActionConfigInterface
Returns:
the Action classname

setImplementor

public void setImplementor(java.lang.String implementor)
Description copied from interface: ActionConfigInterface
Allow implementor to be overwritten

Specified by:
setImplementor in interface ActionConfigInterface

setParentActionConfig

public void setParentActionConfig(AppdefEntityID aeid,
                                  ConfigResponse config)
Description copied from interface: ActionInterface
Inherit configuration from parent action

Specified by:
setParentActionConfig in interface ActionInterface

Hyperic HQ Plugin API v. 4.4.0.2

Copyright © 2004-2006 Hyperic, Inc. support@hyperic.net, All Rights Reserved.