nl.nn.adapterframework.pipes

Class XmlSwitch

java.lang.Object

nl.nn.adapterframework.core.TransactionAttributes

nl.nn.adapterframework.pipes.AbstractPipe

nl.nn.adapterframework.pipes.XmlSwitch

All Implemented Interfaces:

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

@Category(value="Basic")
 @ElementType(value=ROUTER)
public class XmlSwitch
extends AbstractPipe

Selects an exitState, based on either the content of the input message, by means of a XSLT-stylesheet, the content of a session variable or, by default, by returning the name of the root-element.

Author:

Johan Verrips

Field Summary

Fields

Modifier and Type	Field and Description
static String	XML_SWITCH_FORWARD_FOUND_MONITOR_EVENT
static String	XML_SWITCH_FORWARD_NOT_FOUND_MONITOR_EVENT

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

Method Summary

Modifier and Type	Method and Description
void	configure() If no styleSheetName is specified, the switch uses the root node.
boolean	consumesSessionVariable(String sessionKey) returns true if the pipe or one of its children use the named session variable.
PipeRunResult	doPipe(Message message, PipeLineSession session) This is where the action takes place, the switching is done.
String	getSessionKey() Deprecated.
void	setEmptyForwardName(String empty) Forward returned when the content, on which the switch is performed, is empty.
void	setForwardNameSessionKey(String forwardNameSessionKey) Session key that will be used to get the forward name from.
void	setNamespaceAware(boolean b) controls namespace-awareness of XSLT transformation
void	setNamespaceDefs(String namespaceDefs) Namespace defintions for xpathExpression.
void	setNotFoundForwardName(String notFound) Forward returned when the pipename derived from the stylesheet could not be found.
void	setServiceSelectionStylesheetFilename(String newServiceSelectionStylesheetFilename) Deprecated.
void	setSessionKey(String sessionKey) Deprecated.
void	setStoreForwardInSessionKey(String storeForwardInSessionKey) Selected forward name will be stored in the specified session key.
void	setStyleSheetName(String styleSheetName) stylesheet may return a string representing the forward to look up
void	setXpathExpression(String xpathExpression) xpath-expression that returns a string representing the forward to look up.
void	setXslt2(boolean b) Deprecated.
void	setXsltVersion(int xsltVersion) If set to 2 or 3 a Saxon (net.sf.saxon) xslt processor 2.0 or 3.0 respectively will be used, otherwise xslt processor 1.0 (org.apache.xalan).
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.

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

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

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

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

Field Detail

XML_SWITCH_FORWARD_FOUND_MONITOR_EVENT

public static final String XML_SWITCH_FORWARD_FOUND_MONITOR_EVENT

See Also:

Constant Field Values

XML_SWITCH_FORWARD_NOT_FOUND_MONITOR_EVENT

public static final String XML_SWITCH_FORWARD_NOT_FOUND_MONITOR_EVENT

See Also:

Constant Field Values

Constructor Detail

XmlSwitch

public XmlSwitch()

Method Detail

configure

public void configure()
               throws ConfigurationException

If no styleSheetName is specified, the switch uses the root node.

Specified by:

configure in interface IConfigurable

Specified by:

configure in interface IPipe

Overrides:

configure in class AbstractPipe

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

This is where the action takes place, the switching is done. Pipes may only throw a PipeRunException, to be handled by the caller of this object.
As WebLogic has the problem that when an non-well formed XML stream is given to weblogic.xerces the transformer gets corrupt, on an exception the configuration is done again, so that the transformer is re-initialized.

Throws:

PipeRunException

consumesSessionVariable

public boolean consumesSessionVariable(String sessionKey)

Description copied from interface: IPipe

returns true if the pipe or one of its children use the named session variable. Callers can use this to determine if a message needs to be preserved.

Specified by:

consumesSessionVariable in interface IPipe

Overrides:

consumesSessionVariable in class AbstractPipe

setStyleSheetName

public void setStyleSheetName(String styleSheetName)

stylesheet may return a string representing the forward to look up

Default value

a stylesheet that returns the name of the root-element

setServiceSelectionStylesheetFilename

@Deprecated
 @ConfigurationWarning(value="Please use the attribute styleSheetName.")
public void setServiceSelectionStylesheetFilename(String newServiceSelectionStylesheetFilename)

Deprecated.

stylesheet may return a string representing the forward to look up

Default value

a stylesheet that returns the name of the root-element

setXpathExpression

public void setXpathExpression(String xpathExpression)

xpath-expression that returns a string representing the forward to look up. It's possible to refer to a parameter (which e.g. contains a value from a sessionkey) by using the parameter name prefixed with $

setNamespaceDefs

public void setNamespaceDefs(String namespaceDefs)

Namespace defintions for xpathExpression. Must be in the form of a comma or space separated list of prefix=namespaceuri-definitions. For some use other cases (NOT xpathExpression), one entry can be without a prefix, that will define the default namespace.

setSessionKey

@Deprecated
 @ConfigurationWarning(value="Please use \'getInputFromSessionKey\' or \'forwardNameSessionKey\' attribute instead.")
public void setSessionKey(String sessionKey)

Deprecated.

getSessionKey

@Deprecated
public String getSessionKey()

Deprecated.

setNotFoundForwardName

public void setNotFoundForwardName(String notFound)

Forward returned when the pipename derived from the stylesheet could not be found.

setEmptyForwardName

public void setEmptyForwardName(String empty)

Forward returned when the content, on which the switch is performed, is empty. if emptyforwardname is not specified, notfoundforwardname is used.

setXsltVersion

public void setXsltVersion(int xsltVersion)

If set to 2 or 3 a Saxon (net.sf.saxon) xslt processor 2.0 or 3.0 respectively will be used, otherwise xslt processor 1.0 (org.apache.xalan). 0 will auto detect

Default value

0

setXslt2

@Deprecated
 @ConfigurationWarning(value="Its value is now auto detected. If necessary, replace with a setting of xsltVersion")
public void setXslt2(boolean b)

Deprecated.

when set true xslt processor 2.0 (net.sf.saxon) will be used, otherwise xslt processor 1.0 (org.apache.xalan)

Default value

false

setStoreForwardInSessionKey

public void setStoreForwardInSessionKey(String storeForwardInSessionKey)

Selected forward name will be stored in the specified session key.

setForwardNameSessionKey

public void setForwardNameSessionKey(String forwardNameSessionKey)

Session key that will be used to get the forward name from.

setNamespaceAware

public void setNamespaceAware(boolean b)

controls namespace-awareness of XSLT transformation

Default value

true