|
xmlBlaster 2.2.0 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface I_XmlBlasterConnection
This is the client interface to xmlBlaster.
All protocol drivers are accessed through these methods. We need it to decouple the protocol specific stuff (like RemoteException from RMI or CORBA exceptions) from our java client code. Note that you don't need this code, you can access xmlBlaster with your own lowlevel RMI or CORBA coding as well. If you are interested in a failsafe client connection, consider using XmlBlasterAccess.java which implements some nice features.The plugins which implement this interface do NOT need to be thread safe.
XmlBlasterAccess
Method Summary | |
---|---|
java.lang.String |
connect(java.lang.String connectQos)
Login and authenticate, the authentication schema is transported in the qos. |
void |
connectLowlevel(Address address)
Initialize the driver and verify if the remote side is reachable on the low-level protocol layer. |
boolean |
disconnect(java.lang.String disconnectQos)
Logout from xmlBlaster. |
java.lang.String[] |
erase(java.lang.String xmlKey,
java.lang.String qos)
|
MsgUnitRaw[] |
get(java.lang.String xmlKey,
java.lang.String qos)
|
java.lang.String |
getProtocol()
|
boolean |
isLoggedIn()
|
java.lang.String |
ping(java.lang.String qos)
Ping the server on physical level and/or application level (see AvailabilityChecker). |
java.lang.String |
publish(MsgUnitRaw msgUnit)
|
java.lang.String[] |
publishArr(MsgUnitRaw[] msgUnitArr)
|
void |
publishOneway(MsgUnitRaw[] msgUnitArr)
|
I_ProgressListener |
registerProgressListener(I_ProgressListener listener)
Register a listener for to receive information about the progress of incoming data. |
void |
resetConnection()
Reset the driver on problems. |
void |
setConnectReturnQos(ConnectReturnQos connectReturnQos)
Pass the driver the decrypted and parsed ConnectReturnQos directly after a connect. |
void |
shutdown()
Cleans up the resource. |
java.lang.String |
subscribe(java.lang.String xmlKey,
java.lang.String qos)
|
java.lang.String[] |
unSubscribe(java.lang.String xmlKey,
java.lang.String qos)
|
Methods inherited from interface org.xmlBlaster.util.plugin.I_Plugin |
---|
getType, getVersion, init |
Method Detail |
---|
void connectLowlevel(Address address) throws XmlBlasterException
address
- Contains the remote address,
e.g. the host and port where the remote server listens
XmlBlasterException
- ErrorCode.COMMUNICATION* if the server is not reachable,
in this case we can poll for the server.java.lang.String connect(java.lang.String connectQos) throws XmlBlasterException
connectQos
- The authentication and other informations (ConnectQos encrypted)
XmlBlasterException
void setConnectReturnQos(ConnectReturnQos connectReturnQos) throws XmlBlasterException
XmlBlasterException
boolean disconnect(java.lang.String disconnectQos) throws XmlBlasterException
disconnectQos
- The QoS or null
XmlBlasterException
java.lang.String getProtocol()
void shutdown() throws XmlBlasterException
I_Plugin
shutdown
in interface I_Plugin
XmlBlasterException
- if an exception occurs. The exception is
handled by the RunLevelManager depending on how the plugin has been
configured with the action:
<action do='STOP' onShutdownRunlevel='2' sequence='5'
onFail='resource.configuration.pluginFailed'>
If onFail is defined to something, the RunLevelManager will stop.void resetConnection()
boolean isLoggedIn()
java.lang.String ping(java.lang.String qos) throws XmlBlasterException
XmlBlasterException
java.lang.String subscribe(java.lang.String xmlKey, java.lang.String qos) throws XmlBlasterException
XmlBlasterException
MsgUnitRaw[] get(java.lang.String xmlKey, java.lang.String qos) throws XmlBlasterException
XmlBlasterException
java.lang.String[] unSubscribe(java.lang.String xmlKey, java.lang.String qos) throws XmlBlasterException
XmlBlasterException
java.lang.String publish(MsgUnitRaw msgUnit) throws XmlBlasterException
The
- msgUnit which is encrypted if a security plugin is activated
XmlBlasterException
void publishOneway(MsgUnitRaw[] msgUnitArr) throws XmlBlasterException
XmlBlasterException
java.lang.String[] publishArr(MsgUnitRaw[] msgUnitArr) throws XmlBlasterException
XmlBlasterException
java.lang.String[] erase(java.lang.String xmlKey, java.lang.String qos) throws XmlBlasterException
XmlBlasterException
I_ProgressListener registerProgressListener(I_ProgressListener listener)
listener
- Your listener, pass 0 to unregister.
|
xmlBlaster 2.2.0 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |