nl.nn.adapterframework.extensions.api

Class ApiSoapWrapperPipe

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.api.ApiSoapWrapperPipe

All Implemented Interfaces:

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

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

IWrapperPipe.Direction

Field Summary

Fields

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

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

Method Summary

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

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

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

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, 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

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

getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute

Field Detail

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 Detail

ApiSoapWrapperPipe

public ApiSoapWrapperPipe()

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 SoapWrapperPipe

Throws:

ConfigurationException