nl.nn.adapterframework.soap

Class SoapValidator

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

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:

EsbSoapValidator, WsdlXmlValidator

public class SoapValidator
extends Json2XmlValidator

XmlValidator that will automatically add the SOAP envelope XSD to the set of XSD's used for validation. Before the outputSoapBody attribute was introduced, two validators were used for a request-reply pattern (an inputValidator for the request and an outputValidator for the reply). These inputValidator and outputValidator were identical except for the child element of the SOAP body. Because validators use relatively a lot of memory, the outputSoapBody attribute was added which replaces the outputValidator. Both the request and the reply are then validated by the inputValidator.

To generate a wsdl with a soap action included one of the following properties must be set to the expected soapAction

wsdl.${adapterName}.${listenerName}.soapAction

wsdl.${adapterName}.soapAction

wsdl.soapAction

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
protected boolean	addSoapEnvelopeToSchemaLocation
static String	SOAP_BODY
static String	SOAP_ENVELOPE
static String	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
SoapValidator()

Method Summary

Modifier and Type	Method and Description
void	configure() Configure the XmlValidator
protected RootValidations	createRootValidation(String messageRoot)
String	getMessageRoot()
String	getResponseRoot()
String	getRoot()
protected boolean	isConfiguredForMixedValidation()
void	setAllowPlainXml(boolean allowPlainXml) Allow plain XML, without a SOAP Envelope, too.
void	setNoNamespaceSchemaLocation(String noNamespaceSchemaLocation) A uri reference as a hint as to the location of a schema document with no target namespace.
void	setOutputSoapBody(String outputSoapBody) Identical to the soapBody attribute except that it's used for the output message instead of the input message.
void	setRoot(String r) Deprecated.
void	setSchema(String schema) Deprecated.
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	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,)
void	setSoapHeaderNamespace(String soapHeaderNamespace) Can be used when the SOAP header element exists multiple times
void	setSoapVersion(SoapVersion soapVersion) SOAP envelope XSD version to use

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, 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, setIgnoreUnknownNamespaces, setImplementation, setImportedNamespacesToIgnore, setImportedSchemaLocationsToIgnore, setReasonSessionKey, setResponseRoot, setRootElementSessionKey, setRootNamespaceSessionKey, setSchemaLocation, setSoapNamespace, setThrowException, setUseBaseImportedSchemaLocationsToIgnore, setValidateFile, setWarn, setXmlReasonSessionKey, setXmlSchemaVersion, start, stop, validate

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

SOAP_ENVELOPE

public static final String SOAP_ENVELOPE

See Also:

Constant Field Values

SOAP_BODY

public static final String SOAP_BODY

See Also:

Constant Field Values

SOAP_HEADER

public static final String SOAP_HEADER

See Also:

Constant Field Values

addSoapEnvelopeToSchemaLocation

protected boolean addSoapEnvelopeToSchemaLocation

Constructor Detail

SoapValidator

public SoapValidator()

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 Json2XmlValidator

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

createRootValidation

protected RootValidations createRootValidation(String messageRoot)

Overrides:

createRootValidation in class XmlValidator

isConfiguredForMixedValidation

protected boolean isConfiguredForMixedValidation()

Overrides:

isConfiguredForMixedValidation in class XmlValidator

setSchema

@Deprecated
public void setSchema(String schema)

Deprecated.

Description copied from class: XmlValidator

The filename of the schema on the classpath. It is not possible to specify a namespace using this attribute. (effectively the same as noNamespaceSchemaLocation) An example value would be "xml/xsd/GetPartyDetail.xsd". The value of the schema attribute is only used if the schemaLocation attribute and the noNamespaceSchemaLocation are not set.

Overrides:

setSchema in class XmlValidator

setNoNamespaceSchemaLocation

public void setNoNamespaceSchemaLocation(String noNamespaceSchemaLocation)

Description copied from class: XmlValidator

A uri reference as a hint as to the location of a schema document with no target namespace.

Overrides:

setNoNamespaceSchemaLocation in class XmlValidator

getMessageRoot

public String getMessageRoot()

Specified by:

getMessageRoot in interface IXmlValidator

Overrides:

getMessageRoot in class XmlValidator

getResponseRoot

public String getResponseRoot()

getRoot

public String getRoot()

setRoot

@Deprecated
public void setRoot(String r)

Deprecated.

always envelope (not allowed to change)

Overrides:

setRoot in class XmlValidator

Default value

envelope

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

setOutputSoapBody

public void setOutputSoapBody(String outputSoapBody)

Identical to the soapBody attribute except that it's used for the output message instead of the input message. For more information see note 1

setSoapHeader

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

setSoapHeaderNamespace

public void setSoapHeaderNamespace(String soapHeaderNamespace)

Can be used when the SOAP header element exists multiple times

setSoapVersion

public void setSoapVersion(SoapVersion soapVersion)

SOAP envelope XSD version to use

Default value

1.1

setAllowPlainXml

public void setAllowPlainXml(boolean allowPlainXml)

Allow plain XML, without a SOAP Envelope, too. Be aware that setting this true inhibits the capability to test for exit specific response roots in SOAP messages

Default value

false