nl.nn.adapterframework.extensions.ifsa

Class IfsaRequesterSender

java.lang.Object

nl.nn.adapterframework.extensions.ifsa.jms.IfsaFacade

nl.nn.adapterframework.extensions.ifsa.IfsaRequesterSender

All Implemented Interfaces:

HasPhysicalDestination, IConfigurable, IConfigurationAware, INamedObject, IScopeProvider, ISender, ISenderWithParameters, IWithParameters, HasStatistics, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

IfsaRequesterSender

public class IfsaRequesterSender
extends IfsaFacade
implements ISenderWithParameters, HasStatistics

sender that sends a message to an IFSA service and, in case the MessageProtocol is RR (Request-Reply) it waits for an reply-message.

Since:

4.2, switch class: 4.8

Author:

Gerrit van Brakel

Parameters

All other parameters are passed to the outgoing UDZ (User Defined Zone) object

Specific parameters

name, serviceId When a parameter with name serviceId is present, it is used at runtime instead of the serviceId specified by the attribute. A lookup of the service for this serviceId will be done at runtime, while the service for the serviceId specified as an attribute will be done at configuration time. Hence, IFSA configuration problems will be detected at runtime for the serviceId specified as a param and at configuration time for the serviceId specified with an attribute, occurrence The occurrence part of the serviceId (the part between the fourth and the fifth slash). The occurrence part of the specified serviceId (either specified by a parameter or an attribute) will be replaced with the value of this parameter at runtime. From "IFSA - Naming Standards.doc": IFSA://SERVICE/<group>/<occurrence>/<service>/<version>[?<parameter=value>]

Nested Class Summary

Nested classes/interfaces inherited from interface nl.nn.adapterframework.statistics.HasStatistics

HasStatistics.Action

Field Summary

Fields

Modifier and Type	Field and Description
protected String	bifNameSessionKey
protected ParameterList	paramList

Fields inherited from class nl.nn.adapterframework.extensions.ifsa.jms.IfsaFacade

log

Constructor Summary

Constructors

Constructor and Description
IfsaRequesterSender()

Method Summary

Modifier and Type	Method and Description
void	addParameter(Parameter p)
void	close() Stop the sender and deallocate resources.
void	configure() Checks if messageProtocol and serviceId (only for Requestors) are specified
String	getBifNameSessionKey()
ParameterList	getParameterList()
boolean	isSynchronous() returns true for Request/Reply configurations
boolean	isThrowExceptions()
void	iterateOverStatistics(StatisticsKeeperIterationHandler hski, Object data, HasStatistics.Action action)
void	open() This method will be called to start the sender.
SenderResult	sendMessage(Message message, PipeLineSession session) Send a message to some destination (as configured in the Sender object).
String	sendMessage(String message, Map<String,String> params, String bifName, byte[] btcData) Execute a request to the IFSA service.
String	sendMessage(String dummyCorrelationId, String message, Map<String,String> params)
void	setBifNameSessionKey(String bifnameSessionKey)
void	setThrowExceptions(boolean b)
String	toString()

Methods inherited from class nl.nn.adapterframework.extensions.ifsa.jms.IfsaFacade

cleanUpAfterException, closeReplyReceiver, closeService, closeSession, createSender, createSession, getAckMode, getApplicationId, getExpiry, getExpiry, getLogPrefix, getMessageProtocol, getMessageProtocolEnum, getMessagingSource, getName, getPhysicalDestinationName, getProviderSelector, getReplyReceiver, getServiceId, getServiceQueue, getServiceReceiver, getTimeOut, isJmsTransacted, isProvider, isRequestor, isSessionsArePooled, openService, sendMessage, sendReply, setAckMode, setAcknowledgeMode, setApplicationId, setMessageProtocol, setName, setServiceId, setTimeOut, useSelectorsForProviders

Methods inherited from class java.lang.Object

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

Methods inherited from interface nl.nn.adapterframework.core.ISenderWithParameters

consumesSessionVariable

Methods inherited from interface nl.nn.adapterframework.core.ISender

sendMessageOrThrow

Methods inherited from interface nl.nn.adapterframework.core.INamedObject

getName, setName

Methods inherited from interface nl.nn.adapterframework.core.IConfigurationAware

getApplicationContext, getName

Methods inherited from interface nl.nn.adapterframework.core.IScopeProvider

getConfigurationClassLoader

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Methods inherited from interface nl.nn.adapterframework.core.HasPhysicalDestination

getDomain

Field Detail

bifNameSessionKey

protected String bifNameSessionKey

paramList

protected ParameterList paramList

Constructor Detail

IfsaRequesterSender

public IfsaRequesterSender()

Method Detail

configure

public void configure()
               throws ConfigurationException

Description copied from class: IfsaFacade

Checks if messageProtocol and serviceId (only for Requestors) are specified

Specified by:

configure in interface IConfigurable

Specified by:

configure in interface ISender

Overrides:

configure in class IfsaFacade

Throws:

ConfigurationException

open

public void open()
          throws SenderException

Description copied from interface: ISender

This method will be called to start the sender. After this method is called the sendMessage method may be called. Purpose of this method is to reduce creating connections to databases etc. in the sendMessage() method.

Specified by:

open in interface ISender

Throws:

SenderException

close

public void close()
           throws SenderException

Stop the sender and deallocate resources.

Specified by:

close in interface ISender

Throws:

SenderException

isSynchronous

public boolean isSynchronous()

returns true for Request/Reply configurations

Specified by:

isSynchronous in interface ISender

sendMessage

public SenderResult sendMessage(Message message,
                                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 String sendMessage(String dummyCorrelationId,
                          String message,
                          Map<String,String> params)
                   throws SenderException,
                          TimeoutException

Throws:

SenderException

TimeoutException

sendMessage

public String sendMessage(String message,
                          Map<String,String> params,
                          String bifName,
                          byte[] btcData)
                   throws SenderException,
                          TimeoutException

Execute a request to the IFSA service.

Returns:

in Request/Reply, the retrieved message or TIMEOUT, otherwise null

Throws:

SenderException

TimeoutException

iterateOverStatistics

public void iterateOverStatistics(StatisticsKeeperIterationHandler hski,
                                  Object data,
                                  HasStatistics.Action action)
                           throws SenderException

Specified by:

iterateOverStatistics in interface HasStatistics

Throws:

SenderException

toString

public String toString()

Overrides:

toString in class IfsaFacade

addParameter

public void addParameter(Parameter p)

Specified by:

addParameter in interface IWithParameters

getParameterList

public ParameterList getParameterList()

Specified by:

getParameterList in interface IWithParameters

setThrowExceptions

public void setThrowExceptions(boolean b)

isThrowExceptions

public boolean isThrowExceptions()

setBifNameSessionKey

public void setBifNameSessionKey(String bifnameSessionKey)

getBifNameSessionKey

public String getBifNameSessionKey()