lib/servlet-api/javax/servlet/ServletRegistration.java

   1 /*
   2 * Licensed to the Apache Software Foundation (ASF) under one or more
   3 * contributor license agreements.  See the NOTICE file distributed with
   4 * this work for additional information regarding copyright ownership.
   5 * The ASF licenses this file to You under the Apache License, Version 2.0
   6 * (the "License"); you may not use this file except in compliance with
   7 * the License.  You may obtain a copy of the License at
   8 *
   9 *     http://www.apache.org/licenses/LICENSE-2.0
  10 *
  11 * Unless required by applicable law or agreed to in writing, software
  12 * distributed under the License is distributed on an "AS IS" BASIS,
  13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 * See the License for the specific language governing permissions and
  15 * limitations under the License.
  16 */
  17 package javax.servlet;
  18
  19 import java.util.Collection;
  20 import java.util.Set;
  21
  22 /**
  23  * TODO SERVLET3 - Add comments
  24  * @since Servlet 3.0
  25  */
  26 public interface ServletRegistration extends Registration {
  27
  28     /**
  29      *
  30      * @param urlPatterns
  31      * @return TODO
  32      * @throws IllegalArgumentException if urlPattern is null or empty
  33      * @throws IllegalStateException if the associated ServletContext has
  34      *                                  already been initialised
  35      */
  36     public Set<String> addMapping(String... urlPatterns);
  37
  38     public Collection<String> getMappings();
  39
  40     public String getRunAsRole();
  41
  42     public static interface Dynamic
  43     extends ServletRegistration, Registration.Dynamic {
  44         public void setLoadOnStartup(int loadOnStartup);
  45         public void setMultipartConfig(MultipartConfigElement multipartConfig);
  46         public void setRunAsRole(String roleName);
  47         public Set<String> setServletSecurity(ServletSecurityElement constraint);
  48     }
  49 }