protocol/corba/xmlBlaster.idl

Go to the documentation of this file.

/*------------------------------------------------------------------------------
Name:      xmlBlaster.idl
Project:   xmlBlaster.org
Task:      Server interface
Copyright: xmlBlaster.org, see xmlBlaster-LICENSE file
Comment:   String arguments should never be null, use "" instead
Compile:   JacORB Java 1.2:
              $JacORB_HOME/bin/idl -p org.xmlBlaster -d ${XMLBLASTER_HOME}/src/java xmlBlaster.idl
           VisiBroker (no JacORB should be in CLASSPATH) Java 1.2:
              ${VBROKER_PATH}/bin/idl2java -root_dir ${XMLBLASTER_HOME}/src/java xmlBlaster.idl
           MICO C++:
              $CORBACPP_HOME/bin/idl --poa --no-boa xmlBlaster.idl
           COPE Perl:
              idl2perl -imp xmlBlaster.idl
Author:    xmlBlaster@marcelruff.info
Version:   $Id: xmlBlaster.idl 15026 2006-04-10 16:56:35Z ruff $
------------------------------------------------------------------------------*/

#ifndef _xmlBlaster_IDL_
#define _xmlBlaster_IDL_


#pragma prefix "org.xmlBlaster.protocol.corba"


module serverIdl
{
//This ifdef works with jacorb, but is not added to build.xml for C++ idl compilers
//#ifdef XBL_IDL_WSTRING
      // Works fine with Javaclient    -> xmlBlaster
      // but failed with MicoC++Client -> xmlBlaster, the received ConnectQos wstring was empty, is not yet resolved
//   typedef wstring XmlType; 
//#else
   typedef string XmlType;
//#endif
   typedef sequence<XmlType> XmlTypeArr;

   typedef sequence<octet> ContentType;

   struct MessageUnit {
      XmlType xmlKey;
      ContentType content;
      XmlType qos;
   };
   typedef sequence<MessageUnit> MessageUnitArr;


   exception XmlBlasterException
   {
      string errorCodeStr;
      string node;
      string location;
      string lang;
      string message;
      string versionInfo;
      string timestampStr;
      string stackTrace;
      string embeddedMessage;
      string transactionInfo;
      string reserved;
      // TODO: boolean isServerSide;
   };

}; // org::xmlBlaster::protocol::corba::serverIdl




module clientIdl
{
   interface BlasterCallback
   {
     serverIdl::XmlTypeArr update(in string sessionId, in serverIdl::MessageUnitArr msgUnitArr)
                                raises(serverIdl::XmlBlasterException);

     oneway void updateOneway(in string sessionId, in serverIdl::MessageUnitArr msgUnitArr);

      string ping(in string qos);
   };

}; // org::xmlBlaster::protocol::corba::clientIdl



module serverIdl
{
   interface Server
   {
      XmlType subscribe(in XmlType xmlKey, in XmlType qos)
                                          raises(XmlBlasterException);


      MessageUnitArr get(in XmlType xmlKey, in XmlType qos)
                                          raises(XmlBlasterException);


      XmlTypeArr unSubscribe(in XmlType xmlKey, in XmlType qos)
                                          raises(XmlBlasterException);


      XmlType publish(in MessageUnit msgUnit)
                                          raises(XmlBlasterException);

      XmlTypeArr publishArr(in MessageUnitArr msgUnitArr)
                                          raises(XmlBlasterException);

      oneway void publishOneway(in MessageUnitArr msgUnitArr);

      XmlTypeArr erase(in XmlType xmlKey, in XmlType qos)
                                          raises(XmlBlasterException);


      string ping(in string qos);

   }; // interface server

}; // org::xmlBlaster::protocol::corba::serverIdl



module authenticateIdl
{
   interface AuthServer
   {
      serverIdl::Server login(in string loginName, in string passwd,
                              in serverIdl::XmlType qosClient)
                              raises (serverIdl::XmlBlasterException);

      serverIdl::XmlType connect(in serverIdl::XmlType qos)
                              raises (serverIdl::XmlBlasterException);

      void logout(in serverIdl::Server xmlBlaster)
                  raises (serverIdl::XmlBlasterException);

      void disconnect(in string sessionId, in serverIdl::XmlType qos)
                      raises (serverIdl::XmlBlasterException);

      string ping(in string qos);
   };
}; // org::xmlBlaster::protocol::corba::authenticateIdl



#endif // _xmlBlaster_IDL_