Interface ScopeProvider
-
- All Known Implementing Classes:
CommonScopeProvider
,SecurityServerScopeProvider
,ServerScopeProvider
@Contract public interface ScopeProvider
Entry point for obtaining entity-filtering scopes used to process a request/response entity. Entity-filtering scopes are obtained from (sorted by priority):- entity annotations - provided with entity when creating request/response
- annotations stored under
"jersey.config.entityFiltering.scope" property obtained from
configuration
- entity-filtering annotations present on resource methods/classes (on server)
ScopeResolver
.- See Also:
ScopeResolver
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
DEFAULT_SCOPE
Default entity-filtering scope.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.Set<java.lang.String>
getFilteringScopes(java.lang.annotation.Annotation[] entityAnnotations, boolean defaultIfNotFound)
Get entity-filtering scopes to be used to process an entity.
-
-
-
Field Detail
-
DEFAULT_SCOPE
static final java.lang.String DEFAULT_SCOPE
Default entity-filtering scope. Default scope is used inobject graph
to retrieve a subgraph instance at the moment subgraph's entity class does not define any entity-filtering scope the object graph was created for. This scope is created for anentity graph
if no other entity-filtering / security annotation is present on a class.
-
-
Method Detail
-
getFilteringScopes
java.util.Set<java.lang.String> getFilteringScopes(java.lang.annotation.Annotation[] entityAnnotations, boolean defaultIfNotFound)
Get entity-filtering scopes to be used to process an entity.- Parameters:
entityAnnotations
- entity annotations provided with entity when creating request/response.defaultIfNotFound
- flag determining whether the default entity-filtering scope should be returned if no other scope can be obtained.- Returns:
- non-null entity-filtering scopes.
-
-