Package org.frankframework.jms

Class JmsTransactionalStorage<S extends Serializable>

java.lang.Object

org.frankframework.jndi.JndiBase

org.frankframework.jms.JMSFacade

org.frankframework.jms.AbstractJmsMessageBrowser<S,jakarta.jms.ObjectMessage>

org.frankframework.jms.JmsTransactionalStorage<S>

All Implemented Interfaces:

FrankElement, HasApplicationContext, HasName, HasPhysicalDestination, IConfigurable, IMessageBrowser<S>, IScopeProvider, ITransactionalStorage<S>, IXAEnabled, NameAware, ConfigurableLifecycle, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle

Direct Known Subclasses:

EsbJmsTransactionalStorage

public class JmsTransactionalStorage<S extends Serializable>
extends AbstractJmsMessageBrowser<S,jakarta.jms.ObjectMessage>
implements ITransactionalStorage<S>

Implements a message log (JmsMessageLog) or error store (JmsErrorStorage) that uses JMS technology.

Message log: A message log writes messages in persistent storage for logging purposes. When a message log appears in a receiver, it also ensures that the same message is only processed once, even if a related pushing listener receives the same message multiple times.

Error store: Appears in a receiver or sender pipe to store messages that could not be processed. Storing a message in the error store is the last resort of the Frank!Framework. Many types of listeners and senders offer a retry mechanism. Only if several tries have failed, then an optional transaction is not rolled back and the message is stored in the error store. Users can retry messages in an error store using the Frank!Console. When this is done, the message is processed in the same way as messages received from the original source.

How does a message log or error store see duplicate messages? The message log or error store always appears in combination with a sender or listener. This sender or listener determines a key based on the sent or received message. Messages with the same key are considered to be the same.

Since:

4.1

Author:

Gerrit van Brakel

Nested Class Summary

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

JMSFacade.AcknowledgeMode, JMSFacade.DeliveryMode, JMSFacade.JmsDestinationType, JMSFacade.MessageClass, JMSFacade.SubscriberType

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

IMessageBrowser.HideMethod, IMessageBrowser.SortOrder, IMessageBrowser.StorageType

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FIELD_COMMENTS
static final String	FIELD_HOST
static final String	FIELD_LABEL
static final String	FIELD_ORIGINAL_ID
static final String	FIELD_RECEIVED_DATE
static final String	FIELD_SLOTID
static final String	FIELD_TYPE

Fields inherited from class org.frankframework.jms.JMSFacade

JMS_MESSAGECLASS_KEY, log, messagingSource

Fields inherited from interface org.frankframework.core.ITransactionalStorage

MAXCOMMENTLEN

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor	Description
JmsTransactionalStorage()

Method Summary

Modifier and Type	Method	Description
RawMessageWrapper<S>	browseMessage(String storageKey)	Retrieves the message, but does not delete.
RawMessageWrapper<S>	consumeMessage(String storageKey)	Retrieves and deletes the message.
boolean	containsMessageId(String originalMessageId)	Check if the storage contains message with the given original messageId (as passed to storeMessage).
String	getSelector()
String	getSlotId()
String	getType()
void	setSlotId(String string)	Optional identifier for this storage, to be able to share the physical storage between a number of receivers and pipes.
void	setType(String string)	Possible values are E (error store), M (message store), L (message log for Pipe) or A (message log for Receiver). Receiver will always set type to E for errorStorage and always set type to A for messageLog.
String	storeMessage(String messageId, String correlationId, Date receivedDate, String comments, String label, S message)	Store the message, returns storageKey.

Methods inherited from class org.frankframework.jms.AbstractJmsMessageBrowser

browseJmsMessage, containsCorrelationId, deleteMessage, doBrowse, doBrowse, getCombinedSelector, getCombinedSelector, getContext, getIterator, getIterator, getJmsMessage, getMessageCount, getStorageFields, setTimeout

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, getPhysicalDestinationName, getPhysicalDestinationShortName, getPhysicalDestinationShortName, isRunning, isSessionsArePooled, logMessageDetails, send, send, send, send, send, sendByQueue, sendByTopic, setAcknowledgeMode, setAuthAlias, setCorrelationIdMaxLength, setCorrelationIdToHex, setCorrelationIdToHexPrefix, setDestinationName, setDestinationType, setJndiContextPrefix, setLookupDestination, setMessageClass, setMessageCorrelationID, setMessageSelector, setMessageTimeToLive, setName, setPersistent, setQueueConnectionFactoryName, setSubscriberType, setTopicConnectionFactoryName, setTransacted, start, stop, toString

Methods inherited from class org.frankframework.jndi.JndiBase

getContext, getJndiEnv, setAuthentication, setCredentials, setInitialContextFactoryName, setJmsRealm, setJndiAuthAlias, setJndiProperties, 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.springframework.context.ApplicationContextAware

setApplicationContext

Methods inherited from interface org.frankframework.lifecycle.ConfigurableLifecycle

getPhase, isAutoStartup, isConfigured

Methods inherited from interface org.frankframework.core.FrankElement

addConfigWarning

Methods inherited from interface org.frankframework.core.HasApplicationContext

getApplicationContext, getConfigurationClassLoader

Methods inherited from interface org.frankframework.core.HasName

getName

Methods inherited from interface org.frankframework.core.IMessageBrowser

containsCorrelationId, deleteMessage, getContext, getHideMethod, getHideRegex, getIterator, getIterator, getMessageCount, getStorageFields, setHideMethod, setHideRegex

Methods inherited from interface org.frankframework.core.ITransactionalStorage

configure, start, stop

Methods inherited from interface org.frankframework.core.IXAEnabled

isTransacted

Methods inherited from interface org.frankframework.core.NameAware

setName

Methods inherited from interface org.springframework.context.SmartLifecycle

stop

Field Details

FIELD_TYPE

public static final String FIELD_TYPE

See Also:

• Constant Field Values

FIELD_ORIGINAL_ID

public static final String FIELD_ORIGINAL_ID

See Also:

• Constant Field Values

FIELD_RECEIVED_DATE

public static final String FIELD_RECEIVED_DATE

See Also:

• Constant Field Values

FIELD_COMMENTS

public static final String FIELD_COMMENTS

See Also:

• Constant Field Values

FIELD_SLOTID

public static final String FIELD_SLOTID

See Also:

• Constant Field Values

FIELD_HOST

public static final String FIELD_HOST

See Also:

• Constant Field Values

FIELD_LABEL

public static final String FIELD_LABEL

See Also:

• Constant Field Values

Constructor Details

JmsTransactionalStorage

public JmsTransactionalStorage()

Method Details

storeMessage

public String storeMessage(String messageId,
 String correlationId,
 Date receivedDate,
 String comments,
 String label,
 S message)
                    throws SenderException

Description copied from interface: ITransactionalStorage

Store the message, returns storageKey. The messageId should be unique.

Specified by:

storeMessage in interface ITransactionalStorage<S extends Serializable>

Throws:

SenderException

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<S extends Serializable>

Overrides:

containsMessageId in class AbstractJmsMessageBrowser<S extends Serializable,jakarta.jms.ObjectMessage>

Throws:

ListenerException

browseMessage

public RawMessageWrapper<S> browseMessage(String storageKey)
                                   throws ListenerException

Description copied from interface: IMessageBrowser

Retrieves the message, but does not delete.

Specified by:

browseMessage in interface IMessageBrowser<S extends Serializable>

Throws:

ListenerException

consumeMessage

public RawMessageWrapper<S> consumeMessage(String storageKey)
                                    throws ListenerException

Description copied from interface: ITransactionalStorage

Retrieves and deletes the message.

Specified by:

consumeMessage in interface ITransactionalStorage<S extends Serializable>

Throws:

ListenerException

getSelector

public String getSelector()

setSlotId

@ReferTo(ITransactionalStorage.class)
public void setSlotId(String string)

Description copied from interface: ITransactionalStorage

Optional identifier for this storage, to be able to share the physical storage between a number of receivers and pipes.

Specified by:

setSlotId in interface ITransactionalStorage<S extends Serializable>

getSlotId

public String getSlotId()

Specified by:

getSlotId in interface ITransactionalStorage<S extends Serializable>

setType

@ReferTo(ITransactionalStorage.class)
public void setType(String string)

Description copied from interface: ITransactionalStorage

Possible values are E (error store), M (message store), L (message log for Pipe) or A (message log for Receiver).
Receiver will always set type to E for errorStorage and always set type to A for messageLog. SenderPipe will set type to L for messageLog (when type isn't specified).
See MessageStoreSender for type M.

Specified by:

setType in interface ITransactionalStorage<S extends Serializable>

getType

public String getType()

Specified by:

getType in interface ITransactionalStorage<S extends Serializable>