cern.cmw.mom.pubsub

Interface Publisher

All Known Implementing Classes:

DefaultPublisherImpl

public interface Publisher

Public interface. Provide methods to create and publish messages on topics. The standard JMS specified message types are supported :

• Message
• TextMessage
• StreamMessage
• BytesMessage
• MapMessage
• ObjectMessage

Two kinds of exception are thrown :

• javax.jms.JMSException are thrown for exceptions caused by a problem in the underlying implementation.
• javax.naming.NamingException are thrown if the topic usage is not correct. Each time a topic is used, either in publication or in subscription, the topic name is checked against the topic namespace, to avoid namespace pollution and performance degradation

This example shows a simple publication of a TextMessage on a topic:

 try {
   Publisher p = PubSubFactory.publisher();
 } catch (MOMException momEx) { ... }
 // ...
 try {
   TextMessage msg = p.createTextMessage();
   msg.setText("This is the text");
   p.publish("CMW.DEVICES.PowerConverter.PC1.Current", msg);
   // ...
   p.close();
 }
 catch (JMSException jmsEx) { ... }
 catch (NamingException namingEx) { ... }
 

Author:

Controls Middleware Project

See Also:

PubSubFactory, Subscriber, MappingService

Method Summary

Modifier and Type	Method and Description
void	close() Close the publisher singleton instance and dealloacate any resource
BytesMessage	createBytesMessage() Create an instance of BytesMessage.
MapMessage	createMapMessage() Create an instance of MapMessage.
Message	createMessage() Create an instance of Message.
ObjectMessage	createObjectMessage() Create an instance of ObjectMessage.
StreamMessage	createStreamMessage() Create an instance of StreamMessage.
TextMessage	createTextMessage() Create an instance of TextMessage.
void	publish(java.lang.String topic, Message message) Publish a message to the given topic.
void	publish(java.lang.String topic, Message message, int deliveryMode, int priority, long timeToLive) Publish a message to the given topic.
void	setExceptionListener(ExceptionListener listener) Set the listener for exceptions handling

Method Detail

setExceptionListener

void setExceptionListener(ExceptionListener listener)

Set the listener for exceptions handling

Parameters:

listener - The exceptions listener

close

void close()

Close the publisher singleton instance and dealloacate any resource

createBytesMessage

BytesMessage createBytesMessage()
                         throws JMSException

Create an instance of BytesMessage.

Returns:

BytesMessage the BytesMessage instance

Throws:

JMSException - if JMS fails to create the message due to some internal JMS error.

createMapMessage

MapMessage createMapMessage()
                     throws JMSException

Create an instance of MapMessage.

Returns:

MapMessage the MapMessage instance

Throws:

JMSException - if JMS fails to create the message due to some internal JMS error.

createMessage

Message createMessage()
               throws JMSException

Create an instance of Message.

Returns:

Message the Message instance

Throws:

JMSException - if JMS fails to create the message due to some internal JMS error.

createObjectMessage

ObjectMessage createObjectMessage()
                           throws JMSException

Create an instance of ObjectMessage.

Returns:

ObjectMessage the ObjectMessage instance

Throws:

JMSException - if JMS fails to create the message due to some internal JMS error.

createStreamMessage

StreamMessage createStreamMessage()
                           throws JMSException

Create an instance of StreamMessage.

Returns:

StreamMessage the StreamMessage instance

Throws:

JMSException - if JMS fails to create the message due to some internal JMS error.

createTextMessage

TextMessage createTextMessage()
                       throws JMSException

Create an instance of TextMessage.

Returns:

TextMessage the TextMessage instance

Throws:

JMSException - if JMS fails to create the message due to some internal JMS error.

publish

void publish(java.lang.String topic,
             Message message)
      throws JMSException,
             javax.naming.NamingException

Publish a message to the given topic.

Parameters:

topic - The String representation of the topic

message - The Message object to publish

Throws:

JMSException - if JMS fails to publish the message due to some internal JMS error.

javax.naming.NamingException - if there is a violation in the namespace policy.

publish

void publish(java.lang.String topic,
             Message message,
             int deliveryMode,
             int priority,
             long timeToLive)
      throws JMSException,
             javax.naming.NamingException

Publish a message to the given topic.

Parameters:

topic - The String representation of the topic

message - The Message object to publish

deliveryMode - The Message persistence (true, false)

priority - The Message priority (0..9)

timeToLive - The Message time to live (msec)

Throws:

JMSException - if JMS fails to publish the message due to some internal JMS error.

javax.naming.NamingException - if there is a violation in the namespace policy.