xmlBlaster 2.1.0 API

org.xmlBlaster.client.protocol
Interface I_CallbackExtended

All Superinterfaces:
I_Callback, I_CallbackRaw
All Known Implementing Classes:
AbstractCallbackExtended, TestCorbaThreads, XmlBlasterAccess, XmlScriptInterpreterTest.TestAccessor

public interface I_CallbackExtended
extends I_Callback, I_CallbackRaw

This is a little helper interface which which extends the I_Callback and I_CallbackRaw interface to become suited for protocols like xml-rpc.

The class implementing this interface needs to support the 3 update() variants, so that the protocol drivers can choose the update() they like most.

Version:
$Revision: 1.7 $
Author:
Michele Laghi

Method Summary
 void lostConnection(XmlBlasterException xmlBlasterException)
          For example called by socket layer on EOF
 java.lang.String update(java.lang.String cbSessionId, java.lang.String updateKeyLiteral, byte[] content, java.lang.String updateQosLiteral)
          This is the callback method invoked when using certain callback protocols (for example xml-rpc) which informs the client in an asynchronous mode about a new message.
 void updateOneway(java.lang.String cbSessionId, java.lang.String updateKeyLiteral, byte[] content, java.lang.String updateQosLiteral)
          The oneway variant without a return value or exception
 
Methods inherited from interface org.xmlBlaster.client.I_Callback
update
 
Methods inherited from interface org.xmlBlaster.client.I_CallbackRaw
update, updateOneway
 

Method Detail

update

java.lang.String update(java.lang.String cbSessionId,
                        java.lang.String updateKeyLiteral,
                        byte[] content,
                        java.lang.String updateQosLiteral)
                        throws XmlBlasterException
This is the callback method invoked when using certain callback protocols (for example xml-rpc) which informs the client in an asynchronous mode about a new message.

You can implement this interface in your client. Note that when doing so, you need to implement all update() methods defined (remember the one defined in I_Callback/I_CallbackRaw).

The implementation of the update method with the signature specified in this interface must parse the string literals passed in the argument list and call the other update method (the one with the signature defined in I_Callback).

Parameters:
cbSessionId - The session ID specified by the client which registered the callback
updateKeyLiteral - The arrived key (as an xml-string)
content - The arrived message content
updateQosLiteral - Quality of Service of the MsgUnitRaw (as an xml-string)
Throws:
XmlBlasterException
See Also:
I_Callback, AbstractCallbackExtended

updateOneway

void updateOneway(java.lang.String cbSessionId,
                  java.lang.String updateKeyLiteral,
                  byte[] content,
                  java.lang.String updateQosLiteral)
The oneway variant without a return value or exception


lostConnection

void lostConnection(XmlBlasterException xmlBlasterException)
For example called by socket layer on EOF

Parameters:
xmlBlasterException -

xmlBlaster 2.1.0 API

Copyright © 1999-2011 The xmlBlaster.org contributers.