Class BasicPolymorphicTypeValidator.Builder
java.lang.Object
edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.jsontype.BasicPolymorphicTypeValidator.Builder
- Enclosing class:
- BasicPolymorphicTypeValidator
Builder class for configuring and constructing immutable
BasicPolymorphicTypeValidator
instances. Criteria for allowing
polymorphic subtypes is specified by adding rules in priority order, starting
with the rules to evaluate first: when a matching rule is found, its status
(PolymorphicTypeValidator.Validity.ALLOWED
or PolymorphicTypeValidator.Validity.DENIED
) is used and no further
rules are checked.-
Field Summary
Modifier and TypeFieldDescriptionprotected List<BasicPolymorphicTypeValidator.TypeMatcher>
Collected matchers for base types to allow.Optional set of base types (exact match) that are NOT accepted as base types for polymorphic properties.protected List<BasicPolymorphicTypeValidator.TypeMatcher>
Collected Class-based matchers for sub types to allow.protected List<BasicPolymorphicTypeValidator.NameMatcher>
Collected name-based matchers for sub types to allow. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected BasicPolymorphicTypeValidator.Builder
protected BasicPolymorphicTypeValidator.Builder
protected BasicPolymorphicTypeValidator.Builder
Method for appending custom matcher called with base type: if matcher returnstrue
, all possible subtypes will be accepted; iffalse
, other matchers are applied.allowIfBaseType
(Class<?> baseOfBase) Method for appending matcher that will allow all subtypes in cases where nominal base type is specified class, or one of its subtypes.allowIfBaseType
(String prefixForBase) Method for appending matcher that will allow all subtypes in cases where nominal base type's class name starts with specific prefix.allowIfBaseType
(Pattern patternForBase) Method for appending matcher that will allow all subtypes in cases where nominal base type's class name matches givenPattern
For example, call toMethod for appending custom matcher called with resolved subtype: if matcher returnstrue
, type will be accepted; iffalse
, other matchers are applied.allowIfSubType
(Class<?> subTypeBase) Method for appending matcher that will allow specific subtype (regardless of declared base type) if it issubTypeBase
or its subtype.allowIfSubType
(String prefixForSubType) Method for appending matcher that will allow specific subtype (regardless of declared base type) in cases where subclass name starts with specified prefix For example, call toallowIfSubType
(Pattern patternForSubType) Method for appending matcher that will allow specific subtype (regardless of declared base type) in cases where subclass name matches givenPattern
.Method for appending matcher that will allow all subtypes that are Java arrays (regardless of element type).build()
denyForExactBaseType
(Class<?> baseTypeToDeny) Method for appending matcher that will mark any polymorphic properties with exact specific class to be invalid.
-
Field Details
-
_invalidBaseTypes
Optional set of base types (exact match) that are NOT accepted as base types for polymorphic properties. May be used to prevent "unsafe" base types likeObject
orSerializable
. -
_baseTypeMatchers
Collected matchers for base types to allow. -
_subTypeNameMatchers
Collected name-based matchers for sub types to allow. -
_subTypeClassMatchers
Collected Class-based matchers for sub types to allow.
-
-
Constructor Details
-
Builder
protected Builder()
-
-
Method Details
-
allowIfBaseType
Method for appending matcher that will allow all subtypes in cases where nominal base type is specified class, or one of its subtypes. For example, call tobuilder.allowIfBaseType(MyBaseType.class)
would indicate that any polymorphic properties where declared base type isMyBaseType
(or subclass thereof) would allow all legal (assignment-compatible) subtypes. -
allowIfBaseType
Method for appending matcher that will allow all subtypes in cases where nominal base type's class name matches givenPattern
For example, call tobuilder.allowIfBaseType(Pattern.compile("com\\.mycompany\\..*")
would indicate that any polymorphic properties where declared base type is in packagecom.mycompany
would allow all legal (assignment-compatible) subtypes.NOTE!
Pattern
match is applied usingif (patternForBase.matcher(typeId).matches()) { }
that is, it must match the whole class name, not just part. -
allowIfBaseType
Method for appending matcher that will allow all subtypes in cases where nominal base type's class name starts with specific prefix. For example, call tobuilder.allowIfBaseType("com.mycompany.")
would indicate that any polymorphic properties where declared base type is in packagecom.mycompany
would allow all legal (assignment-compatible) subtypes. -
allowIfBaseType
public BasicPolymorphicTypeValidator.Builder allowIfBaseType(BasicPolymorphicTypeValidator.TypeMatcher matcher) Method for appending custom matcher called with base type: if matcher returnstrue
, all possible subtypes will be accepted; iffalse
, other matchers are applied.- Parameters:
matcher
- Custom matcher to apply to base type- Returns:
- This Builder to allow call chaining
- Since:
- 2.11
-
denyForExactBaseType
Method for appending matcher that will mark any polymorphic properties with exact specific class to be invalid. For example, call tobuilder.denyforExactBaseType(Object.class)
would indicate that any polymorphic properties where declared base type isjava.lang.Object
would be deemed invalid, and attempt to deserialize values of such types should result in an exception. -
allowIfSubType
Method for appending matcher that will allow specific subtype (regardless of declared base type) if it issubTypeBase
or its subtype. For example, call tobuilder.allowIfSubType(MyImplType.class)
would indicate that any polymorphic values with type of isMyImplType
(or subclass thereof) would be allowed. -
allowIfSubType
Method for appending matcher that will allow specific subtype (regardless of declared base type) in cases where subclass name matches givenPattern
. For example, call tobuilder.allowIfSubType(Pattern.compile("com\\.mycompany\\.")
would indicate that any polymorphic values in packagecom.mycompany
would be allowed.NOTE!
Pattern
match is applied usingif (patternForSubType.matcher(typeId).matches()) { }
that is, it must match the whole class name, not just part. -
allowIfSubType
Method for appending matcher that will allow specific subtype (regardless of declared base type) in cases where subclass name starts with specified prefix For example, call tobuilder.allowIfSubType("com.mycompany.")
would indicate that any polymorphic values in packagecom.mycompany
would be allowed. -
allowIfSubType
public BasicPolymorphicTypeValidator.Builder allowIfSubType(BasicPolymorphicTypeValidator.TypeMatcher matcher) Method for appending custom matcher called with resolved subtype: if matcher returnstrue
, type will be accepted; iffalse
, other matchers are applied.- Parameters:
matcher
- Custom matcher to apply to resolved subtype- Returns:
- This Builder to allow call chaining
- Since:
- 2.11
-
allowIfSubTypeIsArray
Method for appending matcher that will allow all subtypes that are Java arrays (regardless of element type). Note that this does NOT validate element type itself as long as Polymorphic Type handling is enabled for element type: this is the case with all standard "Default Typing" inclusion criteria as well as for annotation (@JsonTypeInfo
) use case (since annotation only applies to element types, not container).NOTE: not used with other Java collection types (
List
s,Collection
s), mostly since use of generic types as polymorphic values is not (well) supported.- Since:
- 2.11
-
build
-
_appendBaseMatcher
protected BasicPolymorphicTypeValidator.Builder _appendBaseMatcher(BasicPolymorphicTypeValidator.TypeMatcher matcher) -
_appendSubNameMatcher
protected BasicPolymorphicTypeValidator.Builder _appendSubNameMatcher(BasicPolymorphicTypeValidator.NameMatcher matcher) -
_appendSubClassMatcher
protected BasicPolymorphicTypeValidator.Builder _appendSubClassMatcher(BasicPolymorphicTypeValidator.TypeMatcher matcher)
-