Package org.sdase.commons.server.jackson.filter

Class FieldFilterSerializerModifier

java.lang.Object
com.fasterxml.jackson.databind.ser.BeanSerializerModifier
org.sdase.commons.server.jackson.filter.FieldFilterSerializerModifier
public class FieldFilterSerializerModifier extends com.fasterxml.jackson.databind.ser.BeanSerializerModifier
Applies the field filter when a bean is serialized. This class is called for each property, for each serialized object.

It removes the fields by the following rules:

  1. The property is returned if no field filter is set
  2. The property is not returned if the field (at the top level) is not part of the set of filtered fields (&fields= parameter)
  3. The property is returned if it is part of a nested or embedded object

  • Constructor Summary

    Constructors
    Constructor
    Description
    FieldFilterSerializerModifier()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    com.fasterxml.jackson.databind.JsonSerializer<?>
    modifySerializer(com.fasterxml.jackson.databind.SerializationConfig config, com.fasterxml.jackson.databind.BeanDescription beanDesc, com.fasterxml.jackson.databind.JsonSerializer<?> serializer)
     

    Methods inherited from class com.fasterxml.jackson.databind.ser.BeanSerializerModifier

    changeProperties, modifyArraySerializer, modifyCollectionLikeSerializer, modifyCollectionSerializer, modifyEnumSerializer, modifyKeySerializer, modifyMapLikeSerializer, modifyMapSerializer, orderProperties, updateBuilder

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • FieldFilterSerializerModifier

      public FieldFilterSerializerModifier()

  • Method Details

    • modifySerializer

      public com.fasterxml.jackson.databind.JsonSerializer<?> modifySerializer(com.fasterxml.jackson.databind.SerializationConfig config, com.fasterxml.jackson.databind.BeanDescription beanDesc, com.fasterxml.jackson.databind.JsonSerializer<?> serializer)
      Overrides:
      modifySerializer in class com.fasterxml.jackson.databind.ser.BeanSerializerModifier