org.xmlBlaster.client.qos
Class EraseQos

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

public final class EraseQos
extends java.lang.Object

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

A full specified erase qos could look like this:

<qos>
   <erase forceDestroy='false'/>
</qos>
 

see xmlBlaster/src/dtd/XmlQoS.xml

See Also:

QueryQosData, QueryQosSaxFactory, erase interface

Constructor Summary

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

EraseQos(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	setForceDestroy(boolean forceDestroy) Defaults to false: If a topic is still referenced by callback messages it will be not erased immediately but we wait until all pending messages are delivered.
void	setPersistent(boolean persistent) Mark the erase 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) Converts the data into a valid XML ASCII string.

Methods inherited from class java.lang.Object

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

Constructor Detail

EraseQos

public EraseQos(Global glob)

Constructor for default qos (quality of service).

EraseQos

public EraseQos(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

setForceDestroy

public void setForceDestroy(boolean forceDestroy)

Defaults to false: If a topic is still referenced by callback messages it will be not erased immediately but we wait until all pending messages are delivered.

See Also:

engine.message.lifecycle requirement

setPersistent

public void setPersistent(boolean persistent)

Mark the erase 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)

Converts the data into a valid XML ASCII string.

Returns:

An XML ASCII string