/*
 * Copyright (c) 2012, 2020 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package jakarta.ws.rs.container;

import java.io.IOException;

An extension interface implemented by container response filters.
 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 JAX-RS 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 JAX-RS runtime. Container response filter instances may also be discovered and bound dynamically to particular resource methods. 
Author:
Marek Potociar, Santiago Pericas-Geertsen
See Also:
ContainerRequestFilter
Since:
2.0/**
 * An extension interface implemented by container response filters.
 * <p>
 * By default, i.e. if no {@link jakarta.ws.rs.NameBinding name binding} is applied to the filter implementation class,
 * the filter instance is applied globally to any outgoing response. If there is a {@code @NameBinding} annotation
 * applied to the filter, the filter will only be executed for a response for which the request has been matched to a
 * {@link jakarta.ws.rs.HttpMethod resource or sub-resource method} AND the method or the whole custom
 * {@link jakarta.ws.rs.core.Application JAX-RS Application} class is bound to the same name-binding annotation.
 * </p>
 * <p>
 * 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.
 * </p>
 * <p>
 * Filters implementing this interface must be annotated with {@link jakarta.ws.rs.ext.Provider &#64;Provider} to be
 * discovered by the JAX-RS runtime. Container response filter instances may also be discovered and bound
 * {@link DynamicFeature dynamically} to particular resource methods.
 * </p>
 *
 * @author Marek Potociar
 * @author Santiago Pericas-Geertsen
 * @see jakarta.ws.rs.container.ContainerRequestFilter
 * @since 2.0
 */
public interface ContainerResponseFilter {

    
Filter method called after a response has been provided for a request (either by a 
request filter or by a matched resource method. 
 Filters in the filter chain are ordered according to their jakarta.annotation.Priority class-level annotation value. 
Params:
requestContext – request context.
responseContext – response context.
Throws:
IOException – if an I/O exception occurs./**
     * Filter method called after a response has been provided for a request (either by a {@link ContainerRequestFilter
     * request filter} or by a matched resource method.
     * <p>
     * Filters in the filter chain are ordered according to their {@code jakarta.annotation.Priority} class-level annotation
     * value.
     * </p>
     *
     * @param requestContext request context.
     * @param responseContext response context.
     * @throws IOException if an I/O exception occurs.
     */
    public void filter(ContainerRequestContext requestContext, ContainerResponseContext responseContext)
            throws IOException;
}