nl.nn.adapterframework.extensions.fxf

Class FxfWrapperPipe

java.lang.Object

nl.nn.adapterframework.core.TransactionAttributes

nl.nn.adapterframework.pipes.AbstractPipe

nl.nn.adapterframework.pipes.FixedForwardPipe

nl.nn.adapterframework.soap.SoapWrapperPipe

nl.nn.adapterframework.extensions.esb.EsbSoapWrapperPipe

nl.nn.adapterframework.extensions.fxf.FxfWrapperPipe

All Implemented Interfaces:

HasTransactionAttribute, IConfigurable, IConfigurationAware, IExtendedPipe, IForwardTarget, INamedObject, IPipe, IScopeProvider, IWrapperPipe, EventThrowing, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class FxfWrapperPipe
extends EsbSoapWrapperPipe

FxF wrapper to be used with FxF3. When receiving files (direction=unwrap) the message handed to the pipeline is the local filename extracted from an ESB SOAP message. When sending files (direction=wrap) input should be a local filename which will be wrapped into an ESB SOAP message. Please note: When writing files which need to be send through FxF they should be written to ${fxf.dir}/NNX00000/out. The property ${fxf.dir} will automatically be available on the OTAP environment (define it in StageSpecifics_LOC.properties only). Replace NNX00000 with the specific flowId and generate a unique filename (files will automatically be cleaned after 30 days or any other value specified by ${fxf.retention}).

Author:

Jaco de Groot

Nested Class Summary

Nested classes/interfaces inherited from class nl.nn.adapterframework.extensions.esb.EsbSoapWrapperPipe

EsbSoapWrapperPipe.Mode

Nested classes/interfaces inherited from interface nl.nn.adapterframework.core.IWrapperPipe

IWrapperPipe.Direction

Field Summary

Fields inherited from class nl.nn.adapterframework.extensions.esb.EsbSoapWrapperPipe

APPLICATIONFUNCTION, APPLICATIONNAME, BUSINESSDOMAIN, CMHVERSION, CONVERSATIONID, CORRELATIONID, CPAID, DESTINATION, EXTERNALREFTOMESSAGEID, FIXRESULTNAMESPACE, FROMID, MESSAGEID, MESSAGINGLAYER, MODE, OPERATIONNAME, OPERATIONVERSION, OUTPUTNAMESPACEBASEURI, PARADIGM, PHYSICALDESTINATION, SERVICECONTEXT, SERVICECONTEXTVERSION, SERVICELAYER, SERVICENAME, TIMESTAMP, TRANSACTIONID

Fields inherited from class nl.nn.adapterframework.soap.SoapWrapperPipe

DEFAULT_SOAP_HEADER_SESSION_KEY, DEFAULT_SOAP_NAMESPACE_SESSION_KEY, DEFAULT_SOAP_VERSION_FOR_WRAPPING

Fields inherited from class nl.nn.adapterframework.pipes.AbstractPipe

parameterNamesMustBeUnique

Fields inherited from class nl.nn.adapterframework.core.TransactionAttributes

log

Fields inherited from interface nl.nn.adapterframework.core.IExtendedPipe

LONG_DURATION_MONITORING_EVENT, MESSAGE_SIZE_MONITORING_EVENT, PIPE_EXCEPTION_MONITORING_EVENT

Constructor Summary

Constructors

Constructor and Description
FxfWrapperPipe()

Method Summary

Modifier and Type	Method and Description
void	configure() checks for correct configuration of forward
PipeRunResult	doPipe(Message message, PipeLineSession session) This is where the action takes place.
void	setClientFilenameSessionKey(String clientFilenameSessionKey)
void	setCreateFolder(boolean createFolder) when set to true, the folder corresponding fxf.dir property will be created in case it does not exist
void	setFlowId(String flowId) The flowId of the file transfer when direction=wrap.
void	setFlowIdSessionKey(String flowIdSessionKey)
void	setFlowOutFolder(String flowOutFolder) specifies the output folder if transformFilename=false and direction=wrap
void	setFxfDirSessionKey(String fxfDirSessionKey)
void	setFxfFileSessionKey(String fxfFileSessionKey)
void	setFxfVersion(String fxfVersion) either 3.1 or 3.2
void	setSoapBodySessionKey(String soapBodySessionKey)
void	setTransferFlowIdSessionKey(String transferFlowIdSessionKey)
void	setTransformFilename(boolean transformFilename) when true and direction=wrap, the input which is expected to be a local filename will be transformed to the filename as known on the IUF State machine.
void	setUseServerFilename(boolean useServerFilename) when set to true, ServerFileName from the input will be used as the filename
void	start() Perform necessary action to start the pipe.
void	stop() Perform necessary actions to stop the Pipe. For instance, closing JMS connections, DBMS connections etc.

Methods inherited from class nl.nn.adapterframework.extensions.esb.EsbSoapWrapperPipe

getApplicationFunction, getApplicationName, getBusinessDomain, getDestination, getMessagingLayer, getOperationName, getOperationVersion, getOutputNamespaceBaseUri, getParadigm, getServiceContext, getServiceContextVersion, getServiceLayer, getServiceName, isEsbDestinationWithoutServiceContext, isEsbNamespaceWithoutServiceContext, isValidNamespace, retrievePhysicalDestinationFromListener, retrievePhysicalDestinationFromSender, setAddOutputNamespace, setCmhVersion, setEsbAlias, setFixResultNamespace, setMode, setP2pAlias, setRetrievePhysicalDestination, setUseFixedValues

Methods inherited from class nl.nn.adapterframework.soap.SoapWrapperPipe

setAllowPlainXml, setDirection, setEncodingStyle, setIgnoreSoapFault, setOutputNamespace, setRemoveOutputNamespaces, setRemoveUnusedOutputNamespaces, setRoot, setServiceNamespace, setSoapBodyStyleSheet, setSoapHeaderSessionKey, setSoapHeaderStyleSheet, setSoapNamespace, setSoapNamespaceSessionKey, setSoapVersion, setWssAuthAlias, setWssPassword, setWssPasswordDigest, setWssUserName, unwrapMessage, wrapMessage

Methods inherited from class nl.nn.adapterframework.pipes.FixedForwardPipe

getParameterValue, setIfParam, setIfValue, setOnlyIfSessionKey, setOnlyIfValue, setSkipOnEmptyInput, setUnlessSessionKey, setUnlessValue, skipPipe

Methods inherited from class nl.nn.adapterframework.pipes.AbstractPipe

addParameter, consumesSessionVariable, createBean, findForward, getAdapter, getEventSourceName, getForwards, getInSizeStatDummyObject, getOutSizeStatDummyObject, getParameterList, hasSizeStatistics, registerEvent, registerForward, setApplicationContext, setChompCharSize, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setGetInputFromFixedValue, setGetInputFromSessionKey, setHideRegex, setLocker, setLogIntermediaryResults, setMaxThreads, setName, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSizeStatistics, setStoreResultInSessionKey, setWriteToSecLog, throwEvent

Methods inherited from class nl.nn.adapterframework.core.TransactionAttributes

configureTransactionAttributes, isTransacted, isTransacted, setTransacted, setTransactionTimeout

Methods inherited from class java.lang.Object

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

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

setName

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

consumesSessionVariable, getForwards, getMaxThreads, registerForward

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

getName

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

getName

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

getChompCharSize, getDurationThreshold, getElementToMove, getElementToMoveChain, getElementToMoveSessionKey, getEmptyInputReplacement, getGetInputFromFixedValue, getGetInputFromSessionKey, getLocker, getSecLogSessionKeys, getStoreResultInSessionKey, isPreserveInput, isRemoveCompactMsgNamespaces, isRestoreMovedElements, isWriteToSecLog, setPipeLine, throwEvent

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

getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute

Constructor Detail

FxfWrapperPipe

public FxfWrapperPipe()

Method Detail

configure

public void configure()
               throws ConfigurationException

Description copied from class: FixedForwardPipe

checks for correct configuration of forward

Specified by:

configure in interface IConfigurable

Specified by:

configure in interface IPipe

Overrides:

configure in class EsbSoapWrapperPipe

Throws:

ConfigurationException

start

public void start()
           throws PipeStartException

Description copied from interface: IPipe

Perform necessary action to start the pipe. This method is executed after the IPipe.configure() method, for each start and stop command of the adapter.

Specified by:

start in interface IPipe

Overrides:

start in class SoapWrapperPipe

Throws:

PipeStartException

stop

public void stop()

Description copied from interface: IPipe

Perform necessary actions to stop the Pipe.
For instance, closing JMS connections, DBMS connections etc.

Specified by:

stop in interface IPipe

Overrides:

stop in class SoapWrapperPipe

doPipe

public PipeRunResult doPipe(Message message,
                            PipeLineSession session)
                     throws PipeRunException

Description copied from interface: IPipe

This is where the action takes place. Pipes may only throw a PipeRunException, to be handled by the caller of this object. Implementations must either consume the message, or pass it on to the next Pipe in the PipeRunResult. If the result of the Pipe does not depend on the input, like for the FixedResultPipe, the Pipe can schedule the input to be closed at session exit, by calling Message.closeOnCloseOf(PipeLineSession, String) This allows the previous Pipe to release any resources (e.g. connections) that it might have kept open until the message was consumed. Doing so avoids connections leaking from pools, while it enables efficient streaming processing of data while it is being read from a stream.

Specified by:

doPipe in interface IPipe

Overrides:

doPipe in class SoapWrapperPipe

Throws:

PipeRunException

setFlowId

public void setFlowId(String flowId)

The flowId of the file transfer when direction=wrap. When direction=unwrap the flowId will be extracted from the incoming message and added as a sessionKey to the pipeline.

setFlowOutFolder

public void setFlowOutFolder(String flowOutFolder)

specifies the output folder if transformFilename=false and direction=wrap

setTransformFilename

public void setTransformFilename(boolean transformFilename)

when true and direction=wrap, the input which is expected to be a local filename will be transformed to the filename as known on the IUF State machine.

Default value

true

setSoapBodySessionKey

public void setSoapBodySessionKey(String soapBodySessionKey)

setTransferFlowIdSessionKey

public void setTransferFlowIdSessionKey(String transferFlowIdSessionKey)

setClientFilenameSessionKey

public void setClientFilenameSessionKey(String clientFilenameSessionKey)

setFlowIdSessionKey

public void setFlowIdSessionKey(String flowIdSessionKey)

setFxfDirSessionKey

public void setFxfDirSessionKey(String fxfDirSessionKey)

setFxfFileSessionKey

public void setFxfFileSessionKey(String fxfFileSessionKey)

setFxfVersion

public void setFxfVersion(String fxfVersion)

either 3.1 or 3.2

Default value

3.1

setCreateFolder

public void setCreateFolder(boolean createFolder)

when set to true, the folder corresponding fxf.dir property will be created in case it does not exist

Default value

false

setUseServerFilename

public void setUseServerFilename(boolean useServerFilename)

when set to true, ServerFileName from the input will be used as the filename

Default value

false