|
xmlBlaster 2.2.0 client API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.xmlBlaster.util.qos.QosData org.xmlBlaster.util.qos.QueryQosData
public final class QueryQosData
Data container handling of query / access QoS.
This data holder is accessible through decorators, each of them allowing a specialized view on the data:
For the xml representation see QueryQosSaxFactory.
QueryQosSaxFactory
,
org.xmlBlaster.test.classtest.qos.QueryQosFactoryTest
,
Serialized FormField Summary |
---|
Fields inherited from class org.xmlBlaster.util.qos.QosData |
---|
DEFAULT_persistent, glob, rcvTimestamp, routeNodeList, routeNodes, serialData |
Constructor Summary | |
---|---|
QueryQosData(Global glob,
I_QueryQosFactory factory,
MethodName methodName)
Constructs the specialized quality of service object for query informations. |
|
QueryQosData(Global glob,
I_QueryQosFactory factory,
java.lang.String serialData,
MethodName methodName)
Constructs the specialized quality of service object for a publish() call. |
|
QueryQosData(Global glob,
MethodName methodName)
true if query has to be /** Constructs the specialized quality of service object for query informations. |
Method Summary | |
---|---|
void |
addAccessFilter(AccessFilterQos filter)
Adds your supplied subscribe filter |
void |
addQuerySpec(QuerySpecQos querySpec)
Adds the querySpec you supplied. |
java.lang.Object |
clone()
Returns a deep clone, you can change savely all basic or immutable types like boolean, String, int and also the ClientProperties and RouteInfo. |
boolean |
containsHistoryQos()
Was a history qos specified? |
java.lang.String |
generateSubscriptionId(SessionName sessionName,
QueryKeyData subscribeKey)
A client side subscriptionId must start with "__subId:" followed by the relative session name. |
AccessFilterQos[] |
getAccessFilterArr()
Return the subscribe filters or null if none is specified. |
java.util.ArrayList |
getAccessFilters()
|
PropBoolean |
getContentProp()
|
boolean |
getForceDestroy()
Defaults to false. |
PropBoolean |
getForceDestroyProp()
|
HistoryQos |
getHistoryQos()
Get the QoS which describes the history query settings. |
PropBoolean |
getInitialUpdateProp()
|
PropBoolean |
getLocalProp()
|
PropBoolean |
getMetaProp()
|
boolean |
getMultiSubscribe()
Allow to subscribe multiple times to the same query/oid |
PropBoolean |
getMultiSubscribeProp()
|
PropBoolean |
getNotifyProp()
|
QuerySpecQos[] |
getQuerySpecArr()
Return the subscribe filters or null if none is specified. |
java.util.ArrayList |
getQuerySpecs()
|
java.lang.String |
getSubscriptionId()
Get the identifier (unique handle) for this subscription. |
PropBoolean |
getUpdateOnewayProp()
|
boolean |
getWantContent()
Defaults to true. |
boolean |
getWantInitialUpdate()
Defaults to true. |
boolean |
getWantLocal()
Defaults to true. |
boolean |
getWantMeta()
Defaults to true. |
boolean |
getWantNotify()
For erase(): Notify the subscribers on erase? Defaults to true. |
boolean |
getWantUpdateOneway()
Defaults to true. |
boolean |
hasSubscriptionId()
|
boolean |
newestOnly()
if __newestOnly client property is true remove older instances from callback queue of client |
void |
setFilters(AccessFilterQos[] newFilters)
|
void |
setForceDestroy(boolean forceDestroy)
Topic erase behavior with pending messages, defaults to false. |
void |
setGlobal(Global glob)
Sets the global object (used when deserializing the object) |
void |
setHistoryQos(HistoryQos historyQos)
Set the QoS which describes the history query settings. |
void |
setMultiSubscribe(boolean multiSubscribe)
|
void |
setNewestOnly(boolean newestOnly)
|
void |
setSubscriptionId(java.lang.String subscriptionId)
Force the identifier (unique handle) for this subscription. |
void |
setWantContent(boolean content)
Defaults to true. |
void |
setWantInitialUpdate(boolean initialUpdate)
Do we want to have an initial update on subscribe if the message exists already? Defaults to true. |
void |
setWantLocal(boolean local)
Defaults to true. |
void |
setWantMeta(boolean meta)
Defaults to true. |
void |
setWantNotify(boolean notify)
Set to true if you want an erase notification if the topic is explicitly erased. |
void |
setWantUpdateOneway(boolean updateOneway)
Do we want the callback message delivered with update() or with updateOneway()? Defaults to false. |
java.lang.String |
toString()
|
java.lang.String |
toXml()
Dump state of this object into a XML ASCII string. |
java.lang.String |
toXml(java.lang.String extraOffset)
|
java.lang.String |
toXml(java.lang.String extraOffset,
java.util.Properties props)
Dump state of this object into a XML ASCII string. |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public QueryQosData(Global glob, MethodName methodName)
The
- factory which knows how to serialize and parse mepublic QueryQosData(Global glob, I_QueryQosFactory factory, MethodName methodName)
The
- factory which knows how to serialize and parse mepublic QueryQosData(Global glob, I_QueryQosFactory factory, java.lang.String serialData, MethodName methodName)
the
- XML based ASCII stringtrue
- Method Detail |
---|
public boolean getMultiSubscribe()
public PropBoolean getMultiSubscribeProp()
public void setMultiSubscribe(boolean multiSubscribe)
public void setWantInitialUpdate(boolean initialUpdate)
public boolean getWantInitialUpdate()
public PropBoolean getInitialUpdateProp()
public void setWantUpdateOneway(boolean updateOneway)
public boolean getWantUpdateOneway()
public PropBoolean getUpdateOnewayProp()
public boolean newestOnly()
public void setNewestOnly(boolean newestOnly)
public void setWantNotify(boolean notify)
notify
- Defaults to true.public boolean getWantNotify()
public PropBoolean getNotifyProp()
public void setWantLocal(boolean local)
setWantLocal
- false Inhibit the dispatch of messages to myself if i have published it.public boolean getWantLocal()
public PropBoolean getLocalProp()
public void setWantMeta(boolean meta)
meta
- false: Don't send me the meta information of a message keypublic boolean getWantMeta()
public PropBoolean getMetaProp()
public void setWantContent(boolean content)
public boolean getWantContent()
public PropBoolean getContentProp()
public void setForceDestroy(boolean forceDestroy)
forceDestroy
- public boolean getForceDestroy()
public PropBoolean getForceDestroyProp()
public void setFilters(AccessFilterQos[] newFilters)
public void addAccessFilter(AccessFilterQos filter)
public java.util.ArrayList getAccessFilters()
public AccessFilterQos[] getAccessFilterArr()
public void addQuerySpec(QuerySpecQos querySpec)
public java.util.ArrayList getQuerySpecs()
public QuerySpecQos[] getQuerySpecArr()
public void setHistoryQos(HistoryQos historyQos)
public HistoryQos getHistoryQos()
public boolean containsHistoryQos()
public java.lang.String getSubscriptionId()
public boolean hasSubscriptionId()
public void setSubscriptionId(java.lang.String subscriptionId)
public java.lang.String generateSubscriptionId(SessionName sessionName, QueryKeyData subscribeKey)
This us only useful for positive session Ids in fail save environments: if the subscription is queued the faked subscriptionId will be used later by the server
sessionName
- subscribeKey
-
public java.lang.String toXml()
toXml
in class QosData
public java.lang.String toXml(java.lang.String extraOffset)
public java.lang.String toXml(java.lang.String extraOffset, java.util.Properties props)
toXml
in class QosData
extraOffset
- indenting of tags for nice output
public java.lang.Object clone()
clone
in class QosData
public void setGlobal(Global glob)
setGlobal
in class QosData
public java.lang.String toString()
toString
in class java.lang.Object
|
xmlBlaster 2.2.0 client API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |