Package org.frankframework.validation

Class AbstractXmlValidator

java.lang.Object

org.frankframework.validation.AbstractXmlValidator

All Implemented Interfaces:

IConfigurationAware, IScopeProvider, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

JavaxXmlValidator, XercesXmlValidator

public abstract class AbstractXmlValidator
extends Object
implements IConfigurationAware

baseclass for validating input message against a XML Schema. N.B. noNamespaceSchemaLocation may contain spaces, but not if the schema is stored in a .jar or .zip file on the class path.

Author:

Johan Verrips IOS, Jaco de Groot

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AbstractXmlValidator.ValidationResult

Field Summary

Fields

Modifier and Type	Field	Description
protected Boolean	ignoreUnknownNamespaces
protected static org.apache.logging.log4j.Logger	log
protected String	logPrefix
protected SchemasProvider	schemasProvider
protected boolean	warn

Constructor Summary

Constructors

Constructor	Description
AbstractXmlValidator()

Method Summary

Modifier and Type	Method	Description
void	configure(IConfigurationAware owner)	Configure the XmlValidator
ValidationContext	createValidationContext(PipeLineSession session, RootValidations rootValidations, Map<List<String>,List<String>> invalidRootNamespaces)
AbstractXmlValidator.ValidationResult	finalizeValidation(ValidationContext context, PipeLineSession session, Throwable t)	Evaluate the validation and set 'reason' session variables.
org.springframework.context.ApplicationContext	getApplicationContext()
String	getCharset()
ClassLoader	getConfigurationClassLoader()	This ClassLoader is set upon creation of the object, used to retrieve resources configured by the Ibis application.
Boolean	getIgnoreUnknownNamespaces()
protected InputSource	getInputSource(Message input)
protected String	getLogPrefix(PipeLineSession session)
String	getName()
IConfigurationAware	getOwner()
String	getReasonSessionKey()
abstract ValidatorHandler	getValidatorHandler(PipeLineSession session, ValidationContext context)
String	getXmlReasonSessionKey()
String	getXmlSchemaVersion()
abstract List<org.apache.xerces.xs.XSModel>	getXSModels()
boolean	isFullSchemaChecking()
boolean	isIgnoreCaching()
boolean	isStarted()
boolean	isThrowException()
boolean	isValidateFile()
boolean	isXmlSchema1_0()
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setCharset(String string)	Characterset used for reading file, only used when validateFile is true
void	setFullSchemaChecking(boolean fullSchemaChecking)	Enable full schema grammar constraint checking, including checking which may be time-consuming or memory intensive.
void	setIgnoreCaching(boolean ignoreCaching)	If set true, the number for caching validators in appConstants is ignored and no caching is done (for this validator only)
void	setIgnoreUnknownNamespaces(Boolean b)	Ignore namespaces in the input message which are unknown
void	setReasonSessionKey(String reasonSessionKey)	If set: key of session variable to store reasons of mis-validation in
void	setSchemasProvider(SchemasProvider schemasProvider)
void	setThrowException(boolean throwException)	Should the XmlValidator throw a PipeRunexception on a validation error.
void	setValidateFile(boolean b)	If set true, the input is assumed to be the name of the file to be validated.
void	setWarn(boolean warn)	If set true, send warnings to logging and console about syntax problems in the configured schema('s).
void	setXmlReasonSessionKey(String xmlReasonSessionKey)	Like reasonSessionKey but stores reasons in xml format and more extensive
void	setXmlSchemaVersion(String xmlSchemaVersion)	If set to 1.0, Xerces's previous XML Schema factory will be used, which would make all XSD 1.1 features illegal.
void	start()
void	stop()
AbstractXmlValidator.ValidationResult	validate(Object input, PipeLineSession session, String logPrefix, RootValidations rootValidations, Map<List<String>,List<String>> invalidRootNamespaces)
AbstractXmlValidator.ValidationResult	validate(Object input, PipeLineSession session, ValidatorHandler validatorHandler, XMLFilterImpl filter, ValidationContext context)
AbstractXmlValidator.ValidationResult	validate(InputSource inputSource, ValidatorHandler validatorHandler, PipeLineSession session, ValidationContext context)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

log

protected static org.apache.logging.log4j.Logger log

warn

protected boolean warn

logPrefix

protected String logPrefix

ignoreUnknownNamespaces

protected Boolean ignoreUnknownNamespaces

schemasProvider

protected SchemasProvider schemasProvider

Constructor Details

AbstractXmlValidator

public AbstractXmlValidator()

Method Details

configure

public void configure(IConfigurationAware owner)
               throws ConfigurationException

Configure the XmlValidator

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

getName

public String getName()

Specified by:

getName in interface IConfigurationAware

start

public void start()
           throws ConfigurationException

Throws:

ConfigurationException

stop

public void stop()

createValidationContext

public ValidationContext createValidationContext(PipeLineSession session,
 RootValidations rootValidations,
 Map<List<String>,List<String>> invalidRootNamespaces)
                                          throws ConfigurationException,
PipeRunException

Throws:

ConfigurationException

PipeRunException

finalizeValidation

public AbstractXmlValidator.ValidationResult finalizeValidation(ValidationContext context,
 PipeLineSession session,
 Throwable t)
                                                         throws XmlValidatorException

Evaluate the validation and set 'reason' session variables.

Parameters:

context - the validationContext of this attempt

session - the PipeLineSession

t - the exception thrown by the validation, or null

Returns:

the result event, e.g. 'valid XML' or 'Invalid XML'

Throws:

XmlValidatorException

getValidatorHandler

public abstract ValidatorHandler getValidatorHandler(PipeLineSession session,
 ValidationContext context)
                                              throws ConfigurationException,
PipeRunException

Throws:

ConfigurationException

PipeRunException

getXSModels

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

validate

public AbstractXmlValidator.ValidationResult validate(Object input,
 PipeLineSession session,
 String logPrefix,
 RootValidations rootValidations,
 Map<List<String>,List<String>> invalidRootNamespaces)
                                               throws XmlValidatorException,
PipeRunException,
ConfigurationException

Parameters:

input - the XML string to validate

session - a pipeLineSession

Returns:

ValidationResult

Throws:

XmlValidatorException - when isThrowException is true and a validationerror occurred.

PipeRunException

ConfigurationException

validate

public AbstractXmlValidator.ValidationResult validate(Object input,
 PipeLineSession session,
 ValidatorHandler validatorHandler,
 XMLFilterImpl filter,
 ValidationContext context)
                                               throws XmlValidatorException

Throws:

XmlValidatorException

validate

public AbstractXmlValidator.ValidationResult validate(InputSource inputSource,
 ValidatorHandler validatorHandler,
 PipeLineSession session,
 ValidationContext context)
                                               throws XmlValidatorException

Throws:

XmlValidatorException

getLogPrefix

protected String getLogPrefix(PipeLineSession session)

getInputSource

protected InputSource getInputSource(Message input)
                              throws XmlValidatorException

Throws:

XmlValidatorException

setFullSchemaChecking

public void setFullSchemaChecking(boolean fullSchemaChecking)

Enable full schema grammar constraint checking, including checking which may be time-consuming or memory intensive. Currently, particle unique attribution constraint checking and particle derivation restriction checking are controlled by this option.

see property http://apache.org/xml/features/validation/schema-full-checking

Default value

false

setThrowException

public void setThrowException(boolean throwException)

Should the XmlValidator throw a PipeRunexception on a validation error. If not, a forward with name 'failure' must be defined.

Default value

false

setReasonSessionKey

public void setReasonSessionKey(String reasonSessionKey)

If set: key of session variable to store reasons of mis-validation in

Default value

failureReason

setXmlReasonSessionKey

public void setXmlReasonSessionKey(String xmlReasonSessionKey)

Like reasonSessionKey but stores reasons in xml format and more extensive

Default value

xmlFailureReason

setValidateFile

public void setValidateFile(boolean b)

If set true, the input is assumed to be the name of the file to be validated. Otherwise the input itself is validated

Default value

false

setCharset

public void setCharset(String string)

Characterset used for reading file, only used when validateFile is true

Default value

utf-8

setWarn

public void setWarn(boolean warn)

If set true, send warnings to logging and console about syntax problems in the configured schema('s). Alternatively, warnings can be switched off using suppression properties , and

Default value

true

setIgnoreUnknownNamespaces

public void setIgnoreUnknownNamespaces(Boolean b)

Ignore namespaces in the input message which are unknown

Default value

true when schema or noNamespaceSchemaLocation is used, false otherwise

setIgnoreCaching

public void setIgnoreCaching(boolean ignoreCaching)

If set true, the number for caching validators in appConstants is ignored and no caching is done (for this validator only)

Default value

false

setXmlSchemaVersion

public void setXmlSchemaVersion(String xmlSchemaVersion)

If set to 1.0, Xerces's previous XML Schema factory will be used, which would make all XSD 1.1 features illegal. The default behaviour can also be set with xsd.processor.version property.

Default value

1.1

isXmlSchema1_0

public boolean isXmlSchema1_0()

getConfigurationClassLoader

public ClassLoader getConfigurationClassLoader()

Description copied from interface: IScopeProvider

This ClassLoader is set upon creation of the object, used to retrieve resources configured by the Ibis application.

Specified by:

getConfigurationClassLoader in interface IScopeProvider

Returns:

returns the ClassLoader created by the ClassLoaderManager.

getApplicationContext

public org.springframework.context.ApplicationContext getApplicationContext()

Specified by:

getApplicationContext in interface IConfigurationAware

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

getOwner

public IConfigurationAware getOwner()

isThrowException

public boolean isThrowException()

isFullSchemaChecking

public boolean isFullSchemaChecking()

getReasonSessionKey

public String getReasonSessionKey()

getXmlReasonSessionKey

public String getXmlReasonSessionKey()

isValidateFile

public boolean isValidateFile()

getCharset

public String getCharset()

getIgnoreUnknownNamespaces

public Boolean getIgnoreUnknownNamespaces()

isIgnoreCaching

public boolean isIgnoreCaching()

getXmlSchemaVersion

public String getXmlSchemaVersion()

setSchemasProvider

public void setSchemasProvider(SchemasProvider schemasProvider)

isStarted

public boolean isStarted()