Package org.frankframework.extensions.esb

Class EsbSoapValidator

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.extensions.esb.EsbSoapValidator

All Implemented Interfaces:

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

@Category(NN_SPECIAL)
public class EsbSoapValidator
extends SoapValidator
implements WsdlGeneratorExtension<EsbSoapWsdlGeneratorContext>

XmlValidator that will automatically add the SOAP envelope XSD and the ESB XSD (e.g. a CommonMessageHeader.xsd) to the set of XSDs used for validation.

Author:

Michiel Meeuwissen, Jaco de Groot

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	EsbSoapValidator.Direction

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

XmlValidator.ResponseValidatorWrapper

Field Summary

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

Method Summary

Modifier and Type	Method	Description
EsbSoapWsdlGeneratorContext	buildExtensionContext(PipeLine pipeLine)
void	configure()	Configure the XmlValidator
void	setCmhVersion(int i)	Only used when mode=reg!
void	setDirection(EsbSoapValidator.Direction direction)
void	setMode(EsbSoapWrapperPipe.Mode mode)
void	setSoapHeader(String soapHeader)	Name of the child element of the SOAP header, or a comma separated list of names to choose from (only one is allowed) (wsdl generator will use the first element) (use empty value to allow an empty soap header, for example to allow element x and an empty soap header use: x,)

Methods inherited from class org.frankframework.soap.SoapValidator

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

Methods inherited from class org.frankframework.pipes.Json2XmlValidator

addNamespace, alignJson, alignXml2Json, createJsonSchema, createJsonSchema, doPipe, getJsonRootValidations, getOutputFormat, getPhysicalDestinationName, 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, checkSchemaSpecified, determineForward, getCharset, getConfigurationException, getDocumentation, getErrorResult, getIgnoreUnknownNamespaces, getInvalidRootNamespaces, getMessageRoot, getReasonSessionKey, getRequestRootValidations, getResponseRootValidations, getResponseValidator, getRootValidations, getSchema, getSchemas, getSchemas, getSchemas, getSchemasId, getSchemasId, getSoapNamespace, getSpecialDefaultValue, getXmlReasonSessionKey, getXsds, 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, validate

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

getApplicationContext, getConfigurationClassLoader

Methods inherited from interface org.frankframework.core.HasName

getName

Methods inherited from interface org.frankframework.core.HasPhysicalDestination

getDomain

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

EsbSoapValidator

public EsbSoapValidator()

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 SoapValidator

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

setSoapHeader

public void setSoapHeader(String soapHeader)

Description copied from class: SoapValidator

Name of the child element of the SOAP header, or a comma separated list of names to choose from (only one is allowed) (wsdl generator will use the first element) (use empty value to allow an empty soap header, for example to allow element x and an empty soap header use: x,)

Overrides:

setSoapHeader in class SoapValidator

setDirection

public void setDirection(EsbSoapValidator.Direction direction)

setMode

public void setMode(EsbSoapWrapperPipe.Mode mode)

setCmhVersion

public void setCmhVersion(int i)

Only used when mode=reg! Sets the Common Message Header version. 1 or 2

Default value

1

buildExtensionContext

public EsbSoapWsdlGeneratorContext buildExtensionContext(PipeLine pipeLine)

Specified by:

buildExtensionContext in interface WsdlGeneratorExtension<EsbSoapWsdlGeneratorContext>