org.hawkular.component.pinger

Class PingStatus

java.lang.Object

org.hawkular.component.pinger.PingStatus

public class PingStatus
extends Object

An outcome of a ping.

Author:

Heiko W. Rupp, Peter Palaga

Field Summary

Fields

Modifier and Type	Field and Description
static int	INVALID_DURATION A value for duration in case the ping ends up in some broken state where there is no meaningful duration.

Constructor Summary

Constructors

Constructor and Description
PingStatus(PingDestination destination, int code, long timestamp, int duration, Traits traits) Creates a new PingStatus with timedOut set to false.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static PingStatus	error(PingDestination destination, int code, long timestamp) Returns a new timeout PingStatus with the given PingDestination, HTTP response code.
int	getCode()
PingDestination	getDestination()
int	getDuration()
long	getTimestamp()
Traits	getTraits()
int	hashCode()
boolean	isTimedOut()
static PingStatus	timeout(PingDestination destination, long timestamp, int duration) Returns a new PingStatus with the given PingDestination, timestamp, duration and timedOut set to true.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

INVALID_DURATION

public static final int INVALID_DURATION

A value for duration in case the ping ends up in some broken state where there is no meaningful duration. The value is -1

See Also:

Constant Field Values

Constructor Detail

PingStatus

public PingStatus(PingDestination destination,
                  int code,
                  long timestamp,
                  int duration,
                  Traits traits)

Creates a new PingStatus with timedOut set to false.

Parameters:

destination - where the ping was sent

code - the HTTP response code

timestamp - the value of System.currentTimeMillis() when the response was received or when the timeout or other error was detected

duration - Ping round trip duration in milliseconds or -1 if the ping timed out

See Also:

timeout(PingDestination, long, int), error(PingDestination, int, long)

Method Detail

timeout

public static final PingStatus timeout(PingDestination destination,
                                       long timestamp,
                                       int duration)

Returns a new PingStatus with the given PingDestination, timestamp, duration and timedOut set to true.

Parameters:

destination - the destination where the ping was sent

timestamp - the value of System.currentTimeMillis() when the response was received or when the timeout or other error was detected

duration - the ping round trip duration in milliseconds or -1 if the ping timed out

Returns:

a new PingStatus

error

public static final PingStatus error(PingDestination destination,
                                     int code,
                                     long timestamp)

Returns a new timeout PingStatus with the given PingDestination, HTTP response code.

Parameters:

destination - the destination where the ping was sent

code - the HTTP status code of the ping response

Returns:

a new PingStatus

getCode

public int getCode()

Returns:

the HTTP status code of the ping response

getDuration

public int getDuration()

Returns:

ping round trip duration in milliseconds or -1 if the ping timed out

isTimedOut

public boolean isTimedOut()

Returns:

true if the ping timed out, false otherwise

getTimestamp

public long getTimestamp()

Returns:

the value of System.currentTimeMillis() when the response was received or when the timeout or other error was detected

getDestination

public PingDestination getDestination()

Returns:

the destination where the ping was sent

getTraits

public Traits getTraits()

Returns:

the Traits collected from the ping response

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object