Class CryptoSoapValidator

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.soap.CryptoSoapValidator

All Implemented Interfaces:

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

public class CryptoSoapValidator
extends SoapValidator
implements HasKeystore

Validator that can sign, encrypt, verify and decrypt SOAP messages. At least one operation is required, you may combine `sign,encrypt` and `verify,decrypt` operations.
This validator extends the SoapValidator and can be used to validate SOAP messages with additional security features. If you wish to use it without validating the soap message, set the attribute allowPlainXml to true.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CryptoSoapValidator.Operation

Nested classes/interfaces inherited from class XmlValidator

XmlValidator.ResponseValidatorWrapper

Field Summary

Fields inherited from class SoapValidator

addSoapEnvelopeToSchemaLocation

Fields inherited from class Json2XmlValidator

INPUT_FORMAT_SESSION_KEY_PREFIX, READ_AHEAD_LIMIT

Fields inherited from class XmlValidator

configurationException, validator

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

Method Summary

Modifier and Type	Method	Description
void	configure()	Configure the XmlValidator
PipeRunResult	doPipe(Message input, PipeLineSession session, boolean responseMode, String messageRoot)	Validate the XML or JSON input, and align/convert it into JSON or XML according to a XML Schema.
void	setKeystoreConfiguration(KeystoreConfiguration keystoreConfiguration)	FrankDoc requirement, to be able to set the KEYSTORE element.
void	setOperations(CryptoSoapValidator.Operation... operations)	Which operations must be executed.

Methods inherited from class SoapValidator

createRootValidation, getMessageRoot, getResponseRoot, getRoot, isConfiguredForMixedValidation, setAllowPlainXml, setIgnoreUnknownNamespaces, setNoNamespaceSchemaLocation, setOutputSoapBody, setRoot, setSchema, setSoapBody, setSoapHeader, setSoapHeaderNamespace, setSoapVersion

Methods inherited from class Json2XmlValidator

addNamespace, alignJson, alignXml2Json, createJsonSchema, createJsonSchema, 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 XmlValidator

addInvalidRootNamespaces, addRequestRootValidation, addResponseRootValidation, afterPropertiesSet, checkSchemaSpecified, determineForward, getCharset, getConfigurationException, getDocumentation, getErrorResult, getIgnoreUnknownNamespaces, getInvalidRootNamespaces, getMessageRoot, getReasonSessionKey, getRequestRootValidations, getResponseRootValidations, getResponseValidator, getRootValidations, getSchema, getSchemas, getSchemas, getSchemas, getSchemasId, getSchemasId, getSoapNamespace, getXmlReasonSessionKey, getXsds, 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, validate

Methods inherited from class AbstractValidator

determineForward, doPipe, setForwardFailureToSuccess, setSchemaSessionKey, validate, validate

Methods inherited from class AbstractPipe

addForward, addParameter, createBean, findForward, 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, 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 org.springframework.context.ApplicationContextAware

setApplicationContext

Methods inherited from interface FrankElement

addConfigWarning

Methods inherited from interface HasApplicationContext

getApplicationContext, getConfigurationClassLoader

Methods inherited from interface HasKeystore

createKeystoreConfiguration, getKeyManagerAlgorithm, getKeystore, getKeystoreAlias, getKeystoreAliasAuthAlias, getKeystoreAliasPassword, getKeystoreAuthAlias, getKeystoreConfiguration, getKeystorePassword, getKeystoreType, setKeyManagerAlgorithm, setKeystore, setKeystoreAlias, setKeystoreAliasAuthAlias, setKeystoreAliasPassword, setKeystoreAuthAlias, setKeystorePassword, setKeystoreType

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

Methods inherited from interface IValidator

setName, validate

Methods inherited from interface IXmlValidator

getSchemaLocation

Methods inherited from interface org.springframework.context.Lifecycle

isRunning

Constructor Details

CryptoSoapValidator

public CryptoSoapValidator()

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 SoapValidator

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

doPipe

public PipeRunResult doPipe(Message input,
 PipeLineSession session,
 boolean responseMode,
 String messageRoot)

Description copied from class: Json2XmlValidator

Validate the XML or JSON input, and align/convert it into JSON or XML according to a XML Schema. The format of the input message (XML or JSON) is automatically detected.

Overrides:

doPipe in class Json2XmlValidator

setOperations

public void setOperations(CryptoSoapValidator.Operation... operations)

Which operations must be executed.

It is not possible to use this validator as a Mixed input-output validator.

setKeystoreConfiguration

public void setKeystoreConfiguration(KeystoreConfiguration keystoreConfiguration)

Description copied from interface: HasKeystore

FrankDoc requirement, to be able to set the KEYSTORE element.

Specified by:

setKeystoreConfiguration in interface HasKeystore