Class 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
,ReceiverAware<jakarta.jms.Message>
,org.springframework.beans.factory.Aware
,org.springframework.context.ApplicationContextAware
,org.springframework.context.Lifecycle
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" |
- 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.DestinationType, JMSFacade.MessageClass, JMSFacade.SubscriberType
-
Field Summary
Fields inherited from class org.frankframework.jms.JMSFacade
JMS_MESSAGECLASS_KEY, messagingSource
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
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 this component.void
setCreateProcessedDirectory
(boolean b) (only used whenmoveProcessedFile=true
) when set totrue
, the directory to move processed files in is created if it does not existvoid
setFxfFileSessionKey
(String fxfFileSessionKey) name of the session key to store the name of the received file invoid
setMoveProcessedFile
(boolean b) If set totrue
, the received file is moved after being processedvoid
setProcessedSiblingDirectory
(String processedSiblingDirectory) (only used whenmoveProcessedFile=true
) sibling directory (related to the parent directory of the file to process) where files are stored after being processedMethods 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, getMessagingSourceFactory, getPhysicalDestinationName, getPhysicalDestinationShortName, getPhysicalDestinationShortName, isRunning, isSessionsArePooled, logMessageDetails, send, send, send, send, send, send, send, sendByQueue, sendByTopic, setAcknowledgeMode, setAuthAlias, setCorrelationIdMaxLength, setCorrelationIdToHex, setCorrelationIdToHexPrefix, setDestinationType, setLookupDestination, setMessageClass, setMessageCorrelationID, setMessageSelector, setMessageTimeToLive, setPersistent, setQueueConnectionFactoryName, setSubscriberType, setTopicConnectionFactoryName, setTransacted, toString
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.HasPhysicalDestination
getDomain
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.receivers.ReceiverAware
getReceiver, setReceiver
-
Constructor Details
-
FxfListener
public FxfListener()
-
-
Method Details
-
configure
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 thisIConfigurable
. 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 theconfigure()
, to improve performance.In the case of a container, this will propagate the configure signal to all components that apply.
- Specified by:
configure
in interfaceIConfigurable
- Overrides:
configure
in classEsbJmsListener
- 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 interfaceIListener<jakarta.jms.Message>
- Overrides:
afterMessageProcessed
in classEsbJmsListener
- Throws:
ListenerException
-
setFxfFileSessionKey
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 totrue
, the received file is moved after being processed- Default value
- true
-
setProcessedSiblingDirectory
(only used whenmoveProcessedFile=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 whenmoveProcessedFile=true
) when set totrue
, the directory to move processed files in is created if it does not exist- Default value
- false
-