com.tangosol.coherence.servlet.api23

Class JspServlet

java.lang.Object

javax.servlet.GenericServlet

com.tangosol.coherence.servlet.api23.JspServlet

All Implemented Interfaces:

Serializable, javax.servlet.jsp.HttpJspPage, javax.servlet.jsp.JspPage, javax.servlet.Servlet, javax.servlet.ServletConfig

public class JspServlet
extends javax.servlet.GenericServlet
implements javax.servlet.Servlet, javax.servlet.jsp.HttpJspPage

An implementation of the Servlet interface that provides for clustered ServletContext and HttpSession objects.

Version:

Coherence 3.4.1

Author:

jh 2008.10.15

Constructor Summary

Constructors

Constructor and Description
JspServlet() Public default constructor; required by spec.

Method Summary

Modifier and Type	Method and Description
void	_jspInit() This method is also invoked when the JspPage is initialized.
void	_jspService(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) This method corresponds to the body of the JSP page.
void	destroy() Called by the servlet container to indicate to a servlet that the servlet is being taken out of service.
protected String	getDescription() Returns a string representation of this object's attributes.
javax.servlet.ServletConfig	getServletConfig() Returns a ServletConfig object, which contains initialization and startup parameters for this servlet.
javax.servlet.ServletContext	getServletContext() Returns a reference to the ServletContext in which this Servlet is running.
String	getServletInfo() Returns information about the servlet, such as author, version, and copyright.
protected SessionHelper	getSessionHelper() Get the SessionHelper.
void	init(javax.servlet.ServletConfig cfg) Called by the servlet container to indicate to a servlet that the servlet is being placed into service.
void	jspDestroy() This method is invoked when the JspPage is about to be destroyed.
void	jspInit() This method is invoked when the JspPage is initialized.
void	service(javax.servlet.ServletRequest req, javax.servlet.ServletResponse res) Called by the servlet container to allow the servlet to respond to a request.
String	toString() Returns a string representation of the object.

Methods inherited from class javax.servlet.GenericServlet

getInitParameter, getInitParameterNames, getServletName, init, log, log

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

JspServlet

public JspServlet()

Public default constructor; required by spec.

Method Detail

init

public final void init(javax.servlet.ServletConfig cfg)
                throws javax.servlet.ServletException

Called by the servlet container to indicate to a servlet that the servlet is being placed into service.

The servlet container calls the init method exactly once after instantiating the servlet. The init method must complete successfully before the servlet can receive any requests.

The servlet container cannot place the servlet into service if the init method

1. Throws a ServletException
2. Does not return within a time period defined by the Web server

Specified by:

init in interface javax.servlet.Servlet

Overrides:

init in class javax.servlet.GenericServlet

Parameters:

cfg - a ServletConfig object containing the servlet's configuration and initialization parameters

Throws:

javax.servlet.ServletException - if an exception has occurred that interferes with the servlet's normal operation

getServletConfig

public final javax.servlet.ServletConfig getServletConfig()

Returns a ServletConfig object, which contains initialization and startup parameters for this servlet. The ServletConfig object returned is the one passed to the init method.

Implementations of this interface are responsible for storing the ServletConfig object so that this method can return it.

Specified by:

getServletConfig in interface javax.servlet.Servlet

Overrides:

getServletConfig in class javax.servlet.GenericServlet

Returns:

the ServletConfig object that initializes this servlet

See Also:

init(javax.servlet.ServletConfig)

service

public final void service(javax.servlet.ServletRequest req,
                          javax.servlet.ServletResponse res)
                   throws javax.servlet.ServletException,
                          IOException

Called by the servlet container to allow the servlet to respond to a request.

This method is only called after the servlet's init() method has completed successfully.

Servlets typically run inside multithreaded servlet containers that can handle multiple requests concurrently. Developers must be aware to synchronize access to any shared resources such as files, network connections, and as well as the servlet's class and instance variables. More information on multithreaded programming in Java is available in the Java tutorial on multi-threaded programming.

Specified by:

service in interface javax.servlet.Servlet

Specified by:

service in class javax.servlet.GenericServlet

Parameters:

req - the ServletRequest object that contains the client's request

res - the ServletResponse object that contains the servlet's response

Throws:

javax.servlet.ServletException - if an exception occurs that interferes with the servlet's normal operation

IOException - if an input or output exception occurs

getServletInfo

public String getServletInfo()

Returns information about the servlet, such as author, version, and copyright.

The string that this method returns should be plain text and not markup of any kind (such as HTML, XML, etc.).

Specified by:

getServletInfo in interface javax.servlet.Servlet

Overrides:

getServletInfo in class javax.servlet.GenericServlet

Returns:

a String containing servlet information

destroy

public final void destroy()

Called by the servlet container to indicate to a servlet that the servlet is being taken out of service. This method is only called once all threads within the servlet's service method have exited or after a timeout period has passed. After the servlet container calls this method, it will not call the service method again on this servlet.

This method gives the servlet an opportunity to clean up any resources that are being held (for example, memory, file handles, threads) and make sure that any persistent state is synchronized with the servlet's current state in memory.

Specified by:

destroy in interface javax.servlet.Servlet

Overrides:

destroy in class javax.servlet.GenericServlet

jspInit

public void jspInit()

This method is invoked when the JspPage is initialized. At this point, getServletConfig() will return the desired value.

Specified by:

jspInit in interface javax.servlet.jsp.JspPage

_jspInit

public void _jspInit()

This method is also invoked when the JspPage is initialized. At this point, getServletConfig() will return the desired value. JBoss TagLibs will not be properly initialized if this method is not executed.

jspDestroy

public void jspDestroy()

This method is invoked when the JspPage is about to be destroyed.

Specified by:

jspDestroy in interface javax.servlet.jsp.JspPage

_jspService

public void _jspService(javax.servlet.http.HttpServletRequest req,
                        javax.servlet.http.HttpServletResponse res)
                 throws javax.servlet.ServletException,
                        IOException

This method corresponds to the body of the JSP page. This method is defined automatically by the JSP processor and should NEVER BE DEFINED BY THE JSP AUTHOR.

Specified by:

_jspService in interface javax.servlet.jsp.HttpJspPage

Parameters:

req - the HttpServletRequest object that contains the client's request

res - the HttpServletResponse object that contains the JSP's response

Throws:

javax.servlet.ServletException

IOException

toString

public String toString()

Returns a string representation of the object.

Overrides:

toString in class Object

Returns:

a string representation of the object

getDescription

protected String getDescription()

Returns a string representation of this object's attributes.

Returns:

a string representation of this object's attributes

getSessionHelper

protected SessionHelper getSessionHelper()

Get the SessionHelper.

Returns:

the SessionHelper for this app

getServletContext

public javax.servlet.ServletContext getServletContext()

Returns a reference to the ServletContext in which this Servlet is running.

Specified by:

getServletContext in interface javax.servlet.ServletConfig

Overrides:

getServletContext in class javax.servlet.GenericServlet

Returns:

the ServletContext