Class OpenApiValidator

java.lang.Object

org.frankframework.core.TransactionAttributes

org.frankframework.pipes.AbstractPipe

org.frankframework.pipes.FixedForwardPipe

org.frankframework.pipes.AbstractValidator

org.frankframework.pipes.OpenApiValidator

All Implemented Interfaces:

AdapterAware, FrankElement, HasApplicationContext, HasName, HasTransactionAttribute, IConfigurable, IDualModeValidator, IForwardTarget, IPipe, IScopeProvider, IValidator, IWithParameters, NameAware, EventThrowing, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle

@Category(BASIC)
public class OpenApiValidator
extends AbstractValidator

Pipe that validates the input message against an OpenAPI specification.

Author:

evandongen

Nested Class Summary

Nested classes/interfaces inherited from class AbstractValidator

AbstractValidator.ResponseValidatorWrapper

Field Summary

Fields inherited from class AbstractPipe

parameterNamesMustBeUnique

Fields inherited from class TransactionAttributes

log

Fields inherited from interface IPipe

LONG_DURATION_MONITORING_EVENT, MESSAGE_SIZE_MONITORING_EVENT, PIPE_EXCEPTION_MONITORING_EVENT

Constructor Summary

Constructors

Constructor	Description
OpenApiValidator()

Method Summary

Modifier and Type	Method	Description
void	configure()	Checks for correct configuration of forward.
protected boolean	isConfiguredForMixedValidation()
void	setMethod(String method)	Set the HTTP method to validate against.
void	setOpenApiDefinition(String openApiDefinition)	The OpenAPI specification file to validate against.
void	setPath(String path)	Set the path in the OpenAPI specification to validate against.
void	setReasonSessionKey(String reasonSessionKey)	If set: creates a sessionKey to store any errors when validating the json output
void	setUseAsOutputValidator(boolean useAsOutputValidator)	Mark this Validator as configured for mixed validation, meaning it will be used for both request and response validation.
protected PipeForward	validate(Message messageToValidate, PipeLineSession session, boolean responseMode, String messageRoot)

Methods inherited from class AbstractValidator

determineForward, doPipe, doPipe, getResponseValidator, setForwardFailureToSuccess, setResponseRoot, setRoot, setSchemaSessionKey, validate, validate

Methods inherited from class FixedForwardPipe

getParameterValue

Methods inherited from class AbstractPipe

addForward, addParameter, createBean, findForward, getAdapter, getEventSourceName, getParameterList, getRegisteredForwards, hasRegisteredForward, isRunning, registerEvent, setApplicationContext, setChompCharSize, setDefaultValue, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setGetInputFromFixedValue, setGetInputFromSessionKey, setHideRegex, setIfParam, setIfValue, setLocker, setLogIntermediaryResults, setMaxThreads, setName, setOnlyIfSessionKey, setOnlyIfValue, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSizeStatistics, setSkipOnEmptyInput, setStoreResultInSessionKey, setUnlessSessionKey, setUnlessValue, setWriteToSecLog, sizeStatisticsEnabled, skipPipe, start, stop, throwEvent

Methods inherited from class TransactionAttributes

configureTransactionAttributes, isTransacted, isTransacted, setTransacted, setTransactionTimeout

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface AdapterAware

setAdapter

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Methods inherited from interface FrankElement

addConfigWarning

Methods inherited from interface HasApplicationContext

getApplicationContext, getConfigurationClassLoader

Methods inherited from interface HasName

getName

Methods inherited from interface HasTransactionAttribute

getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute

Methods inherited from interface IForwardTarget

getName

Methods inherited from interface IPipe

addForward, findForward, getChompCharSize, getDefaultValue, getDurationThreshold, getElementToMove, getElementToMoveChain, getElementToMoveSessionKey, getGetInputFromFixedValue, getGetInputFromSessionKey, getHideRegex, getIfParam, getIfValue, getLocker, getLogIntermediaryResults, getMaxThreads, getOnlyIfSessionKey, getOnlyIfValue, getRegisteredForwards, getSecLogSessionKeys, getStoreResultInSessionKey, getUnlessSessionKey, getUnlessValue, isPreserveInput, isRemoveCompactMsgNamespaces, isRestoreMovedElements, isSkipOnEmptyInput, isWriteToSecLog, registerEvent, setChompCharSize, setDefaultValue, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setGetInputFromFixedValue, setGetInputFromSessionKey, setHideRegex, setIfParam, setIfValue, setLocker, setLogIntermediaryResults, setOnlyIfSessionKey, setOnlyIfValue, setPipeLine, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSkipOnEmptyInput, setStoreResultInSessionKey, setUnlessSessionKey, setUnlessValue, setWriteToSecLog, sizeStatisticsEnabled, skipPipe, start, stop, throwEvent, throwEvent

Methods inherited from interface IValidator

setName

Methods inherited from interface org.springframework.context.Lifecycle

isRunning

Constructor Details

OpenApiValidator

public OpenApiValidator()

Method Details

configure

public void configure()
               throws ConfigurationException

Description copied from class: FixedForwardPipe

Checks for correct configuration of forward.

Specified by:

configure in interface IConfigurable

Overrides:

configure in class AbstractValidator

Throws:

ConfigurationException - in case it was not able to configure the component.

validate

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

Specified by:

validate in class AbstractValidator

Throws:

PipeRunException

setOpenApiDefinition

@Mandatory
public void setOpenApiDefinition(String openApiDefinition)

The OpenAPI specification file to validate against. This should be a JSON file containing the OpenAPI specification. The file should be available on the classpath.

setPath

@Mandatory
public void setPath(String path)

Set the path in the OpenAPI specification to validate against. This is used in combination with the method attribute to validate against a specific operation in the OpenAPI specification.

setMethod

@Mandatory
public void setMethod(String method)

Set the HTTP method to validate against. This is used in combination with the path attribute to validate against a specific operation in the OpenAPI specification.

setReasonSessionKey

public void setReasonSessionKey(String reasonSessionKey)

If set: creates a sessionKey to store any errors when validating the json output

Default value

failureReason

setUseAsOutputValidator

public void setUseAsOutputValidator(boolean useAsOutputValidator)

Mark this Validator as configured for mixed validation, meaning it will be used for both request and response validation. Depending solely on the responseRoot being set is not sufficient, since in case of OpenApiValidator, the resposeRoot is not used, but it is still a mixed validator.

Default value

false

isConfiguredForMixedValidation

protected boolean isConfiguredForMixedValidation()

Overrides:

isConfiguredForMixedValidation in class AbstractValidator