Hyperic HQ Plugin API v. 4.4.0.2

org.hyperic.hq.measurement.agent.client
Class LegacyMeasurementCommandsClientImpl

java.lang.Object
  extended by org.hyperic.hq.measurement.agent.client.LegacyMeasurementCommandsClientImpl
All Implemented Interfaces:
MeasurementCommandsClient

public class LegacyMeasurementCommandsClientImpl
extends java.lang.Object
implements MeasurementCommandsClient

The Measurement Commands client that uses the legacy transport.


Constructor Summary
LegacyMeasurementCommandsClientImpl(AgentConnection agentConn)
          Creates a new MeasurementCommandsClient object which should communicate through the passed connection object.
 
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

LegacyMeasurementCommandsClientImpl

public LegacyMeasurementCommandsClientImpl(AgentConnection agentConn)
Creates a new MeasurementCommandsClient object which should communicate through the passed connection object.

Parameters:
agentConn - Connection this object should use when sending commands.
Method Detail

closeConnection

public void closeConnection()
                     throws AgentRemoteException
Specified by:
closeConnection in interface MeasurementCommandsClient
Throws:
AgentRemoteException

scheduleMeasurements

public void scheduleMeasurements(ScheduleMeasurements_args args)
                          throws AgentRemoteException,
                                 AgentConnectionException
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
AgentConnectionException - indicating an error in communication with the agent.
See Also:
MeasurementCommandsClient.scheduleMeasurements(org.hyperic.hq.measurement.agent.commands.ScheduleMeasurements_args)

unscheduleMeasurements

public void unscheduleMeasurements(UnscheduleMeasurements_args args)
                            throws AgentRemoteException,
                                   AgentConnectionException
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.
AgentConnectionException - indicating an error in communication with the agent.
See Also:
MeasurementCommandsClient.unscheduleMeasurements(org.hyperic.hq.measurement.agent.commands.UnscheduleMeasurements_args)

getMeasurements

public GetMeasurements_result getMeasurements(GetMeasurements_args args)
                                       throws AgentRemoteException,
                                              AgentConnectionException
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
AgentConnectionException - indicating an error in communication with the agent.
See Also:
MeasurementCommandsClient.getMeasurements(org.hyperic.hq.measurement.agent.commands.GetMeasurements_args)

setProperties

public void setProperties(SetProperties_args args)
                   throws AgentRemoteException,
                          AgentConnectionException
Specified by:
setProperties in interface MeasurementCommandsClient
Throws:
AgentRemoteException
AgentConnectionException
See Also:
MeasurementCommandsClient.setProperties(org.hyperic.hq.measurement.agent.commands.SetProperties_args)

deleteProperties

public void deleteProperties(DeleteProperties_args args)
                      throws AgentRemoteException,
                             AgentConnectionException
Specified by:
deleteProperties in interface MeasurementCommandsClient
Throws:
AgentRemoteException
AgentConnectionException
See Also:
MeasurementCommandsClient.deleteProperties(org.hyperic.hq.measurement.agent.commands.DeleteProperties_args)

addTrackPlugin

public void addTrackPlugin(java.lang.String id,
                           java.lang.String pluginType,
                           java.lang.String resourceName,
                           ConfigResponse response)
                    throws AgentRemoteException,
                           AgentConnectionException
Specified by:
addTrackPlugin in interface MeasurementCommandsClient
Throws:
AgentRemoteException
AgentConnectionException
See Also:
MeasurementCommandsClient.addTrackPlugin(java.lang.String, java.lang.String, java.lang.String, org.hyperic.util.config.ConfigResponse)

removeTrackPlugin

public void removeTrackPlugin(java.lang.String id,
                              java.lang.String pluginType)
                       throws AgentRemoteException,
                              AgentConnectionException
Specified by:
removeTrackPlugin in interface MeasurementCommandsClient
Throws:
AgentRemoteException
AgentConnectionException
See Also:
MeasurementCommandsClient.removeTrackPlugin(java.lang.String, java.lang.String)

Hyperic HQ Plugin API v. 4.4.0.2

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