jakarta.ws.rs.container.ContainerRequestFilter Maven / Gradle / Ivy
Show all versions of jaxrs-ri Show documentation
/*
* Copyright (c) 2012, 2019 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 request filters.
*
* 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, however only after the incoming request has been matched to a particular
* resource by JAX-RS runtime. If there is a {@link jakarta.ws.rs.NameBinding @NameBinding} annotation applied to the
* filter, the filter will also be executed at the post-match request extension point, but only in case the
* matched {@link jakarta.ws.rs.HttpMethod resource or sub-resource method} is bound to the same name-binding annotation.
*
*
* In case the filter should be applied at the pre-match extension point, i.e. before any request matching has
* been performed by JAX-RS runtime, the filter MUST be annotated with a {@link PreMatching @PreMatching}
* annotation.
*
*
* Use a pre-match request filter to update the input to the JAX-RS matching algorithm, e.g., the HTTP method, Accept
* header, return cached responses etc. Otherwise, the use of a request filter invoked at the post-match request
* extension point (after a successful resource method matching) is recommended.
*
*
* Filters implementing this interface must be annotated with {@link jakarta.ws.rs.ext.Provider @Provider} to be
* discovered by the JAX-RS runtime. Container request filter instances may also be discovered and bound
* {@link DynamicFeature dynamically} to particular resource methods.
*
*
* @author Marek Potociar
* @author Santiago Pericas-Geertsen
* @see PreMatching
* @see jakarta.ws.rs.container.ContainerResponseFilter
* @since 2.0
*/
public interface ContainerRequestFilter {
/**
* Filter method called before a request has been dispatched to a resource.
*
*
* Filters in the filter chain are ordered according to their {@code javax.annotation.Priority} class-level annotation
* value. If a request filter produces a response by calling {@link ContainerRequestContext#abortWith} method, the
* execution of the (either pre-match or post-match) request filter chain is stopped and the response is passed to the
* corresponding response filter chain (either pre-match or post-match). For example, a pre-match caching filter may
* produce a response in this way, which would effectively skip any post-match request filters as well as post-match
* response filters. Note however that a responses produced in this manner would still be processed by the pre-match
* response filter chain.
*
*
* @param requestContext request context.
* @throws IOException if an I/O exception occurs.
* @see PreMatching
*/
public void filter(ContainerRequestContext requestContext) throws IOException;
}