org.ikasan.component.endpoint.jms.consumer

Class GenericJmsConsumer

java.lang.Object

org.ikasan.component.endpoint.jms.consumer.GenericJmsConsumer

All Implemented Interfaces:

Consumer<EventListener<?>,EventFactory>, EndpointListener<javax.jms.Message,Throwable>, Configured<GenericJmsConsumerConfiguration>, ConfiguredResource<GenericJmsConsumerConfiguration>, ManagedIdentifierService<ManagedEventIdentifierService>, ResubmissionService<javax.jms.Message>

public class GenericJmsConsumer
extends Object
implements Consumer<EventListener<?>,EventFactory>, ManagedIdentifierService<ManagedEventIdentifierService>, EndpointListener<javax.jms.Message,Throwable>, ConfiguredResource<GenericJmsConsumerConfiguration>, ResubmissionService<javax.jms.Message>

Implementation of a generic client consumer based on the JMS specification.

Author:

Ikasan Development Team

Field Summary

Fields

Modifier and Type	Field and Description
protected GenericJmsConsumerConfiguration	configuration JMS consumer configuration - default to vanilla instance
protected String	configuredResourceId configured resource id
protected javax.jms.Connection	connection JMS Connection
protected javax.jms.ConnectionFactory	connectionFactory JMS Connection Factory
protected javax.jms.Destination	destination JMS Destination instance
protected DestinationResolver	destinationResolver destination resolver for locating and returning the configured destination instance
protected EventListener	eventListener consumer event listener
protected EventFactory<FlowEvent<?,?>>	flowEventFactory consumer event factory
protected ManagedEventIdentifierService<?,javax.jms.Message>	managedEventIdentifierService default event identifier service - can be overridden via the setter
protected javax.jms.MessageConsumer	messageConsumer session message consumer
protected javax.jms.MessageListener	messageListener tech endpoint listener for callbacks from the endpoint
protected javax.jms.Session	session session has to be closed prior to connection being closed

Constructor Summary

Constructors

Constructor and Description
GenericJmsConsumer() Default constructor
GenericJmsConsumer(javax.jms.ConnectionFactory connectionFactory, javax.jms.Destination destination) Constructor
GenericJmsConsumer(javax.jms.ConnectionFactory connectionFactory, DestinationResolver destinationResolver) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
protected Object	extractContent(javax.jms.Message message)
GenericJmsConsumerConfiguration	getConfiguration()
String	getConfiguredResourceId()
EventFactory	getEventFactory()
boolean	isActive()
boolean	isRunning() Is the underlying JMS actively running
void	onException(Throwable jmsException) Callback method from the JMS connector for exception reporting.
void	onMessage(javax.jms.Message message) Callback method from the underlying JMS tech.
void	setConfiguration(GenericJmsConsumerConfiguration configuration)
void	setConfiguredResourceId(String configuredResourceId)
void	setEventFactory(EventFactory flowEventFactory)
void	setListener(EventListener eventListener) Set the consumer event listener
void	setManagedIdentifierService(ManagedEventIdentifierService managedEventIdentifierService) Override the default consumer event life identifier service
void	setMessageListener(javax.jms.MessageListener messageListener)
void	start() Start the underlying JMS
void	stop() Stop the underlying JMS
void	submit(javax.jms.Message event)

Methods inherited from class java.lang.Object

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

Field Detail

connectionFactory

protected javax.jms.ConnectionFactory connectionFactory

JMS Connection Factory

destination

protected javax.jms.Destination destination

JMS Destination instance

connection

protected javax.jms.Connection connection

JMS Connection

session

protected javax.jms.Session session

session has to be closed prior to connection being closed

flowEventFactory

protected EventFactory<FlowEvent<?,?>> flowEventFactory

consumer event factory

eventListener

protected EventListener eventListener

consumer event listener

managedEventIdentifierService

protected ManagedEventIdentifierService<?,javax.jms.Message> managedEventIdentifierService

default event identifier service - can be overridden via the setter

configuredResourceId

protected String configuredResourceId

configured resource id

configuration

protected GenericJmsConsumerConfiguration configuration

JMS consumer configuration - default to vanilla instance

messageListener

protected javax.jms.MessageListener messageListener

tech endpoint listener for callbacks from the endpoint

destinationResolver

protected DestinationResolver destinationResolver

destination resolver for locating and returning the configured destination instance

messageConsumer

protected javax.jms.MessageConsumer messageConsumer

session message consumer

Constructor Detail

GenericJmsConsumer

public GenericJmsConsumer()

Default constructor

GenericJmsConsumer

public GenericJmsConsumer(javax.jms.ConnectionFactory connectionFactory,
                  javax.jms.Destination destination)

Constructor

Parameters:

connectionFactory -

destination -

GenericJmsConsumer

public GenericJmsConsumer(javax.jms.ConnectionFactory connectionFactory,
                  DestinationResolver destinationResolver)

Constructor

Parameters:

connectionFactory -

destinationResolver -

Method Detail

setMessageListener

public void setMessageListener(javax.jms.MessageListener messageListener)

setEventFactory

public void setEventFactory(EventFactory flowEventFactory)

Specified by:

setEventFactory in interface Consumer<EventListener<?>,EventFactory>

start

public void start()

Start the underlying JMS

Specified by:

start in interface Consumer<EventListener<?>,EventFactory>

isActive

public boolean isActive()

Specified by:

isActive in interface EndpointListener<javax.jms.Message,Throwable>

stop

public void stop()

Stop the underlying JMS

Specified by:

stop in interface Consumer<EventListener<?>,EventFactory>

isRunning

public boolean isRunning()

Is the underlying JMS actively running

Specified by:

isRunning in interface Consumer<EventListener<?>,EventFactory>

Returns:

boolean

setListener

public void setListener(EventListener eventListener)

Set the consumer event listener

Specified by:

setListener in interface Consumer<EventListener<?>,EventFactory>

Parameters:

eventListener -

setManagedIdentifierService

public void setManagedIdentifierService(ManagedEventIdentifierService managedEventIdentifierService)

Override the default consumer event life identifier service

Specified by:

setManagedIdentifierService in interface ManagedIdentifierService<ManagedEventIdentifierService>

Parameters:

managedEventIdentifierService -

onMessage

public void onMessage(javax.jms.Message message)

Callback method from the underlying JMS tech. On invocation this method creates a flowEvent from the tech specific message and invokes the event listener.

Specified by:

onMessage in interface EndpointListener<javax.jms.Message,Throwable>

submit

public void submit(javax.jms.Message event)

Specified by:

submit in interface ResubmissionService<javax.jms.Message>

extractContent

protected Object extractContent(javax.jms.Message message)
                         throws javax.jms.JMSException

Throws:

javax.jms.JMSException

onException

public void onException(Throwable jmsException)

Callback method from the JMS connector for exception reporting.

Specified by:

onException in interface EndpointListener<javax.jms.Message,Throwable>

Parameters:

jmsException -

getConfiguration

public GenericJmsConsumerConfiguration getConfiguration()

Specified by:

getConfiguration in interface Configured<GenericJmsConsumerConfiguration>

getConfiguredResourceId

public String getConfiguredResourceId()

Specified by:

getConfiguredResourceId in interface ConfiguredResource<GenericJmsConsumerConfiguration>

setConfiguration

public void setConfiguration(GenericJmsConsumerConfiguration configuration)

Specified by:

setConfiguration in interface Configured<GenericJmsConsumerConfiguration>

setConfiguredResourceId

public void setConfiguredResourceId(String configuredResourceId)

Specified by:

setConfiguredResourceId in interface ConfiguredResource<GenericJmsConsumerConfiguration>

getEventFactory

public EventFactory getEventFactory()

Specified by:

getEventFactory in interface Consumer<EventListener<?>,EventFactory>