Package org.frankframework.soap

Class SoapWrapperPipe

java.lang.Object

org.frankframework.core.TransactionAttributes

org.frankframework.pipes.AbstractPipe

org.frankframework.pipes.FixedForwardPipe

org.frankframework.soap.SoapWrapperPipe

All Implemented Interfaces:

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

public class SoapWrapperPipe
extends FixedForwardPipe
implements IWrapperPipe

Pipe to wrap or unwrap a message from/into a SOAP Envelope.

Author:

Peter Leeuwenburgh

Parameters

Any parameters defined on the pipe will be applied to the created transformer.

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	DEFAULT_SOAP_HEADER_SESSION_KEY
protected static final String	DEFAULT_SOAP_NAMESPACE_SESSION_KEY
protected static final SoapVersion	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
SoapWrapperPipe()

Method Summary

Modifier and Type	Method	Description
void	configure()	checks for correct configuration of forward
PipeRunResult	doPipe(Message message, PipeLineSession session)	This is where the action takes place.
IWrapperPipe.Direction	getDirection()
String	getEncodingStyle()
String	getOutputNamespace()
String	getRoot()
String	getServiceNamespace()
String	getSoapBodyStyleSheet()
String	getSoapHeaderSessionKey()
String	getSoapHeaderStyleSheet()
String	getSoapNamespace()
String	getSoapNamespaceSessionKey()
SoapVersion	getSoapVersion()
String	getWssAuthAlias()
String	getWssPassword()
String	getWssUserName()
boolean	isAllowPlainXml()
boolean	isIgnoreSoapFault()
boolean	isOmitXmlDeclaration()
boolean	isRemoveOutputNamespaces()
boolean	isRemoveUnusedOutputNamespaces()
boolean	isWssPasswordDigest()
void	setAllowPlainXml(boolean allowPlainXml)	For direction=unwrap only: if true, allow unwrapped xml too
void	setDirection(IWrapperPipe.Direction value)
void	setEncodingStyle(String string)	The encodingStyle to be set in the soap header
void	setIgnoreSoapFault(boolean b)	(only used when direction=unwrap) If false and the soap body contains a soap fault, a PipeRunException is thrown
void	setOmitXmlDeclaration(boolean b)	For direction=wrap only: When false, adds an XML declaration to the output message.
void	setOutputNamespace(String string)	(only used when direction=wrap) If not empty, this namespace is added to the root element in the soap body
void	setRemoveOutputNamespaces(boolean b)	(only used when direction=unwrap) If true, namespaces (and prefixes) in the content of the soap body are removed
void	setRemoveUnusedOutputNamespaces(boolean b)	(only used when direction=unwrap and removeoutputnamespaces=false) If true, unused namespaces in the content of the soap body are removed
void	setRoot(String string)	If not empty, the root element in the soap body is changed to this value
void	setServiceNamespace(String string)	The default for the namespace of the message sent.
void	setSoapBodyStyleSheet(String string)	(only used when direction=wrap) Stylesheet to apply to the input message.
void	setSoapHeaderSessionKey(String string)	Key of session variable to store soap header
void	setSoapHeaderStyleSheet(String string)	(only used when direction=wrap) Stylesheet to create the content of the soap header.
void	setSoapNamespace(String soapNamespace)	(only used when direction=wrap) Namespace of the soap envelope
void	setSoapNamespaceSessionKey(String string)	Key of session variable to store auto-detected soapNamespace
void	setSoapVersion(SoapVersion value)	Soap version to use
void	setWssAuthAlias(String string)	alias used to obtain credentials for authentication to WebServiceSecurity
void	setWssPassword(String string)	Default password for WebServiceSecurity
void	setWssPasswordDigest(boolean b)	If true, the password is sent digested; Otherwise it is sent in clear text
void	setWssUserName(String string)	Default username for WebServiceSecurity
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.
protected Message	unwrapMessage(Message message, PipeLineSession session)
protected Message	wrapMessage(Message message, String soapHeader, PipeLineSession session)

Methods inherited from class org.frankframework.pipes.FixedForwardPipe

getIfParam, getIfValue, getOnlyIfSessionKey, getOnlyIfValue, getParameterValue, getSuccessForward, getUnlessSessionKey, getUnlessValue, isSkipOnEmptyInput, setIfParam, setIfValue, setOnlyIfSessionKey, setOnlyIfValue, setSkipOnEmptyInput, setUnlessSessionKey, setUnlessValue, skipPipe

Methods inherited from class org.frankframework.pipes.AbstractPipe

addForward, addParameter, consumesSessionVariable, createBean, findForward, getAdapter, getApplicationContext, getChompCharSize, getConfigurationClassLoader, getDurationThreshold, getElementToMove, getElementToMoveChain, getElementToMoveSessionKey, getEmptyInputReplacement, getEventSourceName, getForwards, getGetInputFromFixedValue, getGetInputFromSessionKey, getHideRegex, getLocker, getLogIntermediaryResults, getMaxThreads, getName, getParameterList, getPipeLine, getSecLogSessionKeys, getStoreResultInSessionKey, hasRegisteredForward, isPreserveInput, isRemoveCompactMsgNamespaces, isRestoreMovedElements, isWriteToSecLog, registerEvent, setApplicationContext, setChompCharSize, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setEventPublisher, setGetInputFromFixedValue, setGetInputFromSessionKey, setHideRegex, setLocker, setLogIntermediaryResults, setMaxThreads, setName, setPipeLine, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSizeStatistics, setStoreResultInSessionKey, setWriteToSecLog, sizeStatisticsEnabled, throwEvent

Methods inherited from class org.frankframework.core.TransactionAttributes

configureTransactionAttributes, getTransactionAttribute, getTransactionTimeout, getTxDef, isTransacted, isTransacted, setTransacted, setTransactionAttribute, 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.IConfigurationAware

getApplicationContext, getName

Methods inherited from interface org.frankframework.core.IForwardTarget

getName

Methods inherited from interface org.frankframework.core.INamedObject

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

getConfigurationClassLoader

Methods inherited from interface org.frankframework.core.IWrapperPipe

setName

Field Details

DEFAULT_SOAP_HEADER_SESSION_KEY

protected static final String DEFAULT_SOAP_HEADER_SESSION_KEY

See Also:

• Constant Field Values

DEFAULT_SOAP_NAMESPACE_SESSION_KEY

protected static final String DEFAULT_SOAP_NAMESPACE_SESSION_KEY

See Also:

• Constant Field Values

DEFAULT_SOAP_VERSION_FOR_WRAPPING

protected static final SoapVersion DEFAULT_SOAP_VERSION_FOR_WRAPPING

Constructor Details

SoapWrapperPipe

public SoapWrapperPipe()

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

Specified by:

configure in interface IPipe

Overrides:

configure in class FixedForwardPipe

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 AbstractPipe

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 AbstractPipe

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

Throws:

PipeRunException

unwrapMessage

protected Message unwrapMessage(Message message,
 PipeLineSession session)
                         throws IOException,
TransformerException,
SAXException

Throws:

IOException

TransformerException

SAXException

wrapMessage

protected Message wrapMessage(Message message,
 String soapHeader,
 PipeLineSession session)
                       throws IOException

Throws:

IOException

setDirection

@Default("wrap")
public void setDirection(IWrapperPipe.Direction value)

setSoapVersion

public void setSoapVersion(SoapVersion value)

Soap version to use

Default value

auto

setSoapNamespace

public void setSoapNamespace(String soapNamespace)

(only used when direction=wrap) Namespace of the soap envelope

Default value

auto determined from soapVersion

setSoapNamespaceSessionKey

public void setSoapNamespaceSessionKey(String string)

Key of session variable to store auto-detected soapNamespace

Default value

If configured as Pipeline Input Wrapper or PipeLine Output Wrapper: "soapNamespace"

setSoapHeaderSessionKey

public void setSoapHeaderSessionKey(String string)

Key of session variable to store soap header

Default value

If configured as Pipeline Input Wrapper and direction=unwrap: "soapHeader"

setEncodingStyle

public void setEncodingStyle(String string)

The encodingStyle to be set in the soap header

setServiceNamespace

public void setServiceNamespace(String string)

The default for the namespace of the message sent. Identifies the service to be called. May be overriden by an actual namespace setting in the message to be sent

setSoapHeaderStyleSheet

public void setSoapHeaderStyleSheet(String string)

(only used when direction=wrap) Stylesheet to create the content of the soap header. As input for this stylesheet a dummy xml string is used. Note: outputType=xml and xsltVersion=

setSoapBodyStyleSheet

public void setSoapBodyStyleSheet(String string)

(only used when direction=wrap) Stylesheet to apply to the input message. Note: outputType=xml and xsltVersion=2

setRemoveOutputNamespaces

public void setRemoveOutputNamespaces(boolean b)

(only used when direction=unwrap) If true, namespaces (and prefixes) in the content of the soap body are removed

Default value

false

setRemoveUnusedOutputNamespaces

public void setRemoveUnusedOutputNamespaces(boolean b)

(only used when direction=unwrap and removeoutputnamespaces=false) If true, unused namespaces in the content of the soap body are removed

Default value

true

setOutputNamespace

public void setOutputNamespace(String string)

(only used when direction=wrap) If not empty, this namespace is added to the root element in the soap body

setRoot

public void setRoot(String string)

If not empty, the root element in the soap body is changed to this value

setIgnoreSoapFault

public void setIgnoreSoapFault(boolean b)

(only used when direction=unwrap) If false and the soap body contains a soap fault, a PipeRunException is thrown

Default value

false

setAllowPlainXml

public void setAllowPlainXml(boolean allowPlainXml)

For direction=unwrap only: if true, allow unwrapped xml too

Default value

false

setWssAuthAlias

public void setWssAuthAlias(String string)

alias used to obtain credentials for authentication to WebServiceSecurity

setWssUserName

public void setWssUserName(String string)

Default username for WebServiceSecurity

Default value

setWssPassword

public void setWssPassword(String string)

Default password for WebServiceSecurity

Default value

setWssPasswordDigest

public void setWssPasswordDigest(boolean b)

If true, the password is sent digested; Otherwise it is sent in clear text

Default value

true

setOmitXmlDeclaration

public void setOmitXmlDeclaration(boolean b)

For direction=wrap only: When false, adds an XML declaration to the output message.

Default value

true

getDirection

public IWrapperPipe.Direction getDirection()

getSoapVersion

public SoapVersion getSoapVersion()

getSoapNamespace

public String getSoapNamespace()

getSoapNamespaceSessionKey

public String getSoapNamespaceSessionKey()

getSoapHeaderSessionKey

public String getSoapHeaderSessionKey()

getEncodingStyle

public String getEncodingStyle()

getServiceNamespace

public String getServiceNamespace()

getSoapHeaderStyleSheet

public String getSoapHeaderStyleSheet()

getSoapBodyStyleSheet

public String getSoapBodyStyleSheet()

isRemoveOutputNamespaces

public boolean isRemoveOutputNamespaces()

isRemoveUnusedOutputNamespaces

public boolean isRemoveUnusedOutputNamespaces()

getOutputNamespace

public String getOutputNamespace()

getRoot

public String getRoot()

isIgnoreSoapFault

public boolean isIgnoreSoapFault()

isAllowPlainXml

public boolean isAllowPlainXml()

isOmitXmlDeclaration

public boolean isOmitXmlDeclaration()

getWssAuthAlias

public String getWssAuthAlias()

getWssUserName

public String getWssUserName()

getWssPassword

public String getWssPassword()

isWssPasswordDigest

public boolean isWssPasswordDigest()