https://projects.eclipse.org/projects/ee4j.servlet: Provides, via submodules, a base configuration for JBoss project builds, as well as a derived configuration supporting multi-release JARs (JBoss by Red Hat)
  • Ed Burns
  • Shing Wai Chan 
/*
 * Copyright (c) 2017, 2018 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 javax.servlet;

import java.util.*;


Interface through which a Servlet may be further configured. 
Since:Servlet 3.0
/**
 * Interface through which a {@link 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.

 The returned set is not backed by the ServletRegistration object, so changes in the returned set are not reflected in the ServletRegistration object, and vice-versa. 


Params:
  • urlPatterns – the URL patterns of the servlet mapping
Throws:
Returns:the (possibly empty) Set of URL patterns that are already mapped to a different Servlet
/**
     * Adds a servlet mapping with the given URL patterns for the Servlet represented by this ServletRegistration.
     *
     * <p>
     * If any of the specified URL patterns are already mapped to a different Servlet, no updates will be performed.
     *
     * <p>
     * If this method is called multiple times, each successive call adds to the effects of the former.
     *
     * <p>
     * The returned set is not backed by the {@code ServletRegistration} object, so changes in the returned set are not
     * reflected in the {@code ServletRegistration} object, and vice-versa.
     * </p>
     *
     * @param urlPatterns the URL patterns of the servlet mapping
     *
     * @return the (possibly empty) Set of URL patterns that are already mapped to a different Servlet
     *
     * @throws IllegalArgumentException if <tt>urlPatterns</tt> is null or empty
     * @throws IllegalStateException    if the ServletContext from which this ServletRegistration was obtained has
     *                                  already been initialized
     */
    public Set<String> addMapping(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
/**
     * Gets the currently available mappings of the Servlet represented by this <code>ServletRegistration</code>.
     *
     * <p>
     * If permitted, any changes to the returned <code>Collection</code> must not affect this
     * <code>ServletRegistration</code>.
     *
     * @return a (possibly empty) <code>Collection</code> of the currently available mappings of the Servlet represented
     *         by this <code>ServletRegistration</code>
     */
    public Collection<String> getMappings();

    
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
/**
     * Gets the name of the runAs role of the Servlet represented by this <code>ServletRegistration</code>.
     * 
     * @return 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 through which a {@link Servlet} registered via one of the <tt>addServlet</tt> methods on
     * {@link ServletContext} may be further configured.
     */
    interface Dynamic extends ServletRegistration, Registration.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 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.

Params:
  • loadOnStartup – the initialization priority of the Servlet
Throws:
  • IllegalStateException – if the ServletContext from which this ServletRegistration was obtained has
                              already been initialized
/**
         * Sets the <code>loadOnStartup</code> priority on the Servlet represented by this dynamic ServletRegistration.
         *
         * <p>
         * A <tt>loadOnStartup</tt> 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 {@link ServletContextListener#contextInitialized} method.
         *
         * <p>
         * If <tt>loadOnStartup</tt> is a negative integer, the container is free to instantiate and initialize the
         * Servlet lazily.
         *
         * <p>
         * The default value for <tt>loadOnStartup</tt> is <code>-1</code>.
         *
         * <p>
         * A call to this method overrides any previous setting.
         *
         * @param loadOnStartup the initialization priority of the Servlet
         *
         * @throws 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 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 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.

 The returned set is not backed by the Dynamic object, so changes in the returned set are not reflected in the Dynamic object, and vice-versa. 


Params:
Throws:
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
/**
         * Sets the {@link ServletSecurityElement} to be applied to the mappings defined for this
         * <code>ServletRegistration</code>.
         *
         * <p>
         * This method applies to all mappings added to this <code>ServletRegistration</code> up until the point that
         * the <code>ServletContext</code> from which it was obtained has been initialized.
         * 
         * <p>
         * If a URL pattern of this ServletRegistration is an exact target of a <code>security-constraint</code> that
         * was established via the portable deployment descriptor, then this method does not change the
         * <code>security-constraint</code> for that pattern, and the pattern will be included in the return value.
         * 
         * <p>
         * If a URL pattern of this ServletRegistration is an exact target of a security constraint that was established
         * via the {@link javax.servlet.annotation.ServletSecurity} annotation or a previous call to this method, then
         * this method replaces the security constraint for that pattern.
         * 
         * <p>
         * If a URL pattern of this ServletRegistration is neither the exact target of a security constraint that was
         * established via the {@link javax.servlet.annotation.ServletSecurity} annotation or a previous call to this
         * method, nor the exact target of a <code>security-constraint</code> in the portable deployment descriptor,
         * then this method establishes the security constraint for that pattern from the argument
         * <code>ServletSecurityElement</code>.
         *
         * <p>
         * The returned set is not backed by the {@code Dynamic} object, so changes in the returned set are not
         * reflected in the {@code Dynamic} object, and vice-versa.
         * </p>
         * 
         * @param constraint the {@link ServletSecurityElement} to be applied to the patterns mapped to this
         *                   ServletRegistration
         * 
         * @return the (possibly empty) Set of URL patterns that were already the exact target of a
         *         <code>security-constraint</code> that was established via the portable deployment descriptor. This
         *         method has no effect on the patterns included in the returned set
         * 
         * @throws IllegalArgumentException if <tt>constraint</tt> is null
         * 
         * @throws IllegalStateException    if the {@link ServletContext} from which this
         *                                  <code>ServletRegistration</code> was obtained has already been initialized
         */
        public Set<String> setServletSecurity(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.

Params:
Throws:
/**
         * Sets the {@link MultipartConfigElement} to be applied to the mappings defined for this
         * <code>ServletRegistration</code>. If this method is called multiple times, each successive call overrides the
         * effects of the former.
         *
         * @param multipartConfig the {@link MultipartConfigElement} to be applied to the patterns mapped to the
         *                        registration
         *
         * @throws IllegalArgumentException if <tt>multipartConfig</tt> is null
         *
         * @throws IllegalStateException    if the {@link 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.

Params:
  • roleName – the name of the runAs role
Throws:
/**
         * Sets the name of the <code>runAs</code> role for this <code>ServletRegistration</code>.
         *
         * @param roleName the name of the <code>runAs</code> role
         *
         * @throws IllegalArgumentException if <tt>roleName</tt> is null
         *
         * @throws IllegalStateException    if the {@link ServletContext} from which this ServletRegistration was
         *                                  obtained has already been initialized
         */
        public void setRunAsRole(String roleName);

    }

}