xmlBlaster 2.1.0 API

org.xmlBlaster.util.qos.address
Class Destination

java.lang.Object
  extended by org.xmlBlaster.util.qos.address.Destination
All Implemented Interfaces:
java.io.Serializable

public class Destination
extends java.lang.Object
implements java.io.Serializable

Holding destination address attributes.

This class corresponds to the QOS destination tag

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

Field Summary
private  boolean DEFAULT_forceQueuing
          No queuing is default
private  SessionName destination
          The destination address (==login name) or the XPath query string
private  boolean forceQueuing
           
private static java.util.logging.Logger log
           
private  java.lang.String ME
           
private  java.lang.String queryType
          EXACT is default
private static long serialVersionUID
           
 
Constructor Summary
Destination()
          For SAX parser
Destination(Global glob, SessionName address)
          Constructs the specialized quality of service destination object.
Destination(SessionName address)
          Constructs the specialized quality of service destination object.
Destination(java.lang.String address, java.lang.String queryType)
          Constructs the specialized quality of service destination object.
 
Method Summary
 boolean forceQueuing()
           
 void forceQueuing(boolean forceQueuing)
          Set queuing of messages.
 SessionName getDestination()
           
 boolean isExactAddress()
           
 boolean isXPathQuery()
           
static void main(java.lang.String[] args)
          Only for testing java org.xmlBlaster.engine.Destination
 void setDestination(SessionName destination)
          Set the destination address or the destination query string.
 void setQueryType(java.lang.String queryType)
           
 java.lang.String toString()
           
 java.lang.String toXml()
          Get the XML ASCII representation of this object.
 java.lang.String toXml(java.lang.String extraOffset)
          Dump state of this object into a XML ASCII string.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

serialVersionUID

private static final long serialVersionUID
See Also:
Constant Field Values

log

private static java.util.logging.Logger log

ME

private java.lang.String ME

destination

private SessionName destination
The destination address (==login name) or the XPath query string


queryType

private java.lang.String queryType
EXACT is default


DEFAULT_forceQueuing

private boolean DEFAULT_forceQueuing
No queuing is default


forceQueuing

private boolean forceQueuing
Constructor Detail

Destination

public Destination()
For SAX parser


Destination

public Destination(SessionName address)
Constructs the specialized quality of service destination object.

Parameters:
address - The destination address (EXACT), this is typically the login name of another client

Destination

public Destination(Global glob,
                   SessionName address)
Constructs the specialized quality of service destination object.

Parameters:
address - The destination address (EXACT), this is typically the login name of another client

Destination

public Destination(java.lang.String address,
                   java.lang.String queryType)
Constructs the specialized quality of service destination object.

Parameters:
address - The destination address or query string
queryType - "EXACT" or "XPATH"
Method Detail

isXPathQuery

public boolean isXPathQuery()
Returns:
true/false

isExactAddress

public boolean isExactAddress()
Returns:
true/false

forceQueuing

public boolean forceQueuing()
Returns:
true/false

forceQueuing

public void forceQueuing(boolean forceQueuing)
Set queuing of messages.

true: If client is not logged in, messages will be queued until he comes.
false: Default is that on PtP messages when the destination address is not online, an Exception is thrown


setDestination

public final void setDestination(SessionName destination)
Set the destination address or the destination query string.

Parameters:
destination - The destination address or the query string, may not be null

getDestination

public final SessionName getDestination()
Parameters:
The - destination address or XPath query string

setQueryType

public final void setQueryType(java.lang.String queryType)
Parameters:
queryType - The query type, one of "EXACT" | "XPATH"
Throws:
java.lang.IllegalArgumentException - for unknown queryType

toString

public final java.lang.String toString()
Overrides:
toString in class java.lang.Object

toXml

public final java.lang.String toXml()
Get the XML ASCII representation of this object.

Returns:
The destination as 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
Returns:
The Destination as a XML ASCII string

main

public static void main(java.lang.String[] args)
Only for testing java org.xmlBlaster.engine.Destination


xmlBlaster 2.1.0 API

Copyright © 1999-2011 The xmlBlaster.org contributers.