xmlBlaster 2.2.0 client API

org.xmlBlaster.client.qos
Class UnSubscribeReturnQos

java.lang.Object
  extended by org.xmlBlaster.client.qos.UnSubscribeReturnQos

public final class UnSubscribeReturnQos
extends java.lang.Object

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

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

Example:

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

See Also:
org.xmlBlaster.test.classtest.qos.StatusQosFactoryTest, the interface.unSubscribe requirement

Constructor Summary
UnSubscribeReturnQos(Global glob, StatusQosData statusQosData)
          Constructor which reuses a StatusQosData object.
UnSubscribeReturnQos(Global glob, java.lang.String xmlQos)
          Constructor which parses XML string.
 
Method Summary
 StatusQosData getData()
          Access the raw data object.
 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 subscription-identifier (unique handle) which was unsubscribed.
 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
 

Constructor Detail

UnSubscribeReturnQos

public UnSubscribeReturnQos(Global glob,
                            java.lang.String xmlQos)
                     throws XmlBlasterException
Constructor which parses XML string.

Throws:
XmlBlasterException

UnSubscribeReturnQos

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

Method Detail

getData

public StatusQosData getData()
Access the raw data object.


getState

public java.lang.String getState()
Access the state of message.

Returns:
OK (Other values are not yet supported)

getStateInfo

public java.lang.String getStateInfo()
Additional structured information about a state.

Returns:
"QUEUED" or "QUEUED[bilbo]"
See Also:
Constants

getSubscriptionId

public java.lang.String getSubscriptionId()
Get the subscription-identifier (unique handle) which was unsubscribed.


toXml

public java.lang.String toXml()
See Also:
toXml(String)

toXml

public 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 java.lang.String toString()
Overrides:
toString in class java.lang.Object

xmlBlaster 2.2.0 client API

Copyright © 1999-2014 The xmlBlaster.org contributers.