xmlBlaster 2.1.0 API

org.xmlBlaster.client.qos
Class GetQos

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

public final class GetQos
extends java.lang.Object

This class encapsulates the QoS (quality of service) of a get() request.

A full specified get qos could look like this:

<qos>
   <meta>false</meta>       <!-- Don't return me the xmlKey meta data -->
   <content>false</content> <!-- Don't return me the content data (notify only) -->
   <filter type='myPlugin' version='1.0'>a!=100</filter>
                                  <!-- MIME access filters plugin -->
   <history numEntries='20'/>  <!-- Default is to deliver the current entry (numEntries='1'), '-1' deliver all -->
</qos>
 

see xmlBlaster/src/dtd/XmlQoS.xml

See Also:
QueryQosData, QueryQosSaxFactory, get interface, MIME access filter requirement

Field Summary
private  Global glob
           
private  java.lang.String ME
           
private  QueryQosData queryQosData
           
 
Constructor Summary
GetQos(Global glob)
          Constructor for default qos (quality of service).
GetQos(Global glob, QueryQosData queryQosData)
          Constructor for internal use.
 
Method Summary
 void addAccessFilter(AccessFilterQos filter)
          Adds your supplied get filter.
 void addClientProperty(java.lang.String key, java.lang.Object value)
          Sets a client property (an application specific property) to the given value
 void addQuerySpec(QuerySpecQos querySpec)
          Adds your supplied get querySpec.
 ClientProperty getClientProperty(java.lang.String key)
          Read back a property.
 QueryQosData getData()
          Access the wrapped data holder
static void main(java.lang.String[] args)
          For testing: java org.xmlBlaster.client.qos.GetQos
 void setHistoryQos(HistoryQos historyQos)
          Query historical messages.
 void setWantContent(boolean content)
          If false, the update contains not the content (it is a notify of change only)

This may be useful if you have huge contents, and you only want to be informed about a change TODO: Implement in server!!!

 java.lang.String toString()
          Converts the data into a valid XML ASCII string.
 java.lang.String toXml()
           
 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
 

Field Detail

ME

private java.lang.String ME

glob

private final Global glob

queryQosData

private final QueryQosData queryQosData
Constructor Detail

GetQos

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


GetQos

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


setWantContent

public void setWantContent(boolean content)
If false, the update contains not the content (it is a notify of change only)

This may be useful if you have huge contents, and you only want to be informed about a change TODO: Implement in server!!!


addAccessFilter

public void addAccessFilter(AccessFilterQos filter)
Adds your supplied get filter. The access filter plugin requirement


addQuerySpec

public void addQuerySpec(QuerySpecQos querySpec)
Adds your supplied get querySpec. The query plugin requirement


setHistoryQos

public void setHistoryQos(HistoryQos historyQos)
Query historical messages.


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()

toXml

public java.lang.String toXml(java.util.Properties props)
Converts the data into a valid XML ASCII string.

Parameters:
props - Formatting control, see Constants.TOXML_*
Returns:
An XML ASCII string

main

public static void main(java.lang.String[] args)
For testing: java org.xmlBlaster.client.qos.GetQos


xmlBlaster 2.1.0 API

Copyright © 1999-2011 The xmlBlaster.org contributers.