nl.nn.adapterframework.extensions.api

Class ApiWsdlXmlValidator

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

nl.nn.adapterframework.extensions.api.ApiWsdlXmlValidator

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

public class ApiWsdlXmlValidator
extends WsdlXmlValidator

Extension to WsdlXmlValidator for API Management. The SOAP header can only contain the following schema (or it's empty):

element	level	mandatory
MessageHeader	0	yes
xmlns="http://api.nn.nl/MessageHeader"		yes
From	1	no
HeaderFields	1	yes
ConversationId	2	yes

Author:

Peter Leeuwenburgh

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 static String	API_NAMESPACE

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

RESOURCE_INTERNAL_REFERENCE_PREFIX

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

addSoapEnvelopeToSchemaLocation

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

INPUT_FORMAT_SESSION_KEY_PREFIX

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

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

Method Summary

Modifier and Type	Method and Description
void	configure() Configure the XmlValidator
String	getDocumentation() Provide additional generic documentation on the validation of the subsequent processing.
void	setMultipart(boolean b) indicates whether the message is multipart/form-data.

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

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

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, afterPropertiesSet, determineForward, getCharset, getConfigurationException, 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, 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, throwEvent

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

getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute

Field Detail

API_NAMESPACE

protected static final String API_NAMESPACE

See Also:

Constant Field Values

Constructor Detail

ApiWsdlXmlValidator

public ApiWsdlXmlValidator()

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

setMultipart

public void setMultipart(boolean b)

indicates whether the message is multipart/form-data. If so, the wsdl only represents the first part, other parts are attachments. This attribute is only used for generating the 'real' wsdl which is available in the ibis console (../rest/webservices)

Default value

false

getDocumentation

public String getDocumentation()

Description copied from interface: IXmlValidator

Provide additional generic documentation on the validation of the subsequent processing. This documentation will be included in generated schema's like WSDL or OpenApi

Specified by:

getDocumentation in interface IXmlValidator

Overrides:

getDocumentation in class XmlValidator