nl.nn.adapterframework.pipes

Class ValidatorBase

java.lang.Object

nl.nn.adapterframework.core.TransactionAttributes

nl.nn.adapterframework.pipes.AbstractPipe

nl.nn.adapterframework.pipes.FixedForwardPipe

nl.nn.adapterframework.pipes.ValidatorBase

All Implemented Interfaces:

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

Direct Known Subclasses:

JsonValidator, XmlValidator

public abstract class ValidatorBase
extends FixedForwardPipe
implements IDualModeValidator

Pipe that validates the input message against a Schema.

Author:

Gerrit van Brakel

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ValidatorBase.ResponseValidatorWrapper

Field Summary

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

Method Summary

Modifier and Type	Method and Description
void	configure() checks for correct configuration of forward
protected PipeForward	determineForward(AbstractXmlValidator.ValidationResult validationResult, PipeLineSession session, boolean responseMode, Supplier<String> errorMessageProvider)
PipeRunResult	doPipe(Message message, PipeLineSession session) This is where the action takes place.
PipeRunResult	doPipe(Message input, PipeLineSession session, boolean responseMode, String messageRoot)
IValidator	getResponseValidator()
protected boolean	isConfiguredForMixedValidation()
void	setForwardFailureToSuccess(boolean b) Deprecated.
void	setResponseRoot(String responseRoot) Name of the response root element
void	setRoot(String root) Name of the root element
void	setSchemaSessionKey(String schemaSessionKey) Session key for retrieving a schema
protected abstract PipeForward	validate(Message messageToValidate, PipeLineSession session, boolean responseMode, String messageRoot)
PipeRunResult	validate(Message message, PipeLineSession session, String messageRoot)
protected PipeForward	validate(String messageToValidate, PipeLineSession session)

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, hasSizeStatistics, registerEvent, registerForward, setApplicationContext, setChompCharSize, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setGetInputFromFixedValue, setGetInputFromSessionKey, setHideRegex, setLocker, setLogIntermediaryResults, setMaxThreads, setName, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSizeStatistics, setStoreResultInSessionKey, setWriteToSecLog, start, stop, 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.IValidator

setName

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

consumesSessionVariable, getForwards, getMaxThreads, registerForward, start, stop

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

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

getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute

Constructor Detail

ValidatorBase

public ValidatorBase()

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 FixedForwardPipe

Throws:

ConfigurationException

doPipe

public final 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

validate

public PipeRunResult validate(Message message,
                              PipeLineSession session,
                              String messageRoot)
                       throws PipeRunException

Specified by:

validate in interface IValidator

Throws:

PipeRunException

doPipe

public PipeRunResult doPipe(Message input,
                            PipeLineSession session,
                            boolean responseMode,
                            String messageRoot)
                     throws PipeRunException

Throws:

PipeRunException

validate

protected final PipeForward validate(String messageToValidate,
                                     PipeLineSession session)
                              throws PipeRunException,
                                     XmlValidatorException,
                                     ConfigurationException

Throws:

PipeRunException

XmlValidatorException

ConfigurationException

validate

protected abstract PipeForward validate(Message messageToValidate,
                                        PipeLineSession session,
                                        boolean responseMode,
                                        String messageRoot)
                                 throws PipeRunException,
                                        XmlValidatorException,
                                        ConfigurationException

Throws:

PipeRunException

XmlValidatorException

ConfigurationException

determineForward

protected PipeForward determineForward(AbstractXmlValidator.ValidationResult validationResult,
                                       PipeLineSession session,
                                       boolean responseMode,
                                       Supplier<String> errorMessageProvider)
                                throws PipeRunException

Throws:

PipeRunException

isConfiguredForMixedValidation

protected boolean isConfiguredForMixedValidation()

getResponseValidator

public IValidator getResponseValidator()

Specified by:

getResponseValidator in interface IDualModeValidator

setSchemaSessionKey

public void setSchemaSessionKey(String schemaSessionKey)

Session key for retrieving a schema

setRoot

public void setRoot(String root)

Name of the root element

setResponseRoot

public void setResponseRoot(String responseRoot)

Name of the response root element

setForwardFailureToSuccess

@Deprecated
 @ConfigurationWarning(value="please specify a forward with name=failure instead")
public void setForwardFailureToSuccess(boolean b)

Deprecated.

If set true, the failure forward is replaced by the success forward (like a warning mode)