org.xmlBlaster.client.qos
Class UnSubscribeQos

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

public final class UnSubscribeQos
extends java.lang.Object

This class encapsulates the QoS of an unSubcribe() request.

A full specified unSubcribe qos could look like this:

<qos>
</qos>
 

see xmlBlaster/src/dtd/XmlQoS.xml

See Also:

QueryQosData, QueryQosSaxFactory, unSubscribe interface

Field Summary

private Global	glob
private java.lang.String	ME
private QueryQosData	queryQosData

Constructor Summary

UnSubscribeQos(Global glob)
Constructor for default qos (quality of service).

UnSubscribeQos(Global glob, QueryQosData queryQosData)
Constructor for internal use.

Method Summary

void	addClientProperty(java.lang.String key, java.lang.Object value) Sets a client property (an application specific property) to the given value
ClientProperty	getClientProperty(java.lang.String key) Read back a property.
QueryQosData	getData() Access the wrapped data holder
void	setPersistent(boolean persistent) Mark the unSubscribe request to be persistent.
java.lang.String	toString() Converts the data into a valid XML ASCII string.
java.lang.String	toXml() Converts the data into a valid XML ASCII string.
java.lang.String	toXml(java.util.Properties props)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ME

private java.lang.String ME

glob

private final Global glob

queryQosData

private final QueryQosData queryQosData

Constructor Detail

UnSubscribeQos

public UnSubscribeQos(Global glob)

Constructor for default qos (quality of service).

UnSubscribeQos

public UnSubscribeQos(Global glob,
                      QueryQosData queryQosData)

Constructor for internal use.

Parameters:

queryQosData - The struct holding the data

Method Detail

getData

public QueryQosData getData()

Access the wrapped data holder

setPersistent

public void setPersistent(boolean persistent)

Mark the unSubscribe request to be persistent.

NOTE: The request is only persistent in the client side queue if we are polling for xmlBlaster.

addClientProperty

public void addClientProperty(java.lang.String key,
                              java.lang.Object value)

Sets a client property (an application specific property) to the given value

Parameters:

key -

value -

getClientProperty

public ClientProperty getClientProperty(java.lang.String key)

Read back a property.

Returns:

The client property or null if not found

toString

public java.lang.String toString()

Converts the data into a valid XML ASCII string.

Overrides:

toString in class java.lang.Object

Returns:

An XML ASCII string

toXml

public java.lang.String toXml()

Converts the data into a valid XML ASCII string.

Returns:

An XML ASCII string

toXml

public java.lang.String toXml(java.util.Properties props)