Class JmsSender

java.lang.Object

org.frankframework.jndi.JndiBase

org.frankframework.jms.JMSFacade

org.frankframework.jms.JmsSender

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

Direct Known Subclasses:

BisJmsSender, EsbJmsSender, MQSender

public class JmsSender
extends JMSFacade
implements ISenderWithParameters, ICorrelatedSender

Author:

Gerrit van Brakel

Parameters

All parameters present are set as message-properties.

Specific parameters

SoapAction Automatically filled from attribute soapAction

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	JmsSender.LinkMethod

Nested classes/interfaces inherited from class JMSFacade

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

Field Summary

Fields

Modifier and Type	Field	Description
protected @NonNull ParameterList	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
JmsSender()

Method Summary

Modifier and Type	Method	Description
void	addParameter(IParameter p)
void	configure()	Configures the sender
protected jakarta.jms.Session	createSession()	Returns a session on the connection for a topic or a queue
jakarta.jms.Destination	getDestination(PipeLineSession session, ParameterValueList pvl)
@NonNull ParameterList	getParameterList()
@NonNull SenderResult	sendMessage(@NonNull Message message, @NonNull PipeLineSession session)	Send a message to some destination (as configured in the Sender object).
@NonNull Message	sendMessage(@NonNull Message message, @NonNull PipeLineSession pipeLineSession, String soapHeader)
void	setDeliveryMode(JMSFacade.DeliveryMode deliveryMode)	Controls mode that messages are sent with
void	setDestinationParam(String string)	Parameter that is used, if specified and not empty, to determine the destination.
void	setEncodingStyleURI(String string)	SOAP encoding style URI
void	setLinkMethod(JmsSender.LinkMethod method)	(Only used when synchronous=true and replyToName is set).
void	setMessageType(String string)	Value of the JMSType field
void	setPriority(int i)	Sets the priority that is used to deliver the message.
void	setReplySoapHeaderSessionKey(String string)	session key to store SOAP header of reply
void	setReplyTimeout(int i)	(Only for synchronous=true).
void	setReplyToName(String replyTo)	Name of the queue the reply is expected on.
void	setResponseHeadersToSessionKeys(String responseHeaders)	A list of JMS headers of the response to add to the PipeLineSession
void	setServiceNamespaceURI(String string)	SOAP service namespace URI
void	setSoap(boolean b)	If true, messages sent are put in a SOAP envelope
void	setSoapAction(String string)	SOAPAction string sent as message property
void	setSoapHeaderParam(String string)	Name of parameter containing SOAP header
void	setSynchronous(boolean synchronous)	If true, the sender operates in RR mode: A reply is expected, either on the queue specified in replyToName, or on a dynamically generated temporary queue
void	start()	Starts the sender
String	toString()

Methods inherited from class JMSFacade

checkTransactionManagerValidity, closeSession, createBytesMessage, createMessage, createMessage, 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, 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 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

Field Details

paramList

protected @NonNull ParameterList paramList

Constructor Details

JmsSender

public JmsSender()

Method Details

configure

public void configure()
               throws ConfigurationException

Configures the sender

Specified by:

configure in interface IConfigurable

Overrides:

configure in class JMSFacade

Throws:

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

createSession

protected jakarta.jms.Session createSession()
                                     throws JmsException

Description copied from class: JMSFacade

Returns a session on the connection for a topic or a queue

Overrides:

createSession in class JMSFacade

Throws:

JmsException

start

public void start()

Starts the sender

Specified by:

start in interface ConfigurableLifecycle

Specified by:

start in interface ISender

Specified by:

start in interface org.springframework.context.Lifecycle

Overrides:

start in class JMSFacade

addParameter

public void addParameter(IParameter p)

Specified by:

addParameter in interface IWithParameters

getParameterList

public @NonNull ParameterList getParameterList()

Specified by:

getParameterList in interface IWithParameters

sendMessage

public @NonNull SenderResult sendMessage(@NonNull Message message,
 @NonNull PipeLineSession session)
                                  throws SenderException,
TimeoutException

Description copied from interface: ISender

Send a message to some destination (as configured in the Sender object). This method may only be called after the configure() method is called.

The following table shows the difference between synchronous and a-synchronous senders:

	synchronous	a-synchronous
ISender.isSynchronous() returns	true	false
return value of sendMessage() is	the reply-message	the messageId of the message sent
the correlationID specified with sendMessage()	may be ignored	is sent with the message
a {link TimeOutException}	may be thrown if a timeout occurs waiting for a reply	should not be expected

Multiple objects may try to call this method at the same time, from different threads. Implementations of this method should therefore be thread-safe, or synchronized.

Specified by:

sendMessage in interface ISender

Throws:

SenderException

TimeoutException

sendMessage

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

Throws:

SenderException

TimeoutException

getDestination

public jakarta.jms.Destination getDestination(PipeLineSession session,
 ParameterValueList pvl)
                                       throws JmsException,
NamingException,
jakarta.jms.JMSException

Throws:

JmsException

NamingException

jakarta.jms.JMSException

toString

public String toString()

Overrides:

toString in class JMSFacade

setDestinationParam

public void setDestinationParam(String string)

Parameter that is used, if specified and not empty, to determine the destination. Overrides the destination attribute

setSynchronous

public void setSynchronous(boolean synchronous)

If true, the sender operates in RR mode: A reply is expected, either on the queue specified in replyToName, or on a dynamically generated temporary queue

Default value

false

setReplyToName

public void setReplyToName(String replyTo)

Name of the queue the reply is expected on. This value is sent in the JMSReplyTo-header with the message.

Default value

a dynamically generated temporary destination

setLinkMethod

public void setLinkMethod(JmsSender.LinkMethod method)

(Only used when synchronous=true and replyToName is set). Indicates whether the server uses the correlationId from the pipeline, the correlationId from the message or the messageId in the correlationId field of the reply. This requires the sender to have set the correlationId at the time of sending.

Default value

MESSAGEID

setReplyTimeout

public void setReplyTimeout(int i)

(Only for synchronous=true). Maximum time in ms to wait for a reply. 0 means no timeout.

Default value

5000

setMessageType

public void setMessageType(String string)

Value of the JMSType field

Default value

not set by application

setDeliveryMode

public void setDeliveryMode(JMSFacade.DeliveryMode deliveryMode)

Controls mode that messages are sent with

Default value

not set by application

setPriority

public void setPriority(int i)

Sets the priority that is used to deliver the message. Ranges from 0 to 9. Defaults to -1, meaning not set. Effectively the default priority is set by JMS to 4

Default value

-1

setSoap

public void setSoap(boolean b)

If true, messages sent are put in a SOAP envelope

Default value

false

setEncodingStyleURI

public void setEncodingStyleURI(String string)

SOAP encoding style URI

setServiceNamespaceURI

public void setServiceNamespaceURI(String string)

SOAP service namespace URI

setSoapAction

public void setSoapAction(String string)

SOAPAction string sent as message property

setSoapHeaderParam

public void setSoapHeaderParam(String string)

Name of parameter containing SOAP header

Default value

soapHeader

setReplySoapHeaderSessionKey

public void setReplySoapHeaderSessionKey(String string)

session key to store SOAP header of reply

Default value

replySoapHeader

setResponseHeadersToSessionKeys

public void setResponseHeadersToSessionKeys(String responseHeaders)

A list of JMS headers of the response to add to the PipeLineSession