Package org.frankframework.jms

Class AbstractJmsMessageBrowser<M,J extends jakarta.jms.Message>

java.lang.Object

org.frankframework.jndi.JndiBase

org.frankframework.jms.JMSFacade

org.frankframework.jms.AbstractJmsMessageBrowser<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:

HasApplicationContext, HasPhysicalDestination, IConfigurable, IMessageBrowser<M>, IScopeProvider, IXAEnabled, NameAware, org.springframework.context.Lifecycle

Direct Known Subclasses:

JmsBrowser, JmsTransactionalStorage

public abstract class AbstractJmsMessageBrowser<M,J extends jakarta.jms.Message>
extends JMSFacade
implements IMessageBrowser<M>

Basic browser of JMS Messages.

Author:

Johan Verrips

Nested Class Summary

Nested classes/interfaces inherited from class org.frankframework.jms.JMSFacade

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

Nested classes/interfaces inherited from interface org.frankframework.core.IMessageBrowser

IMessageBrowser.HideMethod, IMessageBrowser.SortOrder, IMessageBrowser.StorageType

Field Summary

Fields inherited from class org.frankframework.jms.JMSFacade

JMS_MESSAGECLASS_KEY, messagingSource

Fields inherited from class org.frankframework.jndi.JndiBase

log

Constructor Summary

Constructors

Constructor	Description
AbstractJmsMessageBrowser()
AbstractJmsMessageBrowser(String selector)

Method Summary

Modifier and Type	Method	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 jakarta.jms.Message	doBrowse(String selectorKey, String selectorValue)
protected jakarta.jms.Message	doBrowse(Map<String,String> selectors)
protected String	getCombinedSelector(String messageId)
protected String	getCombinedSelector(Map<String,String> selectors)
IMessageBrowsingIteratorItem	getContext(String messageId)	Retrieves the message context as an iteratorItem.
IMessageBrowser.HideMethod	getHideMethod()
String	getHideRegex()
IMessageBrowsingIterator	getIterator()	Gets an enumeration of messages.
IMessageBrowsingIterator	getIterator(Date startTime, Date endTime, IMessageBrowser.SortOrder order)
J	getJmsMessage(String messageId)
int	getMessageCount()
String	getSelector()
long	getTimeout()
void	setHideMethod(IMessageBrowser.HideMethod hideMethod)	(Only used when hideRegex is not empty) Specifies the way to hide
void	setHideRegex(String hideRegex)	Regular expression to mask strings in the errorStore/logStore.
void	setTimeout(long newTimeOut)	Timeout in milliseconds for receiving a message from the queue
void	setTimeOut(long newTimeOut)	Deprecated. use setTimeout(long) instead

Methods inherited from class org.frankframework.jms.JMSFacade

checkTransactionManagerValidity, closeSession, configure, createBytesMessage, createMessage, createMessage, createSession, createTextMessage, extractMessage, extractMessageBody, getAcknowledgeMode, getAuthAlias, getConnectionFactoryFactory, getConnectionFactoryInfo, getConnectionFactoryName, getContext, getCorrelationIdMaxLength, getCorrelationIdToHexPrefix, getDestination, getDestination, getDestinationName, getDestinationType, getDomain, getJmsMessagingSource, getLogPrefix, getMessageClass, getMessageConsumer, getMessageConsumer, getMessageConsumerForCorrelationId, getMessageProducer, getMessageSelector, getMessageTimeToLive, getMessagingSource, getMessagingSourceFactory, getPhysicalDestinationName, getPhysicalDestinationShortName, getPhysicalDestinationShortName, getProxiedDestinationNames, getQueueConnectionFactoryName, getSubscriberType, getTopicConnectionFactoryName, getTxManager, isCorrelationIdToHex, isJmsTransacted, isLookupDestination, isPersistent, isRunning, isSessionsArePooled, isTransacted, isUseTopicFunctions, logMessageDetails, send, send, send, send, send, send, send, sendByQueue, sendByTopic, setAcknowledgeMode, setAuthAlias, setConnectionFactoryFactory, setCorrelationIdMaxLength, setCorrelationIdToHex, setCorrelationIdToHexPrefix, setDestinationName, setDestinationType, setJmsTransacted, setLookupDestination, setMessageClass, setMessageCorrelationID, setMessageSelector, setMessageTimeToLive, setPersistent, setProxiedDestinationNames, setQueueConnectionFactoryName, setSubscriberType, setTopicConnectionFactoryName, setTransacted, setTxManager, start, stop, toString

Methods inherited from class org.frankframework.jndi.JndiBase

getApplicationContext, getAuthentication, getConfigurationClassLoader, getContext, getCredentials, getInitialContextFactoryName, getJmsRealmName, getJndiAuthAlias, getJndiContextPrefix, getJndiEnv, getJndiProperties, getName, getPrincipal, getProviderURL, getSecurityProtocol, getUrlPkgPrefixes, setApplicationContext, 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 org.frankframework.core.IMessageBrowser

browseMessage

Methods inherited from interface org.frankframework.core.IXAEnabled

isTransacted

Constructor Details

AbstractJmsMessageBrowser

public AbstractJmsMessageBrowser()

AbstractJmsMessageBrowser

public AbstractJmsMessageBrowser(String selector)

Method Details

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 jakarta.jms.Message doBrowse(Map<String,String> selectors)
                                throws ListenerException

Throws:

ListenerException

doBrowse

protected jakarta.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

@Deprecated(since="8.1")
@ConfigurationWarning("Use attribute timeout instead")
public void setTimeOut(long newTimeOut)

Deprecated.

use setTimeout(long) instead

Timeout in milliseconds for receiving a message from the queue

Default value

3000

setTimeout

public void setTimeout(long newTimeOut)

Timeout in milliseconds for receiving a message from the queue

Default value

3000

getTimeout

public long getTimeout()

getSelector

public String getSelector()

getHideRegex

public String getHideRegex()

Specified by:

getHideRegex in interface IMessageBrowser<M>

setHideRegex

public void setHideRegex(String hideRegex)

Description copied from interface: IMessageBrowser

Regular expression to mask strings in the errorStore/logStore. Every character between to the strings in this expression will be replaced by a '*'.
For example, the regular expression (?<=<party>).*?(?=</party>) will replace every character between keys <party> and </party>
When no hideRegex is configured on the errorStore / logStore but is configured on the Receiver.setHideRegex(String), then the Receiver's hideRegex is used for the errorStore / logStore.

Specified by:

setHideRegex in interface IMessageBrowser<M>

getHideMethod

public IMessageBrowser.HideMethod getHideMethod()

Specified by:

getHideMethod in interface IMessageBrowser<M>

setHideMethod

public void setHideMethod(IMessageBrowser.HideMethod hideMethod)

Description copied from interface: IMessageBrowser

(Only used when hideRegex is not empty) Specifies the way to hide

Specified by:

setHideMethod in interface IMessageBrowser<M>