com.adaptris.core.jms

Class PasConsumer

java.lang.Object

com.adaptris.core.AdaptrisMessageWorkerImp

com.adaptris.core.AdaptrisMessageConsumerImp

com.adaptris.core.jms.JmsConsumerImpl

com.adaptris.core.jms.PasConsumer

All Implemented Interfaces:

AdaptrisComponent, AdaptrisMessageConsumer, AdaptrisMessageWorker, ComponentLifecycle, ComponentLifecycleExtension, JmsActorConfig, MessageEventGenerator, StateManagedComponent, javax.jms.MessageListener

@ComponentProfile(summary="Listen for JMS messages on the specified topic",
                  tag="consumer,jms",
                  recommended=JmsConnection.class)
public class PasConsumer
extends JmsConsumerImpl

JMS Publish-and-subscribe implementation of AdaptrisMessageConsumer.

In the adapter configuration file this class is aliased as jms-topic-consumer which is the preferred alternative to the fully qualified classname when building your configuration.

Field Summary

Fields inherited from class com.adaptris.core.jms.JmsConsumerImpl

consumer

Fields inherited from class com.adaptris.core.AdaptrisMessageWorkerImp

log

Fields inherited from interface com.adaptris.core.MessageEventGenerator

CONFIRMATION_ID_KEY

Constructor Summary

Constructors

Constructor and Description
PasConsumer()
PasConsumer(ConsumeDestination d)

Method Summary

Modifier and Type	Method and Description
protected javax.jms.MessageConsumer	createConsumer()
java.lang.Boolean	getDurable() Returns whether this consumer is durable.
java.lang.String	getSubscriptionId() Returns the subscription ID to use for durable subscriptions.
void	setDurable(java.lang.Boolean b) Sets whether this consumer is durable.
void	setSubscriptionId(java.lang.String s) Sets the subscription ID to use for durable subscriptions.

Methods inherited from class com.adaptris.core.jms.JmsConsumerImpl

close, configuredAcknowledgeMode, configuredCorrelationIdSource, configuredMessageListener, configuredMessageTranslator, currentLogger, currentSession, getAcknowledgeMode, getCorrelationIdSource, getMessageTranslator, init, isManagedTransaction, onMessage, prepare, rollbackTimeout, setAcknowledgeMode, setCorrelationIdSource, setManagedTransaction, setMessageTranslator, start, stop

Methods inherited from class com.adaptris.core.AdaptrisMessageConsumerImp

changeState, getDestination, registerAdaptrisMessageListener, renameThread, requestClose, requestInit, requestStart, requestStop, retrieveAdaptrisMessageListener, retrieveComponentState, setDestination

Methods inherited from class com.adaptris.core.AdaptrisMessageWorkerImp

createName, createQualifier, decode, encode, getEncoder, getIsConfirmation, getIsTrackingEndpoint, getMessageFactory, getUniqueId, handleConnectionException, isConfirmation, isTrackingEndpoint, registerConnection, registerEncoderMessageFactory, retrieveConnection, setEncoder, setIsConfirmation, setIsTrackingEndpoint, setMessageFactory, setUniqueId, withMessageFactory

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.adaptris.core.AdaptrisMessageWorker

decode, encode, getEncoder, getMessageFactory, handleConnectionException, registerConnection, retrieveConnection, setEncoder, setMessageFactory

Methods inherited from interface com.adaptris.core.AdaptrisComponent

getUniqueId

Methods inherited from interface com.adaptris.core.MessageEventGenerator

createName, createQualifier, isConfirmation, isTrackingEndpoint

Constructor Detail

PasConsumer

public PasConsumer()

PasConsumer

public PasConsumer(ConsumeDestination d)

Method Detail

createConsumer

protected javax.jms.MessageConsumer createConsumer()
                                            throws javax.jms.JMSException,
                                                   CoreException

Specified by:

createConsumer in class JmsConsumerImpl

Throws:

javax.jms.JMSException

CoreException

setDurable

public void setDurable(java.lang.Boolean b)

Sets whether this consumer is durable.

Parameters:

b - whether this consumer is durable

getDurable

public java.lang.Boolean getDurable()

Returns whether this consumer is durable.

Returns:

whether this consumer is durable

setSubscriptionId

public void setSubscriptionId(java.lang.String s)

Sets the subscription ID to use for durable subscriptions. This must remain constant for the same durable subscription to be accessed each time messages are consumed.

Parameters:

s - the subscription ID to use for durable subscriptions

getSubscriptionId

public java.lang.String getSubscriptionId()

Returns the subscription ID to use for durable subscriptions.

Returns:

the subscription ID to use for durable subscriptions