org.rhq.core.clientapi.server.core

Class ConnectAgentResults

java.lang.Object

org.rhq.core.clientapi.server.core.ConnectAgentResults

All Implemented Interfaces:

Serializable

public class ConnectAgentResults
extends Object
implements Serializable

These are the results of a successful "agent connect".

Author:

John Mazzitelli

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConnectAgentResults(long serverTime, boolean isDown, AgentVersion latestAgentVersion)

Method Summary

Methods

Modifier and Type	Method and Description
AgentVersion	getLatestAgentVersion() Returns the latest agent version as known by the server returning this results object.
long	getServerTime() The current time as seen by the server clock.
boolean	isDown() If true, this indicates if the server thinks the agent is down.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ConnectAgentResults

public ConnectAgentResults(long serverTime,
                   boolean isDown,
                   AgentVersion latestAgentVersion)

Method Detail

getServerTime

public long getServerTime()

The current time as seen by the server clock. This is the time the agent connect was made and can also be used to determine if the agent's clock is in sync with the server.

Returns:

the server's clock, in epoch milliseconds

isDown

public boolean isDown()

If true, this indicates if the server thinks the agent is down. This happens if the agent hasn't connected in a long time and the server had "backfilled" the agent's resources as DOWN/UNKNOWN. When an agent connects to a server, and the server thinks that agent was down, the agent needs to prepare to notify the server of its state - for example, the agent should soon send up a full availability report so the server can get the up-to-date availability statuses of all resources.

Returns:

true if the server had this agent's resources marked as DOWN/UNKNOWN.

getLatestAgentVersion

public AgentVersion getLatestAgentVersion()

Returns the latest agent version as known by the server returning this results object. This agent version is that version of the agent update distribution that is served up by this server. This should represent the most up-to-date agent version available. This can be null if the latest agent version cannot be determined.

Returns:

the most up-to-date agent version known

toString

public String toString()

Overrides:

toString in class Object