FasterXML/jackson-databind#1296 @JsonIncludeProperties

src/main/java/com/fasterxml/jackson/databind/AnnotationIntrospector.java

@@ -278,6 +278,18 @@ public JsonIgnoreProperties.Value findPropertyIgnorals(Annotated ac)
      */
     public Boolean isIgnorableType(AnnotatedClass ac) { return null; }
 
+    /**
+     * Method for finding information about properties to include.
+     *
+     * @param ac Annotated class to introspect
+     *
+     * @since 2.12
+     */
+    public JsonIncludeProperties.Value findPropertyInclusions(Annotated ac)
+    {
+        return JsonIncludeProperties.Value.all();
+    }
+
     /**
      * Method for finding if annotated class has associated filter; and if so,
      * to return id that is used to locate filter.

src/main/java/com/fasterxml/jackson/databind/cfg/MapperConfig.java

@@ -498,6 +498,17 @@ public JsonInclude.Value getDefaultInclusion(Class<?> baseType,
     public abstract JsonIgnoreProperties.Value getDefaultPropertyIgnorals(Class<?> baseType,
             AnnotatedClass actualClass);
 
+    /**
+     * Helper method that may be called to see if there are property inclusion
+     * definitions from annotations (via {@link AnnotatedClass}).
+     *
+     * TODO: config override.
+     *
+     * @since 2.12
+     */
+    public abstract JsonIncludeProperties.Value getDefaultPropertyInclusions(Class<?> baseType,
+            AnnotatedClass actualClass);
+
     /**
      * Accessor for object used for determining whether specific property elements
      * (method, constructors, fields) can be auto-detected based on

src/main/java/com/fasterxml/jackson/databind/cfg/MapperConfigBase.java

@@ -665,6 +665,14 @@ public final JsonIgnoreProperties.Value getDefaultPropertyIgnorals(Class<?> base
         return JsonIgnoreProperties.Value.merge(base, overrides);
     }
 
+    @Override
+    public final JsonIncludeProperties.Value getDefaultPropertyInclusions(Class<?> baseType,
+            AnnotatedClass actualClass)
+    {
+        AnnotationIntrospector intr = getAnnotationIntrospector();
+        return (intr == null) ? null : intr.findPropertyInclusions(actualClass);
+    }
+
     @Override
     public final VisibilityChecker<?> getDefaultVisibilityChecker()
     {

src/main/java/com/fasterxml/jackson/databind/deser/BasicDeserializerFactory.java

@@ -8,6 +8,7 @@
 import com.fasterxml.jackson.annotation.JacksonInject;
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonIncludeProperties;
 import com.fasterxml.jackson.annotation.JsonSetter;
 import com.fasterxml.jackson.annotation.Nulls;
 import com.fasterxml.jackson.annotation.JsonCreator.Mode;
@@ -1373,6 +1374,10 @@ public JsonDeserializer<?> createMapDeserializer(DeserializationContext ctxt,
                     Set<String> ignored = (ignorals == null) ? null
                             : ignorals.findIgnoredForDeserialization();
                     md.setIgnorableProperties(ignored);
+                    JsonIncludeProperties.Value inclusions = config.getDefaultPropertyInclusions(Map.class,
+                            beanDesc.getClassInfo());
+                    Set<String> included = inclusions == null ? null : inclusions.getIncluded();
+                    md.setIncludableProperties(included);
                     deser = md;
                 }
             }

src/main/java/com/fasterxml/jackson/databind/deser/BeanDeserializer.java

@@ -8,6 +8,7 @@
 import com.fasterxml.jackson.databind.cfg.CoercionAction;
 import com.fasterxml.jackson.databind.deser.impl.*;
 import com.fasterxml.jackson.databind.deser.impl.ReadableObjectId.Referring;
+import com.fasterxml.jackson.databind.util.IgnorePropertiesUtil;
 import com.fasterxml.jackson.databind.util.NameTransformer;
 import com.fasterxml.jackson.databind.util.TokenBuffer;
 
@@ -56,14 +57,31 @@ public class BeanDeserializer
 
     /**
      * Constructor used by {@link BeanDeserializerBuilder}.
+     *
+     * @deprecated in 2.12, remove from 3.0
      */
+    @Deprecated
     public BeanDeserializer(BeanDeserializerBuilder builder, BeanDescription beanDesc,
             BeanPropertyMap properties, Map<String, SettableBeanProperty> backRefs,
             HashSet<String> ignorableProps, boolean ignoreAllUnknown,
             boolean hasViews)
     {
         super(builder, beanDesc, properties, backRefs,
-                ignorableProps, ignoreAllUnknown, hasViews);
+                ignorableProps, ignoreAllUnknown, null, hasViews);
+    }
+
+    /**
+     * Constructor used by {@link BeanDeserializerBuilder}.
+     *
+     * @since 2.12
+     */
+    public BeanDeserializer(BeanDeserializerBuilder builder, BeanDescription beanDesc,
+                            BeanPropertyMap properties, Map<String, SettableBeanProperty> backRefs,
+                            HashSet<String> ignorableProps, boolean ignoreAllUnknown, Set<String> includableProps,
+                            boolean hasViews)
+    {
+        super(builder, beanDesc, properties, backRefs,
+                ignorableProps, ignoreAllUnknown, includableProps, hasViews);
     }
 
     /**
@@ -86,10 +104,21 @@ public BeanDeserializer(BeanDeserializerBase src, ObjectIdReader oir) {
         super(src, oir);
     }
 
+    /**
+     * @deprecated in 2.12, remove from 3.0
+     */
+    @Deprecated
     public BeanDeserializer(BeanDeserializerBase src, Set<String> ignorableProps) {
         super(src, ignorableProps);
     }
 
+    /**
+     * @since 2.12
+     */
+    public BeanDeserializer(BeanDeserializerBase src, Set<String> ignorableProps, Set<String> includableProps) {
+        super(src, ignorableProps, includableProps);
+    }
+
     public BeanDeserializer(BeanDeserializerBase src, BeanPropertyMap props) {
         super(src, props);
     }
@@ -119,8 +148,8 @@ public BeanDeserializer withObjectIdReader(ObjectIdReader oir) {
     }
 
     @Override
-    public BeanDeserializer withIgnorableProperties(Set<String> ignorableProps) {
-        return new BeanDeserializer(this, ignorableProps);
+    public BeanDeserializer withIgnorableProperties(Set<String> ignorableProps, Set<String> includableProps) {
+        return new BeanDeserializer(this, ignorableProps, includableProps);
     }
 
     @Override
@@ -464,7 +493,7 @@ protected Object _deserializeUsingPropertyBased(final JsonParser p, final Deseri
                 continue;
             }
             // Things marked as ignorable should not be passed to any setter
-            if (_ignorableProps != null && _ignorableProps.contains(propName)) {
+            if (IgnorePropertiesUtil.shouldIgnore(propName, _ignorableProps, _includableProps)) {
                 handleIgnoredProperty(p, ctxt, handledType(), propName);
                 continue;
             }
@@ -694,7 +723,7 @@ protected Object deserializeWithUnwrapped(JsonParser p, DeserializationContext c
                 continue;
             }
             // Things marked as ignorable should not be passed to any setter
-            if (_ignorableProps != null && _ignorableProps.contains(propName)) {
+            if (IgnorePropertiesUtil.shouldIgnore(propName, _ignorableProps, _includableProps)) {
                 handleIgnoredProperty(p, ctxt, bean, propName);
                 continue;
             }
@@ -751,7 +780,7 @@ protected Object deserializeWithUnwrapped(JsonParser p, DeserializationContext c
                 }
                 continue;
             }
-            if (_ignorableProps != null && _ignorableProps.contains(propName)) {
+            if (IgnorePropertiesUtil.shouldIgnore(propName, _ignorableProps, _includableProps)) {
                 handleIgnoredProperty(p, ctxt, bean, propName);
                 continue;
             }
@@ -850,7 +879,7 @@ protected Object deserializeUsingPropertyBasedWithUnwrapped(JsonParser p, Deseri
                 continue;
             }
             // Things marked as ignorable should not be passed to any setter
-            if (_ignorableProps != null && _ignorableProps.contains(propName)) {
+            if (IgnorePropertiesUtil.shouldIgnore(propName, _ignorableProps, _includableProps)) {
                 handleIgnoredProperty(p, ctxt, handledType(), propName);
                 continue;
             }
@@ -942,7 +971,7 @@ protected Object deserializeWithExternalTypeId(JsonParser p, DeserializationCont
                 continue;
             }
             // ignorable things should be ignored
-            if (_ignorableProps != null && _ignorableProps.contains(propName)) {
+            if (IgnorePropertiesUtil.shouldIgnore(propName, _ignorableProps, _includableProps)) {
                 handleIgnoredProperty(p, ctxt, bean, propName);
                 continue;
             }
@@ -1033,7 +1062,7 @@ protected Object deserializeUsingPropertyBasedWithExternalTypeId(JsonParser p, D
                 continue;
             }
             // Things marked as ignorable should not be passed to any setter
-            if (_ignorableProps != null && _ignorableProps.contains(propName)) {
+            if (IgnorePropertiesUtil.shouldIgnore(propName, _ignorableProps, _includableProps)) {
                 handleIgnoredProperty(p, ctxt, handledType(), propName);
                 continue;
             }

src/main/java/com/fasterxml/jackson/databind/deser/BeanDeserializerBase.java

@@ -135,6 +135,11 @@ public abstract class BeanDeserializerBase
      */
     final protected Set<String> _ignorableProps;
 
+    /**
+     * Keep track of the the properties that needs to be specifically included.
+     */
+    final protected Set<String> _includableProps;
+
     /**
      * Flag that can be set to ignore and skip unknown properties.
      * If set, will not throw an exception for unknown properties.
@@ -201,6 +206,7 @@ protected BeanDeserializerBase(BeanDeserializerBuilder builder,
             BeanDescription beanDesc,
             BeanPropertyMap properties, Map<String, SettableBeanProperty> backRefs,
             Set<String> ignorableProps, boolean ignoreAllUnknown,
+            Set<String> includableProps,
             boolean hasViews)
     {
         super(beanDesc.getType());
@@ -211,6 +217,7 @@ protected BeanDeserializerBase(BeanDeserializerBuilder builder,
         _backRefs = backRefs;
         _ignorableProps = ignorableProps;
         _ignoreAllUnknown = ignoreAllUnknown;
+        _includableProps = includableProps;
 
         _anySetter = builder.getAnySetter();
         List<ValueInjector> injectables = builder.getInjectables();
@@ -263,6 +270,7 @@ protected BeanDeserializerBase(BeanDeserializerBase src, boolean ignoreAllUnknow
         _backRefs = src._backRefs;
         _ignorableProps = src._ignorableProps;
         _ignoreAllUnknown = ignoreAllUnknown;
+        _includableProps = src._includableProps;
         _anySetter = src._anySetter;
         _injectables = src._injectables;
         _objectIdReader = src._objectIdReader;
@@ -288,6 +296,7 @@ protected BeanDeserializerBase(BeanDeserializerBase src, NameTransformer unwrapp
         _backRefs = src._backRefs;
         _ignorableProps = src._ignorableProps;
         _ignoreAllUnknown = (unwrapper != null) || src._ignoreAllUnknown;
+        _includableProps = src._includableProps;
         _anySetter = src._anySetter;
         _injectables = src._injectables;
         _objectIdReader = src._objectIdReader;
@@ -325,6 +334,7 @@ public BeanDeserializerBase(BeanDeserializerBase src, ObjectIdReader oir)
         _backRefs = src._backRefs;
         _ignorableProps = src._ignorableProps;
         _ignoreAllUnknown = src._ignoreAllUnknown;
+        _includableProps = src._includableProps;
         _anySetter = src._anySetter;
         _injectables = src._injectables;
 
@@ -351,6 +361,14 @@ public BeanDeserializerBase(BeanDeserializerBase src, ObjectIdReader oir)
     }
 
     public BeanDeserializerBase(BeanDeserializerBase src, Set<String> ignorableProps)
+    {
+        this(src, ignorableProps, src._includableProps);
+    }
+
+    /**
+     * @since 2.12
+     */
+    public BeanDeserializerBase(BeanDeserializerBase src, Set<String> ignorableProps, Set<String> includableProps)
     {
         super(src._beanType);
         _beanType = src._beanType;
@@ -362,6 +380,7 @@ public BeanDeserializerBase(BeanDeserializerBase src, Set<String> ignorableProps
         _backRefs = src._backRefs;
         _ignorableProps = ignorableProps;
         _ignoreAllUnknown = src._ignoreAllUnknown;
+        _includableProps = includableProps;
         _anySetter = src._anySetter;
         _injectables = src._injectables;
 
@@ -375,9 +394,10 @@ public BeanDeserializerBase(BeanDeserializerBase src, Set<String> ignorableProps
 
         // 01-May-2016, tatu: [databind#1217]: Remove properties from mapping,
         //    to avoid them being deserialized
-        _beanProperties = src._beanProperties.withoutProperties(ignorableProps);
+        _beanProperties = src._beanProperties.withoutProperties(ignorableProps, includableProps);
     }
 
+
     /**
      * @since 2.8
      */
@@ -394,6 +414,7 @@ protected BeanDeserializerBase(BeanDeserializerBase src, BeanPropertyMap beanPro
         _backRefs = src._backRefs;
         _ignorableProps = src._ignorableProps;
         _ignoreAllUnknown = src._ignoreAllUnknown;
+        _includableProps = src._includableProps;
         _anySetter = src._anySetter;
         _injectables = src._injectables;
         _objectIdReader = src._objectIdReader;
@@ -411,7 +432,21 @@ protected BeanDeserializerBase(BeanDeserializerBase src, BeanPropertyMap beanPro
 
     public abstract BeanDeserializerBase withObjectIdReader(ObjectIdReader oir);
 
-    public abstract BeanDeserializerBase withIgnorableProperties(Set<String> ignorableProps);
+    public BeanDeserializerBase withIgnorableProperties(Set<String> ignorableProps) {
+        return withIgnorableProperties(ignorableProps, _includableProps);
+    }
+
+    /**
+     * @since 2.12
+     */
+    public abstract BeanDeserializerBase withIgnorableProperties(Set<String> ignorableProps, Set<String> includableProps);
+
+    /**
+     * @since 2.12
+     */
+    public BeanDeserializerBase withIncludableProperties(Set<String> includableProperties) {
+        return withIgnorableProperties(_ignorableProps, includableProperties);
+    }
 
     // NOTE! To be made `abstract` in 2.12 or later
     /**
@@ -422,7 +457,7 @@ public BeanDeserializerBase withIgnoreAllUnknown(boolean ignoreUnknown) {
         if (ignoreUnknown == _ignoreAllUnknown) {
             return this;
         }
-        return withIgnorableProperties(_ignorableProps);
+        return withIgnorableProperties(_ignorableProps, _includableProps);
     }
 
     /**
@@ -469,10 +504,10 @@ public void resolve(DeserializationContext ctxt) throws JsonMappingException
             // 22-Jan-2018, tatu: May need to propagate "ignorable" status (from `Access.READ_ONLY`
             //     or perhaps class-ignorables) into Creator properties too. Can not just delete,
             //     at this point, but is needed for further processing down the line
-            if (_ignorableProps != null) {
+            if (_ignorableProps != null || _includableProps != null) {
                 for (int i = 0, end = creatorProps.length; i < end; ++i) {
                     SettableBeanProperty prop  = creatorProps[i];
-                    if (_ignorableProps.contains(prop.getName())) {
+                    if (IgnorePropertiesUtil.shouldIgnore(prop.getName(), _ignorableProps, _includableProps)) {
                         creatorProps[i].markAsIgnorable();
                     }
                 }
@@ -773,6 +808,21 @@ public JsonDeserializer<?> createContextual(DeserializationContext ctxt,
                     contextual = contextual.withIgnoreAllUnknown(true);
                 }
             }
+            JsonIncludeProperties.Value inclusions = intr.findPropertyInclusions(accessor);
+            if (inclusions != null) {
+                Set<String> included = inclusions.getIncluded();
+                Set<String> prev = contextual._includableProps;
+                if (prev != null && included != null) {
+                    Set<String> newIncluded = new HashSet<>();
+                    // Make the intersection with the previously included properties.
+                    for(String prop : prev) {
+                        if (included.contains(prop)) {
+                            newIncluded.add(prop);
+                        }
+                    }
+                    contextual = contextual.withIncludableProperties(newIncluded);
+                }
+            }
         }
 
         // One more thing: are we asked to serialize POJO as array?
@@ -1587,7 +1637,8 @@ protected void handleUnknownVanilla(JsonParser p, DeserializationContext ctxt,
             Object beanOrBuilder, String propName)
         throws IOException
     {
-        if (_ignorableProps != null && _ignorableProps.contains(propName)) {
+
+        if (IgnorePropertiesUtil.shouldIgnore(propName, _ignorableProps, _includableProps)) {
             handleIgnoredProperty(p, ctxt, beanOrBuilder, propName);
         } else if (_anySetter != null) {
             try {
@@ -1615,7 +1666,7 @@ protected void handleUnknownProperty(JsonParser p, DeserializationContext ctxt,
             p.skipChildren();
             return;
         }
-        if (_ignorableProps != null && _ignorableProps.contains(propName)) {
+        if (IgnorePropertiesUtil.shouldIgnore(propName, _ignorableProps, _includableProps)) {
             handleIgnoredProperty(p, ctxt, beanOrClass, propName);
         }
         // Otherwise use default handling (call handler(s); if not