Package org.frankframework.pipes

Class JsonValidator

java.lang.Object

org.frankframework.core.TransactionAttributes

org.frankframework.pipes.AbstractPipe

org.frankframework.pipes.FixedForwardPipe

org.frankframework.pipes.AbstractValidator

org.frankframework.pipes.JsonValidator

All Implemented Interfaces:

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 JsonValidator
extends AbstractValidator

Pipe that validates the input message against a JSON Schema.

Author:

Gerrit van Brakel

Nested Class Summary

Nested classes/interfaces inherited from class org.frankframework.pipes.AbstractValidator

AbstractValidator.ResponseValidatorWrapper

Field Summary

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

Method Summary

Modifier and Type	Method	Description
void	configure()	Checks for correct configuration of forward.
protected com.networknt.schema.JsonSchema	getJsonSchema()
void	setReasonSessionKey(String reasonSessionKey)	If set: creates a sessionKey to store any errors when validating the json output
void	setSchema(String schema)	The JSON Schema to validate to
void	setSubSchemaPrefix(String prefix)	The subSchemaPrefix is an optional attribute used when referencing a subschema located in a nested structure, such as $defs or definitions.
void	start()	Perform necessary action to start the pipe.
protected PipeForward	validate(Message messageToValidate, PipeLineSession session, boolean responseMode, String messageRoot)

Methods inherited from class org.frankframework.pipes.AbstractValidator

determineForward, doPipe, doPipe, getResponseValidator, isConfiguredForMixedValidation, setForwardFailureToSuccess, setResponseRoot, setRoot, 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, stop, 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, 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, stop, throwEvent, throwEvent

Methods inherited from interface org.frankframework.core.IValidator

setName

Methods inherited from interface org.springframework.context.Lifecycle

isRunning

Constructor Details

JsonValidator

public JsonValidator()

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.

start

public void start()

Description copied from interface: IPipe

Perform necessary action to start the pipe. This method is executed after the IConfigurable.configure() method, for each start and stop command of the adapter.

Specified by:

start in interface IPipe

Specified by:

start in interface org.springframework.context.Lifecycle

Overrides:

start in class AbstractPipe

validate

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

Specified by:

validate in class AbstractValidator

Throws:

PipeRunException

getJsonSchema

protected com.networknt.schema.JsonSchema getJsonSchema()
                                                 throws IOException

Throws:

IOException

setSchema

@Mandatory
public void setSchema(String schema)

The JSON Schema to validate to

setSubSchemaPrefix

public void setSubSchemaPrefix(String prefix)

The subSchemaPrefix is an optional attribute used when referencing a subschema located in a nested structure, such as $defs or definitions. Adding only the subSchema attribute is not enough if your schema organizes definitions in nested objects. Add root attribute to complete the process.

Default value

/definitions/

setReasonSessionKey

public void setReasonSessionKey(String reasonSessionKey)

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

Default value

failureReason