nl.nn.adapterframework.extensions.ifsa.jms

Class IfsaFacade

java.lang.Object

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

All Implemented Interfaces:

HasPhysicalDestination, IConfigurable, IConfigurationAware, INamedObject, IScopeProvider, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

IfsaListener, IfsaRequesterSender

public class IfsaFacade
extends Object
implements IConfigurable, HasPhysicalDestination

Base class for IFSA 2.0/2.2 functions.

Descender classes must set either Requester or Provider behaviour in their constructor.

N.B. Starting from IFSA-jms version 2.2.10.055(beta) a feature was created to have separate service-queues for Request/Reply and for Fire & Forget services. This allows applications to provide both types of services, each in its own transaction mode. This options is not compatible with earlier versions of IFSA-jms. If an earlier version of IFSA-jms is deployed on the server, this behaviour must be disabled by the following setting in DeploymentSpecifics.properties: ifsa.provider.useSelectors=false

Since:

4.2

Author:

Johan Verrips / Gerrit van Brakel

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.logging.log4j.Logger	log

Constructor Summary

Constructors

Constructor and Description
IfsaFacade(boolean asProvider)

Method Summary

Modifier and Type	Method and Description
protected void	cleanUpAfterException()
void	closeReplyReceiver(javax.jms.QueueReceiver receiver)
void	closeService() Stops communication on the IFSA bus.
protected void	closeSession(javax.jms.Session session)
void	configure() Checks if messageProtocol and serviceId (only for Requestors) are specified
protected javax.jms.QueueSender	createSender(javax.jms.QueueSession session, javax.jms.Queue queue)
protected javax.jms.QueueSession	createSession() Create a session on the connection to the service
int	getAckMode()
String	getApplicationId()
long	getExpiry()
long	getExpiry(com.ing.ifsa.IFSAQueue queue)
protected String	getLogPrefix()
String	getMessageProtocol()
IfsaMessageProtocolEnum	getMessageProtocolEnum()
protected IfsaMessagingSource	getMessagingSource()
String	getName()
String	getPhysicalDestinationName()
protected String	getProviderSelector()
javax.jms.QueueReceiver	getReplyReceiver(javax.jms.QueueSession session, javax.jms.Message sentMessage) Gets the queueReceiver, by utilizing the getInputQueue() method. For serverside getQueueReceiver() the creating of the QueueReceiver is done without the selector information, as this is not allowed by IFSA. For a clientconnection, the receiver is done with the getClientReplyQueue
String	getServiceId()
protected com.ing.ifsa.IFSAQueue	getServiceQueue() Looks up the serviceId in the IFSAContext.
protected javax.jms.QueueReceiver	getServiceReceiver(javax.jms.QueueSession session) Gets the queueReceiver, by utilizing the getInputQueue() method. For serverside getQueueReceiver() the creating of the QueueReceiver is done without the selector information, as this is not allowed by IFSA. For a clientconnection, the receiver is done with the getClientReplyQueue
long	getTimeOut()
protected boolean	isJmsTransacted() controls whether sessions are created in JMS transacted mode.
boolean	isProvider() Indicates whether the object at hand represents a Client (returns False) or a Server (returns True).
boolean	isRequestor() Indicates whether the object at hand represents a Client (returns True) or a Server (returns False).
boolean	isSessionsArePooled()
void	openService() Prepares object for communication on the IFSA bus.
javax.jms.TextMessage	sendMessage(javax.jms.QueueSession session, javax.jms.QueueSender sender, String message, Map udzMap, String bifName, byte[] btcData) Sends a message,and if transacted, the queueSession is committed.
void	sendReply(javax.jms.QueueSession session, javax.jms.Message received_message, String response) Intended for server-side reponse sending and implies that the received message *always* contains a reply-to address.
void	setAckMode(int ackMode)
void	setAcknowledgeMode(String acknowledgeMode)
void	setApplicationId(String newApplicationId) the ApplicationID, in the form of "IFSA://AppId"
void	setMessageProtocol(String newMessageProtocol) Protocol of the IFSA-Service to be called.
void	setName(String newName) The functional name of the object.
void	setServiceId(String newServiceId) set the IFSA service Id, for requesters only
void	setTimeOut(long timeOut) The receive timeout in milliseconds.
String	toString()
protected boolean	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.IConfigurationAware

getApplicationContext

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

log

protected org.apache.logging.log4j.Logger log

Constructor Detail

IfsaFacade

public IfsaFacade(boolean asProvider)

Method Detail

getLogPrefix

protected String getLogPrefix()

configure

public void configure()
               throws ConfigurationException

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

Specified by:

configure in interface IConfigurable

Throws:

ConfigurationException

cleanUpAfterException

protected void cleanUpAfterException()

openService

public void openService()
                 throws IfsaException

Prepares object for communication on the IFSA bus. Obtains a connection and a serviceQueue.

Throws:

IfsaException

closeService

public void closeService()
                  throws IfsaException

Stops communication on the IFSA bus. Releases references to serviceQueue and connection.

Throws:

IfsaException

getServiceQueue

protected com.ing.ifsa.IFSAQueue getServiceQueue()
                                          throws IfsaException

Looks up the serviceId in the IFSAContext.

The method is knowledgable of Provider versus Requester processing. When the request concerns a Provider lookupProviderInput is used, when it concerns a Requester lookupService(serviceId) is used. This method distinguishes a server-input queue and a client-input queue

Throws:

IfsaException

getMessagingSource

protected IfsaMessagingSource getMessagingSource()
                                          throws IfsaException

Throws:

IfsaException

createSession

protected javax.jms.QueueSession createSession()
                                        throws IfsaException

Create a session on the connection to the service

Throws:

IfsaException

closeSession

protected void closeSession(javax.jms.Session session)

createSender

protected javax.jms.QueueSender createSender(javax.jms.QueueSession session,
                                             javax.jms.Queue queue)
                                      throws IfsaException

Throws:

IfsaException

getProviderSelector

protected String getProviderSelector()

getServiceReceiver

protected javax.jms.QueueReceiver getServiceReceiver(javax.jms.QueueSession session)
                                              throws IfsaException

Gets the queueReceiver, by utilizing the getInputQueue() method.
For serverside getQueueReceiver() the creating of the QueueReceiver is done without the selector information, as this is not allowed by IFSA.
For a clientconnection, the receiver is done with the getClientReplyQueue

Throws:

IfsaException

See Also:

QueueReceiver

getExpiry

public long getExpiry()
               throws IfsaException

Throws:

IfsaException

getExpiry

public long getExpiry(com.ing.ifsa.IFSAQueue queue)
               throws IfsaException

Throws:

IfsaException

getMessageProtocol

public String getMessageProtocol()

getMessageProtocolEnum

public IfsaMessageProtocolEnum getMessageProtocolEnum()

getReplyReceiver

public javax.jms.QueueReceiver getReplyReceiver(javax.jms.QueueSession session,
                                                javax.jms.Message sentMessage)
                                         throws IfsaException

Gets the queueReceiver, by utilizing the getInputQueue() method.
For serverside getQueueReceiver() the creating of the QueueReceiver is done without the selector information, as this is not allowed by IFSA.
For a clientconnection, the receiver is done with the getClientReplyQueue

Throws:

IfsaException

closeReplyReceiver

public void closeReplyReceiver(javax.jms.QueueReceiver receiver)
                        throws IfsaException

Throws:

IfsaException

isRequestor

public boolean isRequestor()
                    throws IfsaException

Indicates whether the object at hand represents a Client (returns True) or a Server (returns False).

Throws:

IfsaException

isProvider

public boolean isProvider()
                   throws IfsaException

Indicates whether the object at hand represents a Client (returns False) or a Server (returns True).

Throws:

IfsaException

See Also:

isRequestor()

sendMessage

public javax.jms.TextMessage sendMessage(javax.jms.QueueSession session,
                                         javax.jms.QueueSender sender,
                                         String message,
                                         Map udzMap,
                                         String bifName,
                                         byte[] btcData)
                                  throws IfsaException

Sends a message,and if transacted, the queueSession is committed.

This method is intended for clients, as servers will use the sendReply.

Returns:

the correlationID of the sent message

Throws:

IfsaException

sendReply

public void sendReply(javax.jms.QueueSession session,
                      javax.jms.Message received_message,
                      String response)
               throws IfsaException

Intended for server-side reponse sending and implies that the received message *always* contains a reply-to address.

Throws:

IfsaException

setMessageProtocol

public void setMessageProtocol(String newMessageProtocol)

Protocol of the IFSA-Service to be called. When the protocol equals to FF, transacted is set to true.

See Also:

IfsaMessageProtocolEnum

isSessionsArePooled

public boolean isSessionsArePooled()

isJmsTransacted

protected boolean isJmsTransacted()

controls whether sessions are created in JMS transacted mode. JMS transacted sessions are required by IFSA for FF, although they result in log messages about active transactions that should be present.

toString

public String toString()

Overrides:

toString in class Object

getPhysicalDestinationName

public String getPhysicalDestinationName()

Specified by:

getPhysicalDestinationName in interface HasPhysicalDestination

setServiceId

public void setServiceId(String newServiceId)

set the IFSA service Id, for requesters only

Parameters:

newServiceId - the name of the service, e.g. IFSA://SERVICE/CLAIMINFORMATIONMANAGEMENT/NLDFLT/FINDCLAIM:01

getServiceId

public String getServiceId()

setApplicationId

public void setApplicationId(String newApplicationId)

the ApplicationID, in the form of "IFSA://AppId"

getApplicationId

public String getApplicationId()

useSelectorsForProviders

protected boolean useSelectorsForProviders()

setName

public void setName(String newName)

Description copied from interface: INamedObject

The functional name of the object.

Specified by:

setName in interface INamedObject

getName

public String getName()

Specified by:

getName in interface IConfigurationAware

Specified by:

getName in interface INamedObject

setTimeOut

public void setTimeOut(long timeOut)

The receive timeout in milliseconds. To use the timeout defined as IFSA expiry, set this value to -1

Default value

20000

getTimeOut

public long getTimeOut()

setAckMode

public void setAckMode(int ackMode)

getAckMode

public int getAckMode()

setAcknowledgeMode

public void setAcknowledgeMode(String acknowledgeMode)