1
2
3 /*
4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
5 *
6 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
7 *
8 * Portions Copyright Apache Software Foundation.
9 *
10 * The contents of this file are subject to the terms of either the GNU
11 * General Public License Version 2 only ("GPL") or the Common Development
12 * and Distribution License("CDDL") (collectively, the "License"). You
13 * may not use this file except in compliance with the License. You can obtain
14 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
15 * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
16 * language governing permissions and limitations under the License.
17 *
18 * When distributing the software, include this License Header Notice in each
19 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
20 * Sun designates this particular file as subject to the "Classpath" exception
21 * as provided by Sun in the GPL Version 2 section of the License file that
22 * accompanied this code. If applicable, add the following below the License
23 * Header, with the fields enclosed by brackets [] replaced by your own
24 * identifying information: "Portions Copyrighted [year]
25 * [name of copyright owner]"
26 *
27 * Contributor(s):
28 *
29 * If you wish your version of this file to be governed by only the CDDL or
30 * only the GPL Version 2, indicate your decision by adding "[Contributor]
31 * elects to include this software in this distribution under the [CDDL or GPL
32 * Version 2] license." If you don't indicate a single choice of license, a
33 * recipient has the option to distribute your version of this file under
34 * either the CDDL, the GPL Version 2 or to extend the choice of license to
35 * its licensees as provided above. However, if you add GPL Version 2 code
36 * and therefore, elected the GPL Version 2 license, then the option applies
37 * only if the new code is made subject to such option by the copyright
38 * holder.
39 */
40
41 package javax.servlet;
42
43 import java.util.Enumeration;
44
45
46
47 /**
48 *
49 * A servlet configuration object used by a servlet container
50 * to pass information to a servlet during initialization.
51 *
52 */
53
54 public interface ServletConfig {
55
56
57 /**
58 * Returns the name of this servlet instance.
59 * The name may be provided via server administration, assigned in the
60 * web application deployment descriptor, or for an unregistered (and thus
61 * unnamed) servlet instance it will be the servlet's class name.
62 *
63 * @return the name of the servlet instance
64 *
65 *
66 *
67 */
68
69 public String getServletName();
70
71 /**
72 * Returns a reference to the {@link ServletContext} in which the caller
73 * is executing.
74 *
75 *
76 * @return a {@link ServletContext} object, used
77 * by the caller to interact with its servlet
78 * container
79 *
80 * @see ServletContext
81 *
82 */
83
84 public ServletContext getServletContext();
85
86 /**
87 * Returns a <code>String</code> containing the value of the
88 * named initialization parameter, or <code>null</code> if
89 * the parameter does not exist.
90 *
91 * @param name a <code>String</code> specifying the name
92 * of the initialization parameter
93 *
94 * @return a <code>String</code> containing the value
95 * of the initialization parameter
96 *
97 */
98
99 public String getInitParameter(String name);
100
101
102 /**
103 * Returns the names of the servlet's initialization parameters
104 * as an <code>Enumeration</code> of <code>String</code> objects,
105 * or an empty <code>Enumeration</code> if the servlet has
106 * no initialization parameters.
107 *
108 * @return an <code>Enumeration</code> of <code>String</code>
109 * objects containing the names of the servlet's
110 * initialization parameters
111 *
112 *
113 *
114 */
115
116 public Enumeration getInitParameterNames();
117
118
119 }
Save This Page