Package 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

Constructor Summary

Constructors

Constructor	Description
PasConsumer()

Method Summary

Modifier and Type	Method	Description
protected java.lang.String	configuredEndpoint()
protected javax.jms.MessageConsumer	createConsumer()
java.lang.String	getSubscriptionId()	Our subscription ID.
java.lang.String	getTopic()	The JMS Topic
void	prepare()	Prepare for initialisation.
void	setSubscriptionId(java.lang.String subscriptionId)	Our subscription ID.
void	setTopic(java.lang.String topic)	The JMS Topic
protected java.lang.String	subscriptionId()
PasConsumer	withTopic(java.lang.String t)

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

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

Methods inherited from class com.adaptris.core.AdaptrisMessageConsumerImp

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

Methods inherited from class com.adaptris.core.AdaptrisMessageWorkerImp

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

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.AdaptrisComponent

getUniqueId

Methods inherited from interface com.adaptris.core.AdaptrisMessageWorker

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

Methods inherited from interface com.adaptris.core.MessageEventGenerator

createName, createQualifier, isTrackingEndpoint

Constructor Detail

PasConsumer

public PasConsumer()

Method Detail

subscriptionId

protected java.lang.String subscriptionId()

prepare

public void prepare()
             throws CoreException

Description copied from interface: ComponentLifecycleExtension

Prepare for initialisation.

Specified by:

prepare in interface ComponentLifecycleExtension

Overrides:

prepare in class JmsConsumerImpl

Throws:

CoreException

configuredEndpoint

protected java.lang.String configuredEndpoint()

Specified by:

configuredEndpoint in class JmsConsumerImpl

createConsumer

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

Specified by:

createConsumer in class JmsConsumerImpl

Throws:

javax.jms.JMSException

CoreException

withTopic

public PasConsumer withTopic(java.lang.String t)

getSubscriptionId

public java.lang.String getSubscriptionId()

Our subscription ID.

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.

setSubscriptionId

public void setSubscriptionId(java.lang.String subscriptionId)

Our subscription ID.

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.

getTopic

public java.lang.String getTopic()

The JMS Topic

setTopic

public void setTopic(java.lang.String topic)

The JMS Topic