|
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.client.qos.DisconnectQos
public class DisconnectQos
This class encapsulates the qos of a logout() or disconnect()
So you don't need to type the 'ugly' XML ASCII string by yourself. After construction access the ASCII-XML string with the toXml() method.<qos> <deleteSubjectQueue>true</deleteSubjectQueue> <clearSessions>false</clearSessions> </qos>The following properties are evaluated (command line or xmlBlaster.properties) and control the behaviour on client side:
dispatch/connection/shutdownDispatcher true/false dispatch/connection/shutdownCbServer true/false dispatch/connection/leaveServer true/falseAdditionally you can set these values as clientProperties, which have priority:
<qos> <clientProperty name='shutdownDispatcher'>true</clientProperty> <clientProperty name='shutdownCbServer'>true</clientProperty> <clientProperty name='leaveServer'>false</clientProperty> </qos>
org.xmlBlaster.test.classtest.DisconnectQosTest
Constructor Summary | |
---|---|
DisconnectQos()
Deprecated. |
|
DisconnectQos(Global glob)
|
|
DisconnectQos(Global glob,
DisconnectQosData disconnectQosData)
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. |
boolean |
clearClientQueue()
|
void |
clearClientQueue(boolean clearClientQueue)
If there are tail back messages in the client side queue, what to do with them. |
boolean |
clearSessions()
Return true if we shall kill all other sessions of this user on logout (defaults to false). |
void |
clearSessions(boolean del)
|
boolean |
deleteSubjectQueue()
Return true if subject queue shall be deleted with last user session |
void |
deleteSubjectQueue(boolean del)
If subject queue shall be deleted with last user session logout |
PropBoolean |
getClearClientQueueProp()
|
ClientProperty |
getClientProperty(java.lang.String key)
Read back a property. |
DisconnectQosData |
getData()
Access the wrapped data holder |
boolean |
isLeaveServer()
|
void |
setLeaveServer(boolean leaveServer)
Set this to true if you just want to cleanup the client library but not disconnect from the server. |
boolean |
shutdownCbServer()
|
void |
shutdownCbServer(boolean shutdownCbServer)
Shutdown the client side callback server on disconnect. |
boolean |
shutdownDispatcher()
|
void |
shutdownDispatcher(boolean shutdownDispatcher)
Shutdown the client side dispatcher framework on disconnect, which includes the low level connection like CORBA. |
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.lang.String extraOffset,
java.util.Properties props)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public DisconnectQos(Global glob)
public DisconnectQos(Global glob, DisconnectQosData disconnectQosData)
disconnectQosData
- The struct holding the datapublic DisconnectQos()
Method Detail |
---|
public DisconnectQosData getData()
public boolean deleteSubjectQueue()
public void deleteSubjectQueue(boolean del)
del
- defaults to truepublic boolean clearSessions()
public void clearSessions(boolean del)
true
- if we shall kill all other sessions of this user on logout (defaults to false).public void addClientProperty(java.lang.String key, java.lang.Object value)
Note that this is no multimap, later similar keys will overwrite the previous
key
- value
- public ClientProperty getClientProperty(java.lang.String key)
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String toXml()
public final java.lang.String toXml(java.lang.String extraOffset, java.util.Properties props)
public void clearClientQueue(boolean clearClientQueue)
Controls client side behavior.
clearClientQueue
- true Removes all entries of the client side tailback queue which is defaultpublic boolean clearClientQueue()
clearClientQueue(boolean)
public PropBoolean getClearClientQueueProp()
public void shutdownDispatcher(boolean shutdownDispatcher)
Controls client side behavior.
shutdownDispatcher
- true is defaultpublic boolean shutdownDispatcher()
public void shutdownCbServer(boolean shutdownCbServer)
Controls client side behavior.
shutdownCbServer
- true is defaultpublic boolean shutdownCbServer()
public boolean isLeaveServer()
public void setLeaveServer(boolean leaveServer)
leaveServer
- The leaveServer to set.
|
xmlBlaster 2.2.0 client API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |