Package org.frankframework.pipes

Class XmlValidator

java.lang.Object

org.frankframework.core.TransactionAttributes

org.frankframework.pipes.AbstractPipe

org.frankframework.pipes.FixedForwardPipe

org.frankframework.pipes.AbstractValidator

org.frankframework.pipes.XmlValidator

All Implemented Interfaces:

HasSpecialDefaultValues, FrankElement, HasApplicationContext, HasName, HasTransactionAttribute, IConfigurable, IDualModeValidator, IForwardTarget, IPipe, IScopeProvider, IValidator, IWithParameters, IXmlValidator, NameAware, EventThrowing, SchemasProvider, org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle

Direct Known Subclasses:

Json2XmlValidator

@Category(BASIC)
public class XmlValidator
extends AbstractValidator
implements SchemasProvider, HasSpecialDefaultValues, IXmlValidator, org.springframework.beans.factory.InitializingBean

Pipe that validates the input message against an XML Schema.

Author:

Johan Verrips IOS, Jaco de Groot

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XmlValidator.ResponseValidatorWrapper	Wrapper for the XML response validator.

Field Summary

Fields

Modifier and Type	Field	Description
protected ConfigurationException	configurationException
protected AbstractXmlValidator	validator

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

Method Summary

Modifier and Type	Method	Description
protected void	addInvalidRootNamespaces(List<String> path, List<String> invalidRootNamespaces)
protected void	addRequestRootValidation(RootValidation path)
protected void	addResponseRootValidation(RootValidation path)
void	afterPropertiesSet()
protected void	checkSchemaSpecified()
void	configure()	Configure the XmlValidator
protected RootValidations	createRootValidation(String messageRoot)
protected PipeForward	determineForward(AbstractXmlValidator.ValidationResult validationResult, PipeLineSession session, boolean responseMode)
PipeRunResult	doPipe(Message input, PipeLineSession session, boolean responseMode, String messageRoot)
String	getCharset()
ConfigurationException	getConfigurationException()
String	getDocumentation()	Provide additional generic documentation on the validation of the subsequent processing.
protected PipeRunResult	getErrorResult(String reason, PipeLineSession session, boolean responseMode)
Boolean	getIgnoreUnknownNamespaces()
String	getImportedNamespacesToIgnore()
String	getImportedSchemaLocationsToIgnore()
Map<List<String>,List<String>>	getInvalidRootNamespaces()
String	getMessageRoot()
String	getMessageRoot(boolean responseMode)
String	getNoNamespaceSchemaLocation()
String	getReasonSessionKey()
protected RootValidations	getRequestRootValidations()
protected RootValidations	getResponseRootValidations()
IValidator	getResponseValidator()
String	getRootElementSessionKey()
String	getRootNamespaceSessionKey()
RootValidations	getRootValidations(boolean responseMode)
String	getSchema()
String	getSchemaLocation()
List<Schema>	getSchemas()
List<Schema>	getSchemas(boolean checkRootValidations)
List<Schema>	getSchemas(PipeLineSession session)
String	getSchemasId()
String	getSchemasId(PipeLineSession session)
String	getSoapNamespace()	Deprecated.
Object	getSpecialDefaultValue(String attributeName, Object defaultValue, Map<String,String> attributes)
String	getXmlReasonSessionKey()
Set<IXSD>	getXsds()
List<org.apache.xerces.xs.XSModel>	getXSModels()
boolean	isAddNamespaceToSchema()
protected boolean	isConfiguredForMixedValidation()
boolean	isFullSchemaChecking()
boolean	isThrowException()
boolean	isUseBaseImportedSchemaLocationsToIgnore()
boolean	isValidateFile()
void	setAddNamespaceToSchema(boolean addNamespaceToSchema)	If set true, the namespace from schemalocation is added to the schema document as targetnamespace
void	setCharset(String string)
void	setFullSchemaChecking(boolean fullSchemaChecking)
void	setIgnoreCaching(boolean ignoreCaching)
void	setIgnoreUnknownNamespaces(Boolean ignoreUnknownNamespaces)
void	setImplementation(Class<? extends AbstractXmlValidator> clazz)
void	setImportedNamespacesToIgnore(String string)	Comma separated list of namespaces which are excluded from an import or include in the schema document
void	setImportedSchemaLocationsToIgnore(String string)	Comma separated list of schemaLocations which are excluded from an import or include in the schema document
void	setNoNamespaceSchemaLocation(String noNamespaceSchemaLocation)	A uri reference as a hint as to the location of a schema document with no target namespace.
void	setReasonSessionKey(String reasonSessionKey)
void	setResponseRoot(String responseRoot)	Name of the response root element, or a comma separated list of element names.
void	setRoot(String root)	Name of the root element, or a comma separated list of element names.
void	setRootElementSessionKey(String rootElementSessionKey)	Key of session variable to store the name of the root element
void	setRootNamespaceSessionKey(String rootNamespaceSessionKey)	Key of session variable to store the namespace of the root element
void	setSchema(String schema)	The filename of the schema on the classpath.
void	setSchemaLocation(String schemaLocation)	Pairs of URI references (one for the namespace name, and one for a hint as to the location of a schema document defining names for that namespace name). The syntax is the same as for schemaLocation attributes in instance documents: e.g, "http://www.example.com file%20name.xsd". The user can specify more than one XML Schema in the list. Note that spaces are considered separators for this attributed.
void	setSoapNamespace(String string)	Deprecated.
void	setThrowException(boolean throwException)
void	setUseBaseImportedSchemaLocationsToIgnore(boolean useBaseImportedSchemaLocationsToIgnore)	If set true, the comparison for importedSchemaLocationsToIgnore is done on base filename without any path
void	setValidateFile(boolean b)
void	setWarn(boolean warn)
void	setXmlReasonSessionKey(String xmlReasonSessionKey)
void	setXmlSchemaVersion(String xmlSchemaVersion)
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 PipeForward	validate(Message messageToValidate, PipeLineSession session, boolean responseMode, String messageRoot)

Methods inherited from class org.frankframework.pipes.AbstractValidator

determineForward, doPipe, getResponseRoot, getRoot, getSchemaSessionKey, isForwardFailureToSuccess, setForwardFailureToSuccess, setSchemaSessionKey, validate, validate

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, isRunning, 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.HasApplicationContext

getApplicationContext, getConfigurationClassLoader

Methods inherited from interface org.frankframework.core.HasName

getName

Methods inherited from interface org.frankframework.core.IForwardTarget

getName

Methods inherited from interface org.frankframework.core.IPipe

addForward, consumesSessionVariable, doPipe, 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.IValidator

setName, validate

Methods inherited from interface org.springframework.context.Lifecycle

isRunning

Field Details

validator

protected AbstractXmlValidator validator

configurationException

protected ConfigurationException configurationException

Constructor Details

XmlValidator

public XmlValidator()

Method Details

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

configure

public void configure()
               throws ConfigurationException

Configure the XmlValidator

Specified by:

configure in interface IConfigurable

Specified by:

configure in interface IPipe

Overrides:

configure in class AbstractValidator

Throws:

ConfigurationException - when:

• the schema cannot be found
• <isThrowException() is false and there is no forward defined for "failure"
• when the parser does not accept setting the properties for validating

start

public void start()

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

Specified by:

start in interface org.springframework.context.Lifecycle

Overrides:

start in class AbstractPipe

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

Specified by:

stop in interface org.springframework.context.Lifecycle

Overrides:

stop in class AbstractPipe

checkSchemaSpecified

protected void checkSchemaSpecified()
                             throws ConfigurationException

Throws:

ConfigurationException

getConfigurationException

public ConfigurationException getConfigurationException()

Specified by:

getConfigurationException in interface IXmlValidator

getXSModels

public List<org.apache.xerces.xs.XSModel> getXSModels()

doPipe

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

Overrides:

doPipe in class AbstractValidator

Throws:

PipeRunException

validate

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

Specified by:

validate in class AbstractValidator

Throws:

XmlValidatorException

PipeRunException

ConfigurationException

createRootValidation

protected RootValidations createRootValidation(String messageRoot)

determineForward

protected PipeForward determineForward(AbstractXmlValidator.ValidationResult validationResult,
 PipeLineSession session,
 boolean responseMode)
                                throws PipeRunException

Throws:

PipeRunException

getErrorResult

protected PipeRunResult getErrorResult(String reason,
 PipeLineSession session,
 boolean responseMode)
                                throws PipeRunException

Throws:

PipeRunException

isConfiguredForMixedValidation

protected boolean isConfiguredForMixedValidation()

Overrides:

isConfiguredForMixedValidation in class AbstractValidator

getMessageRoot

public String getMessageRoot(boolean responseMode)

getSchemasId

public String getSchemasId()

Specified by:

getSchemasId in interface SchemasProvider

getXsds

public Set<IXSD> getXsds()
                  throws ConfigurationException

Specified by:

getXsds in interface IXmlValidator

Throws:

ConfigurationException

getSchemas

public List<Schema> getSchemas()
                        throws ConfigurationException

Specified by:

getSchemas in interface SchemasProvider

Throws:

ConfigurationException

getSchemas

public List<Schema> getSchemas(boolean checkRootValidations)
                        throws ConfigurationException

Throws:

ConfigurationException

getResponseValidator

public IValidator getResponseValidator()

Specified by:

getResponseValidator in interface IDualModeValidator

Overrides:

getResponseValidator in class AbstractValidator

getRootValidations

public RootValidations getRootValidations(boolean responseMode)

getSchemasId

public String getSchemasId(PipeLineSession session)
                    throws PipeRunException

Specified by:

getSchemasId in interface SchemasProvider

Throws:

PipeRunException

getSchemas

public List<Schema> getSchemas(PipeLineSession session)
                        throws PipeRunException

Specified by:

getSchemas in interface SchemasProvider

Throws:

PipeRunException

getSpecialDefaultValue

public Object getSpecialDefaultValue(String attributeName,
 Object defaultValue,
 Map<String,String> attributes)

Specified by:

getSpecialDefaultValue in interface HasSpecialDefaultValues

addRequestRootValidation

protected void addRequestRootValidation(RootValidation path)

getRequestRootValidations

protected RootValidations getRequestRootValidations()

addResponseRootValidation

protected void addResponseRootValidation(RootValidation path)

getResponseRootValidations

protected RootValidations getResponseRootValidations()

addInvalidRootNamespaces

protected void addInvalidRootNamespaces(List<String> path,
 List<String> invalidRootNamespaces)

Parameters:

path - to the element from where to start validating namespaces

invalidRootNamespaces - XML namespace that is not allowed on the current element

getInvalidRootNamespaces

public Map<List<String>,List<String>> getInvalidRootNamespaces()

getDocumentation

public String getDocumentation()

Description copied from interface: IXmlValidator

Provide additional generic documentation on the validation of the subsequent processing. This documentation will be included in generated schema's like WSDL or OpenApi

Specified by:

getDocumentation in interface IXmlValidator

setImplementation

public void setImplementation(Class<? extends AbstractXmlValidator> clazz)
                       throws ReflectiveOperationException,
SecurityException

Throws:

ReflectiveOperationException

SecurityException

setSchema

public void setSchema(String schema)

The filename of the schema on the classpath. It is not possible to specify a namespace using this attribute. (effectively the same as noNamespaceSchemaLocation) An example value would be "xml/xsd/GetPartyDetail.xsd". The value of the schema attribute is only used if the schemaLocation attribute and the noNamespaceSchemaLocation are not set.

getSchema

public String getSchema()

Specified by:

getSchema in interface IXmlValidator

Returns:

noNamespaceSchemalocation, if specified

setSchemaLocation

public void setSchemaLocation(String schemaLocation)

Pairs of URI references (one for the namespace name, and one for a hint as to the location of a schema document defining names for that namespace name).
The syntax is the same as for schemaLocation attributes in instance documents: e.g, "http://www.example.com file%20name.xsd".
The user can specify more than one XML Schema in the list.
Note that spaces are considered separators for this attributed. This means that, for example, spaces in filenames should be escaped to %20.

setNoNamespaceSchemaLocation

public void setNoNamespaceSchemaLocation(String noNamespaceSchemaLocation)

A uri reference as a hint as to the location of a schema document with no target namespace.

setRoot

public void setRoot(String root)

Name of the root element, or a comma separated list of element names. The validation fails if the root element is not present in the list. N.B. for WSDL generation only the first element is used

Overrides:

setRoot in class AbstractValidator

setResponseRoot

public void setResponseRoot(String responseRoot)

Name of the response root element, or a comma separated list of element names. The validation fails if the root element is not present in the list. N.B. for WSDL generation only the first element is used

Overrides:

setResponseRoot in class AbstractValidator

getMessageRoot

public String getMessageRoot()

Specified by:

getMessageRoot in interface IXmlValidator

setFullSchemaChecking

@ReferTo(AbstractXmlValidator.class)
public void setFullSchemaChecking(boolean fullSchemaChecking)

isFullSchemaChecking

public boolean isFullSchemaChecking()

setThrowException

@ReferTo(AbstractXmlValidator.class)
public void setThrowException(boolean throwException)

isThrowException

public boolean isThrowException()

Overrides:

isThrowException in class AbstractValidator

setReasonSessionKey

@ReferTo(AbstractXmlValidator.class)
public void setReasonSessionKey(String reasonSessionKey)

getReasonSessionKey

public String getReasonSessionKey()

setXmlReasonSessionKey

@ReferTo(AbstractXmlValidator.class)
public void setXmlReasonSessionKey(String xmlReasonSessionKey)

getXmlReasonSessionKey

public String getXmlReasonSessionKey()

setValidateFile

@ReferTo(AbstractXmlValidator.class)
public void setValidateFile(boolean b)

isValidateFile

public boolean isValidateFile()

setCharset

@ReferTo(AbstractXmlValidator.class)
public void setCharset(String string)

getCharset

public String getCharset()

setAddNamespaceToSchema

public void setAddNamespaceToSchema(boolean addNamespaceToSchema)

If set true, the namespace from schemalocation is added to the schema document as targetnamespace

Default value

false

setImportedSchemaLocationsToIgnore

public void setImportedSchemaLocationsToIgnore(String string)

Comma separated list of schemaLocations which are excluded from an import or include in the schema document

setUseBaseImportedSchemaLocationsToIgnore

public void setUseBaseImportedSchemaLocationsToIgnore(boolean useBaseImportedSchemaLocationsToIgnore)

If set true, the comparison for importedSchemaLocationsToIgnore is done on base filename without any path

Default value

false

setImportedNamespacesToIgnore

public void setImportedNamespacesToIgnore(String string)

Comma separated list of namespaces which are excluded from an import or include in the schema document

setWarn

@ReferTo(AbstractXmlValidator.class)
public void setWarn(boolean warn)

setIgnoreUnknownNamespaces

@ReferTo(AbstractXmlValidator.class)
public void setIgnoreUnknownNamespaces(Boolean ignoreUnknownNamespaces)

getIgnoreUnknownNamespaces

public Boolean getIgnoreUnknownNamespaces()

setIgnoreCaching

@ReferTo(AbstractXmlValidator.class)
public void setIgnoreCaching(boolean ignoreCaching)

setXmlSchemaVersion

@ReferTo(AbstractXmlValidator.class)
public void setXmlSchemaVersion(String xmlSchemaVersion)

setSoapNamespace

@Deprecated
public void setSoapNamespace(String string)

Deprecated.

The namespace of the SOAP envelope, when this property has a value and the input message is a SOAP message, the content of the SOAP Body is used for validation, hence the SOAP Envelope and SOAP Body elements are not considered part of the message to validate. Please note that this functionality is deprecated, using SoapValidator is now the preferred solution in case a SOAP message needs to be validated, in other cases give this property an empty value.

Default value

http://schemas.xmlsoap.org/soap/envelope/

getSoapNamespace

@Deprecated
public String getSoapNamespace()

Deprecated.

setRootElementSessionKey

public void setRootElementSessionKey(String rootElementSessionKey)

Key of session variable to store the name of the root element

setRootNamespaceSessionKey

public void setRootNamespaceSessionKey(String rootNamespaceSessionKey)

Key of session variable to store the namespace of the root element

getSchemaLocation

public String getSchemaLocation()

Specified by:

getSchemaLocation in interface IXmlValidator

getNoNamespaceSchemaLocation

public String getNoNamespaceSchemaLocation()

getRootElementSessionKey

public String getRootElementSessionKey()

getRootNamespaceSessionKey

public String getRootNamespaceSessionKey()

isAddNamespaceToSchema

public boolean isAddNamespaceToSchema()

getImportedSchemaLocationsToIgnore

public String getImportedSchemaLocationsToIgnore()

isUseBaseImportedSchemaLocationsToIgnore

public boolean isUseBaseImportedSchemaLocationsToIgnore()

getImportedNamespacesToIgnore

public String getImportedNamespacesToIgnore()