AgentClient (RHQ Enterprise Server JAR 4.13.0 API)

All Known Implementing Classes:

AgentClientImpl
```
public interface AgentClient
```
The client interface to an RHQ agent - used by the RHQ server to send commands to the various agent subsystems. If you want to know all the things the RHQ Server can command the RHQ agent to do, study this interface and the Agent Services it provides.

Method Summary

Methods
Modifier and Type	Method and Description
`org.rhq.core.domain.resource.Agent`	`getAgent()` Returns the agent domain object which provides the information about the agent.
`BundleAgentService`	`getBundleAgentService()`
`BundleAgentService`	`getBundleAgentService(Long timeout)`
`ConfigurationAgentService`	`getConfigurationAgentService()`
`ConfigurationAgentService`	`getConfigurationAgentService(Long timeout)`
`ContentAgentService`	`getContentAgentService()`
`ContentAgentService`	`getContentAgentService(Long timeout)`
`DiscoveryAgentService`	`getDiscoveryAgentService()`
`DiscoveryAgentService`	`getDiscoveryAgentService(Long timeout)`
`DriftAgentService`	`getDriftAgentService()`
`DriftAgentService`	`getDriftAgentService(Long timeout)`
`MeasurementAgentService`	`getMeasurementAgentService()`
`MeasurementAgentService`	`getMeasurementAgentService(Long timeout)`
`OperationAgentService`	`getOperationAgentService()`
`OperationAgentService`	`getOperationAgentService(Long timeout)`
`ResourceFactoryAgentService`	`getResourceFactoryAgentService()`
`ResourceFactoryAgentService`	`getResourceFactoryAgentService(Long timeout)`
`SupportAgentService`	`getSupportAgentService()`
`SupportAgentService`	`getSupportAgentService(Long timeout)`
`boolean`	`ping(long timeoutMillis)` Returns `true` if this client can communicate with the agent.
`boolean`	`pingService(long timeoutMillis)` Returns `true` if this client can communicate with the agent and the agent Services are available.
`void`	`startSending()` Puts this agent client in "sending mode" which enables this client to begin sending messages to the agent.
`void`	`stopSending()` Stops the agent client from sending messages.
`void`	`updatePlugins()` Makes the agent download the plugin updates from the server and make its plugin container use them.

- Method Detail
  - getAgent
```
org.rhq.core.domain.resource.Agent getAgent()
```
    Returns the agent domain object which provides the information about the agent.
    
    Returns:
    agent information
  - startSending
```
void startSending()
```
    Puts this agent client in "sending mode" which enables this client to begin sending messages to the agent. Calling this method will immediately begin sending messages that were flagged as guaranteed delivery and have yet to be successfully sent (that is, messages spooled will be flushed out to the agent).
  - stopSending
```
void stopSending()
```
    Stops the agent client from sending messages. Any messages sent asynchronously with guaranteed delivery will be spooled and sent the next time an agent client is started.
  - ping
```
boolean ping(long timeoutMillis)
```
    Returns true if this client can communicate with the agent. This *only* means a comm link can be established. It does not mean the Agent is ready to service requests. For that use pingService(long) This will return false if, for any reason, the agent cannot be pinged (which could mean the agent is down, or a network problem has occurred that prohibits the client from reaching the agent).
    
    Parameters:
    timeoutMillis - the amount of time, in milliseconds, the caller wants to wait before considering the agent down
    
    Returns:
    true if the agent can be pinged; false if this client cannot communicate with the agent for some reason
  - updatePlugins
```
void updatePlugins()
```
    Makes the agent download the plugin updates from the server and make its plugin container use them.
    
    Since:
    
    4.11
  - pingService
```
boolean pingService(long timeoutMillis)
```
    Returns true if this client can communicate with the agent and the agent Services are available. For a simple communication check see ping(long). This will return false if, for any reason, the agent cannot be pinged (which could mean the agent is down, or a network problem has occurred that prohibits the client from reaching the agent) or its Services are not yet available.
    
    Parameters:
    timeoutMillis - the amount of time, in milliseconds, the caller wants to wait before considering the agent Services unavailable.
    
    Returns:
    true if the agent Services can be pinged; false if this client cannot communicate with the agent or the agent is not yet servicing requests.
  - getBundleAgentService
```
BundleAgentService getBundleAgentService()
```
  - getBundleAgentService
```
BundleAgentService getBundleAgentService(Long timeout)
```
  - getContentAgentService
```
ContentAgentService getContentAgentService()
```
  - getContentAgentService
```
ContentAgentService getContentAgentService(Long timeout)
```
  - getResourceFactoryAgentService
```
ResourceFactoryAgentService getResourceFactoryAgentService()
```
  - getResourceFactoryAgentService
```
ResourceFactoryAgentService getResourceFactoryAgentService(Long timeout)
```
  - getDiscoveryAgentService
```
DiscoveryAgentService getDiscoveryAgentService()
```
  - getDiscoveryAgentService
```
DiscoveryAgentService getDiscoveryAgentService(Long timeout)
```
  - getMeasurementAgentService
```
MeasurementAgentService getMeasurementAgentService()
```
  - getMeasurementAgentService
```
MeasurementAgentService getMeasurementAgentService(Long timeout)
```
  - getOperationAgentService
```
OperationAgentService getOperationAgentService()
```
  - getOperationAgentService
```
OperationAgentService getOperationAgentService(Long timeout)
```
  - getConfigurationAgentService
```
ConfigurationAgentService getConfigurationAgentService()
```
  - getConfigurationAgentService
```
ConfigurationAgentService getConfigurationAgentService(Long timeout)
```
  - getSupportAgentService
```
SupportAgentService getSupportAgentService()
```
  - getSupportAgentService
```
SupportAgentService getSupportAgentService(Long timeout)
```
  - getDriftAgentService
```
DriftAgentService getDriftAgentService()
```
  - getDriftAgentService
```
DriftAgentService getDriftAgentService(Long timeout)
```

Interface AgentClient

Method Summary

Method Detail

getAgent

startSending

stopSending

ping

updatePlugins

pingService

getBundleAgentService

getBundleAgentService

getContentAgentService

getContentAgentService

getResourceFactoryAgentService

getResourceFactoryAgentService

getDiscoveryAgentService

getDiscoveryAgentService

getMeasurementAgentService

getMeasurementAgentService

getOperationAgentService

getOperationAgentService

getConfigurationAgentService

getConfigurationAgentService

getSupportAgentService

getSupportAgentService

getDriftAgentService

getDriftAgentService