Class EntityFilteringFeature
- java.lang.Object
-
- org.glassfish.jersey.message.filtering.EntityFilteringFeature
-
- All Implemented Interfaces:
javax.ws.rs.core.Feature
public final class EntityFilteringFeature extends java.lang.Object implements javax.ws.rs.core.Feature
Feature
used to add support for Entity Data Filtering feature for entity-filtering annotations based onEntityFiltering
meta-annotation.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ENTITY_FILTERING_SCOPE
Defines one or more annotations that should be used as entity-filtering scope when reading/writing an entity.
-
Constructor Summary
Constructors Constructor Description EntityFilteringFeature()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
configure(javax.ws.rs.core.FeatureContext context)
static boolean
enabled(javax.ws.rs.core.Configuration config)
Returntrue
whether at least one of the entity filtering features is registered in the given config.
-
-
-
Field Detail
-
ENTITY_FILTERING_SCOPE
public static final java.lang.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
orAnnotation[]
array. To obtain the annotation instances refer to theEntityFiltering
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:
EntityFiltering
, Constant Field Values
-
-
Method Detail
-
configure
public boolean configure(javax.ws.rs.core.FeatureContext context)
- Specified by:
configure
in interfacejavax.ws.rs.core.Feature
-
enabled
public static boolean enabled(javax.ws.rs.core.Configuration config)
Returntrue
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.
-
-