nl.nn.adapterframework.extensions.esb

Class EsbSoapWrapperPipe

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.esb.EsbSoapWrapperPipe

All Implemented Interfaces:

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

Direct Known Subclasses:

FxfWrapperPipe

@Category(value="NN-Special")
public class EsbSoapWrapperPipe
extends SoapWrapperPipe

Extension to SoapWrapperPipe for separate modes.

Configuration (where deviating from SoapWrapperPipe):

attributes	description	default
mode	either i2t (ifsa2tibco), reg (regular) or bis (Business Integration Services)	reg
cmhVersion	(only used when mode=reg) Common Message Header version (1 or 2)	1 when mode=reg, 0 otherwise
soapHeaderSessionKey	if direction=unwrap:	soapHeader
soapHeaderStyleSheet	if direction=wrap and mode=i2t:	/xml/xsl/esb/soapHeader.xsl
	if direction=wrap and mode=reg:	TODO (for now identical to the "i2t" SOAP Header)
	if direction=wrap and mode=bis:	/xml/xsl/esb/bisSoapHeader.xsl
soapBodyStyleSheet	if direction=wrap and mode=reg:	/xml/xsl/esb/soapBody.xsl
	if direction=wrap and mode=bis:	/xml/xsl/esb/bisSoapBody.xsl
addOutputNamespace	(only used when direction=wrap) when true, outputNamespace is automatically set using the parameters (if $messagingLayer='P2P' then 'http://nn.nl/XSD/$businessDomain/$applicationName/$applicationFunction' else is serviceContext is not empty 'http://nn.nl/XSD/$businessDomain/$serviceName/$serviceContext/$serviceContextVersion/$operationName/$operationVersion' else 'http://nn.nl/XSD/$businessDomain/$serviceName/$serviceVersion/$operationName/$operationVersion')	false
retrievePhysicalDestination	(only used when direction=wrap) when true, the physical destination is retrieved from the queue instead of using the parameter destination	true
useFixedValues	If true, the fields CorrelationId, MessageId and Timestamp will have a fixed value (for testing purposes only)	false
fixResultNamespace	(only used when direction=wrap) when true and the Result tag already exists, the namespace is changed	false
p2pAlias	When the messagingLayer part of the destination has this value interpret it as P2P
esbAlias	When the messagingLayer part of the destination has this value interpret it as ESB

/xml/xsl/esb/soapHeader.xsl:

element	level	value
MessageHeader	0
		xmlns=$namespace
From	1
Id	2	$fromId
To	1
Location	2	if $messagingLayer='P2P' then $messagingLayer.$businessDomain.$applicationName.$applicationFunction.$paradigm else if $serviceContext is not empty then $messagingLayer.$businessDomain.$serviceLayer.$serviceName.$serviceContext.$serviceContextVersion.$operationName.$operationVersion.$paradigm else $messagingLayer.$businessDomain.$serviceLayer.$serviceName.$serviceVersion.$operationName.$operationVersion.$paradigm
HeaderFields	1
CPAId	2	$cpaId
ConversationId	2	$conversationId
CorrelationId	2	$correlationId (if empty then skip this element)
MessageId	2	$messageId
ExternalRefToMessageId	2	$externalRefToMessageId (if empty then skip this element)
Timestamp	2	$timestamp
TransactionId	2	$transactionId (only used when $mode=reg and $cmhVersion=2; if empty then skip this element)
Service	1
Name	2	$serviceName
Context	2	$serviceContext
Action	2
Paradigm	3	$paradigm
Name	3	$operationName
Version	3	$operationVersion

Parameters:

name	default
mode	copied from mode
cmhVersion	copied from cmhVersion
namespace	"http://nn.nl/XSD/Generic/MessageHeader/2" (only when $mode=reg and $cmhVersion=2) "http://nn.nl/XSD/Generic/MessageHeader/1" (otherwise)
businessDomain
serviceName
serviceContext
service(Context)Version	1
operationName
operationVersion	1
paradigm
applicationName
applicationFunction
messagingLayer	ESB
serviceLayer
destination	if not empty this parameter contains the preceding parameters as described in 'Location' in the table above
fromId	property 'instance.name'
cpaId	if applicable, copied from the original (received) SOAP Header, else 'n/a'
conversationId	if applicable, copied from the original (received) SOAP Header, else parameter pattern '{hostname}_{uid}'
messageId	parameter pattern '{hostname}_{uid}'
correlationId	if $paradigm equals 'Response' then copied from MessageId in the original (received) SOAP Header
externalRefToMessageId	if applicable, copied from the original (received) SOAP Header
timestamp	parameter pattern '{now,date,yyyy-MM-dd'T'HH:mm:ss}'
transactionId	if applicable, copied from the original (received) SOAP Header

/xml/xsl/esb/bisSoapHeader.xsl:

element	level	value
MessageHeader	0
		xmlns=$namespace
From	1
Id	2	$fromId
HeaderFields	1
ConversationId	2	$conversationId
MessageId	2	$messageId
ExternalRefToMessageId	2	$externalRefToMessageId (if empty then skip this element)
Timestamp	2	$timestamp

Parameters:

name	default
namespace	"http://www.ing.com/CSP/XSD/General/Message_2"
fromId	property 'instance.name'
conversationId	if applicable, copied from the original (received) SOAP Header, else parameter pattern '{hostname}_{uid}'
messageId	parameter pattern '{hostname}_{uid}'
externalRefToMessageId	if applicable, copied from MessageId in the original (received) SOAP Header
timestamp	parameter pattern '{now,date,yyyy-MM-dd'T'HH:mm:ss}'

/xml/xsl/esb/soapBody.xsl:

element	level	value
[Payload]	0	if $errorCode is empty then the complete payload will be copied and if not already existing a Result tag will be added else only the root tag will be copied
Result	1	this element will be the last child in the copied root tag (only applicable for $paradigm 'Response'); if $errorCode is empty and a Result tag already exists then skip this element including its child elements
		xmlns=$namespace
Status	2	if $errorCode is empty then 'OK' else 'ERROR'
ErrorList	2	if $errorCode is empty then skip this element including its child elements
Error	3
Code	4	$errorCode
Reason	4	if $errorReason is not empty then $errorReason else it will be derived from $errorCode: errorCode errorText ERR6002 Service Interface Request Time Out ERR6003 Invalid Request Message ERR6004 Invalid Backend system response ERR6005 Backend system failure response ERR6999 Unspecified Errors
Service	4
Name	5	$serviceName
Context	5	$serviceContext
Action	5
Paradigm	6	$paradigm
Name	6	$operationName
Version	6	$operationVersion
DetailList	4	if $errorDetailCode is empty then skip this element including its child elements
Detail	5
Code	6	$errorDetailCode
Text	6	$errorDetailText (if empty then skip this element)

Parameters:

name	default
mode	copied from mode
cmhVersion	copied from cmhVersion
namespace	"http://nn.nl/XSD/Generic/MessageHeader/2" (only when $mode=reg and $cmhVersion=2) "http://nn.nl/XSD/Generic/MessageHeader/1" (otherwise)
errorCode
errorReason
errorDetailCode
errorDetailText
serviceName
serviceContext
operationName
operationVersion	1
paradigm
fixResultNamespace	false

/xml/xsl/esb/bisSoapBody.xsl:

element	level	value
[Payload]	0	if $errorCode is empty then the complete payload will be copied and if not already existing a Result tag will be added else only the root tag will be copied
Result	1	this element will be the last child in the copied root tag (only applicable for $paradigm 'Response' and 'Reply'); if $errorCode is empty and a Result tag already exists then skip this element including its child elements
		xmlns=$namespace
Status	2	if $errorCode is empty then 'OK' else 'ERROR'
ErrorList	2	if $errorCode is empty then skip this element including its child elements
Error	3
Code	4	$errorCode
Reason	4	if $errorReason is not empty then $errorReason else it will be derived from $errorCode: errorCode errorText ERR6002 Service Interface Request Time Out ERR6003 Invalid Request Message ERR6004 Invalid Backend system response ERR6005 Backend system failure response ERR6999 Unspecified Errors
Service	4
Name	5	$serviceName
Context	5	$serviceContext
Action	5
Name	6	$operationName
Version	6	$operationVersion
DetailList	4	if $errorDetailCode is empty then skip this element including its child elements
Detail	5
Code	6	$errorDetailCode
Text	6	$errorDetailText (if empty then skip this element)

Parameters:

name	default
namespace	"http://www.ing.com/CSP/XSD/General/Message_2"
errorCode
errorReason
errorDetailCode
errorDetailText
serviceName
serviceContext
operationName
operationVersion	1
paradigm

Author:

Peter Leeuwenburgh

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	EsbSoapWrapperPipe.Mode

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	APPLICATIONFUNCTION
protected static String	APPLICATIONNAME
protected static String	BUSINESSDOMAIN
protected static String	CMHVERSION
protected static String	CONVERSATIONID
protected static String	CORRELATIONID
protected static String	CPAID
protected static String	DESTINATION
protected static String	EXTERNALREFTOMESSAGEID
protected static String	FIXRESULTNAMESPACE
protected static String	FROMID
protected static String	MESSAGEID
protected static String	MESSAGINGLAYER
protected static String	MODE
protected static String	OPERATIONNAME
protected static String	OPERATIONVERSION
protected static String	OUTPUTNAMESPACEBASEURI
protected static String	PARADIGM
protected static String	PHYSICALDESTINATION
protected static String	SERVICECONTEXT
protected static String	SERVICECONTEXTVERSION
protected static String	SERVICELAYER
protected static String	SERVICENAME
protected static String	TIMESTAMP
protected static String	TRANSACTIONID

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

Method Summary

Modifier and Type	Method and Description
void	configure() checks for correct configuration of forward
String	getApplicationFunction()
String	getApplicationName()
String	getBusinessDomain()
String	getDestination()
String	getMessagingLayer()
String	getOperationName()
String	getOperationVersion()
static String	getOutputNamespaceBaseUri()
String	getParadigm()
String	getServiceContext()
String	getServiceContextVersion()
String	getServiceLayer()
String	getServiceName()
static boolean	isEsbDestinationWithoutServiceContext(String destination)
static boolean	isEsbNamespaceWithoutServiceContext(String namespace)
static boolean	isValidNamespace(String namespace)
boolean	retrievePhysicalDestinationFromListener(IListener listener)
boolean	retrievePhysicalDestinationFromSender(ISender sender)
void	setAddOutputNamespace(boolean b) (only used when direction=wrap) when true, outputNamespace is automatically set using the parameters (if $messagingLayer='P2P' then 'http://nn.nl/XSD/$businessDomain/$applicationName/$applicationFunction' else is serviceContext is not empty 'http://nn.nl/XSD/$businessDomain/$serviceName/$serviceContext/$serviceContextVersion/$operationName/$operationVersion' else 'http://nn.nl/XSD/$businessDomain/$serviceName/$serviceVersion/$operationName/$operationVersion')
void	setCmhVersion(int i) Only used when mode=reg! Sets the Common Message Header version.
void	setEsbAlias(String esbAlias) When the messagingLayer part of the destination has this value interpret it as ESB
void	setFixResultNamespace(boolean b) (only used when direction=wrap) when true and the Result tag already exists, the namespace is changed
void	setMode(EsbSoapWrapperPipe.Mode mode)
void	setP2pAlias(String p2pAlias) When the messagingLayer part of the destination has this value interpret it as P2P
void	setRetrievePhysicalDestination(boolean b) (only used when direction=wrap) when true, the physical destination is retrieved from the queue instead of using the parameter destination
void	setUseFixedValues(boolean b) If true, the fields CorrelationId, MessageId and Timestamp will have a fixed value (for testing purposes only)

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

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

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

getParameterValue, setIfParam, setIfValue, setOnlyIfSessionKey, setOnlyIfValue, setSkipOnEmptyInput, setUnlessSessionKey, setUnlessValue, skipPipe

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

addParameter, consumesSessionVariable, createBean, findForward, getAdapter, getEventSourceName, getForwards, getInSizeStatDummyObject, getOutSizeStatDummyObject, getParameterList, getParameterOverriddenAttributeValue, getParameterValueList, 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

OUTPUTNAMESPACEBASEURI

protected static final String OUTPUTNAMESPACEBASEURI

See Also:

Constant Field Values

BUSINESSDOMAIN

protected static final String BUSINESSDOMAIN

See Also:

Constant Field Values

SERVICENAME

protected static final String SERVICENAME

See Also:

Constant Field Values

SERVICECONTEXT

protected static final String SERVICECONTEXT

See Also:

Constant Field Values

SERVICECONTEXTVERSION

protected static final String SERVICECONTEXTVERSION

See Also:

Constant Field Values

OPERATIONNAME

protected static final String OPERATIONNAME

See Also:

Constant Field Values

OPERATIONVERSION

protected static final String OPERATIONVERSION

See Also:

Constant Field Values

PARADIGM

protected static final String PARADIGM

See Also:

Constant Field Values

APPLICATIONNAME

protected static final String APPLICATIONNAME

See Also:

Constant Field Values

APPLICATIONFUNCTION

protected static final String APPLICATIONFUNCTION

See Also:

Constant Field Values

MESSAGINGLAYER

protected static final String MESSAGINGLAYER

See Also:

Constant Field Values

SERVICELAYER

protected static final String SERVICELAYER

See Also:

Constant Field Values

DESTINATION

protected static final String DESTINATION

See Also:

Constant Field Values

PHYSICALDESTINATION

protected static final String PHYSICALDESTINATION

See Also:

Constant Field Values

FROMID

protected static final String FROMID

See Also:

Constant Field Values

CPAID

protected static final String CPAID

See Also:

Constant Field Values

CONVERSATIONID

protected static final String CONVERSATIONID

See Also:

Constant Field Values

MESSAGEID

protected static final String MESSAGEID

See Also:

Constant Field Values

CORRELATIONID

protected static final String CORRELATIONID

See Also:

Constant Field Values

EXTERNALREFTOMESSAGEID

protected static final String EXTERNALREFTOMESSAGEID

See Also:

Constant Field Values

TIMESTAMP

protected static final String TIMESTAMP

See Also:

Constant Field Values

FIXRESULTNAMESPACE

protected static final String FIXRESULTNAMESPACE

See Also:

Constant Field Values

TRANSACTIONID

protected static final String TRANSACTIONID

See Also:

Constant Field Values

MODE

protected static final String MODE

See Also:

Constant Field Values

CMHVERSION

protected static final String CMHVERSION

See Also:

Constant Field Values

Constructor Detail

EsbSoapWrapperPipe

public EsbSoapWrapperPipe()

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

getOutputNamespaceBaseUri

public static String getOutputNamespaceBaseUri()

getBusinessDomain

public String getBusinessDomain()

getServiceName

public String getServiceName()

getServiceContext

public String getServiceContext()

getServiceContextVersion

public String getServiceContextVersion()

getOperationName

public String getOperationName()

getOperationVersion

public String getOperationVersion()

getDestination

public String getDestination()

getMessagingLayer

public String getMessagingLayer()

getServiceLayer

public String getServiceLayer()

getParadigm

public String getParadigm()

getApplicationName

public String getApplicationName()

getApplicationFunction

public String getApplicationFunction()

isValidNamespace

public static boolean isValidNamespace(String namespace)

retrievePhysicalDestinationFromSender

public boolean retrievePhysicalDestinationFromSender(ISender sender)

retrievePhysicalDestinationFromListener

public boolean retrievePhysicalDestinationFromListener(IListener listener)
                                                throws JmsException

Throws:

JmsException

isEsbDestinationWithoutServiceContext

public static boolean isEsbDestinationWithoutServiceContext(String destination)

isEsbNamespaceWithoutServiceContext

public static boolean isEsbNamespaceWithoutServiceContext(String namespace)

setMode

public void setMode(EsbSoapWrapperPipe.Mode mode)

Default value

REG

setCmhVersion

public void setCmhVersion(int i)

Only used when mode=reg! Sets the Common Message Header version. 1 or 2

Default value

1

setAddOutputNamespace

public void setAddOutputNamespace(boolean b)

(only used when direction=wrap) when true, outputNamespace is automatically set using the parameters (if $messagingLayer='P2P' then 'http://nn.nl/XSD/$businessDomain/$applicationName/$applicationFunction' else is serviceContext is not empty 'http://nn.nl/XSD/$businessDomain/$serviceName/$serviceContext/$serviceContextVersion/$operationName/$operationVersion' else 'http://nn.nl/XSD/$businessDomain/$serviceName/$serviceVersion/$operationName/$operationVersion')

Default value

false

setRetrievePhysicalDestination

public void setRetrievePhysicalDestination(boolean b)

(only used when direction=wrap) when true, the physical destination is retrieved from the queue instead of using the parameter destination

Default value

true

setUseFixedValues

public void setUseFixedValues(boolean b)

If true, the fields CorrelationId, MessageId and Timestamp will have a fixed value (for testing purposes only)

Default value

false

setFixResultNamespace

public void setFixResultNamespace(boolean b)

(only used when direction=wrap) when true and the Result tag already exists, the namespace is changed

Default value

false

setP2pAlias

public void setP2pAlias(String p2pAlias)

When the messagingLayer part of the destination has this value interpret it as P2P

setEsbAlias

public void setEsbAlias(String esbAlias)

When the messagingLayer part of the destination has this value interpret it as ESB