com.sap.cds.feature.messaging.local

Class FileBasedBrokerConnector

java.lang.Object

com.sap.cds.feature.messaging.local.FileBasedBrokerConnector

All Implemented Interfaces:

Feature, MessagingBrokerConnector

public class FileBasedBrokerConnector
extends Object
implements MessagingBrokerConnector

Implementation of the MessagingBrokerConnector for the file based messaging service.

Field Summary

Fields inherited from interface com.sap.cds.feature.messaging.MessagingBrokerConnector

INSTANCES

Constructor Summary

Constructors

Constructor and Description
FileBasedBrokerConnector()

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	getFeatureName()
String	getNamespace() Returns the name space if used by the connector.
boolean	isActiveFeature() Checks if the feature is activated
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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileBasedBrokerConnector

public FileBasedBrokerConnector()

Method Detail

connect

public void connect()
             throws IOException

Description copied from interface: MessagingBrokerConnector

Establishes the connection to the messaging broker.

Specified by:

connect in interface MessagingBrokerConnector

Throws:

IOException - In case when any connection errors occurs

isConnected

public boolean isConnected()

Description copied from interface: MessagingBrokerConnector

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

Specified by:

isConnected in interface MessagingBrokerConnector

Returns:

true if connected and false otherwise

getNamespace

public String getNamespace()

Description copied from interface: MessagingBrokerConnector

Returns the name space if used by the connector.

Specified by:

getNamespace in interface MessagingBrokerConnector

Returns:

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

createQueue

public void createQueue(String name)
                 throws IOException

Description copied from interface: MessagingBrokerConnector

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.

Specified by:

createQueue in interface MessagingBrokerConnector

Parameters:

name - queue name

Throws:

IOException - In case an error occurs while creating the queue

createQueueSubscription

public void createQueueSubscription(String queue,
                                    String topic)
                             throws IOException

Description copied from interface: MessagingBrokerConnector

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.

Specified by:

createQueueSubscription in interface MessagingBrokerConnector

Parameters:

queue - the queue name

topic - the topic the queue should subscribe to

Throws:

IOException - In case an error occurs during the subscription

registerQueueListener

public void registerQueueListener(String queue,
                                  MessagingBrokerQueueListener listener)
                           throws IOException

Description copied from interface: MessagingBrokerConnector

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

Specified by:

registerQueueListener in interface MessagingBrokerConnector

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

public void emitTopicMessage(String topic,
                             String message)

Description copied from interface: MessagingBrokerConnector

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

Specified by:

emitTopicMessage in interface MessagingBrokerConnector

Parameters:

topic - message topic pattern

message - the string message

isActiveFeature

public boolean isActiveFeature()

Description copied from interface: Feature

Checks if the feature is activated

Specified by:

isActiveFeature in interface Feature

Returns:

true if the feature is activated

getFeatureName

public String getFeatureName()

Specified by:

getFeatureName in interface Feature

Returns:

a name for the feature to be used in logging