Package org.frankframework.extensions.fxf

Class FxfListener

java.lang.Object

org.frankframework.jndi.JndiBase

org.frankframework.jms.JMSFacade

org.frankframework.jms.AbstractJmsListener

org.frankframework.jms.PushingJmsListener

org.frankframework.jms.JmsListener

org.frankframework.extensions.esb.EsbJmsListener

org.frankframework.extensions.fxf.FxfListener

All Implemented Interfaces:

FrankElement, HasApplicationContext, HasName, HasPhysicalDestination, HasSender, IConfigurable, IJmsListener<jakarta.jms.Message>, IKnowsDeliveryCount<jakarta.jms.Message>, IListener<jakarta.jms.Message>, IPortConnectedListener<jakarta.jms.Message>, IPushingListener<jakarta.jms.Message>, IRedeliveringListener<jakarta.jms.Message>, IScopeProvider, IThreadCountControllable, ITransactionRequirements, IWithParameters, IXAEnabled, NameAware, ConfigurableLifecycle, ReceiverAware<jakarta.jms.Message>, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle

public class FxfListener
extends EsbJmsListener

FxF extension of EsbJmsListener.

Configuration (where deviating from EsbJmsListener):

attributes	description	default
destinationName	name of the JMS destination (queue or topic) to use	"jms/FileTransferAction"
jmsRealm		"qcf_tibco_p2p_ff"
messageProtocol	protocol of ESB service to be called. Possible values "FF": Fire & Forget protocol "RR": Request-Reply protocol	"FF"

Author:

Peter Leeuwenburgh

Nested Class Summary

Nested classes/interfaces inherited from class org.frankframework.extensions.esb.EsbJmsListener

EsbJmsListener.MessageProtocol

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

JMS_MESSAGECLASS_KEY, log, messagingSource

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor	Description
FxfListener()

Method Summary

Modifier and Type	Method	Description
void	afterMessageProcessed(PipeLineResult plr, RawMessageWrapper<jakarta.jms.Message> rawMessageWrapper, PipeLineSession pipeLineSession)	Called to perform actions (like committing or sending a reply) after a message has been processed by the Pipeline.
void	configure()	Configure this component.
void	setCreateProcessedDirectory(boolean b)	(only used when moveProcessedFile=true) when set to true, the directory to move processed files in is created if it does not exist
void	setFxfFileSessionKey(String fxfFileSessionKey)	name of the session key to store the name of the received file in
void	setMoveProcessedFile(boolean b)	If set to true, the received file is moved after being processed
void	setProcessedSiblingDirectory(String processedSiblingDirectory)	(only used when moveProcessedFile=true) sibling directory (related to the parent directory of the file to process) where files are stored after being processed

Methods inherited from class org.frankframework.extensions.esb.EsbJmsListener

extractMessageProperties, getMessageProperties, getResultFromXPath, getxPathLogMap, isSynchronous, setCopyAEProperties, setForceMessageIdAsCorrelationId, setMessageProtocol, setUseReplyTo, setxPathLoggingKeys, transactionalAllowed, transactionalRequired

Methods inherited from class org.frankframework.jms.PushingJmsListener

decreaseThreadCount, getCurrentThreadCount, getDeliveryCount, getMaxThreadCount, increaseThreadCount, isThreadCountControllable, isThreadCountReadable, setCacheMode, setDestinationName, setPollGuardInterval, start, stop, wrapRawMessage

Methods inherited from class org.frankframework.jms.AbstractJmsListener

addParameter, extractMessage, getParameterList, messageWillBeRedeliveredOnExitStateError, prepareReply, prepareReply, sendReply, setReplyDeliveryMode, setReplyDestinationName, setReplyEncodingStyleURI, setReplyMessageTimeToLive, setReplyMessageType, setReplyNamespaceURI, setReplyPriority, setReplySoapAction, setSender, setSoap, setSoapHeaderSessionKey, setTimeout

Methods inherited from class org.frankframework.jms.JMSFacade

checkTransactionManagerValidity, closeSession, createBytesMessage, createMessage, createMessage, createSession, 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, setDestinationType, setJndiContextPrefix, setLookupDestination, setMessageClass, setMessageCorrelationID, setMessageSelector, setMessageTimeToLive, setName, setPersistent, setQueueConnectionFactoryName, setSubscriberType, setTopicConnectionFactoryName, setTransacted, toString

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

getSender

Methods inherited from interface org.frankframework.core.IJmsListener

getDestinationName, getQueueConnectionFactoryName

Methods inherited from interface org.frankframework.core.IListener

extractMessage, start, stop

Methods inherited from interface org.frankframework.core.IPortConnectedListener

checkTransactionManagerValidity, getExceptionListener, getHandler

Methods inherited from interface org.frankframework.core.IPushingListener

setExceptionListener, setHandler

Methods inherited from interface org.frankframework.core.IXAEnabled

isTransacted

Methods inherited from interface org.frankframework.core.NameAware

setName

Methods inherited from interface org.frankframework.receivers.ReceiverAware

getReceiver, setReceiver

Methods inherited from interface org.springframework.context.SmartLifecycle

stop

Constructor Details

FxfListener

public FxfListener()

Method Details

configure

public void configure()
               throws ConfigurationException

Description copied from interface: IConfigurable

Configure this component.

configure() is called once at startup of the framework in the configure method of the owner of this IConfigurable. Purpose of this method is to check whether the static configuration of the object is correct. As much as possible class-instantiating should take place in the configure(), to improve performance.

In the case of a container, this will propagate the configure signal to all components that apply.

Specified by:

configure in interface IConfigurable

Overrides:

configure in class EsbJmsListener

Throws:

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

afterMessageProcessed

public void afterMessageProcessed(PipeLineResult plr,
 RawMessageWrapper<jakarta.jms.Message> rawMessageWrapper,
 PipeLineSession pipeLineSession)
                           throws ListenerException

Description copied from interface: IListener

Called to perform actions (like committing or sending a reply) after a message has been processed by the Pipeline.

Specified by:

afterMessageProcessed in interface IListener<jakarta.jms.Message>

Overrides:

afterMessageProcessed in class EsbJmsListener

Throws:

ListenerException

setFxfFileSessionKey

public void setFxfFileSessionKey(String fxfFileSessionKey)

name of the session key to store the name of the received file in

Default value

fxfFile

setMoveProcessedFile

public void setMoveProcessedFile(boolean b)

If set to true, the received file is moved after being processed

Default value

true

setProcessedSiblingDirectory

public void setProcessedSiblingDirectory(String processedSiblingDirectory)

(only used when moveProcessedFile=true) sibling directory (related to the parent directory of the file to process) where files are stored after being processed

Default value

processed

setCreateProcessedDirectory

public void setCreateProcessedDirectory(boolean b)

(only used when moveProcessedFile=true) when set to true, the directory to move processed files in is created if it does not exist

Default value

false