Package org.frankframework.pipes

Class WsdlXmlValidator

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

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

Direct Known Subclasses:

ApiWsdlXmlValidator, FxfXmlValidator

public class WsdlXmlValidator
extends SoapValidator

XmlValidator that will read the XSD's to use from a WSDL. As it extends the SoapValidator is will also add the SOAP envelope XSD.

Author:

Michiel Meeuwissen, Jaco de Groot

Nested Class Summary

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

XmlValidator.ResponseValidatorWrapper

Field Summary

Fields

Modifier and Type	Field	Description
static final String	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
WsdlXmlValidator()

Method Summary

Modifier and Type	Method	Description
protected static void	addNamespaces(javax.wsdl.extensions.schema.Schema schema, Map<String,String> namespaces)
protected void	checkSchemaSpecified()
void	configure()	Configure the XmlValidator
protected javax.wsdl.Definition	getDefinition(String wsdl)
String	getSchemasId()
Set<IXSD>	getXsds()
void	setSchemaLocationToAdd(String schemaLocationToAdd)	Pairs of URI references which will be added to the WSDL
void	setSoapBody(String soapBody)	Name of the child element of the SOAP body, 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 body, for example to allow element x and an empty SOAP body use: x,).
void	setSoapBodyNamespace(String soapBodyNamespace)	Creates schemaLocation attribute based on the WSDL and replaces the namespace of the soap body element
void	setWsdl(String wsdl)	The WSDL to read the XSDs from
String	toExtendedString()
protected PipeForward	validate(Message messageToValidate, PipeLineSession session, boolean responseMode, String messageRoot)

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

Field Details

RESOURCE_INTERNAL_REFERENCE_PREFIX

public static final String RESOURCE_INTERNAL_REFERENCE_PREFIX

See Also:

• Constant Field Values

Constructor Details

WsdlXmlValidator

public WsdlXmlValidator()

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

getDefinition

protected javax.wsdl.Definition getDefinition(String wsdl)
                                       throws ConfigurationException

Throws:

ConfigurationException

validate

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

Overrides:

validate in class XmlValidator

Throws:

XmlValidatorException

PipeRunException

ConfigurationException

checkSchemaSpecified

protected void checkSchemaSpecified()
                             throws ConfigurationException

Overrides:

checkSchemaSpecified in class XmlValidator

Throws:

ConfigurationException

addNamespaces

protected static void addNamespaces(javax.wsdl.extensions.schema.Schema schema,
 Map<String,String> namespaces)

getSchemasId

public String getSchemasId()

Specified by:

getSchemasId in interface SchemasProvider

Overrides:

getSchemasId in class XmlValidator

getXsds

public Set<IXSD> getXsds()
                  throws ConfigurationException

Specified by:

getXsds in interface IXmlValidator

Overrides:

getXsds in class XmlValidator

Throws:

ConfigurationException

toExtendedString

public String toExtendedString()

setWsdl

public void setWsdl(String wsdl)

The WSDL to read the XSDs from

setSoapBody

public void setSoapBody(String soapBody)

Name of the child element of the SOAP body, 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 body, for example to allow element x and an empty SOAP body use: x,). In case the request contains SOAPAction header and the WSDL contains an element specific to that SOAPAction, it will use that element as SOAP body.

Overrides:

setSoapBody in class SoapValidator

setSchemaLocationToAdd

public void setSchemaLocationToAdd(String schemaLocationToAdd)

Pairs of URI references which will be added to the WSDL

setSoapBodyNamespace

public void setSoapBodyNamespace(String soapBodyNamespace)

Creates schemaLocation attribute based on the WSDL and replaces the namespace of the soap body element