xmlBlaster 2.1.0 API

org.xmlBlaster.engine.qos
Class SubscribeQosServer

java.lang.Object
  extended by org.xmlBlaster.engine.qos.SubscribeQosServer

public final class SubscribeQosServer
extends java.lang.Object

Handling of subscribe() quality of services in the server core.

This decorator hides the real qos data object and gives us a server specific view on it.

QoS Informations sent from the client to the server via the subscribe() method
They are needed to control xmlBlaster

For the xml representation see QueryQosSaxFactory.

Author:
xmlBlaster@marcelruff.info
See Also:
QueryQosData, QueryQosSaxFactory

Field Summary
private  boolean doInhibitInitialUpdates
           
private  Global glob
           
private  QueryQosData queryQosData
           
 
Constructor Summary
SubscribeQosServer(Global glob, QueryQosData queryQosData)
          Constructor which accepts a raw data struct.
SubscribeQosServer(Global glob, java.lang.String xmlQos)
          Constructs the specialized quality of service object for a subscribe() call.
 
Method Summary
 AccessFilterQos[] getAccessFilterArr()
          Return the subscribe filters or null if none is specified.
 QueryQosData getData()
          Access the internal data struct
 Global getGlobal()
           
 HistoryQos getHistoryQos()
          Query the message history
 boolean getMultiSubscribe()
          Are multiple subscribes allowed? Defaults to true.
 QuerySpecQos[] getQuerySpecArr()
          Return the get querySpecs or null if none is specified.
 java.lang.String getSubscriptionId()
          Get the identifier (unique handle) for this subscription.
 boolean getWantContent()
          If false, the update contains not the content (it is a notify of change only) TODO: Implement in server!!!
 boolean getWantInitialUpdate()
           
 boolean getWantLocal()
          false Inhibit the delivery of messages to myself if i have published it.
 boolean getWantMeta()
           
 boolean getWantNotify()
           
 boolean getWantUpdateOneway()
           
 void inhibitInitalUpdates(boolean doInhibit)
          Inhibits the initial updates even if the qosData.wantInitialUpdates has been set.
 boolean isRecoveredFromPersistenceStore()
           
 void setSubscriptionId(java.lang.String subscriptionId)
           
 java.lang.String toXml()
           
 java.lang.String toXml(java.lang.String extraOffset)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

queryQosData

private final QueryQosData queryQosData

doInhibitInitialUpdates

private boolean doInhibitInitialUpdates

glob

private final Global glob
Constructor Detail

SubscribeQosServer

public SubscribeQosServer(Global glob,
                          QueryQosData queryQosData)
Constructor which accepts a raw data struct.


SubscribeQosServer

public SubscribeQosServer(Global glob,
                          java.lang.String xmlQos)
                   throws XmlBlasterException
Constructs the specialized quality of service object for a subscribe() call.

Parameters:
the - XML based ASCII string
Throws:
XmlBlasterException
Method Detail

getData

public QueryQosData getData()
Access the internal data struct


getGlobal

public Global getGlobal()

isRecoveredFromPersistenceStore

public boolean isRecoveredFromPersistenceStore()

getAccessFilterArr

public final AccessFilterQos[] getAccessFilterArr()
Return the subscribe filters or null if none is specified.


getQuerySpecArr

public final QuerySpecQos[] getQuerySpecArr()
Return the get querySpecs or null if none is specified.


getHistoryQos

public HistoryQos getHistoryQos()
Query the message history


getWantInitialUpdate

public boolean getWantInitialUpdate()

getWantUpdateOneway

public boolean getWantUpdateOneway()

getWantNotify

public boolean getWantNotify()

getMultiSubscribe

public boolean getMultiSubscribe()
Are multiple subscribes allowed? Defaults to true.

Returns:
true Multiple subscribes deliver multiple updates false Ignore more than one subscribes on same oid

getWantLocal

public boolean getWantLocal()
false Inhibit the delivery of messages to myself if i have published it.


getWantMeta

public boolean getWantMeta()
Returns:
false: Don't send me the meta information of a message key

getWantContent

public boolean getWantContent()
If false, the update contains not the content (it is a notify of change only) TODO: Implement in server!!!


setSubscriptionId

public final void setSubscriptionId(java.lang.String subscriptionId)

getSubscriptionId

public final java.lang.String getSubscriptionId()
Get the identifier (unique handle) for this subscription.

Returns:
the identifier force by the client, or null if xmlBlaster generates it

inhibitInitalUpdates

public void inhibitInitalUpdates(boolean doInhibit)
Inhibits the initial updates even if the qosData.wantInitialUpdates has been set.

Parameters:
doInhibit -

toXml

public java.lang.String toXml()

toXml

public java.lang.String toXml(java.lang.String extraOffset)

xmlBlaster 2.1.0 API

Copyright © 1999-2011 The xmlBlaster.org contributers.