GrepCode: javax.servlet.ServletConfig (.java) - Interface

Maven-Central
/
javax.servlet / servlet-api
/
3.0-alpha-1

3.0-alpha-1
2.5
2.4
2.3
2.2
/
javax.servlet.ServletConfig
Find Usages
Diff
Raw
Download
HTML Widget
Stack Overflow Questions
1
  /*
2
   * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3
   *
4
   * Copyright 1997-2008 Sun Microsystems, Inc. All rights reserved.
5
   *
6
   * The contents of this file are subject to the terms of either the GNU
7
   * General Public License Version 2 only ("GPL") or the Common Development
8
   * and Distribution License("CDDL") (collectively, the "License").  You
9
   * may not use this file except in compliance with the License. You can obtain
10
  * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11
  * or glassfish/bootstrap/legal/LICENSE.txt.  See the License for the specific
12
  * language governing permissions and limitations under the License.
13
  *
14
  * When distributing the software, include this License Header Notice in each
15
  * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16
  * Sun designates this particular file as subject to the "Classpath" exception
17
  * as provided by Sun in the GPL Version 2 section of the License file that
18
  * accompanied this code.  If applicable, add the following below the License
19
  * Header, with the fields enclosed by brackets [] replaced by your own
20
  * identifying information: "Portions Copyrighted [year]
21
  * [name of copyright owner]"
22
  *
23
  * Contributor(s):
24
  *
25
  * If you wish your version of this file to be governed by only the CDDL or
26
  * only the GPL Version 2, indicate your decision by adding "[Contributor]
27
  * elects to include this software in this distribution under the [CDDL or GPL
28
  * Version 2] license."  If you don't indicate a single choice of license, a
29
  * recipient has the option to distribute your version of this file under
30
  * either the CDDL, the GPL Version 2 or to extend the choice of license to
31
  * its licensees as provided above.  However, if you add GPL Version 2 code
32
  * and therefore, elected the GPL Version 2 license, then the option applies
33
  * only if the new code is made subject to such option by the copyright
34
  * holder.
35
  *
36
  *
37
  * This file incorporates work covered by the following copyright and
38
  * permission notice:
39
  *
40
  * Copyright 2004 The Apache Software Foundation
41
  *
42
  * Licensed under the Apache License, Version 2.0 (the "License");
43
  * you may not use this file except in compliance with the License.
44
  * You may obtain a copy of the License at
45
  *
46
  *     http://www.apache.org/licenses/LICENSE-2.0
47
  *
48
  * Unless required by applicable law or agreed to in writing, software
49
  * distributed under the License is distributed on an "AS IS" BASIS,
50
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
51
  * See the License for the specific language governing permissions and
52
  * limitations under the License.
53
  */
54
 
55
 
56
 
57
 package javax.servlet;
58
 
59
 import java.util.Enumeration;



 
 A servlet configuration object used by a servlet container
 to pass information to a servlet during initialization. 

68
 
69
  
70
 public interface ServletConfig {
    

    
 Returns the name of this servlet instance.
 The name may be provided via server administration, assigned in the 
 web application deployment descriptor, or for an unregistered (and thus
 unnamed) servlet instance it will be the servlet's class name.

 
 Returns:the name of the servlet instance
83
 
84
 
85
     public String getServletName();

    
 Returns a reference to the ServletContext in which the caller
 is executing.


 
 Returns:a ServletContext object, used
   by the caller to interact with its servlet 
                  container See also:ServletContext
98
 
99
 
100
    public ServletContext getServletContext();
    
    
 Returns a String containing the value of the 
 named initialization parameter, or null if 
 the parameter does not exist.

 
 Parameters:name a String specifying the name
   of the initialization parameter Returns:a String containing the value 
   of the initialization parameter
113
114
115
    public String getInitParameter(String name);


    
 Returns the names of the servlet's initialization parameters
 as an Enumeration of String objects, 
 or an empty Enumeration if the servlet has
 no initialization parameters.

 
 Returns:an Enumeration of String 
   objects containing the names of the servlet's 
   initialization parameters
130
131
132
    public Enumeration getInitParameterNames();
133
134
135
}