org.apache.camel.component.sjms

Class SjmsConsumer

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultConsumer

org.apache.camel.component.sjms.SjmsConsumer

All Implemented Interfaces:

Consumer, RouteAware, Service, ShutdownableService, StatefulService, SuspendableService

public class SjmsConsumer
extends DefaultConsumer

The SjmsConsumer is the base class for the SJMS MessageListener pool.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	SjmsConsumer.MessageConsumerPool A pool of MessageConsumerResources created at the initialization of the associated consumer.
protected class	SjmsConsumer.MessageConsumerResources

Field Summary

Fields

Modifier and Type	Field and Description
protected SjmsConsumer.MessageConsumerPool	consumers

Fields inherited from class org.apache.camel.impl.DefaultConsumer

log

Fields inherited from class org.apache.camel.support.ServiceSupport

shutdown, shuttingdown, started, starting, stopped, stopping, suspended, suspending

Constructor Summary

Constructors

Constructor and Description
SjmsConsumer(Endpoint endpoint, Processor processor)

Method Summary

Methods

Modifier and Type	Method and Description
protected javax.jms.MessageListener	createMessageHandler(javax.jms.Session session) Helper factory method used to create a MessageListener based on the MEP
protected void	doStart() Implementations override this method to support customized start/stop.
protected void	doStop() Implementations override this method to support customized start/stop.
int	getAcknowledgementMode()
protected ConnectionResource	getConnectionResource()
int	getConsumerCount() Returns the number of consumer listeners.
java.lang.String	getDestinationName() The destination name for this consumer.
java.lang.String	getDurableSubscriptionId() Gets the durable subscription Id.
SjmsEndpoint	getEndpoint() Gets the endpoint this Consumer consumes from.
java.lang.String	getMessageSelector() Gets the JMS Message selector syntax.
int	getTransactionBatchCount() If transacted, returns the nubmer of messages to be processed before committing the transaction.
long	getTransactionBatchTimeout() Returns the timeout value for batch transactions.
TransactionCommitStrategy	getTransactionCommitStrategy() Gets the commit strategy.
boolean	isSynchronous() Use to determine whether or not to process exchanges synchronously.
boolean	isTopic() Flag set by the endpoint used by consumers and producers to determine if the consumer is a JMS Topic.
boolean	isTransacted() Use to determine if transactions are enabled or disabled.

Methods inherited from class org.apache.camel.impl.DefaultConsumer

createUoW, doneUoW, getAsyncProcessor, getExceptionHandler, getProcessor, getRoute, handleException, handleException, setExceptionHandler, setRoute, toString

Methods inherited from class org.apache.camel.support.ServiceSupport

doResume, doShutdown, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.camel.Service

start, stop

Field Detail

consumers

protected SjmsConsumer.MessageConsumerPool consumers

Constructor Detail

SjmsConsumer

public SjmsConsumer(Endpoint endpoint,
            Processor processor)

Method Detail

getEndpoint

public SjmsEndpoint getEndpoint()

Description copied from interface: Consumer

Gets the endpoint this Consumer consumes from.

Specified by:

getEndpoint in interface Consumer

Overrides:

getEndpoint in class DefaultConsumer

Returns:

the endpoint

doStart

protected void doStart()
                throws java.lang.Exception

Description copied from class: ServiceSupport

Implementations override this method to support customized start/stop.

Important: See ServiceSupport.doStop() for more details.

Overrides:

doStart in class DefaultConsumer

Throws:

java.lang.Exception

See Also:

ServiceSupport.doStop()

doStop

protected void doStop()
               throws java.lang.Exception

Description copied from class: ServiceSupport

Implementations override this method to support customized start/stop.

Important: Camel will invoke this ServiceSupport.doStop() method when the service is being stopped. This method will also be invoked if the service is still in uninitialized state (eg has not been started). The method is always called to allow the service to do custom logic when the service is being stopped, such as when CamelContext is shutting down.

Overrides:

doStop in class DefaultConsumer

Throws:

java.lang.Exception

See Also:

ServiceSupport.doStart()

createMessageHandler

protected javax.jms.MessageListener createMessageHandler(javax.jms.Session session)

Helper factory method used to create a MessageListener based on the MEP

Parameters:

session - a session is only required if we are a transacted consumer

Returns:

the listener

getConnectionResource

protected ConnectionResource getConnectionResource()

getAcknowledgementMode

public int getAcknowledgementMode()

isTransacted

public boolean isTransacted()

Use to determine if transactions are enabled or disabled.

Returns:

true if transacted, otherwise false

isSynchronous

public boolean isSynchronous()

Use to determine whether or not to process exchanges synchronously.

Returns:

true if synchronous

getDestinationName

public java.lang.String getDestinationName()

The destination name for this consumer.

Returns:

String

getConsumerCount

public int getConsumerCount()

Returns the number of consumer listeners.

Returns:

the consumerCount

isTopic

public boolean isTopic()

Flag set by the endpoint used by consumers and producers to determine if the consumer is a JMS Topic.

Returns:

the topic true if consumer is a JMS Topic, default is false

getMessageSelector

public java.lang.String getMessageSelector()

Gets the JMS Message selector syntax.

getDurableSubscriptionId

public java.lang.String getDurableSubscriptionId()

Gets the durable subscription Id.

Returns:

the durableSubscriptionId

getTransactionCommitStrategy

public TransactionCommitStrategy getTransactionCommitStrategy()

Gets the commit strategy.

Returns:

the transactionCommitStrategy

getTransactionBatchCount

public int getTransactionBatchCount()

If transacted, returns the nubmer of messages to be processed before committing the transaction.

Returns:

the transactionBatchCount

getTransactionBatchTimeout

public long getTransactionBatchTimeout()

Returns the timeout value for batch transactions.

Returns:

long