Module tools.jackson.databind

Package tools.jackson.databind.jsontype

Class BasicPolymorphicTypeValidator

java.lang.Object

tools.jackson.databind.jsontype.PolymorphicTypeValidator

tools.jackson.databind.jsontype.PolymorphicTypeValidator.Base

tools.jackson.databind.jsontype.BasicPolymorphicTypeValidator

All Implemented Interfaces:

Serializable

public class BasicPolymorphicTypeValidator
extends PolymorphicTypeValidator.Base
implements Serializable

Standard BasicPolymorphicTypeValidator implementation that users may want to use for constructing validators based on simple class hierarchy and/or name patterns to allow and/or deny certain subtypes.

Most commonly this is used to allow known safe subtypes based on common super type or Java package name.
For example:

 PolymorphicTypeValidator ptv = BasicPolymorphicTypeValidator.builder()
     // base type that polymorphism is enabled for
     .allowIfBaseType(MyValue.class)
     // accept any subtype of MyValue under our own package
     .allowIfSubType("com.example.values.")
     // and any concrete subtype of this specific safe interface
     .allowIfSubType(SafeMarker.class)
     .build();

  ObjectMapper mapper = JsonMapper.builder()
          .activateDefaultTyping(ptv, DefaultTyping.NON_FINAL)
          .build();

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BasicPolymorphicTypeValidator.Builder	Builder class for configuring and constructing immutable BasicPolymorphicTypeValidator instances.
static interface	BasicPolymorphicTypeValidator.NameMatcher	General matcher interface (predicate) for validating unresolved subclass class name.
static interface	BasicPolymorphicTypeValidator.TypeMatcher	General matcher interface (predicate) for validating class values (base type or resolved subtype)

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

PolymorphicTypeValidator.Base, PolymorphicTypeValidator.Validity

Field Summary

Fields

Modifier and Type	Field	Description
protected final boolean	_acceptArrayTypes	[databind#5981]: when true, validateSubType() unwraps arrays (recursively for nested arrays) and validates the innermost element type against the sub-class matchers and sub-type name matchers (name-matcher consultation added by [databind#5988]).
protected final BasicPolymorphicTypeValidator.TypeMatcher[]	_baseTypeMatchers	Set of matchers that can validate all values of polymorphic properties that match specified allowed base types.
protected final Set<Class<?>>	_invalidBaseTypes	Set of specifically denied base types to indicate that use of specific base types is not allowed: most commonly used to fully block use of Object as the base type.
protected final BasicPolymorphicTypeValidator.TypeMatcher[]	_subClassMatchers	Set of matchers that can validate specific values of polymorphic properties that match subtype class criteria.
protected final BasicPolymorphicTypeValidator.NameMatcher[]	_subTypeNameMatchers	Set of matchers that can validate specific values of polymorphic properties that match subtype class name criteria.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BasicPolymorphicTypeValidator(Set<Class<?>> invalidBaseTypes, BasicPolymorphicTypeValidator.TypeMatcher[] baseTypeMatchers, BasicPolymorphicTypeValidator.NameMatcher[] subTypeNameMatchers, BasicPolymorphicTypeValidator.TypeMatcher[] subClassMatchers)
protected	BasicPolymorphicTypeValidator(Set<Class<?>> invalidBaseTypes, BasicPolymorphicTypeValidator.TypeMatcher[] baseTypeMatchers, BasicPolymorphicTypeValidator.NameMatcher[] subTypeNameMatchers, BasicPolymorphicTypeValidator.TypeMatcher[] subClassMatchers, boolean acceptArrayTypes)

Method Summary

Modifier and Type	Method	Description
static BasicPolymorphicTypeValidator.Builder	builder()
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 java.lang.Object

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

Field Details

_invalidBaseTypes

protected final Set<Class<?>> _invalidBaseTypes

Set of specifically denied base types to indicate that use of specific base types is not allowed: most commonly used to fully block use of Object as the base type.

_baseTypeMatchers

protected final BasicPolymorphicTypeValidator.TypeMatcher[] _baseTypeMatchers

Set of matchers that can validate all values of polymorphic properties that match specified allowed base types.

_subTypeNameMatchers

protected final BasicPolymorphicTypeValidator.NameMatcher[] _subTypeNameMatchers

Set of matchers that can validate specific values of polymorphic properties that match subtype class name criteria.

_subClassMatchers

protected final BasicPolymorphicTypeValidator.TypeMatcher[] _subClassMatchers

Set of matchers that can validate specific values of polymorphic properties that match subtype class criteria.

_acceptArrayTypes

protected final boolean _acceptArrayTypes

[databind#5981]: when true, validateSubType() unwraps arrays (recursively for nested arrays) and validates the innermost element type against the sub-class matchers and sub-type name matchers (name-matcher consultation added by [databind#5988]).

Constructor Details

BasicPolymorphicTypeValidator

protected BasicPolymorphicTypeValidator(Set<Class<?>> invalidBaseTypes,
 BasicPolymorphicTypeValidator.TypeMatcher[] baseTypeMatchers,
 BasicPolymorphicTypeValidator.NameMatcher[] subTypeNameMatchers,
 BasicPolymorphicTypeValidator.TypeMatcher[] subClassMatchers)

BasicPolymorphicTypeValidator

protected BasicPolymorphicTypeValidator(Set<Class<?>> invalidBaseTypes,
 BasicPolymorphicTypeValidator.TypeMatcher[] baseTypeMatchers,
 BasicPolymorphicTypeValidator.NameMatcher[] subTypeNameMatchers,
 BasicPolymorphicTypeValidator.TypeMatcher[] subClassMatchers,
 boolean acceptArrayTypes)

Method Details

builder

public static BasicPolymorphicTypeValidator.Builder builder()

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