Package org.frankframework.extensions.api

Class ApiSoapWrapperPipe

java.lang.Object

org.frankframework.core.TransactionAttributes

org.frankframework.pipes.AbstractPipe

org.frankframework.pipes.FixedForwardPipe

org.frankframework.soap.SoapWrapperPipe

org.frankframework.extensions.api.ApiSoapWrapperPipe

All Implemented Interfaces:

FrankElement, HasApplicationContext, HasName, HasTransactionAttribute, IConfigurable, IForwardTarget, IPipe, IScopeProvider, IWithParameters, IWrapperPipe, NameAware, EventThrowing, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle

public class ApiSoapWrapperPipe
extends SoapWrapperPipe

Extension to SoapWrapperPipe for API Management.

Configuration (where deviating from SoapWrapperPipe):

attributes	description	default
soapHeaderSessionKey	if direction=wrap:	soapHeader
soapHeaderStyleSheet	if direction=wrap:	/xml/xsl/api/soapHeader.xsl

/xml/xsl/api/soapHeader.xsl:

element	level	value
MessageHeader	0	MessageHeader is only created when $conversationId is filled (otherwise skipped)
		xmlns=$namespace
From	1	From is only created when $from_in is filled (otherwise skipped) and it's created with the value of $from_out
HeaderFields	1
ConversationId	2	$conversationId

Parameters:

name	default
namespace	"http://api.nn.nl/MessageHeader"
from_in	if applicable, copied from the original (received) SOAP Header
from_out	property 'instance.name'
conversationId	if applicable, copied from the original (received) SOAP Header

Author:

Peter Leeuwenburgh

Nested Class Summary

Nested classes/interfaces inherited from interface org.frankframework.core.IWrapperPipe

IWrapperPipe.Direction

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	CONVERSATIONID
protected static final String	FROM_IN
protected static final String	FROM_OUT

Fields inherited from class org.frankframework.soap.SoapWrapperPipe

DEFAULT_SOAP_HEADER_SESSION_KEY, DEFAULT_SOAP_NAMESPACE_SESSION_KEY, DEFAULT_SOAP_VERSION_FOR_WRAPPING

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

Constructor	Description
ApiSoapWrapperPipe()

Method Summary

Modifier and Type	Method	Description
void	configure()	Checks for correct configuration of forward.

Methods inherited from class org.frankframework.soap.SoapWrapperPipe

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

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, 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.springframework.context.ApplicationContextAware

setApplicationContext

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

getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute

Methods inherited from interface org.frankframework.core.IForwardTarget

getName

Methods inherited from interface org.frankframework.core.IPipe

addForward, consumesSessionVariable, getChompCharSize, getDurationThreshold, getElementToMove, getElementToMoveChain, getElementToMoveSessionKey, getEmptyInputReplacement, getForwards, getGetInputFromFixedValue, getGetInputFromSessionKey, getHideRegex, getLocker, getLogIntermediaryResults, getMaxThreads, getSecLogSessionKeys, getStoreResultInSessionKey, isPreserveInput, isRemoveCompactMsgNamespaces, isRestoreMovedElements, isWriteToSecLog, registerEvent, setChompCharSize, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setGetInputFromFixedValue, setGetInputFromSessionKey, setHideRegex, setLocker, setLogIntermediaryResults, setPipeLine, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setStoreResultInSessionKey, setWriteToSecLog, sizeStatisticsEnabled, throwEvent, throwEvent

Methods inherited from interface org.frankframework.core.IWrapperPipe

setName

Methods inherited from interface org.springframework.context.Lifecycle

isRunning

Field Details

CONVERSATIONID

protected static final String CONVERSATIONID

See Also:

• Constant Field Values

FROM_IN

protected static final String FROM_IN

See Also:

• Constant Field Values

FROM_OUT

protected static final String FROM_OUT

See Also:

• Constant Field Values

Constructor Details

ApiSoapWrapperPipe

public ApiSoapWrapperPipe()

Method Details

configure

public void configure()
               throws ConfigurationException

Description copied from class: FixedForwardPipe

Checks for correct configuration of forward.

Specified by:

configure in interface IConfigurable

Overrides:

configure in class SoapWrapperPipe

Throws:

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