org.objectweb.joram.client.connector.OutboundConsumer Class Reference

Inherited by org.objectweb.joram.client.connector.OutboundReceiver, and org.objectweb.joram.client.connector.OutboundSubscriber.

Inheritance diagram for org.objectweb.joram.client.connector.OutboundConsumer:

[legend]Collaboration diagram for org.objectweb.joram.client.connector.OutboundConsumer:

[legend]List of all members.

Public Member Functions
void	setMessageListener (javax.jms.MessageListener messageListener) throws JMSException
javax.jms.MessageListener	getMessageListener () throws JMSException
String	getMessageSelector () throws JMSException
javax.jms.Message	receive (long timeOut) throws JMSException
javax.jms.Message	receive () throws JMSException
javax.jms.Message	receiveNoWait () throws JMSException
void	close () throws JMSException
Protected Member Functions
void	checkValidity () throws IllegalStateException
Protected Attributes
OutboundSession	session
MessageConsumer	consumer
Package Functions
	OutboundConsumer (MessageConsumer consumer, OutboundSession session)
Package Attributes
boolean	valid = true

---

Detailed Description

An OutboundConsumer instance wraps a JMS consumer for a component involved in outbound messaging.

Definition at line 35 of file OutboundConsumer.java.

---

Constructor & Destructor Documentation

org.objectweb.joram.client.connector.OutboundConsumer.OutboundConsumer	(	MessageConsumer	consumer,
		OutboundSession	session
	)			[package]

Constructs an OutboundConsumer instance.

Parameters:

	consumer	JMS consumer to wrap.
	session	The OutboundSession this consumer belongs to.

Definition at line 52 of file OutboundConsumer.java.

References org.objectweb.joram.client.connector.OutboundConsumer.session.

---

Member Function Documentation

void org.objectweb.joram.client.connector.OutboundConsumer.setMessageListener

(

javax.jms.MessageListener

messageListener

)

throws JMSException

Forbidden call on a component's outbound consumer, throws a IllegalStateException instance.

Definition at line 69 of file OutboundConsumer.java.

References org.objectweb.joram.client.connector.OutboundConsumer.checkValidity().

Here is the call graph for this function:

javax.jms.MessageListener org.objectweb.joram.client.connector.OutboundConsumer.getMessageListener

(

)

throws JMSException

Forbidden call on a component's outbound consumer, throws a IllegalStateException instance.

Definition at line 80 of file OutboundConsumer.java.

References org.objectweb.joram.client.connector.OutboundConsumer.checkValidity().

Here is the call graph for this function:

String org.objectweb.joram.client.connector.OutboundConsumer.getMessageSelector

(

)

throws JMSException

Delegates the call to the wrapped JMS consumer.

Definition at line 89 of file OutboundConsumer.java.

References org.objectweb.joram.client.connector.OutboundConsumer.checkValidity(), and org.objectweb.joram.client.connector.OutboundConsumer.consumer.

Here is the call graph for this function:

javax.jms.Message org.objectweb.joram.client.connector.OutboundConsumer.receive

(

long

timeOut

)

throws JMSException

Delegates the call to the wrapped JMS consumer.

Definition at line 101 of file OutboundConsumer.java.

References org.objectweb.joram.client.connector.OutboundConsumer.checkValidity(), and org.objectweb.joram.client.connector.OutboundConsumer.consumer.

Here is the call graph for this function:

javax.jms.Message org.objectweb.joram.client.connector.OutboundConsumer.receive

(

)

throws JMSException

Delegates the call to the wrapped JMS consumer.

Definition at line 113 of file OutboundConsumer.java.

References org.objectweb.joram.client.connector.OutboundConsumer.checkValidity(), and org.objectweb.joram.client.connector.OutboundConsumer.consumer.

Here is the call graph for this function:

javax.jms.Message org.objectweb.joram.client.connector.OutboundConsumer.receiveNoWait

(

)

throws JMSException

Delegates the call to the wrapped JMS consumer.

Definition at line 125 of file OutboundConsumer.java.

References org.objectweb.joram.client.connector.OutboundConsumer.checkValidity(), org.objectweb.joram.client.connector.OutboundConsumer.consumer, org.objectweb.joram.client.connector.OutboundSession.isStarted(), and org.objectweb.joram.client.connector.OutboundConsumer.session.

Here is the call graph for this function:

void org.objectweb.joram.client.connector.OutboundConsumer.close

(

)

throws JMSException

Delegates the call to the wrapped JMS consumer.

Definition at line 139 of file OutboundConsumer.java.

References org.objectweb.joram.client.connector.OutboundConsumer.consumer, and org.objectweb.joram.client.connector.OutboundConsumer.valid.

void org.objectweb.joram.client.connector.OutboundConsumer.checkValidity

(

)

throws IllegalStateException [protected]

Checks the validity of the subscriber instance.

Definition at line 149 of file OutboundConsumer.java.

References org.objectweb.joram.client.connector.OutboundSession.checkValidity(), org.objectweb.joram.client.connector.OutboundConsumer.session, and org.objectweb.joram.client.connector.OutboundConsumer.valid.

Referenced by org.objectweb.joram.client.connector.OutboundConsumer.getMessageListener(), org.objectweb.joram.client.connector.OutboundConsumer.getMessageSelector(), org.objectweb.joram.client.connector.OutboundSubscriber.getNoLocal(), org.objectweb.joram.client.connector.OutboundReceiver.getQueue(), org.objectweb.joram.client.connector.OutboundSubscriber.getTopic(), org.objectweb.joram.client.connector.OutboundConsumer.receive(), org.objectweb.joram.client.connector.OutboundConsumer.receiveNoWait(), and org.objectweb.joram.client.connector.OutboundConsumer.setMessageListener().

Here is the call graph for this function:

---

Member Data Documentation

OutboundSession org.objectweb.joram.client.connector.OutboundConsumer.session [protected]

The OutboundSession this consumer belongs to.

Definition at line 38 of file OutboundConsumer.java.

Referenced by org.objectweb.joram.client.connector.OutboundConsumer.checkValidity(), org.objectweb.joram.client.connector.OutboundConsumer.OutboundConsumer(), org.objectweb.joram.client.connector.OutboundReceiver.OutboundReceiver(), org.objectweb.joram.client.connector.OutboundSubscriber.OutboundSubscriber(), and org.objectweb.joram.client.connector.OutboundConsumer.receiveNoWait().

MessageConsumer org.objectweb.joram.client.connector.OutboundConsumer.consumer [protected]

Wrapped JMS consumer.

Definition at line 40 of file OutboundConsumer.java.

Referenced by org.objectweb.joram.client.connector.OutboundConsumer.close(), org.objectweb.joram.client.connector.OutboundConsumer.getMessageSelector(), org.objectweb.joram.client.connector.OutboundReceiver.OutboundReceiver(), org.objectweb.joram.client.connector.OutboundConsumer.receive(), and org.objectweb.joram.client.connector.OutboundConsumer.receiveNoWait().

boolean org.objectweb.joram.client.connector.OutboundConsumer.valid = true [package]

false if consumer is no more valid.

Definition at line 43 of file OutboundConsumer.java.

Referenced by org.objectweb.joram.client.connector.OutboundConsumer.checkValidity(), and org.objectweb.joram.client.connector.OutboundConsumer.close().

---

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

• org/objectweb/joram/client/connector/OutboundConsumer.java

---