home *** CD-ROM | disk | FTP | other *** search
/ PC World 2002 May / PCWorld_2002-05_cd.bin / Komunik / sambar / sambar51p.exe / lib / javaeng.jar / javax / servlet / ServletConfig.java < prev    next >
Encoding:
Java Source  |  2001-10-22  |  5.2 KB  |  156 lines

  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;
  64.  
  65.  
  66.  
  67. /**
  68.  * 
  69.  * A servlet configuration object used by a servlet container
  70.  * used to pass information to a servlet during initialization. 
  71.  *
  72.  * <p>The configuration information contains initialization parameters,
  73.  * which are a set of name/value pairs, and a {@link ServletContext} object,
  74.  * which gives the servlet information about the server.
  75.  *
  76.  * @author     Various
  77.  * @version     $Version$
  78.  *
  79.  * @see     ServletContext
  80.  *
  81.  */
  82.  
  83. public interface ServletConfig {
  84.  
  85.  
  86.  
  87.  
  88.     /**
  89.      * Returns a reference to the {@link ServletContext} in which the servlet
  90.      * is executing.
  91.      *
  92.      *
  93.      * @return        a {@link ServletContext} object, used
  94.      *            by the servlet to interact with its servlet 
  95.      *                  container
  96.      * 
  97.      * @see        ServletContext
  98.      *
  99.      */
  100.  
  101.     public ServletContext getServletContext();
  102.     
  103.     
  104.     
  105.     
  106.  
  107.     /**
  108.      * Returns a <code>String</code> containing the value of the 
  109.      * named initialization parameter, or <code>null</code> if 
  110.      * the parameter does not exist.
  111.      *
  112.      * @param name    a <code>String</code> specifying the name
  113.      *            of the initialization parameter
  114.      *
  115.      * @return        a <code>String</code> containing the value 
  116.      *            of the initialization parameter
  117.      *
  118.      */
  119.  
  120.     public String getInitParameter(String name);
  121.     
  122.     
  123.  
  124.     /**
  125.      * Returns the names of the servlet's initialization parameters
  126.      * as an <code>Enumeration</code> of <code>String</code> objects, 
  127.      * or an empty <code>Enumeration</code> if the servlet has
  128.      * no initialization parameters.
  129.      *
  130.      * @return        an <code>Enumeration</code> of <code>String</code> 
  131.      *            objects containing the names of the servlet's 
  132.      *            initialization parameters
  133.      *
  134.      *
  135.      *
  136.      */
  137.  
  138.     public Enumeration getInitParameterNames();
  139.     
  140.  
  141.     /**
  142.      * Returns the name of this servlet instance.
  143.      * The name may be provided via server administration, assigned in the 
  144.      * web application deployment descriptor, or for an unregistered (and thus
  145.      * unnamed) servlet instance it will be the servlet's class name.
  146.      *
  147.      * @return        the name of the servlet instance
  148.      *
  149.      *
  150.      *
  151.      */
  152.  
  153.     public String getServletName();
  154.  
  155. }
  156.