javax.servlet.FilterRegistration Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package javax.servlet;
import java.util.Collection;
import java.util.EnumSet;
/**
* @since Servlet 3.0
* TODO SERVLET3 - Add comments
*/
public interface FilterRegistration extends Registration {
/**
* Add a mapping for this filter to one or more named Servlets.
*
* @param dispatcherTypes The dispatch types to which this filter should
* apply
* @param isMatchAfter Should this filter be applied after any mappings
* defined in the deployment descriptor
* (true) or before?
* @param servletNames Requests mapped to these servlets will be
* processed by this filter
* @throws IllegalArgumentException if the list of servlet names is empty
* or null
* @throws IllegalStateException if the associated ServletContext has
* already been initialised
*/
public void addMappingForServletNames(
EnumSet dispatcherTypes,
boolean isMatchAfter, String... servletNames);
/**
*
* @return TODO
*/
public Collection getServletNameMappings();
/**
* Add a mapping for this filter to one or more URL patterns.
*
* @param dispatcherTypes The dispatch types to which this filter should
* apply
* @param isMatchAfter Should this filter be applied after any mappings
* defined in the deployment descriptor
* (true) or before?
* @param urlPatterns The URL patterns to which this filter should be
* applied
* @throws IllegalArgumentException if the list of URL patterns is empty or
* null
* @throws IllegalStateException if the associated ServletContext has
* already been initialised
*/
public void addMappingForUrlPatterns(
EnumSet dispatcherTypes,
boolean isMatchAfter, String... urlPatterns);
/**
*
* @return TODO
*/
public Collection getUrlPatternMappings();
public static interface Dynamic
extends FilterRegistration, Registration.Dynamic {
// No additional methods
}
}