com.solacesystems.jms

Class SolTopicPublisher

java.lang.Object

com.solacesystems.jms.SolMessageProducer

com.solacesystems.jms.SolTopicPublisher

All Implemented Interfaces:

SolCloseableIF, SolMessageProducerIF, SolProducerEventSource, MessageProducer, TopicPublisher

public class SolTopicPublisher
extends SolMessageProducer
implements TopicPublisher

Field Summary

Fields inherited from class com.solacesystems.jms.SolMessageProducer

Encoder

Method Summary

Modifier and Type	Method and Description
Topic	getTopic() Gets the topic associated with this TopicPublisher.
void	publish(Message message) Publishes a message to the topic.
void	publish(Message message, int deliveryMode, int priority, long timeToLive) Publishes a message to the topic, specifying delivery mode, priority, and time to live.
void	publish(Topic topic, Message message) Publishes a message to a topic for an unidentified message producer.
void	publish(Topic topic, Message message, int deliveryMode, int priority, long timeToLive) Publishes a message to a topic for an unidentified message producer, specifying delivery mode, priority and time to live.

Methods inherited from class com.solacesystems.jms.SolMessageProducer

cancel, close, deliverToOne, getDeliveryMode, getDestination, getDisableMessageID, getDisableMessageTimestamp, getPriority, getTimeToLive, isDMQEligible, isElidingEligible, isReplyMessage, isXMLPayload, send, send, send, send, setDeliveryMode, setDisableMessageID, setDisableMessageTimestamp, setPriority, setProducerEventListener, setTimeToLive, useDirectMessaging

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.jms.MessageProducer

close, getDeliveryMode, getDestination, getDisableMessageID, getDisableMessageTimestamp, getPriority, getTimeToLive, send, send, send, send, setDeliveryMode, setDisableMessageID, setDisableMessageTimestamp, setPriority, setTimeToLive

Method Detail

getTopic

public Topic getTopic()
               throws JMSException

Description copied from interface: TopicPublisher

Gets the topic associated with this TopicPublisher.

Specified by:

getTopic in interface TopicPublisher

Returns:

this publisher's topic

Throws:

JMSException - if the JMS provider fails to get the topic for this TopicPublisher due to some internal error.

publish

public void publish(Message message)
             throws JMSException

Description copied from interface: TopicPublisher

Publishes a message to the topic. Uses the TopicPublisher's default delivery mode, priority, and time to live.

When sending non-persistent messages, notifications of quota, permission, or endpoint problems will occur by sending an exception asynchronously through the Connection's ExceptionListener. In this case the send API will return without error but the message will not have been accepted. When sending persistent messages, the send API will always throw an exception when messages are not accepted.

Specified by:

publish in interface TopicPublisher

Parameters:

message - the message to publish

Throws:

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

MessageFormatException - if an invalid message is specified.

InvalidDestinationException - if a client uses this method with a TopicPublisher with an invalid topic.

See Also:

MessageProducer.getDeliveryMode(), MessageProducer.getTimeToLive(), MessageProducer.getPriority()

publish

public void publish(Message message,
                    int deliveryMode,
                    int priority,
                    long timeToLive)
             throws JMSException

Description copied from interface: TopicPublisher

Publishes a message to the topic, specifying delivery mode, priority, and time to live.

When sending non-persistent messages, notifications of quota, permission, or endpoint problems will occur by sending an exception asynchronously through the Connection's ExceptionListener. In this case the send API will return without error but the message will not have been accepted. When sending persistent messages, the send API will always throw an exception when messages are not accepted.

Specified by:

publish in interface TopicPublisher

Parameters:

message - the message to publish

deliveryMode - the delivery mode to use

priority - the priority for this message

timeToLive - the message's lifetime (in milliseconds) Supported since 4.6.1 SolOS-TR

Throws:

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

MessageFormatException - if an invalid message is specified.

InvalidDestinationException - if a client uses this method with a TopicPublisher with an invalid topic.

publish

public void publish(Topic topic,
                    Message message)
             throws JMSException

Description copied from interface: TopicPublisher

Publishes a message to a topic for an unidentified message producer. Uses the TopicPublisher's default delivery mode, priority, and time to live.

Typically, a message producer is assigned a topic at creation time; however, the JMS API also supports unidentified message producers, which require that the topic be supplied every time a message is published.

When sending non-persistent messages, notifications of quota, permission, or endpoint problems will occur by sending an exception asynchronously through the Connection's ExceptionListener. In this case the send API will return without error but the message will not have been accepted. When sending persistent messages, the send API will always throw an exception when messages are not accepted.

Specified by:

publish in interface TopicPublisher

Parameters:

topic - the topic to publish this message to

message - the message to publish

Throws:

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

MessageFormatException - if an invalid message is specified.

InvalidDestinationException - if a client uses this method with an invalid topic.

See Also:

MessageProducer.getDeliveryMode(), MessageProducer.getTimeToLive(), MessageProducer.getPriority()

publish

public void publish(Topic topic,
                    Message message,
                    int deliveryMode,
                    int priority,
                    long timeToLive)
             throws JMSException

Description copied from interface: TopicPublisher

Publishes a message to a topic for an unidentified message producer, specifying delivery mode, priority and time to live.

Typically, a message producer is assigned a topic at creation time; however, the JMS API also supports unidentified message producers, which require that the topic be supplied every time a message is published.

When sending non-persistent messages, notifications of quota, permission, or endpoint problems will occur by sending an exception asynchronously through the Connection's ExceptionListener. In this case the send API will return without error but the message will not have been accepted. When sending persistent messages, the send API will always throw an exception when messages are not accepted.

Specified by:

publish in interface TopicPublisher

Parameters:

topic - the topic to publish this message to

message - the message to publish

deliveryMode - the delivery mode to use

priority - the priority for this message

timeToLive - the message's lifetime (in milliseconds) Supported since 4.6.1 SolOS-TR

Throws:

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

MessageFormatException - if an invalid message is specified.

InvalidDestinationException - if a client uses this method with an invalid topic.