jakarta.servlet.FilterRegistration Maven / Gradle / Ivy
/*
* Copyright (c) 2017, 2023 Oracle and/or its affiliates and others.
* 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.servlet;
import java.util.*;
/**
* Interface through which a {@link Filter} may be further configured.
*
* @since Servlet 3.0
*/
public interface FilterRegistration extends Registration {
/**
* Adds a filter mapping with the given servlet names and dispatcher types for the Filter represented by this
* FilterRegistration.
*
*
* Filter mappings are matched in the order in which they were added.
*
*
* Depending on the value of the isMatchAfter parameter, the given filter mapping will be considered after or
* before any declared filter mappings of the ServletContext from which this FilterRegistration was obtained.
*
*
* If this method is called multiple times, each successive call adds to the effects of the former.
*
* @param dispatcherTypes the dispatcher types of the filter mapping, or null if the default
* DispatcherType.REQUEST is to be used
* @param isMatchAfter true if the given filter mapping should be matched after any declared filter mappings, and false
* if it is supposed to be matched before any declared filter mappings of the ServletContext from which this
* FilterRegistration was obtained
* @param servletNames the servlet names of the filter mapping
*
* @throws IllegalArgumentException if servletNames is null or empty
* @throws IllegalStateException if the ServletContext from which this FilterRegistration was obtained has already been
* initialized
*/
void addMappingForServletNames(EnumSet dispatcherTypes, boolean isMatchAfter,
String... servletNames);
/**
* Gets the currently available servlet name mappings of the Filter represented by this FilterRegistration.
*
*
* If permitted, any changes to the returned Collection must not affect this
* FilterRegistration.
*
* @return a (possibly empty) Collection of the currently available servlet name mappings of the Filter
* represented by this FilterRegistration
*/
Collection getServletNameMappings();
/**
* Adds a filter mapping with the given url patterns and dispatcher types for the Filter represented by this
* FilterRegistration.
*
*
* Filter mappings are matched in the order in which they were added.
*
*
* Depending on the value of the isMatchAfter parameter, the given filter mapping will be considered after or
* before any declared filter mappings of the ServletContext from which this FilterRegistration was obtained.
*
*
* If this method is called multiple times, each successive call adds to the effects of the former.
*
* @param dispatcherTypes the dispatcher types of the filter mapping, or null if the default
* DispatcherType.REQUEST is to be used
* @param isMatchAfter true if the given filter mapping should be matched after any declared filter mappings, and false
* if it is supposed to be matched before any declared filter mappings of the ServletContext from which this
* FilterRegistration was obtained
* @param urlPatterns the url patterns of the filter mapping
*
* @throws IllegalArgumentException if urlPatterns is null or empty
* @throws IllegalStateException if the ServletContext from which this FilterRegistration was obtained has already been
* initialized
*/
void addMappingForUrlPatterns(EnumSet dispatcherTypes, boolean isMatchAfter,
String... urlPatterns);
/**
* Gets the currently available URL pattern mappings of the Filter represented by this FilterRegistration.
*
*
* If permitted, any changes to the returned Collection must not affect this
* FilterRegistration.
*
* @return a (possibly empty) Collection of the currently available URL pattern mappings of the Filter
* represented by this FilterRegistration
*/
Collection getUrlPatternMappings();
/**
* Interface through which a {@link Filter} registered via one of the addFilter methods on
* {@link ServletContext} may be further configured.
*/
interface Dynamic extends FilterRegistration, Registration.Dynamic {
}
}