Package org.glassfish.jersey.message.filtering.spi
SPI for Entity Data Filtering in Jersey.
To create a custom entity-filtering annotation with special handling (e.g. field aggregator annotation used to annotate
classes), refer to:
To support Entity Data Filtering in custom providers (e.g. message body workers), refer to:
- Since:
- 2.3
-
Interface Summary Interface Description EntityGraph Class available toentity-filtering processors
providing means to add/remove entity-filtering scopes (e.g.EntityGraphProvider Providesentity graph
andobject graph
instances.EntityInspector Responsible for inspecting entity classes.EntityProcessor Contract supposed to process entity classes for Entity Data Filtering.EntityProcessorContext Entity processor
context providing details about entity processing.ObjectGraph Read-only graph containing representations of an entity class that should be processed in entity-filtering.ObjectGraphTransformer<T> This contract brings support for transforming an internal representation of entity data filtering feature into an object familiar to underlying provider (e.g.ObjectProvider<T> Entry point of Entity Data Filtering feature for providers working with custom entities and media types (reading/writing).ScopeProvider Entry point for obtaining entity-filtering scopes used to process a request/response entity.ScopeResolver Class used to resolve entity-filtering scopes from annotations. -
Class Summary Class Description AbstractEntityProcessor Commonentity processor
supposed to be used as a base class for custom implementations.AbstractObjectProvider<T> Common implementation ofobject provider
andobject graph transformer
.AbstractObjectProvider.EntityContext Class to be used as a key in cache (EntityContext
-> filtering object) when processing similar requests.FilteringHelper SPI utility methods for entity filtering. -
Enum Summary Enum Description EntityProcessor.Result Result type of processing an context.EntityProcessorContext.Type The type of the context which describes in which entity processing phase theEntityProcessor.process(EntityProcessorContext)
is triggered.