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
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbrowseJmsMessage
(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
protected jakarta.jms.Message
protected String
getCombinedSelector
(String messageId) protected String
getCombinedSelector
(Map<String, String> selectors) getContext
(String messageId) Retrieves the message context as an iteratorItem.Gets an enumeration of messages.getIterator
(Date startTime, Date endTime, IMessageBrowser.SortOrder order) getJmsMessage
(String messageId) int
void
setTimeout
(long newTimeOut) Timeout in milliseconds for receiving a message from the queuevoid
setTimeOut
(long newTimeOut) Deprecated.Methods inherited from class org.frankframework.jms.JMSFacade
checkTransactionManagerValidity, closeSession, configure, createBytesMessage, createMessage, createMessage, createSession, createTextMessage, extractMessage, extractMessageBody, getConnectionFactoryName, getContext, getDestination, getDestination, getJmsMessagingSource, getLogPrefix, getMessageConsumer, getMessageConsumer, getMessageConsumerForCorrelationId, getMessageProducer, getMessagingSource, getMessagingSourceFactory, getPhysicalDestinationName, getPhysicalDestinationShortName, getPhysicalDestinationShortName, isRunning, isSessionsArePooled, logMessageDetails, send, send, send, send, send, send, send, sendByQueue, sendByTopic, setAcknowledgeMode, setAuthAlias, setCorrelationIdMaxLength, setCorrelationIdToHex, setCorrelationIdToHexPrefix, setDestinationName, setDestinationType, setLookupDestination, setMessageClass, setMessageCorrelationID, setMessageSelector, setMessageTimeToLive, setPersistent, setQueueConnectionFactoryName, setSubscriberType, setTopicConnectionFactoryName, setTransacted, start, stop, toString
Methods inherited from class org.frankframework.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 org.frankframework.core.HasApplicationContext
getApplicationContext, getConfigurationClassLoader
Methods inherited from interface org.frankframework.core.HasPhysicalDestination
getDomain
Methods inherited from interface org.frankframework.core.IMessageBrowser
browseMessage, getHideMethod, getHideRegex, setHideMethod, setHideRegex
Methods inherited from interface org.frankframework.core.IXAEnabled
isTransacted
-
Constructor Details
-
AbstractJmsMessageBrowser
public AbstractJmsMessageBrowser() -
AbstractJmsMessageBrowser
-
-
Method Details
-
getIterator
Description copied from interface:IMessageBrowser
Gets an enumeration of messages. This includes setting up connections, sessions etc.- Specified by:
getIterator
in interfaceIMessageBrowser<M>
- Throws:
ListenerException
-
getIterator
public IMessageBrowsingIterator getIterator(Date startTime, Date endTime, IMessageBrowser.SortOrder order) throws ListenerException - Specified by:
getIterator
in interfaceIMessageBrowser<M>
- Throws:
ListenerException
-
containsMessageId
Description copied from interface:IMessageBrowser
Check if the storage contains message with the given original messageId (as passed to storeMessage).- Specified by:
containsMessageId
in interfaceIMessageBrowser<M>
- Throws:
ListenerException
-
containsCorrelationId
- Specified by:
containsCorrelationId
in interfaceIMessageBrowser<M>
- Throws:
ListenerException
-
getMessageCount
- Specified by:
getMessageCount
in interfaceIMessageBrowser<M>
- Throws:
ListenerException
-
getJmsMessage
- Throws:
ListenerException
-
getContext
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 interfaceIMessageBrowser<M>
- Throws:
ListenerException
-
browseJmsMessage
- Throws:
ListenerException
-
doBrowse
- Throws:
ListenerException
-
doBrowse
protected jakarta.jms.Message doBrowse(String selectorKey, String selectorValue) throws ListenerException - Throws:
ListenerException
-
deleteMessage
Description copied from interface:IMessageBrowser
Deletes the message.- Specified by:
deleteMessage
in interfaceIMessageBrowser<M>
- Throws:
ListenerException
-
getCombinedSelector
-
getCombinedSelector
-
setTimeOut
@Deprecated(since="8.1") @ConfigurationWarning("Use attribute timeout instead") public void setTimeOut(long newTimeOut) Deprecated.usesetTimeout(long)
insteadTimeout 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
-
setTimeout(long)
instead