|
xmlBlaster 2.2.0 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface I_XmlBlaster
This is the native interface to xmlBlaster.
All protocol drivers access xmlBlaster through these methods. This interface is implemented by engine/XmlBlasterImpl.java
RequestBroker
Method Summary | |
---|---|
java.lang.String[] |
erase(AddressServer addressServer,
java.lang.String sessionId,
java.lang.String xmlKey_literal,
java.lang.String eraseQoS_literal)
Delete messages. |
MsgUnitRaw[] |
get(AddressServer addressServer,
java.lang.String sessionId,
java.lang.String xmlKey_literal,
java.lang.String getQoS_literal)
Synchronous access a message. |
java.lang.String |
ping(AddressServer addressServer,
java.lang.String qos)
Ping to check if xmlBlaster is alive. |
java.lang.String |
publish(AddressServer addressServer,
java.lang.String sessionId,
MsgUnitRaw msgUnit)
Publish a message. |
java.lang.String[] |
publishArr(AddressServer addressServer,
java.lang.String sessionId,
MsgUnitRaw[] msgUnitArr)
Publish messages. |
void |
publishOneway(AddressServer addressServer,
java.lang.String sessionId,
MsgUnitRaw[] msgUnitArr)
Publish messages. |
java.lang.String |
subscribe(AddressServer addressServer,
java.lang.String sessionId,
java.lang.String xmlKey_literal,
java.lang.String subscribeQoS_literal)
Subscribe to messages. |
java.lang.String |
toXml()
|
java.lang.String |
toXml(java.lang.String extraOffset)
|
java.lang.String[] |
unSubscribe(AddressServer addressServer,
java.lang.String sessionId,
java.lang.String xmlKey_literal,
java.lang.String unSubscribeQos_literal)
Unsubscribe from messages. |
Method Detail |
---|
java.lang.String subscribe(AddressServer addressServer, java.lang.String sessionId, java.lang.String xmlKey_literal, java.lang.String subscribeQoS_literal) throws XmlBlasterException
xmlKey_literal
- Depending on the security plugin this key is encryptedsubscribeQoS_literal
- Depending on the security plugin this qos is encryptedisInternal
- true if the subscription is internal, i.e. from a recovery
XmlBlasterException
RequestBroker
,
The interface.subscribe requirementjava.lang.String[] unSubscribe(AddressServer addressServer, java.lang.String sessionId, java.lang.String xmlKey_literal, java.lang.String unSubscribeQos_literal) throws XmlBlasterException
xmlKey_literal
- Depending on the security plugin this key is encryptedunSubscribeQoS_literal
- Depending on the security plugin this qos is encrypted
XmlBlasterException
RequestBroker
java.lang.String publish(AddressServer addressServer, java.lang.String sessionId, MsgUnitRaw msgUnit) throws XmlBlasterException
msgUnit
- The MsgUnitRaw contains the literal ASCII strings of xmlKey and publishQos and the binary content.
Depending on the security plugin the msgUnit is encrypted
XmlBlasterException
RequestBroker
,
The interface.publish requirementjava.lang.String[] publishArr(AddressServer addressServer, java.lang.String sessionId, MsgUnitRaw[] msgUnitArr) throws XmlBlasterException
XmlBlasterException
RequestBroker
,
The interface.publish requirementvoid publishOneway(AddressServer addressServer, java.lang.String sessionId, MsgUnitRaw[] msgUnitArr)
RequestBroker
,
The interface.publish requirementjava.lang.String[] erase(AddressServer addressServer, java.lang.String sessionId, java.lang.String xmlKey_literal, java.lang.String eraseQoS_literal) throws XmlBlasterException
XmlBlasterException
RequestBroker
,
The interface.erase requirementMsgUnitRaw[] get(AddressServer addressServer, java.lang.String sessionId, java.lang.String xmlKey_literal, java.lang.String getQoS_literal) throws XmlBlasterException
XmlBlasterException
RequestBroker
,
The interface.get requirementjava.lang.String ping(AddressServer addressServer, java.lang.String qos) throws XmlBlasterException
qos
- Currently an empty string ""
<qos> <state id='OK'/> </qos>Other returned id's are "RUNLEVEL_CLEANUP", "RUNLEVEL_STANDBY", "RUNLEVEL_HALTED". All none "OK" values tell that the server is not willing to process messages.
XmlBlasterException
java.lang.String toXml() throws XmlBlasterException
XmlBlasterException
java.lang.String toXml(java.lang.String extraOffset) throws XmlBlasterException
XmlBlasterException
|
xmlBlaster 2.2.0 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |