xmlBlaster 2.2.0 client API

org.xmlBlaster.util.cluster
Class RouteInfo

java.lang.Object
  extended by org.xmlBlaster.util.cluster.RouteInfo
All Implemented Interfaces:
java.io.Serializable

public final class RouteInfo
extends java.lang.Object
implements java.io.Serializable

This class holds the information about a route node which the message passed.

Author:
xmlBlaster@marcelruff.info
See Also:
Serialized Form

Field Summary
static boolean DEFAULT_dirtyRead
           
 
Constructor Summary
RouteInfo(NodeId nodeId, int stratum, Timestamp timestamp)
           
 
Method Summary
 boolean getDirtyRead()
           
 java.lang.String getId()
          The unique node name of the xmlBlaster instance.
 NodeId getNodeId()
          The unique node name of the xmlBlaster instance.
 int getStratum()
          The distance from the current xmlBlaster node from the master node (for this message).
 Timestamp getTimestamp()
          Message receive timestamp in nano seconds
 void setDirtyRead(boolean dirtyRead)
           
 void setNodeId(NodeId nodeId)
          The unique node name of the xmlBlaster instance.
 void setStratum(int stratum)
          The distance from the current xmlBlaster node from the master node (for this message).
 void setTimestamp(Timestamp timestamp)
          Message receive timestamp in nano seconds
 java.lang.String toXml()
          Dump state of this object into a XML ASCII string.
 java.lang.String toXml(java.lang.String extraOffset)
          Dump state of this object into a XML ASCII string.
 java.lang.String toXml(java.lang.String extraOffset, boolean forceReadable)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_dirtyRead

public static final boolean DEFAULT_dirtyRead
See Also:
Constant Field Values
Constructor Detail

RouteInfo

public RouteInfo(NodeId nodeId,
                 int stratum,
                 Timestamp timestamp)
Parameters:
nodeId - The unique name of the xmlBlaster instance
stratum - The distance from the node to the master node, if you don't know it set it to 0.
timestamp - The receive timestamp of the message (nano seconds)
Method Detail

setNodeId

public void setNodeId(NodeId nodeId)
The unique node name of the xmlBlaster instance.


getNodeId

public NodeId getNodeId()
The unique node name of the xmlBlaster instance.


getId

public java.lang.String getId()
The unique node name of the xmlBlaster instance.

Parameters:
The - string representation of my name

setStratum

public void setStratum(int stratum)
The distance from the current xmlBlaster node from the master node (for this message).


getStratum

public int getStratum()
The distance from the current xmlBlaster node from the master node (for this message).


setTimestamp

public void setTimestamp(Timestamp timestamp)
Message receive timestamp in nano seconds


getTimestamp

public Timestamp getTimestamp()
Message receive timestamp in nano seconds


setDirtyRead

public final void setDirtyRead(boolean dirtyRead)
Parameters:
dirtyRead - true if cluster slaves cache forwarded publish messages
See Also:
The cluster.dirtyRead requirement

getDirtyRead

public final boolean getDirtyRead()

toXml

public final java.lang.String toXml()
Dump state of this object into a XML ASCII string.


toXml

public final java.lang.String toXml(java.lang.String extraOffset)
Dump state of this object into a XML ASCII string.

Parameters:
extraOffset - indenting of tags for nice output

toXml

public final java.lang.String toXml(java.lang.String extraOffset,
                                    boolean forceReadable)

xmlBlaster 2.2.0 client API

Copyright © 1999-2014 The xmlBlaster.org contributers.