MeasurementCommandsService (Hyperic HQ Plugin API)
Keywords: org.hyperic.hq.measurement.agent.server.MeasurementCommandsService 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.measurement.agent.server
Class MeasurementCommandsService

    java.lang.Object
      org.hyperic.hq.measurement.agent.server.MeasurementCommandsService

All Implemented Interfaces:
  MeasurementCommandsClient

    public class MeasurementCommandsService

extends java.lang.Object
implements MeasurementCommandsClient

The Measurement Commands service.

Constructor Summary
`MeasurementCommandsService(AgentStorageProvider storage, java.util.Map validProps, org.hyperic.hq.measurement.agent.server.MeasurementSchedule schedStorage, MeasurementPluginManager pluginManager, LogTrackPluginManager ltPluginManager, ConfigTrackPluginManager ctPluginManager, ScheduleThread scheduleObject)`

Method Summary
`void` | `addTrackPlugin(java.lang.String id, java.lang.String pluginType, java.lang.String resourceName, ConfigResponse response)`
`void` | `closeConnection()`
`void` | `deleteProperties(DeleteProperties_args args)`
`GetMeasurements_result` | `getMeasurements(GetMeasurements_args args)` Get real time measurements from the Agent.
`void` | `removeTrackPlugin(java.lang.String id, java.lang.String pluginType)`
`void` | `scheduleMeasurements(ScheduleMeasurements_args args)` Schedule a group of measurements on the agent.
`void` | `setProperties(SetProperties_args args)`
`void` | `unscheduleMeasurements(UnscheduleMeasurements_args args)` Unschedule a group of previously scheduled measurements.

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

Constructor Detail

### MeasurementCommandsService

    public MeasurementCommandsService(AgentStorageProvider storage,
                                      java.util.Map validProps,
                                      org.hyperic.hq.measurement.agent.server.MeasurementSchedule schedStorage,
                                      MeasurementPluginManager pluginManager,
                                      LogTrackPluginManager ltPluginManager,
                                      ConfigTrackPluginManager ctPluginManager,
                                      ScheduleThread scheduleObject)

Method Detail

### addTrackPlugin

    public void addTrackPlugin(java.lang.String id,
                               java.lang.String pluginType,
                               java.lang.String resourceName,
                               ConfigResponse response)
                        throws AgentRemoteException

  Specified by:
    `addTrackPlugin` in interface `MeasurementCommandsClient`
  Throws:
    `AgentRemoteException`
  See Also:
    `MeasurementCommandsClient.addTrackPlugin(java.lang.String, java.lang.String, java.lang.String, org.hyperic.util.config.ConfigResponse)`

### deleteProperties

    public void deleteProperties(DeleteProperties_args args)
                          throws AgentRemoteException

  Specified by:
    `deleteProperties` in interface `MeasurementCommandsClient`
  Throws:
    `AgentRemoteException`
  See Also:
    `MeasurementCommandsClient.deleteProperties(org.hyperic.hq.measurement.agent.commands.DeleteProperties_args)`

### getMeasurements

    public GetMeasurements_result getMeasurements(GetMeasurements_args args)
                                           throws AgentRemoteException

  Description copied from interface: `MeasurementCommandsClient`
  Get real time measurements from the Agent.

  Specified by:
    `getMeasurements` in interface `MeasurementCommandsClient`
  Parameters:
    `args` - The collection of arguments to send to the remote Agent.
  Throws:
    `AgentRemoteException` - indicating a protocol error
  See Also:
    `MeasurementCommandsClient.getMeasurements(org.hyperic.hq.measurement.agent.commands.GetMeasurements_args)`

### removeTrackPlugin

    public void removeTrackPlugin(java.lang.String id,
                                  java.lang.String pluginType)
                           throws AgentRemoteException

  Specified by:
    `removeTrackPlugin` in interface `MeasurementCommandsClient`
  Throws:
    `AgentRemoteException`
  See Also:
    `MeasurementCommandsClient.removeTrackPlugin(java.lang.String, java.lang.String)`

### scheduleMeasurements

    public void scheduleMeasurements(ScheduleMeasurements_args args)
                              throws AgentRemoteException

  Description copied from interface: `MeasurementCommandsClient`
  Schedule a group of measurements on the agent. This routine cannot fail for the inability to schedule any individual measurements. The only errors which can occur are protocol or connection errors.

  Specified by:
    `scheduleMeasurements` in interface `MeasurementCommandsClient`
  Parameters:
    `args` - The collection of arguments to send to the remote Agent.
  Throws:
    `AgentRemoteException` - indicating a protocol error
  See Also:
    `MeasurementCommandsClient.scheduleMeasurements(org.hyperic.hq.measurement.agent.commands.ScheduleMeasurements_args)`

### setProperties

    public void setProperties(SetProperties_args args)
                       throws AgentRemoteException

  Specified by:
    `setProperties` in interface `MeasurementCommandsClient`
  Throws:
    `AgentRemoteException`
  See Also:
    `MeasurementCommandsClient.setProperties(org.hyperic.hq.measurement.agent.commands.SetProperties_args)`

### unscheduleMeasurements

    public void unscheduleMeasurements(UnscheduleMeasurements_args args)
                                throws AgentRemoteException

  Description copied from interface: `MeasurementCommandsClient`
  Unschedule a group of previously scheduled measurements. An attempt will be made to unschedule all measurements passed, however, if one client ID is unable to be unscheduled, an exception will be thrown at the end of the operation. Therefore, it is safe to assume that all clientIDs passed will be unscheduled, regardless of the exception.

  Specified by:
    `unscheduleMeasurements` in interface `MeasurementCommandsClient`
  Parameters:
    `args` - The collection of arguments to send to the remote Agent.
  Throws:
    `AgentRemoteException` - indicating an error unscheduling or protocol problem.
  See Also:
    `MeasurementCommandsClient.unscheduleMeasurements(org.hyperic.hq.measurement.agent.commands.UnscheduleMeasurements_args)`

### closeConnection

    public void closeConnection()

  Specified by:
    `closeConnection` in interface `MeasurementCommandsClient`

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.