org.rhq.core.clientapi.agent.ping

Interface PingAgentService

public interface PingAgentService

The sole purpose of this interface is to check whether the agent is reachable and servicing requests. It differs from AgentClient.ping() which tests only for comm-layer connectivity but not that the agent is initialized and servicing requests. In general this can be used to surround services with potentially long runtimes. For example:

    if ( agentClient.getPingAgentService(2000L).ping() ) {
        agentClient.getDiscoveryAgentService().uninventoryResource(resourceId);
    }
 

Author:

Jay Shaughnessy

Method Summary

Methods

Modifier and Type	Method and Description
long	ping() This service simply returns immediately and can be used to check whether the agent is reachable and servicing requests.

Method Detail

ping

long ping()
          throws Exception

This service simply returns immediately and can be used to check whether the agent is reachable and servicing requests.

Returns:

the system time on the agent (in ms)

Throws:

Exception - if somehow the ping failed