Package org.frankframework.extensions.api

Class ApiWsdlXmlValidator

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

org.frankframework.extensions.api.ApiWsdlXmlValidator

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

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 org.frankframework.pipes.XmlValidator

XmlValidator.ResponseValidatorWrapper

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	API_NAMESPACE

Fields inherited from class org.frankframework.pipes.WsdlXmlValidator

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

Method Summary

Modifier and Type	Method	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 org.frankframework.pipes.WsdlXmlValidator

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

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

API_NAMESPACE

protected static final String API_NAMESPACE

See Also:

• Constant Field Values

Constructor Details

ApiWsdlXmlValidator

public ApiWsdlXmlValidator()

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