public interface ContainerResponseFilter
By default, i.e. if no name binding
is applied
to the filter implementation class, the filter instance is applied globally to
any outgoing response.
If there is a @NameBinding
annotation applied to the filter, the filter
will only be executed for a response for which the request has been matched to
a resource or sub-resource method
AND the method
or the whole custom Application
class
is bound to the same name-binding annotation.
Implement a name-bound response filter in cases when you want limit the filter functionality to a matched resource or resource method. In other cases, when the filter should be applied globally to any outgoing response, implement an unbound, global response filter.
Filters implementing this interface must be annotated with
@Provider
to be discovered by the
runtime. Container response filter instances may also be discovered and
bound dynamically
to particular resource methods.
ContainerRequestFilter
Modifier and Type | Method | Description |
---|---|---|
void |
filter(ContainerRequestContext requestContext,
ContainerResponseContext responseContext) |
Filter method called after a response has been provided for a request
(either by a
request filter or by a
matched resource method. |
void filter(ContainerRequestContext requestContext, ContainerResponseContext responseContext) throws IOException
request filter
or by a
matched resource method.
Filters in the filter chain are ordered according to their javax.annotation.Priority
class-level annotation value.
requestContext
- request context.responseContext
- response context.IOException
- if an I/O exception occurs.Copyright (c) 2019 Eclipse Foundation. Licensed under Eclipse Foundation Specification License.