Class MessageQueueSender

java.lang.Object

org.frankframework.jndi.JndiBase

org.frankframework.jms.JMSFacade

org.frankframework.jms.JmsSender

org.frankframework.jms.MessageQueueSender

All Implemented Interfaces:

FrankElement, HasApplicationContext, HasName, HasPhysicalDestination, IConfigurable, ICorrelatedSender, IScopeProvider, ISender, ISenderWithParameters, IWithParameters, IXAEnabled, NameAware, ConfigurableLifecycle, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle

public class MessageQueueSender
extends JmsSender

Send messages to another Adapter, including message-metadata (the MessageContext of the input Message), and optionally a number of PipeLineSession keys. This is the JMS-based alternative for the database-based MessageStoreSender.

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 ICorrelatedSender

ICorrelatedSender.LinkMethod

Field Summary

Fields inherited from class JmsSender

paramList

Fields inherited from class JMSFacade

JMS_MESSAGECLASS_KEY, log, messagingSource

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor	Description
MessageQueueSender()

Method Summary

Modifier and Type	Method	Description
@NonNull jakarta.jms.Message	createMessage(@NonNull jakarta.jms.Session session, @Nullable String correlationID, @NonNull Message message, @Nullable PipeLineSession pipeLineSession)
@NonNull Message	sendMessage(@NonNull Message message, @NonNull PipeLineSession pipeLineSession, String soapHeader)
void	setMessageClass(JMSFacade.MessageClass messageClass)	This sender ignores the Message-Class and always sends messages as JMS ObjectMessage.
void	setSessionKeys(String sessionKeys)	Comma separated list of sessionKey's to be stored together with the message.

Methods inherited from class JmsSender

addParameter, configure, createSession, enhanceMessage, getDestination, getParameterList, sendMessage, setDeliveryMode, setDestinationParam, setEncodingStyleURI, setLinkMethod, setMessageType, setPriority, setReplySoapHeaderSessionKey, setReplyTimeout, setReplyToName, setResponseHeadersToSessionKeys, setServiceNamespaceURI, setSoap, setSoapAction, setSoapHeaderParam, setSynchronous, start, toString

Methods inherited from class JMSFacade

checkTransactionManagerValidity, closeSession, createBytesMessage, 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, setMessageCorrelationID, setMessageSelector, setMessageTimeToLive, setName, setQueueConnectionFactoryName, setSubscriberType, setTopicConnectionFactoryName, setTransacted, stop

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 ICorrelatedSender

getLinkMethod

Methods inherited from interface ISender

isSynchronous, sendMessageOrThrow, stop

Methods inherited from interface ISenderWithParameters

consumesSessionVariable

Methods inherited from interface IXAEnabled

isTransacted

Methods inherited from interface NameAware

setName

Methods inherited from interface org.springframework.context.SmartLifecycle

isPauseable, stop

Constructor Details

MessageQueueSender

public MessageQueueSender()

Method Details

sendMessage

public @NonNull Message sendMessage(@NonNull Message message,
 @NonNull PipeLineSession pipeLineSession,
 String soapHeader)
                             throws SenderException,
TimeoutException

Overrides:

sendMessage in class JmsSender

Throws:

SenderException

TimeoutException

createMessage

public @NonNull jakarta.jms.Message createMessage(@NonNull jakarta.jms.Session session,
 @Nullable String correlationID,
 @NonNull Message message,
 @Nullable PipeLineSession pipeLineSession)
                                           throws jakarta.jms.JMSException,
SenderException

Overrides:

createMessage in class JMSFacade

Throws:

jakarta.jms.JMSException

SenderException

setMessageClass

@Protected
public void setMessageClass(JMSFacade.MessageClass messageClass)

This sender ignores the Message-Class and always sends messages as JMS ObjectMessage.

Overrides:

setMessageClass in class JMSFacade

setSessionKeys

public void setSessionKeys(String sessionKeys)

Comma separated list of sessionKey's to be stored together with the message. In the MessageQueueListener, all these keys and values will be added to the PipeLineSession on invocation.