DRAFT

javax.servlet
Interface ServletRegistration

All Superinterfaces:
Registration
All Known Subinterfaces:
ServletRegistration.Dynamic

public interface ServletRegistration
extends Registration

Interface through which a Servlet may be further configured.

Since:
Servlet 3.0

Nested Class Summary
static interface ServletRegistration.Dynamic
          Interface through which a Servlet registered via one of the addServlet methods on ServletContext may be further configured.
 
Method Summary
 java.util.Set<java.lang.String> addMapping(java.lang.String... urlPatterns)
          Adds a servlet mapping with the given URL patterns for the Servlet represented by this ServletRegistration.
 java.lang.Iterable<java.lang.String> getMappings()
          Gets an Iterable over the currently available mappings of the Servlet represented by this ServletRegistration.
 
Methods inherited from interface javax.servlet.Registration
getClassName, getInitParameter, getInitParameters, getName, setInitParameter, setInitParameters
 

Method Detail

addMapping

java.util.Set<java.lang.String> addMapping(java.lang.String... urlPatterns)
Adds a servlet mapping with the given URL patterns for the Servlet represented by this ServletRegistration.

If any of the specified URL patterns are already mapped to a different Servlet, no updates will be performed.

Parameters:
urlPatterns - the URL patterns of the servlet mapping
Returns:
the (possibly empty) Set of URL patterns that are already mapped to a different Servlet
Throws:
java.lang.IllegalArgumentException - if urlPatterns is null or empty
IllegalStateException - if the ServletContext from which this ServletRegistration was obtained has already been initialized

getMappings

java.lang.Iterable<java.lang.String> getMappings()
Gets an Iterable over the currently available mappings of the Servlet represented by this ServletRegistration.

Returns:
Iterable over the currently available mappings of the Servlet represented by this ServletRegistration.

DRAFT

Submit a bug or feature

Copyright © 2009 Sun Microsystems, Inc. All Rights Reserved. Use is subject to license terms.