Class BasicPolymorphicTypeValidator
java.lang.Object
edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.jsontype.PolymorphicTypeValidator
edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.jsontype.PolymorphicTypeValidator.Base
edu.internet2.middleware.grouperClientExt.com.fasterxml.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:
- Since:
- 2.10
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
Builder class for configuring and constructing immutableBasicPolymorphicTypeValidator
instances.static class
General matcher interface (predicate) for validating unresolved subclass class name.static class
General matcher interface (predicate) for validating class values (base type or resolved subtype)Nested classes/interfaces inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.jsontype.PolymorphicTypeValidator
PolymorphicTypeValidator.Base, PolymorphicTypeValidator.Validity
-
Field Summary
Modifier and TypeFieldDescriptionprotected final BasicPolymorphicTypeValidator.TypeMatcher[]
Set of matchers that can validate all values of polymorphic properties that match specified allowed base types.Set of specifically denied base types to indicate that use of specific base types is not allowed: most commonly used to fully block use ofObject
as the base type.protected final BasicPolymorphicTypeValidator.TypeMatcher[]
Set of matchers that can validate specific values of polymorphic properties that match subtype class criteria.protected final BasicPolymorphicTypeValidator.NameMatcher[]
Set of matchers that can validate specific values of polymorphic properties that match subtype class name criteria. -
Constructor Summary
ModifierConstructorDescriptionprotected
BasicPolymorphicTypeValidator
(Set<Class<?>> invalidBaseTypes, BasicPolymorphicTypeValidator.TypeMatcher[] baseTypeMatchers, BasicPolymorphicTypeValidator.NameMatcher[] subTypeNameMatchers, BasicPolymorphicTypeValidator.TypeMatcher[] subClassMatchers) -
Method Summary
Modifier and TypeMethodDescriptionbuilder()
validateBaseType
(MapperConfig<?> ctxt, JavaType baseType) Method called when a property with polymorphic value is encountered, and aTypeResolverBuilder
is needed.validateSubClassName
(MapperConfig<?> ctxt, JavaType baseType, String subClassName) validateSubType
(MapperConfig<?> ctxt, JavaType baseType, JavaType subType) Method called after class name has been resolved to actual type, in cases where previous call toPolymorphicTypeValidator.validateSubClassName(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.cfg.MapperConfig<?>, edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.JavaType, java.lang.String)
returnedPolymorphicTypeValidator.Validity.INDETERMINATE
.
-
Field Details
-
_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 ofObject
as the base type. -
_baseTypeMatchers
Set of matchers that can validate all values of polymorphic properties that match specified allowed base types. -
_subTypeNameMatchers
Set of matchers that can validate specific values of polymorphic properties that match subtype class name criteria. -
_subClassMatchers
Set of matchers that can validate specific values of polymorphic properties that match subtype class criteria.
-
-
Constructor Details
-
BasicPolymorphicTypeValidator
protected BasicPolymorphicTypeValidator(Set<Class<?>> invalidBaseTypes, BasicPolymorphicTypeValidator.TypeMatcher[] baseTypeMatchers, BasicPolymorphicTypeValidator.NameMatcher[] subTypeNameMatchers, BasicPolymorphicTypeValidator.TypeMatcher[] subClassMatchers)
-
-
Method Details
-
builder
-
validateBaseType
Description copied from class:PolymorphicTypeValidator
Method called when a property with polymorphic value is encountered, and aTypeResolverBuilder
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 classPolymorphicTypeValidator.Base
- Parameters:
ctxt
- Configuration for resolution: typically will beDeserializationConfig
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; isPolymorphicTypeValidator.Validity.DENIED
returned no subtyping allowed at all (caller will usually throw an exception); otherwise (returnPolymorphicTypeValidator.Validity.INDETERMINATE
) per sub-type validation calls are made for each new subclass encountered.
-
validateSubClassName
public PolymorphicTypeValidator.Validity validateSubClassName(MapperConfig<?> ctxt, JavaType baseType, 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 actualClass
orJavaType
. Validator may be able to determine validity of eventual type (and returnPolymorphicTypeValidator.Validity.ALLOWED
orPolymorphicTypeValidator.Validity.DENIED
) or, if not able to, can defer validation to actual resolved type by returningPolymorphicTypeValidator.Validity.INDETERMINATE
.Validator may also choose to indicate denial by throwing a
JsonMappingException
(such asInvalidTypeIdException
)- Overrides:
validateSubClassName
in classPolymorphicTypeValidator.Base
- Parameters:
ctxt
- Configuration for resolution: typically will beDeserializationConfig
baseType
- Nominal base type used for polymorphic handling: subtypes MUST be instances of this type and assignment compatibility is verified by Jackson coresubClassName
- Name of class that will be resolved toClass
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<?> ctxt, 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 toPolymorphicTypeValidator.validateSubClassName(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.cfg.MapperConfig<?>, edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.JavaType, java.lang.String)
returnedPolymorphicTypeValidator.Validity.INDETERMINATE
. Validator should be able to determine validity and return appropriatePolymorphicTypeValidator.Validity
value, although it may alsoValidator may also choose to indicate denial by throwing a
JsonMappingException
(such asInvalidTypeIdException
)- Overrides:
validateSubType
in classPolymorphicTypeValidator.Base
- Parameters:
ctxt
- Configuration for resolution: typically will beDeserializationConfig
baseType
- Nominal base type used for polymorphic handling: subtypes MUST be instances of this type and assignment compatibility has been verified by Jackson coresubType
- 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
-