Package com.avaya.collaboration.bus

The Collaboration Bus is used to send and receive messages between services.

See: Description

Interface Summary

Interface	Description
CollaborationBusMessage	A collaboration bus message.
CollaborationBusMessageHandler	This is the main interface for handling messaging on the Collaboration Bus.
CollaborationBusMessageHeader	The Collaboration Bus Message header.
MessageReceiver	A service implement this method to receive messages that have been delivered to a channel for which the service is a consumer.
PreSendMessageHandler	A client uses this interface to be notified of a populated CollaborationBusMessageHeader, before the message is actually sent.

Exception Summary

Exception	Description
CollaborationBusException	Exception raised by the Collaboration Bus.

Package com.avaya.collaboration.bus Description

The Collaboration Bus is used to send and receive messages between services.

See the classes SampleCBClient, SampleCBConnector, and SampleLotteryHttpClient for examples of how to use this API.

Channels are used to route messages between services. Messages can be exchanged using the point to point (Queue) model or the publish/subscribe (Topic)) model. It is very easy to use the collaboration bus. A service designed to consume messages on a channel need only specify it in the properties.xml file. Here is a sample xml snippet for a sample service that wants to consume messages on the "lottery" channel.

         <message>
                <channel>
                        <name>lottery</name>
                        <type>ptop-single</type>
                        <listener-class>com.avaya.collaboration.bus.sample.SampleCBConnector</listener-class>
                </channel>
        </message>

This basically says the service has a class named SampleCBConnector which has a method named messageReceived(message). The messageReceived(message) method will be called asynchronously when a message is sent to the point to point (ptop) channel named lottery. Once this xml is added to the properties.xml file, the programmer needs to implement the one method. A publish/subscribe channel is set up the same way only the type is "pubsub-multi". A service can set up a maximum of 5 channels.