com.continuent.tungsten.common.network
Class PingNotification

java.lang.Object
  extended by com.continuent.tungsten.common.network.PingNotification

public class PingNotification
extends java.lang.Object

Contains status information from a single ping method invocation.

Author:
Robert Hodges

Constructor Summary
PingNotification()
           
 
Method Summary
 long getDuration()
          Returns actual ping duration in milliseconds.
 java.lang.Throwable getException()
          Returns an exception generated by the ping method, if any.
 java.lang.String getHostName()
          Returns the host for which this ping notification used.
 java.lang.String getMethodName()
          Returns the ping method used.
 java.lang.String getNotes()
          Returns a comment string generated by the ping method to provide audit tracking about what was done.
 long getTimeout()
          Returns the ping timeout in milliseconds.
 boolean isReachable()
          Returns true if the method determined the host was reachable.
 void setDuration(long duration)
           
 void setException(java.lang.Throwable exception)
           
 void setHostName(java.lang.String hostName)
           
 void setMethodName(java.lang.String methodName)
           
 void setNotes(java.lang.String notes)
           
 void setReachable(boolean reachable)
           
 void setTimeout(long timeout)
           
 java.lang.String toString()
          
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PingNotification

public PingNotification()
Method Detail

getHostName

public java.lang.String getHostName()
Returns the host for which this ping notification used.


setHostName

public void setHostName(java.lang.String hostName)

isReachable

public boolean isReachable()
Returns true if the method determined the host was reachable.


setReachable

public void setReachable(boolean reachable)

getMethodName

public java.lang.String getMethodName()
Returns the ping method used.


setMethodName

public void setMethodName(java.lang.String methodName)

getTimeout

public long getTimeout()
Returns the ping timeout in milliseconds.


setTimeout

public void setTimeout(long timeout)

getDuration

public long getDuration()
Returns actual ping duration in milliseconds.


setDuration

public void setDuration(long duration)

getNotes

public java.lang.String getNotes()
Returns a comment string generated by the ping method to provide audit tracking about what was done. These should be available regardless of whether there is an exception or not.


setNotes

public void setNotes(java.lang.String notes)

getException

public java.lang.Throwable getException()
Returns an exception generated by the ping method, if any. Exceptions are only generated if there is a failure of the ping method itself.


setException

public void setException(java.lang.Throwable exception)

toString

public java.lang.String toString()

Overrides:
toString in class java.lang.Object
See Also:
Object.toString()