com.sap.cds.feature.messaging

Interface MessagingBrokerConnector

All Superinterfaces:

Feature

All Known Implementing Classes:

FileBasedBrokerConnector

public interface MessagingBrokerConnector
extends Feature

The MessagingBrokerConnector interface provides the basic functionality for interaction with any kind of messaging broker.

Field Summary

Fields

Modifier and Type	Field and Description
static List<MessagingBrokerConnector>	INSTANCES

Method Summary

Modifier and Type	Method and Description
void	connect() Establishes the connection to the messaging broker.
void	createQueue(String name) Request the broker for creating a queue with the specified queue name.
void	createQueueSubscription(String queue, String topic) Requests the broker for creating a queue topic subscription.
void	emitTopicMessage(String topic, String message) Emits the given message to the message broker to the given topic pattern.
String	getNamespace() Returns the name space if used by the connector.
boolean	isConnected() Determines whether the connector is already connected to the message broker.
void	registerQueueListener(String queue, MessagingBrokerQueueListener listener) Registers the MessagingBrokerQueueListener implementation to the specified queue of the message broker.

Methods inherited from interface com.sap.cds.feature.Feature

getFeatureName, isActiveFeature

Field Detail

INSTANCES

static final List<MessagingBrokerConnector> INSTANCES

Method Detail

connect

void connect()
      throws IOException

Establishes the connection to the messaging broker.

Throws:

IOException - In case when any connection errors occurs

isConnected

boolean isConnected()

Determines whether the connector is already connected to the message broker.

Returns:

true if connected and false otherwise

getNamespace

String getNamespace()

Returns the name space if used by the connector.

Returns:

name space used by the connector. If no names pace is used an empty string is returned.

createQueue

void createQueue(String name)
          throws IOException

Request the broker for creating a queue with the specified queue name. The method returns true only when the queue is successfully created or exists already. Otherwise false is returned.

Parameters:

name - queue name

Throws:

IOException - In case an error occurs while creating the queue

createQueueSubscription

void createQueueSubscription(String queue,
                             String topic)
                      throws IOException

Requests the broker for creating a queue topic subscription. The method returnstrue only when the queue topic subscription was successfully created or already available. Otherwise false is returned.

Parameters:

queue - the queue name

topic - the topic the queue should subscribe to

Throws:

IOException - In case an error occurs during the subscription

registerQueueListener

void registerQueueListener(String queue,
                           MessagingBrokerQueueListener listener)
                    throws IOException

Registers the MessagingBrokerQueueListener implementation to the specified queue of the message broker.

Parameters:

queue - the queue name

listener - implementation of the MessagingBrokerQueueListener interface

Throws:

IOException - In case when any errors occurs while registering the listener to the broker

emitTopicMessage

void emitTopicMessage(String topic,
                      String message)

Emits the given message to the message broker to the given topic pattern.

Parameters:

topic - message topic pattern

message - the string message