Class EsbJmsTransactionalStorage

java.lang.Object

org.frankframework.jndi.JndiBase

org.frankframework.jms.JMSFacade

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

org.frankframework.jms.JmsTransactionalStorage

org.frankframework.extensions.esb.EsbJmsTransactionalStorage

All Implemented Interfaces:

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

@Category(NN_SPECIAL)
public class EsbJmsTransactionalStorage
extends JmsTransactionalStorage

ESB (Enterprise Service Bus) extension of JmsTransactionalStorage.

Depending on the type of the TransactionalStorage one of the following messages is sent:

• errorStore: ESB.Infrastructure.US.Log.BusinessLog.2.ExceptionLog.1.Action
• messageLog: ESB.Infrastructure.US.Log.BusinessLog.2.AuditLog.1.Action

Author:

Peter Leeuwenburgh

Nested Class Summary

Nested classes/interfaces inherited from class JMSFacade

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

Nested classes/interfaces inherited from interface IMessageBrowser

IMessageBrowser.HideMethod, IMessageBrowser.SortOrder, IMessageBrowser.StorageType

Field Summary

Fields inherited from class JmsTransactionalStorage

FIELD_COMMENTS, FIELD_HOST, FIELD_LABEL, FIELD_ORIGINAL_ID, FIELD_RECEIVED_DATE, FIELD_SLOTID, FIELD_TYPE

Fields inherited from class JMSFacade

JMS_MESSAGECLASS_KEY, log, messagingSource

Fields inherited from interface ITransactionalStorage

MAXCOMMENTLEN

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor	Description
EsbJmsTransactionalStorage()

Method Summary

Modifier and Type	Method	Description
void	configure()	Configure this component.
int	getMessageCount()
void	start()	Obtains a connection and a serviceQueue.
void	stop()	Releases references to serviceQueue and connection.
String	storeMessage(String messageId, String correlationId, Date receivedDate, String comments, String label, Serializable message)	Store the message, returns storageKey.

Methods inherited from class JmsTransactionalStorage

browseMessage, consumeMessage, containsMessageId, getSelector, getSlotId, getType, setSlotId, setType

Methods inherited from class AbstractJmsMessageBrowser

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

Methods inherited from class JMSFacade

checkTransactionManagerValidity, closeSession, createBytesMessage, 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, setQueueConnectionFactoryName, setSubscriberType, setTopicConnectionFactoryName, setTransacted, toString

Methods inherited from class JndiBase

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

Methods inherited from class Object

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

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Methods inherited from interface ConfigurableLifecycle

getPhase, isAutoStartup, isConfigured

Methods inherited from interface FrankElement

addConfigWarning

Methods inherited from interface HasApplicationContext

getApplicationContext, getConfigurationClassLoader

Methods inherited from interface HasName

getName

Methods inherited from interface IMessageBrowser

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

Methods inherited from interface IXAEnabled

isTransacted

Methods inherited from interface NameAware

setName

Methods inherited from interface org.springframework.context.SmartLifecycle

isPauseable, stop

Constructor Details

EsbJmsTransactionalStorage

public EsbJmsTransactionalStorage()

Method Details

configure

public void configure()
               throws ConfigurationException

Description copied from interface: IConfigurable

Configure this component.

configure() is called once at startup of the framework in the configure method of the owner of this IConfigurable. Purpose of this method is to check whether the static configuration of the object is correct. As much as possible class-instantiating should take place in the configure(), to improve performance.

In the case of a container, this will propagate the configure signal to all components that apply.

Specified by:

configure in interface IConfigurable

Specified by:

configure in interface ITransactionalStorage

Overrides:

configure in class JMSFacade

Throws:

ConfigurationException - in case it was not able to configure the component.

start

public void start()

Description copied from class: JMSFacade

Obtains a connection and a serviceQueue.

Specified by:

start in interface ConfigurableLifecycle

Specified by:

start in interface ITransactionalStorage

Specified by:

start in interface org.springframework.context.Lifecycle

Overrides:

start in class JMSFacade

stop

public void stop()

Description copied from class: JMSFacade

Releases references to serviceQueue and connection.

Specified by:

stop in interface ITransactionalStorage

Specified by:

stop in interface org.springframework.context.Lifecycle

Overrides:

stop in class JMSFacade

storeMessage

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

Description copied from interface: ITransactionalStorage

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

Specified by:

storeMessage in interface ITransactionalStorage

Overrides:

storeMessage in class JmsTransactionalStorage

Throws:

SenderException

getMessageCount

public int getMessageCount()

Specified by:

getMessageCount in interface IMessageBrowser<Serializable>

Overrides:

getMessageCount in class AbstractJmsMessageBrowser<Serializable, jakarta.jms.ObjectMessage>