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
resource or sub-resource method AND the method
or the whole custom
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
dynamically to particular resource methods.
|Modifier and Type||Method and Description|
Filter method called after a response has been provided for a request (either by a
void filter(ContainerRequestContext requestContext, ContainerResponseContext responseContext) throws IOException
request filteror by a matched resource method.
Filters in the filter chain are ordered according to their
class-level annotation value.
requestContext- request context.
responseContext- response context.
IOException- if an I/O exception occurs.
Copyright © 2019 Eclipse Foundation.
Use is subject to license terms.