org.apache.uima.adapter.jms.activemq

Class JmsInputChannel

java.lang.Object

org.apache.uima.adapter.jms.activemq.JmsInputChannel

All Implemented Interfaces:

Serializable, Channel, InputChannel, JmsInputChannelMBean, org.springframework.jms.listener.SessionAwareMessageListener

public class JmsInputChannel
extends Object
implements InputChannel, JmsInputChannelMBean, org.springframework.jms.listener.SessionAwareMessageListener

Thin adapter for receiving JMS messages from Spring. It delegates processing of all messages to the Handler. Each JMS Message is wrapped in transport neutral MessageContext wrapper.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	attachToBrokerMBeanServer

Fields inherited from interface org.apache.uima.aae.Channel

CloseAllChannels, InputChannels

Constructor Summary

Constructors

Constructor and Description
JmsInputChannel()

Method Summary

Modifier and Type	Method and Description
void	abort()
void	ackMessage(MessageContext aMessageContext)
void	createListener(String aDelegateKey, Endpoint endpointToUpdate)
void	destroyListener(String anEndpointName, String aDelegateKey)
String	getBrokerURL()
int	getConcurrentConsumerCount()
org.apache.activemq.ActiveMQConnectionFactory	getConnectionFactory()
AnalysisEngineController	getController()
String	getInputQueueName()
String	getName()
String	getServerUri()
ServiceInfo	getServiceInfo()
int	getSessionAckMode()
boolean	isFailed(String aDelegateKey)
boolean	isListenerActiveOnDestination(javax.jms.Destination destination)
boolean	isListenerForDestination(String anEndpointName)
boolean	isStopped()
void	onMessage(javax.jms.Message aMessage, javax.jms.Session aJmsSession) Receives Messages from the JMS Provider.
void	removeDelegateFromFailedList(String aDelegateKey)
void	setController(AnalysisEngineController aController)
void	setEndpointName(String anEndpointName)
void	setListenerContainer(UimaDefaultMessageListenerContainer messageListener)
void	setMessageHandler(Handler aHandler)
void	setServerUri(String serverUri)
void	setTerminating()
void	stop()
void	stop(int channelsToClose)
void	terminate()
boolean	validMessage(javax.jms.Message aMessage) Validates contents of the message.

Methods inherited from class java.lang.Object

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

Field Detail

attachToBrokerMBeanServer

public static transient boolean attachToBrokerMBeanServer

Constructor Detail

JmsInputChannel

public JmsInputChannel()

Method Detail

getController

public AnalysisEngineController getController()

getName

public String getName()

Specified by:

getName in interface Channel

setController

public void setController(AnalysisEngineController aController)
                   throws Exception

Throws:

Exception

setMessageHandler

public void setMessageHandler(Handler aHandler)

setEndpointName

public void setEndpointName(String anEndpointName)

validMessage

public boolean validMessage(javax.jms.Message aMessage)
                     throws Exception

Validates contents of the message. It checks if command, payload and message types contain valid data.

Parameters:

aMessage - - JMS Message to validate

Returns:

- true if message is valid, false otherwise

Throws:

Exception

abort

public void abort()

onMessage

public void onMessage(javax.jms.Message aMessage,
                      javax.jms.Session aJmsSession)

Receives Messages from the JMS Provider. It checks the message header to determine the type of message received. Based on the type, a MessageContext is created to facilitate access to the transport specific message. Once the MessageContext is determined this routine delegates handling of the message to the chain of MessageHandlers.

Specified by:

onMessage in interface org.springframework.jms.listener.SessionAwareMessageListener

Parameters:

aMessage - - JMS Message containing header and payload

aJmsSession - - JMSSession object

getSessionAckMode

public int getSessionAckMode()

Specified by:

getSessionAckMode in interface InputChannel

getServerUri

public String getServerUri()

Specified by:

getServerUri in interface InputChannel

setListenerContainer

public void setListenerContainer(UimaDefaultMessageListenerContainer messageListener)

getConnectionFactory

public org.apache.activemq.ActiveMQConnectionFactory getConnectionFactory()

ackMessage

public void ackMessage(MessageContext aMessageContext)

Specified by:

ackMessage in interface InputChannel

getBrokerURL

public String getBrokerURL()

Specified by:

getBrokerURL in interface JmsInputChannelMBean

getInputQueueName

public String getInputQueueName()

Specified by:

getInputQueueName in interface InputChannel

Specified by:

getInputQueueName in interface JmsInputChannelMBean

getServiceInfo

public ServiceInfo getServiceInfo()

Specified by:

getServiceInfo in interface InputChannel

setServerUri

public void setServerUri(String serverUri)

Specified by:

setServerUri in interface InputChannel

stop

public void stop()
          throws Exception

Specified by:

stop in interface Channel

Throws:

Exception

setTerminating

public void setTerminating()

Specified by:

setTerminating in interface InputChannel

terminate

public void terminate()

Specified by:

terminate in interface InputChannel

stop

public void stop(int channelsToClose)
          throws Exception

Specified by:

stop in interface Channel

Throws:

Exception

isStopped

public boolean isStopped()

Specified by:

isStopped in interface InputChannel

getConcurrentConsumerCount

public int getConcurrentConsumerCount()

Specified by:

getConcurrentConsumerCount in interface InputChannel

createListener

public void createListener(String aDelegateKey,
                           Endpoint endpointToUpdate)
                    throws Exception

Specified by:

createListener in interface InputChannel

Throws:

Exception

isListenerActiveOnDestination

public boolean isListenerActiveOnDestination(javax.jms.Destination destination)

destroyListener

public void destroyListener(String anEndpointName,
                            String aDelegateKey)

Specified by:

destroyListener in interface InputChannel

isFailed

public boolean isFailed(String aDelegateKey)

Specified by:

isFailed in interface InputChannel

removeDelegateFromFailedList

public void removeDelegateFromFailedList(String aDelegateKey)

Specified by:

removeDelegateFromFailedList in interface InputChannel

isListenerForDestination

public boolean isListenerForDestination(String anEndpointName)

Specified by:

isListenerForDestination in interface InputChannel