Package org.frankframework.extensions.fxf

Class FxfXmlValidator

java.lang.Object

org.frankframework.core.TransactionAttributes

org.frankframework.pipes.AbstractPipe

org.frankframework.pipes.FixedForwardPipe

org.frankframework.pipes.AbstractValidator

org.frankframework.pipes.XmlValidator

org.frankframework.pipes.Json2XmlValidator

org.frankframework.soap.SoapValidator

org.frankframework.pipes.WsdlXmlValidator

org.frankframework.extensions.fxf.FxfXmlValidator

All Implemented Interfaces:

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

public class FxfXmlValidator
extends WsdlXmlValidator

FxF XML validator to be used with FxF3. When receiving files (direction=receive) the message is validated against the OnCompletedTransferNotify WSDL (a P2P connection, hence same WSDL (provided by Tibco) for all queues (every Ibis receiving FxF files has it's own queue)). When sending files (direction=send) the message is validated against the StartTransfer WSDL (ESB service provided by Tibco).

Author:

Jaco de Groot

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	FxfXmlValidator.Direction

Nested classes/interfaces inherited from class org.frankframework.pipes.XmlValidator

XmlValidator.ResponseValidatorWrapper

Field Summary

Fields inherited from class org.frankframework.pipes.WsdlXmlValidator

RESOURCE_INTERNAL_REFERENCE_PREFIX

Fields inherited from class org.frankframework.soap.SoapValidator

addSoapEnvelopeToSchemaLocation

Fields inherited from class org.frankframework.pipes.Json2XmlValidator

INPUT_FORMAT_SESSION_KEY_PREFIX, READ_AHEAD_LIMIT

Fields inherited from class org.frankframework.pipes.XmlValidator

configurationException, 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
FxfXmlValidator()

Method Summary

Modifier and Type	Method	Description
void	configure()	Configure the XmlValidator
void	setDirection(FxfXmlValidator.Direction direction)
void	setFxfVersion(String fxfVersion)	either 3.1 or 3.2

Methods inherited from class org.frankframework.pipes.WsdlXmlValidator

addNamespaces, checkSchemaSpecified, getDefinition, getSchemasId, getXsds, setSchemaLocationToAdd, setSoapBody, setSoapBodyNamespace, setWsdl, toExtendedString, validate

Methods inherited from class org.frankframework.soap.SoapValidator

createRootValidation, getMessageRoot, getResponseRoot, getRoot, isConfiguredForMixedValidation, setAllowPlainXml, setIgnoreUnknownNamespaces, setNoNamespaceSchemaLocation, setOutputSoapBody, setRoot, setSchema, setSoapHeader, setSoapHeaderNamespace, setSoapVersion

Methods inherited from class org.frankframework.pipes.Json2XmlValidator

addNamespace, alignJson, alignXml2Json, createJsonSchema, createJsonSchema, doPipe, getJsonRootValidations, getOutputFormat, setAcceptNamespacelessXml, setAcceptNamespaceLessXml, setAllowJson, setAutoFormat, setCompactJsonArrays, setDeepSearch, setFailOnWildcards, setIgnoreUndeclaredElements, setInputFormatSessionKey, setJsonWithRootElements, setOmitXmlDeclaration, setOutputFormat, setOutputFormatSessionKey, setProduceNamespacelessXml, setProduceNamespaceLessXml, setStrictJsonArraySyntax, setTargetNamespace, setValidateJsonToRootElementOnly, storeInputFormat

Methods inherited from class org.frankframework.pipes.XmlValidator

addInvalidRootNamespaces, addRequestRootValidation, addResponseRootValidation, afterPropertiesSet, determineForward, getCharset, getConfigurationException, getDocumentation, getErrorResult, getIgnoreUnknownNamespaces, getInvalidRootNamespaces, getMessageRoot, getReasonSessionKey, getRequestRootValidations, getResponseRootValidations, getResponseValidator, getRootValidations, getSchema, getSchemas, getSchemas, getSchemas, getSchemasId, getSoapNamespace, getXmlReasonSessionKey, getXSModels, isFullSchemaChecking, isThrowException, isValidateFile, setAddNamespaceToSchema, setCharset, setFullSchemaChecking, setIgnoreCaching, setImplementation, setImportedNamespacesToIgnore, setImportedSchemaLocationsToIgnore, setReasonSessionKey, setResponseRoot, setRootElementSessionKey, setRootNamespaceSessionKey, setSchemaLocation, setSoapNamespace, setThrowException, setUseBaseImportedSchemaLocationsToIgnore, setValidateFile, setWarn, setXmlReasonSessionKey, setXmlSchemaVersion, start, stop

Methods inherited from class org.frankframework.pipes.AbstractValidator

determineForward, doPipe, setForwardFailureToSuccess, setSchemaSessionKey, validate, validate

Methods inherited from class org.frankframework.pipes.FixedForwardPipe

getParameterValue, setIfParam, setIfValue, setOnlyIfSessionKey, setOnlyIfValue, setSkipOnEmptyInput, setUnlessSessionKey, setUnlessValue, skipPipe

Methods inherited from class org.frankframework.pipes.AbstractPipe

addForward, addParameter, consumesSessionVariable, createBean, findForward, getAdapter, getEventSourceName, getForwards, getParameterList, hasRegisteredForward, isRunning, registerEvent, setApplicationContext, setChompCharSize, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setGetInputFromFixedValue, setGetInputFromSessionKey, setHideRegex, setLocker, setLogIntermediaryResults, setMaxThreads, setName, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSizeStatistics, setStoreResultInSessionKey, setWriteToSecLog, sizeStatisticsEnabled, throwEvent

Methods inherited from class org.frankframework.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 org.springframework.context.ApplicationContextAware

setApplicationContext

Methods inherited from interface org.frankframework.core.FrankElement

addConfigWarning

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

getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute

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.frankframework.core.IXmlValidator

getSchemaLocation

Methods inherited from interface org.springframework.context.Lifecycle

isRunning

Constructor Details

FxfXmlValidator

public FxfXmlValidator()

Method Details

configure

public void configure()
               throws ConfigurationException

Description copied from class: XmlValidator

Configure the XmlValidator

Specified by:

configure in interface IConfigurable

Overrides:

configure in class WsdlXmlValidator

Throws:

ConfigurationException - when:

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

setDirection

public void setDirection(FxfXmlValidator.Direction direction)

setFxfVersion

public void setFxfVersion(String fxfVersion)

either 3.1 or 3.2

Default value

3.1