xmlblaster.idl

java开源的企业总线.xmlBlaster

    *   @see Addressless message-event-middleware pattern
    */
   interface Server
   {
      /**
       * Asynchronous read-access method.
       * 
       * The results are returned to the
       * Client-Callback interface via the update() method.
       * You need to implement the method BlasterCallback.update()
       * This is the push modus.
       * 
       * @param xmlKey  Key with attributes allowing XPath or EXACT selection<br />
       *                See xmlBlaster/src/dtd/XmlKey.xml for a description
       * @param qos     Quality of Service, flags to control subscription<br>
       *                See xmlBlaster/src/dtd/XmlQoS.xml for a description
       * @return oid    The subscription ID of your subscribed message(s)<br>
       *                If you subscribed using a query, the subscription ID of this<br>
       *                query handling object is returned.<br>
       *                You should use this subId if you wish to unSubscribe()<br>
       *                If no match is found, an empty string "" is returned.
       *
       * @see addListener in Java event model
       * @see addObserver in Java observer pattern
       * @see <a href="http://www.xmlBlaster.org/xmlBlaster/doc/requirements/interface.subscribe.html" target="others">the interface.subscribe requirement</a>
       */
      XmlType subscribe(in XmlType xmlKey, in XmlType qos)
                                          raises(XmlBlasterException);


      /**
       * Synchronous read-access methods
       * This is the pull modus.
       *
       * @param xmlKey  Key with attributes allowing XPath or EXACT selection<br />
       *                See xmlBlaster/src/dtd/XmlKey.xml for a description
       * @param qos     Quality of Service, flags to control get()<br>
       *                See xmlBlaster/src/dtd/XmlQoS.xml for a description
       * @return Contains a sequence of 0 - n MessageUnit structs with its qos infos
       * @see <a href="http://www.xmlBlaster.org/xmlBlaster/doc/requirements/interface.get.html" target="others">the interface.get requirement</a>
       */
      MessageUnitArr get(in XmlType xmlKey, in XmlType qos)
                                          raises(XmlBlasterException);


      /**
       * if a key was subscribed forever, you can cancel your
       * subscription with following method
       *
       * @param xmlKey  Key contains the subscription ID returned from subscribe()<br />
       *                See xmlBlaster/src/dtd/XmlKey.xml for a description
       * @param qos     Quality of Service, flags to control canceling of a subscription<br>
       *                See xmlBlaster/src/dtd/XmlQoS.xml for a description
       * @return XML string array with the subscription id's in XML markup
       * @see <a href="http://www.xmlBlaster.org/xmlBlaster/doc/requirements/interface.unSubscribe.html" target="others">the interface.unSubscribe requirement</a>
       */
      XmlTypeArr unSubscribe(in XmlType xmlKey, in XmlType qos)
                                          raises(XmlBlasterException);


      /**
       * Write-Access Method. 
       * This triggers the method update() if subscribed (observed) by somebody
       * or if addressed as Point-to-Point (PtP).
       * If the given key oid doesn't exist, it will be automatically added,
       * so this covers the SQL'ish INSERT and UPDATE.<p>
       *
       * @param msgUnit Contains a MessageUnit struct
       * @return String with the key oid of the msgUnit
       *         If you let the oid be generated, you need this information
       *         for further publishing to the same MessageUnit<br>
       *         Rejected Messages will contain an empty string ""
       * @see <a href="http://www.xmlBlaster.org/xmlBlaster/doc/requirements/interface.publish.html" target="others">the interface.publish requirement</a>
       */
      XmlType publish(in MessageUnit msgUnit)
                                          raises(XmlBlasterException);

      /**
       * Write-Access Method
       * This triggers the method update() if observed by somebody
       * If the given key doesn't exist, it will be automatically added,
       * so this covers the SQL'ish INSERT and UPDATE.
       *
       * For performance or transaction reasons, you can send a whole array
       * of MessageUnit with one invocation of publishArr()
       *
       * @param msgUnit Contains a sequence of 1 - n MessageUnit structs
       * @return String array with the key oid's, corresponding to the index
       *         of msgUnitArr<br>
       *         If you let the oid be generated, you need this information
       *         for further publishing to the same MessageUnit array<br>
       *         Rejected Messages will contain an empty string ""
       * @exception On severe problem an XmlBlasterException is thrown, all messages
       *            of this array should be treated as lost
       */
      XmlTypeArr publishArr(in MessageUnitArr msgUnitArr)
                                          raises(XmlBlasterException);

      /**
       * Publish a message to the server. 
       *
       * The oneway variant may be used for better performance,
       * it is not returning a value (no application level ACK). 
       *
       * For performance reasons, you can send a whole array
       * of MessageUnit with one Invocation of publishOneway()
       *
       * @param msgUnit Contains a sequence of 1 - n MessageUnit structs
       */
      oneway void publishOneway(in MessageUnitArr msgUnitArr);

      /**
       * Erase a MessageUnit
       * @return String array with the key oid's which are deleted
       * @see <a href="http://www.xmlBlaster.org/xmlBlaster/doc/requirements/interface.erase.html" target="others">the interface.erase requirement</a>
       */
      XmlTypeArr erase(in XmlType xmlKey, in XmlType qos)
                                          raises(XmlBlasterException);


      /**
       * Ping to check if xmlBlaster is alive. 
       * This ping checks the availability on the application level.
       * @param qos Currently an empty string ""
       * @return    Currently an empty string ""
       */
      string ping(in string qos);

   }; // interface server

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



/**
 * The xmlBlaster authentication interface.
 * <p>
 * Use this interface to access via login() the xmlBlaster
 * <p>
 * The final authentication/authorization interace is not yet specified
 */
module authenticateIdl
{
   interface AuthServer
   {
      /**
       * @deprecated Use connect() instead
       */
      serverIdl::Server login(in string loginName, in string passwd,
                              in serverIdl::XmlType qosClient)
                              raises (serverIdl::XmlBlasterException);

      /**
       * Initializes a new xmlBlaster session. (Successor of login( ... ); )
       * <p>
       * @param qos       Quality of Service, flags for additional client
       *                  information like client certificate (X.509), timeout etc.
       *                  Typically it contains the IOR reference to the
       *                  BlasterCallback interface or other protocol addresses
       *                  like email or http URL
       * @return qos      information like sessionId, keys, ...
       * @exception XmlBlasterException if the login fails
       * @see             xmlBlaster/src/dtd/XmlQoS.xml and dtd for qos examples
       * @see             ConnectQosSaxFactory.java Javadoc description
       * @see <a href="http://www.xmlBlaster.org/xmlBlaster/doc/requirements/interface.connect.html" target="others">the interface.connect requirement</a>
       */
      serverIdl::XmlType connect(in serverIdl::XmlType qos)
                              raises (serverIdl::XmlBlasterException);

      /**
       * @deprecated Use disconnect() instead
       */
      void logout(in serverIdl::Server xmlBlaster)
                  raises (serverIdl::XmlBlasterException);

      /**
       * Disconnects the client from the xmlBlaster and closes the session.
       * <br>(Counterpart of connect( ... ); )
       * <p>
       * @param sessionId The server interface handle returned in the init qos.
       * @param qos       An optional signature etc.
       */
      void disconnect(in string sessionId, in serverIdl::XmlType qos)
                      raises (serverIdl::XmlBlasterException);

      /**
       * Ping to check if the authentication server is alive. 
       * This ping checks the availability on the application level.
       * @param qos Currently an empty string ""
       * @return    Currently an empty string ""
       */
      string ping(in string qos);
   };
}; // org::xmlBlaster::protocol::corba::authenticateIdl



#endif // _xmlBlaster_IDL_