org.xmlBlaster.client.qos
Class SubscribeReturnQos

java.lang.Object
  org.xmlBlaster.client.qos.SubscribeReturnQos

public final class SubscribeReturnQos
extends java.lang.Object

Handling the returned QoS (quality of service) of a subscribe() call.

If you are a Java client and use the I_XmlBlasterAccess interface you get this object as the subscribe() return value.

Example:

   <qos>
     <state id='OK' info='QUEUED[bilbo]'/>
     <subscribe id='_subId:1/>
  </qos>
 

See Also:

StatusQosFactoryTest, the interface.subscribe requirement

Field Summary

private boolean	isFakedReturn
private StatusQosData	statusQosData

Constructor Summary

SubscribeReturnQos(Global glob, StatusQosData statusQosData)
Constructor which reuses a StatusQosData object.

SubscribeReturnQos(Global glob, StatusQosData statusQosData, boolean isFakedReturn)
Constructor which reuses a StatusQosData object.

SubscribeReturnQos(Global glob, java.lang.String xmlQos)
Constructor which parses XML string.

SubscribeReturnQos(Global glob, java.lang.String xmlQos, boolean isFakedReturn)
Constructor which parses XML string.

Method Summary

StatusQosData	getData() Access the raw data object, usually you shouldn't do it.
java.lang.String	getState() Access the state of message.
java.lang.String	getStateInfo() Additional structured information about a state.
java.lang.String	getSubscriptionId() Get the identifier (unique handle) for this subscription.
boolean	isFakedReturn() Check if the subscription is queued on client side.
java.lang.String	toString()
java.lang.String	toXml()
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

statusQosData

private final StatusQosData statusQosData

isFakedReturn

private final boolean isFakedReturn

Constructor Detail

SubscribeReturnQos

public SubscribeReturnQos(Global glob,
                          java.lang.String xmlQos)
                   throws XmlBlasterException

Constructor which parses XML string. Use this for real returns from a server (-> isFakedReturn=false).

Throws:

XmlBlasterException

SubscribeReturnQos

public SubscribeReturnQos(Global glob,
                          java.lang.String xmlQos,
                          boolean isFakedReturn)
                   throws XmlBlasterException

Constructor which parses XML string.

Parameters:

isFakedReturn - true if the return value is faked from the client (on missing server connection)

Throws:

XmlBlasterException

SubscribeReturnQos

public SubscribeReturnQos(Global glob,
                          StatusQosData statusQosData)

Constructor which reuses a StatusQosData object.

SubscribeReturnQos

public SubscribeReturnQos(Global glob,
                          StatusQosData statusQosData,
                          boolean isFakedReturn)

Constructor which reuses a StatusQosData object.

Parameters:

isFakedReturn - true if the return value is faked from the client (on missing server connection)

Method Detail

getData

public StatusQosData getData()

Access the raw data object, usually you shouldn't do it.

Returns:

The raw data object

isFakedReturn

public boolean isFakedReturn()

Check if the subscription is queued on client side.

This happens if the connection is polling.

The getStateInfo() is set to "QUEUED..." in such a case

Returns:

true if the subscribe return value is faked from the client library (on missing server connection)

getState

public final java.lang.String getState()

Access the state of message.

Returns:

OK (Other values are not yet supported)

getStateInfo

public final java.lang.String getStateInfo()

Additional structured information about a state.

Returns:

"QUEUED" or "QUEUED[bilbo]"

See Also:

Constants

getSubscriptionId

public final java.lang.String getSubscriptionId()

Get the identifier (unique handle) for this subscription.

toXml

public final java.lang.String toXml()

See Also:

toXml(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 XML representation

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object