@Category(value="Basic") @ElementType(value=ROUTER) public class XmlSwitch extends AbstractPipe
Modifier and Type | Field and Description |
---|---|
static String |
XML_SWITCH_FORWARD_FOUND_MONITOR_EVENT |
static String |
XML_SWITCH_FORWARD_NOT_FOUND_MONITOR_EVENT |
parameterNamesMustBeUnique
log
LONG_DURATION_MONITORING_EVENT, MESSAGE_SIZE_MONITORING_EVENT, PIPE_EXCEPTION_MONITORING_EVENT
Constructor and Description |
---|
XmlSwitch() |
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. |
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
configureTransactionAttributes, isTransacted, isTransacted, setTransacted, setTransactionTimeout
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getChompCharSize, getDurationThreshold, getElementToMove, getElementToMoveChain, getElementToMoveSessionKey, getEmptyInputReplacement, getGetInputFromFixedValue, getGetInputFromSessionKey, getLocker, getSecLogSessionKeys, getStoreResultInSessionKey, isPreserveInput, isRemoveCompactMsgNamespaces, isRestoreMovedElements, isWriteToSecLog, setPipeLine, throwEvent
getMaxThreads
getName
getApplicationContext, getName
getConfigurationClassLoader
getName
getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute
public static final String XML_SWITCH_FORWARD_FOUND_MONITOR_EVENT
public static final String XML_SWITCH_FORWARD_NOT_FOUND_MONITOR_EVENT
public void configure() throws ConfigurationException
styleSheetName
is specified, the
switch uses the root node.configure
in interface IConfigurable
configure
in interface IPipe
configure
in class AbstractPipe
ConfigurationException
public void start() throws PipeStartException
IPipe
IPipe.configure()
method, for each start and stop command of the
adapter.start
in interface IPipe
start
in class AbstractPipe
PipeStartException
public void stop()
IPipe
Pipe
.stop
in interface IPipe
stop
in class AbstractPipe
public PipeRunResult doPipe(Message message, PipeLineSession session) throws PipeRunException
PipeRunException
public boolean consumesSessionVariable(String sessionKey)
IPipe
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.consumesSessionVariable
in interface IPipe
consumesSessionVariable
in class AbstractPipe
public void setStyleSheetName(String styleSheetName)
@Deprecated @ConfigurationWarning(value="Please use the attribute styleSheetName.") public void setServiceSelectionStylesheetFilename(String newServiceSelectionStylesheetFilename)
public void setXpathExpression(String xpathExpression)
public void setNamespaceDefs(String namespaceDefs)
prefix=namespaceuri
-definitions. For some use other cases (NOT xpathExpression), one entry can be without a prefix, that will define the default namespace.@Deprecated @ConfigurationWarning(value="Please use \'getInputFromSessionKey\' or \'forwardNameSessionKey\' attribute instead.") public void setSessionKey(String sessionKey)
@Deprecated public String getSessionKey()
public void setNotFoundForwardName(String notFound)
public void setEmptyForwardName(String empty)
emptyforwardname
is not specified, notfoundforwardname
is used.public void setXsltVersion(int xsltVersion)
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@Deprecated @ConfigurationWarning(value="Its value is now auto detected. If necessary, replace with a setting of xsltVersion") public void setXslt2(boolean b)
true
xslt processor 2.0 (net.sf.saxon) will be used, otherwise xslt processor 1.0 (org.apache.xalan)public void setStoreForwardInSessionKey(String storeForwardInSessionKey)
public void setForwardNameSessionKey(String forwardNameSessionKey)
public void setNamespaceAware(boolean b)
Copyright © 2023 Frank!Framework. All rights reserved.