xmlBlaster 2.1.0 API

org.xmlBlaster.j2ee.k2.client
Interface BlasterConnection

All Known Implementing Classes:
BlasterConnectionImpl

public interface BlasterConnection

K2 Connection interface for xmlBlaster.

Only a subset of I_XmlBlasterAccess. Be aware that this is a connection interface whose underlying physical pipe typically is pooled.


Method Summary
 void close()
          Close the connection.
 EraseReturnQos[] erase(java.lang.String xmlKey, java.lang.String qos)
          Erase message(s), I think
 MsgUnit[] get(java.lang.String xmlKey, java.lang.String qos)
          Fetch a message from server
 Global getGlobal()
          The the preconfigured global of the connection, good to have to be able to create Qos and keys for example.
 PublishReturnQos publish(MsgUnit msgUnit)
          Publish one message
 PublishReturnQos[] publishArr(MsgUnit[] msgUnitArr)
          Publish one or more message
 

Method Detail

getGlobal

Global getGlobal()
                 throws XmlBlasterException
The the preconfigured global of the connection, good to have to be able to create Qos and keys for example. Ought to be readonly!.

Throws:
XmlBlasterException

get

MsgUnit[] get(java.lang.String xmlKey,
              java.lang.String qos)
              throws XmlBlasterException
Fetch a message from server

Throws:
XmlBlasterException

publish

PublishReturnQos publish(MsgUnit msgUnit)
                         throws XmlBlasterException
Publish one message

Throws:
XmlBlasterException

publishArr

PublishReturnQos[] publishArr(MsgUnit[] msgUnitArr)
                              throws XmlBlasterException
Publish one or more message

Throws:
XmlBlasterException

erase

EraseReturnQos[] erase(java.lang.String xmlKey,
                       java.lang.String qos)
                       throws XmlBlasterException
Erase message(s), I think

Throws:
XmlBlasterException

close

void close()
           throws XmlBlasterException
Close the connection. After this the client may not use the connection again, but should get a new from the ConnectionFactory.

Throws:
XmlBlasterException

xmlBlaster 2.1.0 API

Copyright © 1999-2011 The xmlBlaster.org contributers.