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

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
Copyright 2003-2004 The Apache Software Foundation Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. 
16
 
17
 
18
 //
19
 // This source code implements specifications defined by the Java
20
 // Community Process. In order to remain compliant with the specification
21
 // DO NOT add / change / or delete method signatures!
22
 //
23
 
24
 package javax.servlet;
25
 
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.

Version:
$Rev: 46019 $ $Date: 2004-09-14 04:56:06 -0500 (Tue, 14 Sep 2004) $
51
 
52
 public abstract class GenericServlet implements Servlet, ServletConfig, java.io.Serializable {
53
     private transient ServletConfig config;

    
Does nothing. All of the servlet initialization is done by one of the init methods. 
58
 
59
     public GenericServlet() {
60
     }

    
Called by the servlet container to indicate to a servlet that the servlet is being taken out of service. See Servlet.destroy(). 
65
 
66
     public void destroy() {
67
     }

    
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
83
 
84
     public String getInitParameter(String name) {
85
         return getServletConfig().getInitParameter(name);
86
     }

    
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
103
        return getServletConfig().getInitParameterNames();
104
    }

    
Returns this servlet's ServletConfig object.

Returns:
ServletConfig the ServletConfig object that initialized this servlet
112
    public ServletConfig getServletConfig() {
113
        return ;
114
    }


    
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
128
    public ServletContext getServletContext() {
129
        return getServletConfig().getServletContext();
130
    }


    
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
144
    public String getServletInfo() {
145
        return "";
146
    }


    
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 later 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
166
    public void init(ServletConfig config) throws ServletException {
167
        this. = config;
168
        this.init();
169
    }


    
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
185
    public void init() throws ServletException {
186
    }

    
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
195
    public void log(String msg) {
196
        getServletContext().log(getServletName() + ": " + msg);
197
    }

    
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
211
    public void log(String message, Throwable t) {
212
        getServletContext().log(getServletName() + ": " + message, t);
213
    }

    
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
234
    public abstract void service(ServletRequest req, ServletResponse res) throws ServletException, IOException;

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

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