com.scalagent.kjoram.MessageProducer Class Reference

Inherited by com.scalagent.kjoram.QueueSender, and com.scalagent.kjoram.TopicPublisher.

Inheritance diagram for com.scalagent.kjoram.MessageProducer:

[legend]Collaboration diagram for com.scalagent.kjoram.MessageProducer:

[legend]List of all members.

Public Member Functions
void	setDisableMessageID (boolean value) throws JMSException
void	setDeliveryMode (int deliveryMode) throws JMSException
void	setPriority (int priority) throws JMSException
void	setTimeToLive (long timeToLive) throws JMSException
void	setDisableMessageTimestamp (boolean value) throws JMSException
Destination	getDestination () throws JMSException
boolean	getDisableMessageID () throws JMSException
int	getDeliveryMode () throws JMSException
int	getPriority () throws JMSException
long	getTimeToLive () throws JMSException
boolean	getDisableMessageTimestamp () throws JMSException
void	send (Message message) throws JMSException
void	send (Message message, int deliveryMode, int priority, long timeToLive) throws JMSException
void	send (Destination dest, Message message) throws JMSException
void	send (Destination dest, Message message, int deliveryMode, int priority, long timeToLive) throws JMSException
void	close () throws JMSException
Protected Attributes
boolean	closed = false
Session	sess
Destination	dest = null
Package Functions
	MessageProducer (Session sess, Destination dest) throws JMSException

---

Detailed Description

Definition at line 30 of file MessageProducer.java.

---

Constructor & Destructor Documentation

com.scalagent.kjoram.MessageProducer.MessageProducer	(	Session	sess,
		Destination	dest
	)			throws JMSException [package]

Constructs a producer.

Parameters:

	sess	The session the producer belongs to.
	dest	The destination the producer sends messages to.

Exceptions:

	IllegalStateException	If the connection is broken.
	JMSException	If the creation fails for any other reason.

Definition at line 66 of file MessageProducer.java.

References com.scalagent.kjoram.MessageProducer.dest, com.scalagent.kjoram.Session.producers, and com.scalagent.kjoram.MessageProducer.sess.

---

Member Function Documentation

void com.scalagent.kjoram.MessageProducer.setDisableMessageID

(

boolean

value

)

throws JMSException

API method; not taken into account.

Exceptions:

IllegalStateException

If the producer is closed.

Definition at line 85 of file MessageProducer.java.

References com.scalagent.kjoram.MessageProducer.closed.

void com.scalagent.kjoram.MessageProducer.setDeliveryMode

(

int

deliveryMode

)

throws JMSException

API method.

Exceptions:

	IllegalStateException	If the producer is closed.
	JMSException	When setting an invalid delivery mode.

Definition at line 97 of file MessageProducer.java.

References com.scalagent.kjoram.MessageProducer.closed.

void com.scalagent.kjoram.MessageProducer.setPriority

(

int

priority

)

throws JMSException

API method.

Exceptions:

	IllegalStateException	If the producer is closed.
	JMSException	When setting an invalid priority.

Definition at line 115 of file MessageProducer.java.

References com.scalagent.kjoram.MessageProducer.closed.

void com.scalagent.kjoram.MessageProducer.setTimeToLive

(

long

timeToLive

)

throws JMSException

API method.

Exceptions:

IllegalStateException

If the producer is closed.

Definition at line 131 of file MessageProducer.java.

References com.scalagent.kjoram.MessageProducer.closed.

void com.scalagent.kjoram.MessageProducer.setDisableMessageTimestamp

(

boolean

value

)

throws JMSException

API method.

Exceptions:

IllegalStateException

If the producer is closed.

Definition at line 144 of file MessageProducer.java.

References com.scalagent.kjoram.MessageProducer.closed.

Destination com.scalagent.kjoram.MessageProducer.getDestination

(

)

throws JMSException

API method.

Exceptions:

IllegalStateException

If the producer is closed.

Definition at line 157 of file MessageProducer.java.

References com.scalagent.kjoram.MessageProducer.closed, and com.scalagent.kjoram.MessageProducer.dest.

boolean com.scalagent.kjoram.MessageProducer.getDisableMessageID

(

)

throws JMSException

API method.

Exceptions:

IllegalStateException

If the producer is closed.

Definition at line 170 of file MessageProducer.java.

References com.scalagent.kjoram.MessageProducer.closed.

int com.scalagent.kjoram.MessageProducer.getDeliveryMode

(

)

throws JMSException

API method.

Exceptions:

IllegalStateException

If the producer is closed.

Definition at line 183 of file MessageProducer.java.

References com.scalagent.kjoram.MessageProducer.closed.

int com.scalagent.kjoram.MessageProducer.getPriority

(

)

throws JMSException

API method.

Exceptions:

IllegalStateException

If the producer is closed.

Definition at line 196 of file MessageProducer.java.

References com.scalagent.kjoram.MessageProducer.closed.

long com.scalagent.kjoram.MessageProducer.getTimeToLive

(

)

throws JMSException

API method.

Exceptions:

IllegalStateException

If the producer is closed.

Definition at line 209 of file MessageProducer.java.

References com.scalagent.kjoram.MessageProducer.closed.

boolean com.scalagent.kjoram.MessageProducer.getDisableMessageTimestamp

(

)

throws JMSException

API method.

Exceptions:

IllegalStateException

If the producer is closed.

Definition at line 222 of file MessageProducer.java.

References com.scalagent.kjoram.MessageProducer.closed.

void com.scalagent.kjoram.MessageProducer.send

(

Message

message

)

throws JMSException

Sends a message with the default delivery parameters.

Exceptions:

	UnsupportedOperationException	If the dest is unidentified.
	IllegalStateException	If the producer is closed, or if the connection is broken.
	JMSException	If the request fails for any other reason.

Definition at line 239 of file MessageProducer.java.

References com.scalagent.kjoram.MessageProducer.dest.

void com.scalagent.kjoram.MessageProducer.send	(	Message	message,
		int	deliveryMode,
		int	priority,
		long	timeToLive
	)			throws JMSException

Sends a message with given delivery parameters.

Exceptions:

	UnsupportedOperationException	If the dest is unidentified.
	IllegalStateException	If the producer is closed, or if the connection is broken.
	JMSException	If the request fails for any other reason.

Definition at line 257 of file MessageProducer.java.

References com.scalagent.kjoram.MessageProducer.dest.

void com.scalagent.kjoram.MessageProducer.send	(	Destination	dest,
		Message	message
	)			throws JMSException

Sends a message with default delivery parameters for an unidentified message producer.

Exceptions:

	UnsupportedOperationException	When the producer did not properly identify itself.
	JMSSecurityException	If the user if not a WRITER on the specified destination.
	IllegalStateException	If the producer is closed, or if the connection is broken.
	JMSException	If the request fails for any other reason.

Definition at line 280 of file MessageProducer.java.

References com.scalagent.kjoram.MessageProducer.dest.

void com.scalagent.kjoram.MessageProducer.send	(	Destination	dest,
		Message	message,
		int	deliveryMode,
		int	priority,
		long	timeToLive
	)			throws JMSException

Sends a message with given delivery parameters for an unidentified message producer.

Exceptions:

	UnsupportedOperationException	When the producer did not properly identify itself.
	JMSSecurityException	If the user if not a WRITER on the specified destination.
	IllegalStateException	If the producer is closed, or if the connection is broken.
	JMSException	If the request fails for any other reason.

Definition at line 308 of file MessageProducer.java.

References com.scalagent.kjoram.MessageProducer.dest.

void com.scalagent.kjoram.MessageProducer.close

(

)

throws JMSException

API method.

Exceptions:

JMSException

Actually never thrown.

Definition at line 330 of file MessageProducer.java.

References com.scalagent.kjoram.MessageProducer.closed, com.scalagent.kjoram.Session.producers, and com.scalagent.kjoram.MessageProducer.sess.

---

Member Data Documentation

boolean com.scalagent.kjoram.MessageProducer.closed = false [protected]

true if the producer is closed.

Definition at line 50 of file MessageProducer.java.

Referenced by com.scalagent.kjoram.MessageProducer.close(), com.scalagent.kjoram.MessageProducer.getDeliveryMode(), com.scalagent.kjoram.MessageProducer.getDestination(), com.scalagent.kjoram.MessageProducer.getDisableMessageID(), com.scalagent.kjoram.MessageProducer.getDisableMessageTimestamp(), com.scalagent.kjoram.MessageProducer.getPriority(), com.scalagent.kjoram.QueueSender.getQueue(), com.scalagent.kjoram.MessageProducer.getTimeToLive(), com.scalagent.kjoram.TopicPublisher.getTopic(), com.scalagent.kjoram.MessageProducer.setDeliveryMode(), com.scalagent.kjoram.MessageProducer.setDisableMessageID(), com.scalagent.kjoram.MessageProducer.setDisableMessageTimestamp(), com.scalagent.kjoram.MessageProducer.setPriority(), and com.scalagent.kjoram.MessageProducer.setTimeToLive().

Session com.scalagent.kjoram.MessageProducer.sess [protected]

The session the producer belongs to.

Definition at line 52 of file MessageProducer.java.

Referenced by com.scalagent.kjoram.MessageProducer.close(), com.scalagent.kjoram.MessageProducer.MessageProducer(), com.scalagent.kjoram.QueueSender.QueueSender(), com.scalagent.kjoram.TopicPublisher.TopicPublisher(), com.scalagent.kjoram.TopicPublisher.toString(), and com.scalagent.kjoram.QueueSender.toString().

Destination com.scalagent.kjoram.MessageProducer.dest = null [protected]

The destination the producer sends messages to.

Definition at line 54 of file MessageProducer.java.

Referenced by com.scalagent.kjoram.MessageProducer.getDestination(), com.scalagent.kjoram.MessageProducer.MessageProducer(), and com.scalagent.kjoram.MessageProducer.send().

---

The documentation for this class was generated from the following file:

• com/scalagent/kjoram/MessageProducer.java

---