Package org.frankframework.extensions.bis

Class BisJmsSender

java.lang.Object

org.frankframework.jndi.JndiBase

org.frankframework.jms.JMSFacade

org.frankframework.jms.JmsSender

org.frankframework.extensions.bis.BisJmsSender

All Implemented Interfaces:

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

@Deprecated
@ConfigurationWarning("Please change to JmsSender combined with BisWrapperPipe")
public class BisJmsSender
extends JmsSender

Deprecated.

Please use JmsSender combined with BisWrapperPipe

Bis (Business Integration Services) extension of JmsSender.
For example request and reply, see BisJmsListener.
If synchronous=true and one of the following conditions is true a SenderException is thrown: - Result/Status in the reply soap body equals 'ERROR' - faultcode in the reply soap fault is not empty

Configuration:

Author:

Peter Leeuwenburgh

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.DestinationType, 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, messagingSource

Fields inherited from class org.frankframework.jndi.JndiBase

log

Constructor Summary

Constructors

Constructor	Description
BisJmsSender()	Deprecated.

Method Summary

Modifier and Type	Method	Description
void	configure()	Deprecated. Configures the sender
Message	extractMessageBody(Message message, Map<String,Object> context, SoapWrapper soapWrapper)	Deprecated.
String	getConversationIdSessionKey()	Deprecated.
String	getErrorListSessionKey()	Deprecated.
String	getExternalRefToMessageIdSessionKey()	Deprecated.
String	getRequestNamespace()	Deprecated.
String	getResponseNamespaceDefs()	Deprecated.
String	getResponseXPath()	Deprecated.
boolean	isMessageHeaderInSoapBody()	Deprecated.
boolean	isRemoveResponseNamespaces()	Deprecated.
boolean	isResultInPayload()	Deprecated.
SenderResult	sendMessage(Message input, PipeLineSession session)	Deprecated. Send a message to some destination (as configured in the Sender object).
void	setConversationIdSessionKey(String conversationIdSessionKey)	Deprecated.
void	setErrorListSessionKey(String errorListSessionKey)	Deprecated.
void	setExternalRefToMessageIdSessionKey(String externalRefToMessageIdSessionKey)	Deprecated.
void	setMessageHeaderInSoapBody(boolean b)	Deprecated.
void	setRemoveResponseNamespaces(boolean b)	Deprecated.
void	setRequestNamespace(String requestNamespace)	Deprecated.
void	setResponseNamespaceDefs(String responseNamespaceDefs)	Deprecated.
void	setResponseXPath(String responseXPath)	Deprecated.
void	setResultInPayload(boolean b)	Deprecated.

Methods inherited from class org.frankframework.jms.JmsSender

addParameter, createSession, getDestination, getParameterList, 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, createMessage, createTextMessage, extractMessage, getConnectionFactoryName, getContext, getDestination, getDestination, getJmsMessagingSource, getLogPrefix, getMessageConsumer, getMessageConsumer, getMessageConsumerForCorrelationId, getMessageProducer, getMessagingSource, getPhysicalDestinationName, getPhysicalDestinationShortName, getPhysicalDestinationShortName, isRunning, isSessionsArePooled, logMessageDetails, send, send, send, send, send, send, send, sendByQueue, sendByTopic, setAcknowledgeMode, setAuthAlias, setCorrelationIdMaxLength, setCorrelationIdToHex, setCorrelationIdToHexPrefix, setDestinationName, setDestinationType, setLookupDestination, setMessageClass, setMessageCorrelationID, setMessageSelector, setMessageTimeToLive, setPersistent, setQueueConnectionFactoryName, setSubscriberType, setTopicConnectionFactoryName, setTransacted, stop

Methods inherited from class org.frankframework.jndi.JndiBase

getContext, getJndiEnv, setAuthentication, setCredentials, setInitialContextFactoryName, setJmsRealm, setJndiAuthAlias, setJndiContextPrefix, setJndiProperties, setName, 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.core.HasApplicationContext

getApplicationContext, getConfigurationClassLoader

Methods inherited from interface org.frankframework.core.HasName

getName

Methods inherited from interface org.frankframework.core.HasPhysicalDestination

getDomain

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

Constructor Details

BisJmsSender

public BisJmsSender()

Deprecated.

Method Details

configure

public void configure()
               throws ConfigurationException

Deprecated.

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.

extractMessageBody

public Message extractMessageBody(Message message,
 Map<String,Object> context,
 SoapWrapper soapWrapper)

Deprecated.

Overrides:

extractMessageBody in class JMSFacade

sendMessage

@Nonnull
public SenderResult sendMessage(@Nonnull
 Message input,
 @Nonnull
 PipeLineSession session)
                         throws SenderException,
TimeoutException

Deprecated.

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:

attributes	description	default
className	org.frankframework.extensions.bis.BisSoapJmsSender
soap	when true, messages sent are put in a SOAP envelope	true
responseXPath	xpath expression to extract the message from the reply which is passed to the pipeline. When soap=true the initial message is the content of the soap body. If empty, the content of the soap body is passed (without the root body)
responseNamespaceDefs	namespace defintions for responseXPath. Must be in the form of a comma or space separated list of prefix=namespaceuri-definitions
messageHeaderInSoapBody	when true, the MessageHeader of the request is put in the SOAP body instead of in the SOAP header (first one is the old BIS standard)	false
resultInPayload	when true, the Result tag in the reply will be put in the payload (as last child in root tag) instead of in the SOAP body as sibling of the payload (last one is the old BIS standard)	true
errorListSessionKey	key of session variable to store ErrorList in when Result/Status in the reply equals 'ERROR'	bisErrorList
conversationIdSessionKey	key of session variable in which ConversationId is stored; used in the MessageHeader of the request	bisConversationId
externalRefToMessageIdSessionKey	key of session variable in which ExternalRefToMessageId is stored; used in the MessageHeader of the request	bisExternalRefToMessageId
requestNamespace	if not empty, this namespace is added to the request (this functionality will be used during migration from IFSA to TIBCO)
removeResponseNamespaces	when set true namespaces (and prefixes) in the response are removed (this functionality will be used during migration from IFSA to TIBCO)	false

	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

Overrides:

sendMessage in class JmsSender

Throws:

SenderException

TimeoutException

setResponseXPath

public void setResponseXPath(String responseXPath)

Deprecated.

getResponseXPath

public String getResponseXPath()

Deprecated.

setResponseNamespaceDefs

public void setResponseNamespaceDefs(String responseNamespaceDefs)

Deprecated.

getResponseNamespaceDefs

public String getResponseNamespaceDefs()

Deprecated.

setMessageHeaderInSoapBody

public void setMessageHeaderInSoapBody(boolean b)

Deprecated.

isMessageHeaderInSoapBody

public boolean isMessageHeaderInSoapBody()

Deprecated.

setResultInPayload

public void setResultInPayload(boolean b)

Deprecated.

isResultInPayload

public boolean isResultInPayload()

Deprecated.

setErrorListSessionKey

public void setErrorListSessionKey(String errorListSessionKey)

Deprecated.

getErrorListSessionKey

public String getErrorListSessionKey()

Deprecated.

setExternalRefToMessageIdSessionKey

public void setExternalRefToMessageIdSessionKey(String externalRefToMessageIdSessionKey)

Deprecated.

getExternalRefToMessageIdSessionKey

public String getExternalRefToMessageIdSessionKey()

Deprecated.

setConversationIdSessionKey

public void setConversationIdSessionKey(String conversationIdSessionKey)

Deprecated.

getConversationIdSessionKey

public String getConversationIdSessionKey()

Deprecated.

setRequestNamespace

public void setRequestNamespace(String requestNamespace)

Deprecated.

getRequestNamespace

public String getRequestNamespace()

Deprecated.

setRemoveResponseNamespaces

public void setRemoveResponseNamespaces(boolean b)

Deprecated.

isRemoveResponseNamespaces

public boolean isRemoveResponseNamespaces()

Deprecated.