Class EntityFilteringFeature

java.lang.Object
org.glassfish.jersey.message.filtering.EntityFilteringFeature
All Implemented Interfaces:
javax.ws.rs.core.Feature

public final class EntityFilteringFeature extends Object implements javax.ws.rs.core.Feature
Feature used to add support for Entity Data Filtering feature for entity-filtering annotations based on EntityFiltering meta-annotation.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    Defines one or more annotations that should be used as entity-filtering scope when reading/writing an entity.
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    configure(javax.ws.rs.core.FeatureContext context)
     
    static boolean
    enabled(javax.ws.rs.core.Configuration config)
    Return true whether at least one of the entity filtering features is registered in the given config.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • ENTITY_FILTERING_SCOPE

      public static final String ENTITY_FILTERING_SCOPE
      Defines one or more annotations that should be used as entity-filtering scope when reading/writing an entity.

      The property can be used on client to define the scope as well as on server to override the scope derived from current request processing context (resource methods / resource classes).

      If the property is set, the specified annotations will be used to create (override) entity-filtering scope.

      The property value MUST be an instance of Annotation or Annotation[] array. To obtain the annotation instances refer to the EntityFiltering for requirements on creating entity-filtering annotations.

      A default value is not set.

      The name of the configuration property is "jersey.config.entityFiltering.scope".

      See Also:
  • Constructor Details

    • EntityFilteringFeature

      public EntityFilteringFeature()
  • Method Details

    • configure

      public boolean configure(javax.ws.rs.core.FeatureContext context)
      Specified by:
      configure in interface javax.ws.rs.core.Feature
    • enabled

      public static boolean enabled(javax.ws.rs.core.Configuration config)
      Return true whether at least one of the entity filtering features is registered in the given config.
      Parameters:
      config - config to be examined for presence of entity filtering feature.
      Returns:
      true if entity filtering is enabled for given config, false otherwise.