org.wso2.carbon.andes.event.core

Interface EventBroker

All Known Implementing Classes:

CarbonEventBroker

public interface EventBroker

The main eventing interface for the other components. this interface supports two kinds of subscriptions. 1. Subscriptions with event dispatcher. Event broker does not persists these subscriptions and call the on message method upon receiving an event. 2. Subscriptions with event dispatcher's name. Event broker persists these subscriptions. It is responsibility of the user who calls this method to register the EventDispatcher with the given name. In a server restart again caller has to register the EventDispatcher.

Method Summary

Methods

Modifier and Type	Method and Description
List<Subscription>	getAllSubscriptions(String filter) Get all subscriptions
Subscription	getSubscription(String id) Get subscription from subscription ID
TopicManagerService	getTopicManagerService() Gets the topic manager
void	initializeTenant() This method is called when a tenant initialize.
void	publish(Message message, String topicName) Publish an event to the given topic asynchronously.
void	publish(Message message, String topicName, int deliveryMode) Publish an event to the given topic asynchronously.
void	publishRobust(Message message, String topicName) Publish an event to the given topic synchronously.
void	publishRobust(Message message, String topicName, int deliveryMode) Publish an event to the given topic synchronously.
void	registerEventDispatcher(String eventDispatcherName, EventDispatcher eventDispatcher) Register an event dispatcher in the case of using subscriptions with eventBrokerName
void	renewSubscription(Subscription subscription) Renews a subscription.
String	subscribe(Subscription subscription) Subscribe using the given subscription details.
void	unsubscribe(String id) Unsubscribes a subscription

Method Detail

subscribe

String subscribe(Subscription subscription)
                 throws EventBrokerException

Subscribe using the given subscription details.

Parameters:

subscription - the subscription

Returns:

subscription ID

Throws:

EventBrokerException

unsubscribe

void unsubscribe(String id)
                 throws EventBrokerException

Unsubscribes a subscription

Parameters:

id - subscription ID

Throws:

EventBrokerException

getSubscription

Subscription getSubscription(String id)
                             throws EventBrokerException

Get subscription from subscription ID

Parameters:

id - subscription ID

Returns:

the subscription

Throws:

EventBrokerException

renewSubscription

void renewSubscription(Subscription subscription)
                       throws EventBrokerException

Renews a subscription. Updates expiry time, removal and resetting of the properties

Parameters:

subscription - the subscription to renew

Throws:

EventBrokerException

getAllSubscriptions

List<Subscription> getAllSubscriptions(String filter)
                                       throws EventBrokerException

Get all subscriptions

Parameters:

filter - filter value. use * for all

Returns:

a list of subscriptions

Throws:

EventBrokerException

publish

void publish(Message message,
           String topicName)
             throws EventBrokerException

Publish an event to the given topic asynchronously. i.e it starts a new thread to send the message.

Parameters:

message - - message to publish. this contains the OMElement of the message and any properties.

topicName - topic name

Throws:

EventBrokerException

publish

void publish(Message message,
           String topicName,
           int deliveryMode)
             throws EventBrokerException

Publish an event to the given topic asynchronously. i.e it starts a new thread to send the message.

Parameters:

message - - message to publish. this contains the OMElement of the message and any properties.

topicName - topic name

deliveryMode - - persist or not

Throws:

EventBrokerException

publishRobust

void publishRobust(Message message,
                 String topicName)
                   throws EventBrokerException

Publish an event to the given topic synchronously. i.e it uses the same thread to send the message.

Parameters:

message - message to publish. this contains the OMElement of the message and any properties.

topicName - topic name

Throws:

EventBrokerException

publishRobust

void publishRobust(Message message,
                 String topicName,
                 int deliveryMode)
                   throws EventBrokerException

Publish an event to the given topic synchronously. i.e it uses the same thread to send the message.

Parameters:

message - - message to publish. this contains the OMElement of the message and any properties.

topicName - topic name

deliveryMode - - persist or not

Throws:

EventBrokerException

registerEventDispatcher

void registerEventDispatcher(String eventDispatcherName,
                           EventDispatcher eventDispatcher)

Register an event dispatcher in the case of using subscriptions with eventBrokerName

Parameters:

eventDispatcherName - event dispatcher name

eventDispatcher - event dispatcher

getTopicManagerService

TopicManagerService getTopicManagerService()
                                           throws EventBrokerException

Gets the topic manager

Returns:

topic manager

Throws:

EventBrokerException

initializeTenant

void initializeTenant()
                      throws EventBrokerException,
                             org.wso2.carbon.user.api.UserStoreException

This method is called when a tenant initialize. to do the initialization works for tenants for event broker

Throws:

EventBrokerException

org.wso2.carbon.user.api.UserStoreException