io.micronaut.jms.listener

Class JMSListenerContainer<T>

java.lang.Object

io.micronaut.jms.listener.JMSListenerContainer<T>

Type Parameters:

T - the Message object type to convert to before handling

public class JMSListenerContainer<T>
extends java.lang.Object

Sets up and manages MessageListeners created by the JMSListener and AbstractJMSListenerMethodProcessor processing. There is support for programmatically instantiating listeners however this has not been fully incorporated into a coherent API yet and has not been fully tested. It is recommended to instead use the JMSListener annotation on existing classes.

Since:

1.0.0

Author:

Elliott Pope

Constructor Summary

Constructors

Constructor and Description
JMSListenerContainer(JMSConnectionPool connectionPool, JMSDestinationType type, int threadPoolSize)
JMSListenerContainer(JMSConnectionPool connectionPool, JMSDestinationType type, int threadPoolSize, int maxThreadPoolSize)

Method Summary

Modifier and Type	Method and Description
void	registerListener(java.lang.String destination, MessageHandler<T> listener, java.lang.Class<T> clazz) Registers a JMSListenerContainer with default concurrency.
void	registerListener(java.lang.String destination, javax.jms.MessageListener listener, java.lang.Class<T> clazz, boolean transacted, int acknowledgeMode) Internal method used by the JMSListenerContainerFactory for registering new listeners.
boolean	shutdown() Safely shuts down all open connections linked to the listener container.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

JMSListenerContainer

public JMSListenerContainer(JMSConnectionPool connectionPool,
                            JMSDestinationType type,
                            int threadPoolSize)

Parameters:

connectionPool - the JMSConnectionPool to pull Connections from to create MessageListeners

type - either JMSDestinationType.QUEUE or JMSDestinationType.TOPIC.

threadPoolSize - the pool size

JMSListenerContainer

public JMSListenerContainer(JMSConnectionPool connectionPool,
                            JMSDestinationType type,
                            int threadPoolSize,
                            int maxThreadPoolSize)

Parameters:

connectionPool - the JMSConnectionPool to pull Connections from to create MessageListeners

type - either JMSDestinationType.QUEUE or JMSDestinationType.TOPIC.

threadPoolSize - the minimum core thread pool size

maxThreadPoolSize - the maximum number of threads to use handling incoming requests

Method Detail

registerListener

public void registerListener(java.lang.String destination,
                             MessageHandler<T> listener,
                             java.lang.Class<T> clazz)

Registers a JMSListenerContainer with default concurrency.

NOTE: this method is not recommended; instead use the annotation driven JMSListener

Parameters:

destination - the queue or topic name

listener - the message handler

clazz - the message type

registerListener

public void registerListener(java.lang.String destination,
                             javax.jms.MessageListener listener,
                             java.lang.Class<T> clazz,
                             boolean transacted,
                             int acknowledgeMode)

Internal method used by the JMSListenerContainerFactory for registering new listeners.

NOTE: this method is used internally by the AbstractJMSListenerMethodProcessor and is not recommended for use. Instead the annotation driven JMSListener is preferred.

Parameters:

destination - the queue or topic name

listener - the message handler

clazz - the message type

transacted - indicates whether the session will use a local transaction

acknowledgeMode - when transacted is false, indicates how messages received by the session will be acknowledged

See Also:

Session.AUTO_ACKNOWLEDGE, Session.CLIENT_ACKNOWLEDGE, Session.DUPS_OK_ACKNOWLEDGE

shutdown

@PreDestroy
public boolean shutdown()

Safely shuts down all open connections linked to the listener container. To be executed when the bean is destroyed.

Returns:

true if all open connections are successfully closed

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object