nl.nn.adapterframework.jms

Class JmsMessageBrowser<M,J extends javax.jms.Message>

java.lang.Object

nl.nn.adapterframework.jndi.JndiBase

nl.nn.adapterframework.jms.JMSFacade

nl.nn.adapterframework.jms.JmsMessageBrowser<M,J>

Type Parameters:

M - the payload message type as used by IMessageBrowser.

J - the physical JMS message to carry the payload.

All Implemented Interfaces:

HasPhysicalDestination, IConfigurable, IConfigurationAware, IMessageBrowser<M>, INamedObject, IScopeProvider, IXAEnabled, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

JmsBrowser, JmsTransactionalStorage

public abstract class JmsMessageBrowser<M,J extends javax.jms.Message>
extends JMSFacade
implements IMessageBrowser<M>

Basic browser of JMS Messages.

Author:

Johan Verrips

Nested Class Summary

Nested classes/interfaces inherited from class nl.nn.adapterframework.jms.JMSFacade

JMSFacade.AcknowledgeMode, JMSFacade.DeliveryMode, JMSFacade.DestinationType, JMSFacade.SubscriberType

Nested classes/interfaces inherited from interface nl.nn.adapterframework.core.IMessageBrowser

IMessageBrowser.HideMethod, IMessageBrowser.SortOrder, IMessageBrowser.StorageType

Field Summary

Fields inherited from class nl.nn.adapterframework.jms.JMSFacade

messagingSource

Fields inherited from class nl.nn.adapterframework.jndi.JndiBase

log

Constructor Summary

Constructors

Constructor and Description
JmsMessageBrowser()
JmsMessageBrowser(String selector)

Method Summary

Modifier and Type	Method and Description
J	browseJmsMessage(String messageId)
boolean	containsCorrelationId(String correlationId)
boolean	containsMessageId(String originalMessageId) Check if the storage contains message with the given original messageId (as passed to storeMessage).
void	deleteMessage(String messageId) Deletes the message.
protected javax.jms.Message	doBrowse(Map<String,String> selectors)
protected javax.jms.Message	doBrowse(String selectorKey, String selectorValue)
protected String	getCombinedSelector(Map<String,String> selectors)
protected String	getCombinedSelector(String messageId)
IMessageBrowsingIteratorItem	getContext(String messageId) Retrieves the message context as an iteratorItem.
IMessageBrowsingIterator	getIterator() Gets an enumeration of messages.
IMessageBrowsingIterator	getIterator(Date startTime, Date endTime, IMessageBrowser.SortOrder order)
J	getJmsMessage(String messageId)
int	getMessageCount()
void	setTimeOut(long newTimeOut) Timeout in milliseconds for receiving a message from the queue

Methods inherited from class nl.nn.adapterframework.jms.JMSFacade

checkTransactionManagerValidity, close, closeSession, configure, createMessage, createSession, extractMessage, extractMessageBody, getAcknowledgeModeEnum, getConnectionFactoryInfo, getConnectionFactoryName, getContext, getDestination, getDestination, getJmsMessagingSource, getLogPrefix, getManagedConnectionFactory, getMessageConsumer, getMessageConsumer, getMessageConsumerForCorrelationId, getMessageProducer, getMessagingSource, getMessagingSourceFactory, getPhysicalDestinationName, getPhysicalDestinationShortName, getPhysicalDestinationShortName, isSessionsArePooled, logMessageDetails, open, send, send, send, send, send, send, send, sendByQueue, sendByTopic, setAckMode, setAcknowledgeMode, setAuthAlias, setCorrelationIdMaxLength, setCorrelationIdToHex, setCorrelationIdToHexPrefix, setDestinationName, setDestinationType, setJmsTransacted, setLookupDestination, setMessageCorrelationID, setMessageSelector, setMessageTimeToLive, setPersistent, setQueueConnectionFactoryName, setSubscriberType, setTopicConnectionFactoryName, setTransacted, toString, useJms102

Methods inherited from class nl.nn.adapterframework.jndi.JndiBase

getContext, getJndiEnv, setAuthentication, setCredentials, setInitialContextFactoryName, setJmsRealm, setJndiAuthAlias, setJndiContextPrefix, setJndiProperties, setName, setPrincipal, setProviderURL, setSecurityProtocol, setUrlPkgPrefixes

Methods inherited from class java.lang.Object

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

Methods inherited from interface nl.nn.adapterframework.core.IMessageBrowser

browseMessage, getHideMethod, getHideRegex, setHideMethod, setHideRegex

Methods inherited from interface nl.nn.adapterframework.core.IXAEnabled

isTransacted

Methods inherited from interface nl.nn.adapterframework.core.HasPhysicalDestination

getDomain

Methods inherited from interface nl.nn.adapterframework.core.INamedObject

getName

Methods inherited from interface nl.nn.adapterframework.core.IConfigurationAware

getApplicationContext, getName

Methods inherited from interface nl.nn.adapterframework.core.IScopeProvider

getConfigurationClassLoader

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Constructor Detail

JmsMessageBrowser

public JmsMessageBrowser()

JmsMessageBrowser

public JmsMessageBrowser(String selector)

Method Detail

getIterator

public IMessageBrowsingIterator getIterator()
                                     throws ListenerException

Description copied from interface: IMessageBrowser

Gets an enumeration of messages. This includes setting up connections, sessions etc.

Specified by:

getIterator in interface IMessageBrowser<M>

Throws:

ListenerException

getIterator

public IMessageBrowsingIterator getIterator(Date startTime,
                                            Date endTime,
                                            IMessageBrowser.SortOrder order)
                                     throws ListenerException

Specified by:

getIterator in interface IMessageBrowser<M>

Throws:

ListenerException

containsMessageId

public boolean containsMessageId(String originalMessageId)
                          throws ListenerException

Description copied from interface: IMessageBrowser

Check if the storage contains message with the given original messageId (as passed to storeMessage).

Specified by:

containsMessageId in interface IMessageBrowser<M>

Throws:

ListenerException

containsCorrelationId

public boolean containsCorrelationId(String correlationId)
                              throws ListenerException

Specified by:

containsCorrelationId in interface IMessageBrowser<M>

Throws:

ListenerException

getMessageCount

public int getMessageCount()
                    throws ListenerException

Specified by:

getMessageCount in interface IMessageBrowser<M>

Throws:

ListenerException

getJmsMessage

public J getJmsMessage(String messageId)
                throws ListenerException

Throws:

ListenerException

getContext

public IMessageBrowsingIteratorItem getContext(String messageId)
                                        throws ListenerException

Description copied from interface: IMessageBrowser

Retrieves the message context as an iteratorItem. The result can be used in the methods above that use an iteratorItem. Use this method as try-with-resources to close the connections.

Specified by:

getContext in interface IMessageBrowser<M>

Throws:

ListenerException

browseJmsMessage

public J browseJmsMessage(String messageId)
                   throws ListenerException

Throws:

ListenerException

doBrowse

protected javax.jms.Message doBrowse(Map<String,String> selectors)
                              throws ListenerException

Throws:

ListenerException

doBrowse

protected javax.jms.Message doBrowse(String selectorKey,
                                     String selectorValue)
                              throws ListenerException

Throws:

ListenerException

deleteMessage

public void deleteMessage(String messageId)
                   throws ListenerException

Description copied from interface: IMessageBrowser

Deletes the message.

Specified by:

deleteMessage in interface IMessageBrowser<M>

Throws:

ListenerException

getCombinedSelector

protected String getCombinedSelector(String messageId)

getCombinedSelector

protected String getCombinedSelector(Map<String,String> selectors)

setTimeOut

public void setTimeOut(long newTimeOut)

Timeout in milliseconds for receiving a message from the queue

Default value

3000