OpenNMSAction (Hyperic HQ Plugin API)
Keywords: org.hyperic.hq.bizapp.server.action.integrate.OpenNMSAction class

Overview | Package | Class | Tree | Deprecated | Index | Help
| Hyperic HQ Plugin API v. 4.4.0.2
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.hyperic.hq.bizapp.server.action.integrate
Class OpenNMSAction

    java.lang.Object
      org.hyperic.hq.bizapp.server.action.integrate.OpenNMSAction

All Implemented Interfaces:
  ActionConfigInterface, ActionInterface

    public class OpenNMSAction

extends java.lang.Object
implements ActionInterface

Constructor Summary
`OpenNMSAction()`

Method Summary
`java.lang.String` | `execute(AlertInterface alert, 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
`java.lang.String` | `getIp()`
`java.lang.String` | `getPort()`
`java.lang.String` | `getServer()`
`void` | `init(ConfigResponse config)` Initialize the action instance
`static java.lang.Boolean` | `isLoaded()`
`void` | `setImplementor(java.lang.String implementor)` Allow implementor to be overwritten
`void` | `setIp(java.lang.String ip)`
`void` | `setParentActionConfig(AppdefEntityID aeid, ConfigResponse config)` Inherit configuration from parent action
`void` | `setPort(java.lang.String port)`
`void` | `setServer(java.lang.String server)`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### OpenNMSAction

    public OpenNMSAction()

Method Detail

### isLoaded

    public static java.lang.Boolean isLoaded()

### execute

    public java.lang.String execute(AlertInterface alert,
                                    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`

### setParentActionConfig

    public void setParentActionConfig(AppdefEntityID aeid,
                                      ConfigResponse config)
                               throws InvalidActionDataException

  Description copied from interface: `ActionInterface`
  Inherit configuration from parent action

  Specified by:
    `setParentActionConfig` in interface `ActionInterface`
  Throws:
    `InvalidActionDataException`

### 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`

### 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

### 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

### init

    public void init(ConfigResponse config)
              throws InvalidActionDataException

  Description copied from interface: `ActionConfigInterface`
  Initialize the action instance

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

### setImplementor

    public void setImplementor(java.lang.String implementor)

  Description copied from interface: `ActionConfigInterface`
  Allow implementor to be overwritten

  Specified by:
    `setImplementor` in interface `ActionConfigInterface`

### getServer

    public java.lang.String getServer()

### setServer

    public void setServer(java.lang.String server)

### getIp

    public java.lang.String getIp()

### setIp

    public void setIp(java.lang.String ip)

### getPort

    public java.lang.String getPort()

### setPort

    public void setPort(java.lang.String port)

Overview | Package | Class | Tree | Deprecated | Index | Help
| Hyperic HQ Plugin API v. 4.4.0.2
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

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