Module tools.jackson.databind

Package tools.jackson.databind.jsontype.impl

Class ApprovedBaseTypeValidator

java.lang.Object

tools.jackson.databind.jsontype.PolymorphicTypeValidator

tools.jackson.databind.jsontype.PolymorphicTypeValidator.Base

tools.jackson.databind.jsontype.impl.ApprovedBaseTypeValidator

All Implemented Interfaces:

Serializable

public final class ApprovedBaseTypeValidator
extends PolymorphicTypeValidator.Base

PolymorphicTypeValidator used when the configured validator has approved all subtypes of a polymorphic base type (by returning PolymorphicTypeValidator.Validity.ALLOWED from validateBaseType(tools.jackson.databind.DatabindContext, tools.jackson.databind.JavaType)). Like LaissezFaireSubTypeValidator it allows all subtypes of that base type, but retains the configured validator so that classes named as type parameters of a generic type id (like "java.util.HashMap<a.b.Gadget,java.lang.String>") can still be validated: approval of the base type does not extend to them.

Since:

3.1.8

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class tools.jackson.databind.jsontype.PolymorphicTypeValidator

PolymorphicTypeValidator.Base, PolymorphicTypeValidator.Validity

Constructor Summary

Constructors

Constructor	Description
ApprovedBaseTypeValidator(PolymorphicTypeValidator typeParameterValidator)

Method Summary

Modifier and Type	Method	Description
PolymorphicTypeValidator	getTypeParameterValidator()	Accessor for the configured validator, to use for validating type parameters of generic type ids.
PolymorphicTypeValidator.Validity	validateBaseType(DatabindContext ctxt, JavaType baseType)	Method called when a property with polymorphic value is encountered, and a TypeResolverBuilder is needed.
PolymorphicTypeValidator.Validity	validateSubClassName(DatabindContext ctxt, JavaType baseType, String subClassName)	Method called after intended class name for subtype has been read (and in case of minimal class name, expanded to fully-qualified class name) but before attempt is made to look up actual Class or JavaType.
PolymorphicTypeValidator.Validity	validateSubType(DatabindContext ctxt, JavaType baseType, JavaType subType)	Method called after class name has been resolved to actual type, in cases where previous call to PolymorphicTypeValidator.validateSubClassName(tools.jackson.databind.DatabindContext, tools.jackson.databind.JavaType, java.lang.String) returned PolymorphicTypeValidator.Validity.INDETERMINATE.

Methods inherited from class tools.jackson.databind.jsontype.PolymorphicTypeValidator

isArrayTypeAllowedExplicitly

Methods inherited from class java.lang.Object

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

Constructor Details

ApprovedBaseTypeValidator

public ApprovedBaseTypeValidator(PolymorphicTypeValidator typeParameterValidator)

Method Details

getTypeParameterValidator

public PolymorphicTypeValidator getTypeParameterValidator()

Accessor for the configured validator, to use for validating type parameters of generic type ids.

validateBaseType

public PolymorphicTypeValidator.Validity validateBaseType(DatabindContext ctxt,
 JavaType baseType)

Description copied from class: PolymorphicTypeValidator

Method called when a property with polymorphic value is encountered, and a TypeResolverBuilder is needed. Intent is to allow early determination of cases where subtyping is completely denied (for example for security reasons), or, conversely, allowed for allow subtypes (when base type guarantees that all subtypes are known to be safe). Check can be thought of as both optimization (for latter case) and eager-fail (for former case) to give better feedback.

Overrides:

validateBaseType in class PolymorphicTypeValidator.Base

Parameters:

ctxt - Context for resolution: typically will be DeserializationContext

baseType - Nominal base type used for polymorphic handling: subtypes MUST be instances of this type and assignment compatibility is verified by Jackson core

Returns:

Determination of general validity of all subtypes of given base type; if PolymorphicTypeValidator.Validity.ALLOWED returned, all subtypes will automatically be accepted without further checks; is PolymorphicTypeValidator.Validity.DENIED returned no subtyping allowed at all (caller will usually throw an exception); otherwise (return PolymorphicTypeValidator.Validity.INDETERMINATE) per sub-type validation calls are made for each new subclass encountered.

validateSubClassName

public PolymorphicTypeValidator.Validity validateSubClassName(DatabindContext ctxt,
 JavaType baseType,
 String subClassName)

Description copied from class: PolymorphicTypeValidator

Method called after intended class name for subtype has been read (and in case of minimal class name, expanded to fully-qualified class name) but before attempt is made to look up actual Class or JavaType. Validator may be able to determine validity of eventual type (and return PolymorphicTypeValidator.Validity.ALLOWED or PolymorphicTypeValidator.Validity.DENIED) or, if not able to, can defer validation to actual resolved type by returning PolymorphicTypeValidator.Validity.INDETERMINATE.

Validator may also choose to indicate denial by throwing a DatabindException (such as InvalidTypeIdException)

Overrides:

validateSubClassName in class PolymorphicTypeValidator.Base

Parameters:

ctxt - Context for resolution: typically will be DeserializationContext

baseType - Nominal base type used for polymorphic handling: subtypes MUST be instances of this type and assignment compatibility is verified by Jackson core

subClassName - Name of class that will be resolved to Class if (and only if) validity check is not denied.

Returns:

Determination of validity of given class name, as a subtype of given base type: should NOT return null

validateSubType

public PolymorphicTypeValidator.Validity validateSubType(DatabindContext ctxt,
 JavaType baseType,
 JavaType subType)

Description copied from class: PolymorphicTypeValidator

Method called after class name has been resolved to actual type, in cases where previous call to PolymorphicTypeValidator.validateSubClassName(tools.jackson.databind.DatabindContext, tools.jackson.databind.JavaType, java.lang.String) returned PolymorphicTypeValidator.Validity.INDETERMINATE. Validator should be able to determine validity and return appropriate PolymorphicTypeValidator.Validity value, although it may also

Validator may also choose to indicate denial by throwing a DatabindException (such as InvalidTypeIdException)

Overrides:

validateSubType in class PolymorphicTypeValidator.Base

Parameters:

ctxt - Context for resolution: typically will be DeserializationContext

baseType - Nominal base type used for polymorphic handling: subtypes MUST be instances of this type and assignment compatibility has been verified by Jackson core

subType - Resolved subtype to validate

Returns:

Determination of validity of given class name, as a subtype of given base type: should NOT return null