import java.util.Enumeration;
/**
- *
* Defines a generic, protocol-independent servlet. To write an HTTP servlet for
* use on the Web, extend {@link javax.servlet.http.HttpServlet} instead.
- *
* <p>
* <code>GenericServlet</code> implements the <code>Servlet</code> and
* <code>ServletConfig</code> interfaces. <code>GenericServlet</code> may be
* directly extended by a servlet, although it's more common to extend a
* protocol-specific subclass such as <code>HttpServlet</code>.
- *
* <p>
* <code>GenericServlet</code> makes writing servlets easier. It provides simple
* versions of the lifecycle methods <code>init</code> and <code>destroy</code>
* and of the methods in the <code>ServletConfig</code> interface.
* <code>GenericServlet</code> also implements the <code>log</code> method,
* declared in the <code>ServletContext</code> interface.
- *
* <p>
* To write a generic servlet, you need only override the abstract
* <code>service</code> method.
* Returns a <code>String</code> containing the value of the named
* initialization parameter, or <code>null</code> if the parameter does not
* exist. See {@link ServletConfig#getInitParameter}.
- *
* <p>
* This method is supplied for convenience. It gets the value of the named
* parameter from the servlet's <code>ServletConfig</code> object.
* @param name
* a <code>String</code> specifying the name of the
* initialization parameter
- *
* @return String a <code>String</code> containing the value of the
* initialization parameter
*/
* <code>Enumeration</code> of <code>String</code> objects, or an empty
* <code>Enumeration</code> if the servlet has no initialization parameters.
* See {@link ServletConfig#getInitParameterNames}.
- *
* <p>
* This method is supplied for convenience. It gets the parameter names from
* the servlet's <code>ServletConfig</code> object.
/**
* Returns a reference to the {@link ServletContext} in which this servlet
* is running. See {@link ServletConfig#getServletContext}.
- *
* <p>
* This method is supplied for convenience. It gets the context from the
* servlet's <code>ServletConfig</code> object.
*
- *
* @return ServletContext the <code>ServletContext</code> object passed to
* this servlet by the <code>init</code> method
*/
/**
* Called by the servlet container to indicate to a servlet that the servlet
* is being placed into service. See {@link Servlet#init}.
- *
* <p>
* This implementation stores the {@link ServletConfig} object it receives
* from the servlet container for later use. When overriding this form of
* @param config
* the <code>ServletConfig</code> object that contains
* configuration information for this servlet
- *
* @exception ServletException
* if an exception occurs that interrupts the servlet's
* normal operation
- *
* @see UnavailableException
*/
public void init(ServletConfig config) throws ServletException {
/**
* A convenience method which can be overridden so that there's no need to
* call <code>super.init(config)</code>.
- *
* <p>
* Instead of overriding {@link #init(ServletConfig)}, simply override this
* method and it will be called by
*
* @param message
* a <code>String</code> that describes the error or exception
- *
- * @param tthe
- * <code>java.lang.Throwable</code> error or exception
+ * @param t
+ * the <code>java.lang.Throwable</code> error or exception
*/
public void log(String message, Throwable t) {
getServletContext().log(getServletName() + ": " + message, t);
/**
* Called by the servlet container to allow the servlet to respond to a
* request. See {@link Servlet#service}.
- *
* <p>
* This method is declared abstract so subclasses, such as
* <code>HttpServlet</code>, must override it.
* @param req
* the <code>ServletRequest</code> object that contains the
* client's request
- *
* @param res
* the <code>ServletResponse</code> object that will contain the
* servlet's response
- *
* @exception ServletException
* if an exception occurs that interferes with the servlet's
* normal operation occurred
- *
* @exception IOException
* if an input or output exception occurs
*/
* The default behavior of this method is to return getServletContext() on
* the wrapped request object.
*
- * @return
* @since Servlet 3.0
*/
public ServletContext getServletContext() {
* The default behavior of this method is to return startAsync() on the
* wrapped request object.
*
- * @return
* @throws java.lang.IllegalStateException
* @since Servlet 3.0
*/
*
* @param servletRequest
* @param servletResponse
- * @return
* @throws java.lang.IllegalStateException
* @since Servlet 3.0
*/
* The default behavior of this method is to return isAsyncStarted() on the
* wrapped request object.
*
- * @return
* @since Servlet 3.0
*/
public boolean isAsyncStarted() {
* The default behavior of this method is to return isAsyncSupported() on
* the wrapped request object.
*
- * @return
* @since Servlet 3.0
*/
public boolean isAsyncSupported() {
* The default behavior of this method is to return getAsyncContext() on the
* wrapped request object.
*
- * @return
* @since Servlet 3.0
*/
public AsyncContext getAsyncContext() {
projects / tomcat7.0 / commitdiff