Class ApiStreamPipe
java.lang.Object
org.frankframework.core.TransactionAttributes
org.frankframework.pipes.AbstractPipe
org.frankframework.pipes.FixedForwardPipe
org.frankframework.pipes.StreamPipe
org.frankframework.extensions.api.ApiStreamPipe
- All Implemented Interfaces:
FrankElement
,HasApplicationContext
,HasName
,HasTransactionAttribute
,IConfigurable
,IForwardTarget
,IPipe
,IScopeProvider
,IWithParameters
,NameAware
,EventThrowing
,org.springframework.beans.factory.Aware
,org.springframework.context.ApplicationContextAware
,org.springframework.context.Lifecycle
Deprecated.
Extension to StreamPipe for API Management.
In StreamPipe
for parameter httpRequest
and attribute
extractFirstStringPart=true
the first part is returned to the pipeline.
In this class the first part is checked. If it contains a 'MessageID' with namespace,
then the message to return to the pipeline is retrieved from the MessageStore.
This class is created for applications which can not perform one multipart call with a business request in the first (string) part and one or more filestreams in the next (file) parts. Instead of one multipart call, two calls are performed:
- text/xml call with the business request. The API Management application returns on this call an unique messageId (which is saved in the MessageStore together with the business request)
- multipart call with in the first (string) part the unique messageId and in the following (file) parts the filestreams
- Author:
- Peter Leeuwenburgh
-
Field Summary
Fields inherited from class org.frankframework.pipes.StreamPipe
ANTIVIRUS_FAILED_FORWARD
Fields inherited from class org.frankframework.pipes.AbstractPipe
parameterNamesMustBeUnique
Fields inherited from class org.frankframework.core.TransactionAttributes
log
Fields inherited from interface org.frankframework.core.IPipe
LONG_DURATION_MONITORING_EVENT, MESSAGE_SIZE_MONITORING_EVENT, PIPE_EXCEPTION_MONITORING_EVENT
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected String
adjustFirstStringPart
(String firstStringPart, PipeLineSession session) Deprecated.void
Deprecated.Checks for correct configuration of forward.Methods inherited from class org.frankframework.pipes.StreamPipe
doPipe, getAntiVirusFailureAsSoapFault, getAntiVirusFailureReasonSessionKey, getAntiVirusMessagePartName, getAntiVirusPartName, getAntiVirusPassedMessage, getMultipartXmlSessionKey, isCheckAntiVirus, isExtractFirstStringPart, setAntiVirusFailureAsSoapFault, setAntiVirusFailureReasonSessionKey, setAntiVirusMessagePartName, setAntiVirusPartName, setAntiVirusPassedMessage, setCheckAntiVirus, setExtractFirstStringPart, setMultipartXmlSessionKey
Methods inherited from class org.frankframework.pipes.FixedForwardPipe
getParameterValue, setIfParam, setIfValue, setOnlyIfSessionKey, setOnlyIfValue, setSkipOnEmptyInput, setUnlessSessionKey, setUnlessValue, skipPipe
Methods inherited from class org.frankframework.pipes.AbstractPipe
addForward, addParameter, consumesSessionVariable, createBean, findForward, getAdapter, getEventSourceName, getForwards, getParameterList, hasRegisteredForward, isRunning, registerEvent, setApplicationContext, setChompCharSize, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setGetInputFromFixedValue, setGetInputFromSessionKey, setHideRegex, setLocker, setLogIntermediaryResults, setMaxThreads, setName, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSizeStatistics, setStoreResultInSessionKey, setWriteToSecLog, sizeStatisticsEnabled, start, stop, throwEvent
Methods inherited from class org.frankframework.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 org.frankframework.core.HasApplicationContext
getApplicationContext, getConfigurationClassLoader
Methods inherited from interface org.frankframework.core.HasTransactionAttribute
getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute
Methods inherited from interface org.frankframework.core.IForwardTarget
getName
Methods inherited from interface org.frankframework.core.IPipe
getChompCharSize, getDurationThreshold, getElementToMove, getElementToMoveChain, getElementToMoveSessionKey, getEmptyInputReplacement, getGetInputFromFixedValue, getGetInputFromSessionKey, getHideRegex, getLocker, getLogIntermediaryResults, getMaxThreads, getSecLogSessionKeys, getStoreResultInSessionKey, isPreserveInput, isRemoveCompactMsgNamespaces, isRestoreMovedElements, isWriteToSecLog, setPipeLine, throwEvent
-
Constructor Details
-
ApiStreamPipe
public ApiStreamPipe()Deprecated.
-
-
Method Details
-
configure
Deprecated.Description copied from class:FixedForwardPipe
Checks for correct configuration of forward.- Specified by:
configure
in interfaceIConfigurable
- Overrides:
configure
in classFixedForwardPipe
- Throws:
ConfigurationException
- in case it was not able to configure the component.
-
adjustFirstStringPart
protected String adjustFirstStringPart(String firstStringPart, PipeLineSession session) throws PipeRunException Deprecated.- Overrides:
adjustFirstStringPart
in classStreamPipe
- Throws:
PipeRunException
-