com.fasterxml.jackson.databind.jsontype

Class PolymorphicTypeValidator.Base

java.lang.Object

com.fasterxml.jackson.databind.jsontype.PolymorphicTypeValidator

com.fasterxml.jackson.databind.jsontype.PolymorphicTypeValidator.Base

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

BasicPolymorphicTypeValidator, LaissezFaireSubTypeValidator

Enclosing class:

PolymorphicTypeValidator

public abstract static class PolymorphicTypeValidator.Base
extends PolymorphicTypeValidator
implements java.io.Serializable

Shared base class with partial implementation (with all validation calls returning PolymorphicTypeValidator.Validity.INDETERMINATE) and convenience methods for indicating failure reasons. Use of this base class is strongly recommended over directly implement

See Also:

Serialized Form

Nested Class Summary

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

PolymorphicTypeValidator.Base, PolymorphicTypeValidator.Validity

Constructor Summary

Constructors

Constructor and Description
Base()

Method Summary

Modifier and Type	Method and Description
PolymorphicTypeValidator.Validity	validateBaseType(MapperConfig<?> config, JavaType baseType) Method called when a property with polymorphic value is encountered, and a TypeResolverBuilder is needed.
PolymorphicTypeValidator.Validity	validateSubClassName(MapperConfig<?> config, JavaType baseType, java.lang.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(MapperConfig<?> config, JavaType baseType, JavaType subType) Method called after class name has been resolved to actual type, in cases where previous call to PolymorphicTypeValidator.validateSubClassName(com.fasterxml.jackson.databind.cfg.MapperConfig<?>, com.fasterxml.jackson.databind.JavaType, java.lang.String) returned PolymorphicTypeValidator.Validity.INDETERMINATE.

Methods inherited from class java.lang.Object

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

Constructor Detail

Base

public Base()

Method Detail

validateBaseType

public PolymorphicTypeValidator.Validity validateBaseType(MapperConfig<?> config,
                                                          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.

Specified by:

validateBaseType in class PolymorphicTypeValidator

Parameters:

config - Configuration for resolution: typically will be DeserializationConfig

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(MapperConfig<?> config,
                                                              JavaType baseType,
                                                              java.lang.String subClassName)
                                                       throws JsonMappingException

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 JsonMappingException (such as InvalidTypeIdException)

Specified by:

validateSubClassName in class PolymorphicTypeValidator

Parameters:

config - Configuration for resolution: typically will be DeserializationConfig

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

Throws:

JsonMappingException

validateSubType

public PolymorphicTypeValidator.Validity validateSubType(MapperConfig<?> config,
                                                         JavaType baseType,
                                                         JavaType subType)
                                                  throws JsonMappingException

Description copied from class: PolymorphicTypeValidator

Method called after class name has been resolved to actual type, in cases where previous call to PolymorphicTypeValidator.validateSubClassName(com.fasterxml.jackson.databind.cfg.MapperConfig<?>, com.fasterxml.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 JsonMappingException (such as InvalidTypeIdException)

Specified by:

validateSubType in class PolymorphicTypeValidator

Parameters:

config - Configuration for resolution: typically will be DeserializationConfig

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

Throws:

JsonMappingException