Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
   *
   * Copyright (c) 2008-2010 Oracle and/or its affiliates. All rights reserved.
   *
   * The contents of this file are subject to the terms of either the GNU
   * General Public License Version 2 only ("GPL") or the Common Development
   * and Distribution License("CDDL") (collectively, the "License").  You
   * may not use this file except in compliance with the License.  You can
  * obtain a copy of the License at
  * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
  * or packager/legal/LICENSE.txt.  See the License for the specific
  * language governing permissions and limitations under the License.
  *
  * When distributing the software, include this License Header Notice in each
  * file and include the License file at packager/legal/LICENSE.txt.
  *
  * GPL Classpath Exception:
  * Oracle designates this particular file as subject to the "Classpath"
  * exception as provided by Oracle in the GPL Version 2 section of the License
  * file that accompanied this code.
  *
  * Modifications:
  * If applicable, add the following below the License Header, with the fields
  * enclosed by brackets [] replaced by your own identifying information:
  * "Portions Copyright [year] [name of copyright owner]"
  *
  * Contributor(s):
  * If you wish your version of this file to be governed by only the CDDL or
  * only the GPL Version 2, indicate your decision by adding "[Contributor]
  * elects to include this software in this distribution under the [CDDL or GPL
  * Version 2] license."  If you don't indicate a single choice of license, a
  * recipient has the option to distribute your version of this file under
  * either the CDDL, the GPL Version 2 or to extend the choice of license to
  * its licensees as provided above.  However, if you add GPL Version 2 code
  * and therefore, elected the GPL Version 2 license, then the option applies
  * only if the new code is made subject to such option by the copyright
  * holder.
  */
 
 package javax.servlet;
 
 import java.util.*;

Interface through which a Servlet may be further configured.

Since:
Servlet 3.0
 
 public interface ServletRegistration extends Registration {

    
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.

If this method is called multiple times, each successive call adds to the effects of the former.

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
java.lang.IllegalStateException if the ServletContext from which this ServletRegistration was obtained has already been initialized
 
     public Set<StringaddMapping(String... urlPatterns);

    
Gets the currently available mappings of the Servlet represented by this ServletRegistration.

If permitted, any changes to the returned Collection must not affect this ServletRegistration.

Returns:
a (possibly empty) Collection of the currently available mappings of the Servlet represented by this ServletRegistration
 
     public Collection<StringgetMappings();

    
Gets the name of the runAs role of the Servlet represented by this ServletRegistration.

Returns:
the name of the runAs role, or null if the Servlet is configured to run as its caller
 
     public String getRunAsRole();

    
Interface through which a Servlet registered via one of the addServlet methods on ServletContext may be further configured.
    interface Dynamic extends ServletRegistrationRegistration.Dynamic {

        
Sets the loadOnStartup priority on the Servlet represented by this dynamic ServletRegistration.

A loadOnStartup value of greater than or equal to zero indicates to the container the initialization priority of the Servlet. In this case, the container must instantiate and initialize the Servlet during the initialization phase of the ServletContext, that is, after it has invoked all of the ServletContextListener objects configured for the ServletContext at their ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent) method.

If loadOnStartup is a negative integer, the container is free to instantiate and initialize the Servlet lazily.

The default value for loadOnStartup is -1.

A call to this method overrides any previous setting.

Parameters:
loadOnStartup the initialization priority of the Servlet
Throws:
java.lang.IllegalStateException if the ServletContext from which this ServletRegistration was obtained has already been initialized
        public void setLoadOnStartup(int loadOnStartup);

        
Sets the ServletSecurityElement to be applied to the mappings defined for this ServletRegistration.

This method applies to all mappings added to this ServletRegistration up until the point that the ServletContext from which it was obtained has been initialized.

If a URL pattern of this ServletRegistration is an exact target of a security-constraint that was established via the portable deployment descriptor, then this method does not change the security-constraint for that pattern, and the pattern will be included in the return value.

If a URL pattern of this ServletRegistration is an exact target of a security constraint that was established via the javax.servlet.annotation.ServletSecurity annotation or a previous call to this method, then this method replaces the security constraint for that pattern.

If a URL pattern of this ServletRegistration is neither the exact target of a security constraint that was established via the javax.servlet.annotation.ServletSecurity annotation or a previous call to this method, nor the exact target of a security-constraint in the portable deployment descriptor, then this method establishes the security constraint for that pattern from the argument ServletSecurityElement.

Parameters:
constraint the ServletSecurityElement to be applied to the patterns mapped to this ServletRegistration
Returns:
the (possibly empty) Set of URL patterns that were already the exact target of a security-constraint that was established via the portable deployment descriptor. This method has no effect on the patterns included in the returned set
Throws:
java.lang.IllegalArgumentException if constraint is null
java.lang.IllegalStateException if the ServletContext from which this ServletRegistration was obtained has already been initialized
        public Set<StringsetServletSecurity(ServletSecurityElement constraint);

        
Sets the MultipartConfigElement to be applied to the mappings defined for this ServletRegistration. If this method is called multiple times, each successive call overrides the effects of the former.

Parameters:
multipartConfig the MultipartConfigElement to be applied to the patterns mapped to the registration
Throws:
java.lang.IllegalArgumentException if multipartConfig is null
java.lang.IllegalStateException if the ServletContext from which this ServletRegistration was obtained has already been initialized
        public void setMultipartConfig(
            MultipartConfigElement multipartConfig);

        
Sets the name of the runAs role for this ServletRegistration.

Parameters:
roleName the name of the runAs role
Throws:
java.lang.IllegalArgumentException if roleName is null
java.lang.IllegalStateException if the ServletContext from which this ServletRegistration was obtained has already been initialized
        public void setRunAsRole(String roleName);
    }
New to GrepCode? Check out our FAQ X