|
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.SaxHandlerBase org.xmlBlaster.util.XmlQoSBase org.xmlBlaster.util.qos.ConnectQosSaxFactory
public final class ConnectQosSaxFactory
This class encapsulates the qos of a login() or connect().
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> <securityService type="htpasswd" version="1.0"> <![CDATA[ <user>joe</user> <passwd>secret</passwd> ]]> </securityService> <session name='/node/heron/client/joe' timeout='3600000' maxSessions='10' clearSessions='false' reconnectSameClientOnly='false'/> <ptp>true</ptp> <duplicateUpdates>true</duplicateUpdates> <!-- The client side queue (is ignored on server side): --> <queue relating='client' type='CACHE' version='1.0' maxEntries='1000' maxBytes='4000' onOverflow='exception'> <address type='IOR'> IOR:10000010033200000099000010.... </address> <queue> <!-- Configures the server side callback queue: --> <queue relating='callback' type='CACHE' version='1.0' maxEntries='1000' maxBytes='4000' onOverflow='deadMessage'> <callback type='IOR' sessionId='4e56890ghdFzj0'> IOR:10000010033200000099000010.... <burstMode collectTime='400' /> </callback> </queue> </qos>NOTE: As a user of the Java client helper classes (client.I_XmlBlasterAccess) you don't need to create the
<callback>element. This is generated automatically from I_XmlBlasterAccess when instantiating the callback driver. A typical connect return QoS could look like this (this is the acknowledge returned by the server to the client on successful connect):
<qos> <securityService type="htpasswd" version="1.0"> <![CDATA[ <user>joe</user> <passwd>secret</passwd> ]]> </securityService> <session name='/node/heron/client/joe/-9' timeout='3600000' maxSessions='10' clearSessions='false' clearSessions='false' sessionId='sessionId:192.168.1.4-null-1042823803521-2074317763-3'/> <reconnected>false</reconnected> <!-- Has the client reconnected to an existing session? --> <!-- The server side callback queue: --> <queue relating='callback' type='CACHE' version='1.0' maxEntries='1000' maxBytes='4000' onOverflow='deadMessage'> <callback type='XMLRPC' bootstrapHostname='192.168.1.4' sessionId='4e56890ghdFzj0'> http://192.168.1.4:8081/ <burstMode collectTime='400' /> </callback> <queue> </qos>
org.xmlBlaster.test.classtest.ConnectQosTest
,
connect interfaceField Summary | |
---|---|
protected java.lang.String |
tmpSecurityPluginType
|
protected java.lang.String |
tmpSecurityPluginVersion
|
Fields inherited from class org.xmlBlaster.util.XmlQoSBase |
---|
clientProperty, clientPropertyTagNames, cpCharacter, inQos |
Fields inherited from class org.xmlBlaster.util.SaxHandlerBase |
---|
character, locator, xmlLiteral, xmlSource |
Constructor Summary | |
---|---|
ConnectQosSaxFactory(Global glob)
|
Method Summary | |
---|---|
void |
endElement(java.lang.String uri,
java.lang.String localName,
java.lang.String name)
End element, event from SAX parser. |
void |
endElement(java.lang.String uri,
java.lang.String localName,
java.lang.String name,
java.lang.StringBuffer character)
|
ConnectQosData |
getConnectQosData()
This is NOT thread safe so you need a new factory for each parse. |
java.lang.String |
getName()
A human readable name of this factory |
ConnectQosData |
readObject(java.lang.String xmlQos)
Parses the given xml Qos and returns a ConnectQosData holding the data. |
void |
setConnectQosData(ConnectQosData data)
If a delegate call startElement() directly |
void |
startElement(java.lang.String uri,
java.lang.String localName,
java.lang.String name,
org.xml.sax.Attributes attrs)
Start element, event from SAX parser. |
void |
startElement(java.lang.String uri,
java.lang.String localName,
java.lang.String name,
java.lang.StringBuffer character,
org.xml.sax.Attributes attrs)
Start element from SAX parsing, call as delegate delivers the character |
static java.lang.String |
toXml(java.lang.String rootTag,
ConnectQosData data,
java.lang.String extraOffset,
java.util.Properties props)
|
java.lang.String |
writeObject(ConnectQosData connectQosData,
java.lang.String extraOffset,
java.util.Properties props)
Dump state of this object into a XML ASCII string. |
Methods inherited from class org.xmlBlaster.util.XmlQoSBase |
---|
addTagToString, characters, characters, endElementBase, init, isEmpty, startElementBase |
Methods inherited from class org.xmlBlaster.util.SaxHandlerBase |
---|
comment, endCDATA, endDocument, endDTD, endEntity, endPrefixMapping, error, fatalError, getUseLexicalHandler, ignorableWhitespace, init, init, notationDecl, processingInstruction, setDocumentLocator, setUseLexicalHandler, skippedEntity, startCDATA, startDocument, startDTD, startEntity, startPrefixMapping, toString, toXml, unparsedEntityDecl, warning |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected java.lang.String tmpSecurityPluginType
protected java.lang.String tmpSecurityPluginVersion
Constructor Detail |
---|
public ConnectQosSaxFactory(Global glob)
Method Detail |
---|
public ConnectQosData readObject(java.lang.String xmlQos) throws XmlBlasterException
readObject
in interface I_ConnectQosFactory
the
- XML based ASCII string
XmlBlasterException
public ConnectQosData getConnectQosData()
public void setConnectQosData(ConnectQosData data)
public void startElement(java.lang.String uri, java.lang.String localName, java.lang.String name, org.xml.sax.Attributes attrs)
startElement
in interface org.xml.sax.ContentHandler
startElement
in class XmlQoSBase
name
- Tag nameattrs
- the attributes of the tagpublic void startElement(java.lang.String uri, java.lang.String localName, java.lang.String name, java.lang.StringBuffer character, org.xml.sax.Attributes attrs)
public void endElement(java.lang.String uri, java.lang.String localName, java.lang.String name) throws org.xml.sax.SAXException
endElement
in interface org.xml.sax.ContentHandler
endElement
in class XmlQoSBase
name
- Tag name
org.xml.sax.SAXException
public void endElement(java.lang.String uri, java.lang.String localName, java.lang.String name, java.lang.StringBuffer character) throws org.xml.sax.SAXException
org.xml.sax.SAXException
public java.lang.String writeObject(ConnectQosData connectQosData, java.lang.String extraOffset, java.util.Properties props)
writeObject
in interface I_ConnectQosFactory
extraOffset
- indenting of tags for nice outputconnectQosData
- The data object to serialize
public static final java.lang.String toXml(java.lang.String rootTag, ConnectQosData data, java.lang.String extraOffset, java.util.Properties props)
flag
- For example Constants.TOXML_FLAG_NOSECURITYpublic java.lang.String getName()
getName
in interface I_ConnectQosFactory
|
xmlBlaster 2.2.0 client API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |