Package org.frankframework.extensions.ibm

Class IMSSender

java.lang.Object

org.frankframework.jndi.JndiBase

org.frankframework.jms.JMSFacade

org.frankframework.jms.JmsSender

org.frankframework.extensions.ibm.MQSender

org.frankframework.extensions.ibm.IMSSender

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 IMSSender
extends MQSender

JMS sender which will add an IMS header to the message and call the MQ specific logic.

See JmsSender for configuration

Author:

Ricardo van Holst

Nested Class Summary

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

JmsSender.LinkMethod

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

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

Field Summary

Fields inherited from class org.frankframework.jms.JmsSender

paramList

Fields inherited from class org.frankframework.jms.JMSFacade

JMS_MESSAGECLASS_KEY, log, messagingSource

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor	Description
IMSSender()

Method Summary

Modifier and Type	Method	Description
void	configure()	Configures the sender
jakarta.jms.Message	createMessage(jakarta.jms.Session session, String correlationID, Message message, JMSFacade.MessageClass messageClass)
Message	extractMessage(jakarta.jms.Message rawMessage, Map<String,Object> context, boolean soap, String soapHeaderSessionKey, SoapWrapper soapWrapper)	Extracts string from message obtained from getRawMessage(Map).
String	getTransactionCode()
void	setTransactionCode(String transactionCode)	The transaction code that should be added in the header, must be 8 characters

Methods inherited from class org.frankframework.extensions.ibm.MQSender

getMessageProducer, send, sendByQueue, sendByTopic

Methods inherited from class org.frankframework.jms.JmsSender

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

Methods inherited from class org.frankframework.jms.JMSFacade

checkTransactionManagerValidity, closeSession, createBytesMessage, createMessage, createTextMessage, extractMessageBody, getConnectionFactoryName, getContext, getDestination, getDestination, getJmsMessagingSource, getLogPrefix, getMessageConsumer, getMessageConsumer, getMessageConsumerForCorrelationId, getMessagingSource, getPhysicalDestinationName, getPhysicalDestinationShortName, getPhysicalDestinationShortName, isRunning, isSessionsArePooled, logMessageDetails, send, send, send, send, setAcknowledgeMode, setAuthAlias, setCorrelationIdMaxLength, setCorrelationIdToHex, setCorrelationIdToHexPrefix, setDestinationName, setDestinationType, setJndiContextPrefix, setLookupDestination, setMessageClass, setMessageCorrelationID, setMessageSelector, setMessageTimeToLive, setName, setPersistent, setQueueConnectionFactoryName, setSubscriberType, setTopicConnectionFactoryName, setTransacted, stop

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.ISender

isSynchronous, sendMessageOrThrow, stop

Methods inherited from interface org.frankframework.core.ISenderWithParameters

consumesSessionVariable

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

Constructor Details

IMSSender

public IMSSender()

Method Details

setTransactionCode

public void setTransactionCode(String transactionCode)

The transaction code that should be added in the header, must be 8 characters

getTransactionCode

public String getTransactionCode()

configure

public void configure()
               throws ConfigurationException

Description copied from class: JmsSender

Configures the sender

Specified by:

configure in interface IConfigurable

Overrides:

configure in class JmsSender

Throws:

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

createMessage

@Nonnull
public jakarta.jms.Message createMessage(jakarta.jms.Session session,
 String correlationID,
 Message message,
 JMSFacade.MessageClass messageClass)
                                  throws jakarta.jms.JMSException

Overrides:

createMessage in class JMSFacade

Throws:

jakarta.jms.JMSException

extractMessage

public Message extractMessage(jakarta.jms.Message rawMessage,
 Map<String,Object> context,
 boolean soap,
 String soapHeaderSessionKey,
 SoapWrapper soapWrapper)
                       throws jakarta.jms.JMSException,
IOException

Description copied from class: JMSFacade

Extracts string from message obtained from getRawMessage(Map). May also extract other parameters from the message and put those in the threadContext.

Supports only TextMessages and BytesMessage.

Overrides:

extractMessage in class JMSFacade

Throws:

jakarta.jms.JMSException

IOException