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

Maven-Central
/
javax.servlet / servlet-api
/
2.3

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
   * The Apache Software License, Version 1.1
3
   *
4
   * Copyright (c) 1999 The Apache Software Foundation.  All rights 
5
   * reserved.
6
   *
7
   * Redistribution and use in source and binary forms, with or without
8
   * modification, are permitted provided that the following conditions
9
   * are met:
10
  *
11
  * 1. Redistributions of source code must retain the above copyright
12
  *    notice, this list of conditions and the following disclaimer. 
13
  *
14
  * 2. Redistributions in binary form must reproduce the above copyright
15
  *    notice, this list of conditions and the following disclaimer in
16
  *    the documentation and/or other materials provided with the
17
  *    distribution.
18
  *
19
  * 3. The end-user documentation included with the redistribution, if
20
  *    any, must include the following acknowlegement:  
21
  *       "This product includes software developed by the 
22
  *        Apache Software Foundation (http://www.apache.org/)."
23
  *    Alternately, this acknowlegement may appear in the software itself,
24
  *    if and wherever such third-party acknowlegements normally appear.
25
  *
26
  * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
27
  *    Foundation" must not be used to endorse or promote products derived
28
  *    from this software without prior written permission. For written 
29
  *    permission, please contact apache@apache.org.
30
  *
31
  * 5. Products derived from this software may not be called "Apache"
32
  *    nor may "Apache" appear in their names without prior written
33
  *    permission of the Apache Group.
34
  *
35
  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
36
  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
37
  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
38
  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
39
  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40
  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
41
  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
42
  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
43
  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
44
  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
45
  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
46
  * SUCH DAMAGE.
47
  * ====================================================================
48
  *
49
  * This software consists of voluntary contributions made by many
50
  * individuals on behalf of the Apache Software Foundation.  For more
51
  * information on the Apache Software Foundation, please see
52
  * <http://www.apache.org/>.
53
  *
54
  * ====================================================================
55
  *
56
  * This source code implements specifications defined by the Java
57
  * Community Process. In order to remain compliant with the specification
58
  * DO NOT add / change / or delete method signatures!
59
  */
60
 
61
 package javax.servlet;
62
 
63
 import java.util.Enumeration;



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

 The configuration information contains initialization parameters,
 which are a set of name/value pairs, and a ServletContext object,
 which gives the servlet information about the server.

 
 Author(s):Various Version:$Version$ See also:ServletContext
81
 
82
  
83
 public interface ServletConfig {




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


 
 Returns:a ServletContext object, used
   by the servlet to interact with its servlet 
                  container See also:ServletContext
99
 
100
101
    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
118
119
120
    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
136
137
138
    public Enumeration getInitParameterNames();
    

    
 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
151
152
153
    public String getServletName();
154
155
}