Package org.frankframework.senders

Class XmlValidatorSender

java.lang.Object

org.frankframework.validation.AbstractXmlValidator

org.frankframework.validation.XercesXmlValidator

org.frankframework.senders.XmlValidatorSender

All Implemented Interfaces:

IConfigurable, IConfigurationAware, INamedObject, IScopeProvider, ISender, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

@Category(ADVANCED)
public class XmlValidatorSender
extends XercesXmlValidator
implements ISender

Sender that validates the 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:

Gerrit van Brakel

Nested Class Summary

Nested classes/interfaces inherited from class org.frankframework.validation.AbstractXmlValidator

AbstractXmlValidator.ValidationResult

Field Summary

Fields inherited from class org.frankframework.validation.XercesXmlValidator

DISALLOW_DOCTYPE_DECL_FEATURE_ID, EXTERNAL_GENERAL_ENTITIES_FEATURE_ID, EXTERNAL_PARAMETER_ENTITIES_FEATURE_ID, GRAMMAR_POOL, NAMESPACES_FEATURE_ID, SCHEMA_FULL_CHECKING_FEATURE_ID, SCHEMA_VALIDATION_FEATURE_ID, SECURITY_MANAGER_PROPERTY_ID, VALIDATION_FEATURE_ID, XML_SCHEMA_VERSION_PROPERTY

Fields inherited from class org.frankframework.validation.AbstractXmlValidator

ignoreUnknownNamespaces, log, logPrefix, schemasProvider, warn

Constructor Summary

Constructors

Constructor	Description
XmlValidatorSender()

Method Summary

Modifier and Type	Method	Description
void	configure()	configure() is called once at startup of the framework in the configure method of the owner of this sender.
String	getName()
boolean	isSynchronous()	When true, the result of sendMessage is the reply of the request.
SenderResult	sendMessage(Message message, PipeLineSession session)	Send a message to some destination (as configured in the Sender object).
void	setName(String name)
void	start()	This method will be called to start the sender.
void	stop()	Stop/close the sender and deallocate resources.

Methods inherited from class org.frankframework.validation.XercesXmlValidator

configure, createValidatingParser, createValidationContext, getPreparseResult, getSymbolTableInstance, getValidatorHandler, getXSModels

Methods inherited from class org.frankframework.validation.AbstractXmlValidator

finalizeValidation, getApplicationContext, getCharset, getConfigurationClassLoader, getIgnoreUnknownNamespaces, getInputSource, getLogPrefix, getOwner, getReasonSessionKey, getXmlReasonSessionKey, getXmlSchemaVersion, isFullSchemaChecking, isIgnoreCaching, isStarted, isThrowException, isValidateFile, isXmlSchema1_0, setApplicationContext, setCharset, setFullSchemaChecking, setIgnoreCaching, setIgnoreUnknownNamespaces, setReasonSessionKey, setSchemasProvider, setThrowException, setValidateFile, setWarn, setXmlReasonSessionKey, setXmlSchemaVersion, validate, validate, validate

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.IConfigurationAware

getApplicationContext

Methods inherited from interface org.frankframework.core.IScopeProvider

getConfigurationClassLoader

Methods inherited from interface org.frankframework.core.ISender

consumesSessionVariable, sendMessageOrThrow

Constructor Details

XmlValidatorSender

public XmlValidatorSender()

Method Details

configure

public void configure()
               throws ConfigurationException

Description copied from interface: ISender

configure() is called once at startup of the framework in the configure method of the owner of this sender. Purpose of this method is to check whether the static configuration of the sender is correct. As much as possible class-instantiating should take place in the configure() or open() method, to improve performance.

Specified by:

configure in interface IConfigurable

Specified by:

configure in interface ISender

Throws:

ConfigurationException

stop

public void stop()

Description copied from interface: ISender

Stop/close the sender and deallocate resources.

Specified by:

stop in interface ISender

Overrides:

stop in class AbstractXmlValidator

start

public void start()

Description copied from interface: ISender

This method will be called to start the sender. After this method is called the sendMessage method may be called. Purpose of this method is to reduce creating connections to databases etc. in the sendMessage() method.

Specified by:

start in interface ISender

Overrides:

start in class XercesXmlValidator

sendMessage

@Nonnull
public SenderResult sendMessage(@Nonnull
 Message message,
 @Nonnull
 PipeLineSession session)
                         throws SenderException,
TimeoutException

Description copied from interface: ISender

Send a message to some destination (as configured in the Sender object). This method may only be called after the configure() method is called.

The following table shows the difference between synchronous and a-synchronous senders:

	synchronous	a-synchronous
ISender.isSynchronous() returns	true	false
return value of sendMessage() is	the reply-message	the messageId of the message sent
the correlationID specified with sendMessage()	may be ignored	is sent with the message
a {link TimeOutException}	may be thrown if a timeout occurs waiting for a reply	should not be expected

Multiple objects may try to call this method at the same time, from different threads. Implementations of this method should therefore be thread-safe, or synchronized.

Specified by:

sendMessage in interface ISender

Throws:

SenderException

TimeoutException

isSynchronous

public boolean isSynchronous()

Description copied from interface: ISender

When true, the result of sendMessage is the reply of the request.

Specified by:

isSynchronous in interface ISender

getName

public String getName()

Specified by:

getName in interface IConfigurationAware

Specified by:

getName in interface INamedObject

Overrides:

getName in class AbstractXmlValidator

setName

public void setName(String name)

Specified by:

setName in interface INamedObject