nl.nn.adapterframework.extensions.api

Class ApiStreamPipe

java.lang.Object

nl.nn.adapterframework.core.TransactionAttributes

nl.nn.adapterframework.pipes.AbstractPipe

nl.nn.adapterframework.pipes.FixedForwardPipe

nl.nn.adapterframework.pipes.StreamPipe

nl.nn.adapterframework.extensions.api.ApiStreamPipe

All Implemented Interfaces:

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

public class ApiStreamPipe
extends StreamPipe

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 "http://www.w3.org/2005/08/addressing", 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:

1. 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)
2. 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 nl.nn.adapterframework.pipes.StreamPipe

ANTIVIRUS_FAILED_FORWARD

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
ApiStreamPipe()

Method Summary

Modifier and Type	Method and Description
protected String	adjustFirstStringPart(String firstStringPart, PipeLineSession session)
void	configure() checks for correct configuration of forward
String	getJmsRealm()
void	setJmsRealm(String jmsRealm)

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

doPipe, getAntiVirusFailureAsSoapFault, getAntiVirusFailureReasonSessionKey, getAntiVirusMessagePartName, getAntiVirusPartName, getAntiVirusPassedMessage, getMultipartXmlSessionKey, isCheckAntiVirus, isExtractFirstStringPart, setAntiVirusFailureAsSoapFault, setAntiVirusFailureReasonSessionKey, setAntiVirusMessagePartName, setAntiVirusPartName, setAntiVirusPassedMessage, setCheckAntiVirus, setExtractFirstStringPart, setMultipartXmlSessionKey

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

doInitialPipe, getParameterValue, setIfParam, setIfValue, setSkipOnEmptyInput

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

addParameter, consumesSessionVariable, createBean, findForward, getAdapter, getEventSourceName, getForwards, getInSizeStatDummyObject, getLogPrefix, 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, start, stop, 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.IExtendedPipe

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

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

getMaxThreads

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 nl.nn.adapterframework.core.IForwardTarget

getName

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

getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute

Constructor Detail

ApiStreamPipe

public ApiStreamPipe()

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 FixedForwardPipe

Throws:

ConfigurationException

adjustFirstStringPart

protected String adjustFirstStringPart(String firstStringPart,
                                       PipeLineSession session)
                                throws PipeRunException

Overrides:

adjustFirstStringPart in class StreamPipe

Throws:

PipeRunException

getJmsRealm

public String getJmsRealm()

setJmsRealm

public void setJmsRealm(String jmsRealm)