Find Usages Diff Raw Download HTML Widget
Start line:  
End line:  

Snippet Preview

Snippet HTML Code

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
 
Defines a generic, protocol-independent servlet. To write an HTTP servlet for use on the Web, extend javax.servlet.http.HttpServlet instead.

GenericServlet implements the Servlet and ServletConfig interfaces. GenericServlet may be directly extended by a servlet, although it's more common to extend a protocol-specific subclass such as HttpServlet.

GenericServlet makes writing servlets easier. It provides simple versions of the lifecycle methods init and destroy and of the methods in the ServletConfig interface. GenericServlet also implements the log method, declared in the ServletContext interface.

To write a generic servlet, you need only override the abstract service method.

Author(s):
Various
Version:
$Version$
93
 
94
 
95
  
96
 public abstract class GenericServlet 
97
     implements Servlet, ServletConfig, java.io.Serializable
98
 {
99
 
100
    private transient ServletConfig config;
    

    
Does nothing. All of the servlet initialization is done by one of the init methods. 
110
    public GenericServlet() { }
    
    
    
   
Called by the servlet container to indicate to a servlet that the servlet is being taken out of service. See Servlet.destroy(). 
121
    public void destroy() {
122
	log("destroy");
123
    }
    
    
    
    
Returns a String containing the value of the named initialization parameter, or null if the parameter does not exist. See ServletConfig.getInitParameter(java.lang.String).

This method is supplied for convenience. It gets the value of the named parameter from the servlet's ServletConfig object.

Parameters:
name a String specifying the name of the initialization parameter
Returns:
String a String containing the value of the initalization parameter
142
 
144
    public String getInitParameter(String name) {
146
    }
    
    

   
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. See ServletConfig.getInitParameterNames().

This method is supplied for convenience. It gets the parameter names from the servlet's ServletConfig object.

Returns:
Enumeration an enumeration of String objects containing the names of the servlet's initialization parameters
169
    }   
    
     
 
     

    
Returns this servlet's ServletConfig object.

Returns:
ServletConfig the ServletConfig object that initialized this servlet
182
    
183
    public ServletConfig getServletConfig() {
184
	return ;
185
    }
    
    
 
    
    
Returns a reference to the ServletContext in which this servlet is running. See ServletConfig.getServletContext().

This method is supplied for convenience. It gets the context from the servlet's ServletConfig object.

Returns:
ServletContext the ServletContext object passed to this servlet by the init method
204
    public ServletContext getServletContext() {
206
    }



 

    
Returns information about the servlet, such as author, version, and copyright. By default, this method returns an empty string. Override this method to have it return a meaningful value. See Servlet.getServletInfo().

Returns:
String information about this servlet, by default an empty string
224
    
225
    public String getServletInfo() {
226
	return "";
227
    }




    
Called by the servlet container to indicate to a servlet that the servlet is being placed into service. See Servlet.init(javax.servlet.ServletConfig).

This implementation stores the ServletConfig object it receives from the servlet container for alter use. When overriding this form of the method, call super.init(config).

Parameters:
config the ServletConfig object that contains configutation information for this servlet
Throws:
ServletException if an exception occurs that interrupts the servlet's normal operation
See also:
UnavailableException
255
    public void init(ServletConfig config) throws ServletException {
256
	this. = config;
257
	log("init");
258
	this.init();
259
    }





    
A convenience method which can be overridden so that there's no need to call super.init(config).

Instead of overriding init(javax.servlet.ServletConfig), simply override this method and it will be called by GenericServlet.init(ServletConfig config). The ServletConfig object can still be retrieved via getServletConfig().

Throws:
ServletException if an exception occurs that interrupts the servlet's normal operation
281
    
282
    public void init() throws ServletException {
284
    }
    



    
Writes the specified message to a servlet log file, prepended by the servlet's name. See ServletContext.log(java.lang.String).

Parameters:
msg a String specifying the message to be written to the log file
298
     
299
    public void log(String msg) {
300
	getServletContext().log(getServletName() + ": "+ msg);
301
    }
   
   
   
   
    
Writes an explanatory message and a stack trace for a given Throwable exception to the servlet log file, prepended by the servlet's name. See ServletContext.log(java.lang.String,java.lang.Throwable).

Parameters:
message a String that describes the error or exception
t the java.lang.Throwable error or exception
321
   
322
    public void log(String message, Throwable t) {
323
	getServletContext().log(getServletName() + ": " + message, t);
324
    }
    
    
    
    
Called by the servlet container to allow the servlet to respond to a request. See Servlet.service(javax.servlet.ServletRequest,javax.servlet.ServletResponse).

This method is declared abstract so subclasses, such as HttpServlet, must override it.

Parameters:
req the ServletRequest object that contains the client's request
res the ServletResponse object that will contain the servlet's response
Throws:
ServletException if an exception occurs that interferes with the servlet's normal operation occurred
java.io.IOException if an input or output exception occurs
352
    public abstract void service(ServletRequest req, ServletResponse res)
353
	throws ServletException, IOException;
    


    
Returns the name of this servlet instance. See ServletConfig.getServletName().

Returns:
the name of this servlet instance
367
    public String getServletName() {
368
        return .getServletName();
369
    }
New to GrepCode? Check out our FAQ X