nl.nn.adapterframework.pipes

Class WsdlXmlValidator

java.lang.Object

nl.nn.adapterframework.core.TransactionAttributes

nl.nn.adapterframework.pipes.AbstractPipe

nl.nn.adapterframework.pipes.FixedForwardPipe

nl.nn.adapterframework.pipes.ValidatorBase

nl.nn.adapterframework.pipes.XmlValidator

nl.nn.adapterframework.pipes.Json2XmlValidator

nl.nn.adapterframework.soap.SoapValidator

nl.nn.adapterframework.pipes.WsdlXmlValidator

All Implemented Interfaces:

HasSpecialDefaultValues, HasPhysicalDestination, HasTransactionAttribute, IConfigurable, IConfigurationAware, IDualModeValidator, IExtendedPipe, IForwardTarget, INamedObject, IPipe, IScopeProvider, IValidator, IXmlValidator, EventThrowing, SchemasProvider, org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware

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 nl.nn.adapterframework.pipes.XmlValidator

XmlValidator.ResponseValidatorWrapper

Field Summary

Fields

Modifier and Type	Field and Description
static String	RESOURCE_INTERNAL_REFERENCE_PREFIX

Fields inherited from class nl.nn.adapterframework.soap.SoapValidator

addSoapEnvelopeToSchemaLocation, SOAP_BODY, SOAP_ENVELOPE, SOAP_HEADER

Fields inherited from class nl.nn.adapterframework.pipes.Json2XmlValidator

INPUT_FORMAT_SESSION_KEY_PREFIX

Fields inherited from class nl.nn.adapterframework.pipes.XmlValidator

ABSTRACTXMLVALIDATOR, configurationException, validator

Fields inherited from class nl.nn.adapterframework.pipes.AbstractPipe

parameterNamesMustBeUnique

Fields inherited from class nl.nn.adapterframework.core.TransactionAttributes

log

Fields inherited from interface nl.nn.adapterframework.core.IExtendedPipe

LONG_DURATION_MONITORING_EVENT, MESSAGE_SIZE_MONITORING_EVENT, PIPE_EXCEPTION_MONITORING_EVENT

Constructor Summary

Constructors

Constructor and Description
WsdlXmlValidator()

Method Summary

Modifier and Type	Method and 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 nl.nn.adapterframework.soap.SoapValidator

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

Methods inherited from class nl.nn.adapterframework.pipes.Json2XmlValidator

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

Methods inherited from class nl.nn.adapterframework.pipes.XmlValidator

addInvalidRootNamespaces, addRequestRootValidation, addResponseRootValidation, addRootValidation, afterPropertiesSet, determineForward, getCharset, getConfigurationException, getDocumentation, getErrorResult, getIgnoreUnknownNamespaces, getInvalidRootNamespaces, getMessageRoot, getReasonSessionKey, getRequestRootValidations, getResponseRootValidations, getResponseValidator, getRootValidations, getSchema, getSchemas, getSchemas, getSchemas, getSchemasId, getSoapNamespace, getSpecialDefaultValue, 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 nl.nn.adapterframework.pipes.ValidatorBase

determineForward, doPipe, setForwardFailureToSuccess, setSchemaSessionKey, validate, validate

Methods inherited from class nl.nn.adapterframework.pipes.FixedForwardPipe

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

Methods inherited from class nl.nn.adapterframework.pipes.AbstractPipe

addParameter, consumesSessionVariable, createBean, findForward, getAdapter, getEventSourceName, getForwards, getInSizeStatDummyObject, getOutSizeStatDummyObject, getParameterList, getParameterOverriddenAttributeValue, getParameterValueList, hasSizeStatistics, registerEvent, registerForward, setApplicationContext, setChompCharSize, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setGetInputFromFixedValue, setGetInputFromSessionKey, setHideRegex, setLocker, setLogIntermediaryResults, setMaxThreads, setName, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSizeStatistics, setStoreResultInSessionKey, setWriteToSecLog, throwEvent

Methods inherited from class nl.nn.adapterframework.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 nl.nn.adapterframework.core.HasPhysicalDestination

getDomain

Methods inherited from interface nl.nn.adapterframework.core.IXmlValidator

getSchemaLocation

Methods inherited from interface nl.nn.adapterframework.core.IValidator

setName, validate

Methods inherited from interface nl.nn.adapterframework.core.IPipe

consumesSessionVariable, doPipe, getForwards, getMaxThreads, registerForward

Methods inherited from interface nl.nn.adapterframework.core.INamedObject

getName

Methods inherited from interface nl.nn.adapterframework.core.IConfigurationAware

getApplicationContext, getName

Methods inherited from interface nl.nn.adapterframework.core.IScopeProvider

getConfigurationClassLoader

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Methods inherited from interface nl.nn.adapterframework.core.IForwardTarget

getName

Methods inherited from interface nl.nn.adapterframework.core.IExtendedPipe

getChompCharSize, getDurationThreshold, getElementToMove, getElementToMoveChain, getElementToMoveSessionKey, getEmptyInputReplacement, getGetInputFromFixedValue, getGetInputFromSessionKey, getLocker, getSecLogSessionKeys, getStoreResultInSessionKey, isPreserveInput, isRemoveCompactMsgNamespaces, isRestoreMovedElements, isWriteToSecLog, setPipeLine

Methods inherited from interface nl.nn.adapterframework.core.HasTransactionAttribute

getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute

Field Detail

RESOURCE_INTERNAL_REFERENCE_PREFIX

public static final String RESOURCE_INTERNAL_REFERENCE_PREFIX

See Also:

Constant Field Values

Constructor Detail

WsdlXmlValidator

public WsdlXmlValidator()

Method Detail

configure

public void configure()
               throws ConfigurationException

Description copied from class: XmlValidator

Configure the XmlValidator

Specified by:

configure in interface IConfigurable

Specified by:

configure in interface IPipe

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)

Description copied from class: SoapValidator

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,)

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