Top Description Fields Constructors Methods
org.mortbay.servlet

public Class ProxyServlet

extends Object
implements Servlet
Class Inheritance
All Implemented Interfaces
javax.servlet.Servlet
Imports
java.io.IOException, .InputStream, .OutputStream, java.net.HttpURLConnection, .InetSocketAddress, .Socket, .URL, .URLConnection, java.util.Enumeration, .HashSet, javax.servlet.Servlet, .ServletConfig, .ServletContext, .ServletException, .ServletRequest, .ServletResponse, javax.servlet.http.HttpServletRequest, .HttpServletResponse, org.mortbay.util.IO
EXPERIMENTAL Proxy servlet.
Author
gregw

Field Summary

Modifier and TypeField and Description
protected HashSet<E>
_DontProxyHeaders

private int
_tunnelTimeoutMs

private ServletConfig
config

private ServletContext
context

Constructor Summary

AccessConstructor and Description
public
ProxyServlet()

Method Summary

Modifier and TypeMethod and Description
public void
destroy()

Implements javax.servlet.Servlet.destroy.

Called by the servlet container to indicate to a servlet that the servlet is being taken out of service.
public ServletConfig
getServletConfig()

Implements javax.servlet.Servlet.getServletConfig.

Returns a ServletConfig object, which contains initialization and startup parameters for this servlet.
public String
getServletInfo()

Implements javax.servlet.Servlet.getServletInfo.

Returns information about the servlet, such as author, version, and copyright.
public void
handleConnect(HttpServletRequest request, HttpServletResponse response)

public void
init(ServletConfig
a ServletConfig object containing the servlet's configuration and initialization parameters
config)

Implements javax.servlet.Servlet.init.

Called by the servlet container to indicate to a servlet that the servlet is being placed into service.
public void
service(ServletRequest
the ServletRequest object that contains the client's request
req, ServletResponse
the ServletResponse object that contains the servlet's response
res)

Implements javax.servlet.Servlet.service.

Called by the servlet container to allow the servlet to respond to a request.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

_DontProxyHeadersback to summary
protected HashSet<E> _DontProxyHeaders
_tunnelTimeoutMsback to summary
private int _tunnelTimeoutMs
configback to summary
private ServletConfig config
contextback to summary
private ServletContext context

Constructor Detail

ProxyServletback to summary
public ProxyServlet()

Method Detail

destroyback to summary
public void destroy()

Implements javax.servlet.Servlet.destroy.

Doc from javax.servlet.Servlet.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.

getServletConfigback to summary
public ServletConfig getServletConfig()

Implements javax.servlet.Servlet.getServletConfig.

Doc from javax.servlet.Servlet.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. The GenericServlet class, which implements this interface, already does this.

Returns:ServletConfig

the ServletConfig object that initializes this servlet

getServletInfoback to summary
public String getServletInfo()

Implements javax.servlet.Servlet.getServletInfo.

Doc from javax.servlet.Servlet.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.).

Returns:String

a String containing servlet information

handleConnectback to summary
public void handleConnect(HttpServletRequest request, HttpServletResponse response) throws IOException
initback to summary
public void init(ServletConfig config) throws ServletException

Implements javax.servlet.Servlet.init.

Doc from javax.servlet.Servlet.init.

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
Parameters
config:ServletConfig

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

Exceptions
ServletException:
if an exception has occurred that interferes with the servlet's normal operation
serviceback to summary
public void service(ServletRequest req, ServletResponse res) throws ServletException, IOException

Implements javax.servlet.Servlet.service.

Doc from javax.servlet.Servlet.service.

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.

The status code of the response always should be set for a servlet that throws or sends an error.

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.

Parameters
req:ServletRequest

the ServletRequest object that contains the client's request

res:ServletResponse

the ServletResponse object that contains the servlet's response

Exceptions
ServletException:
if an exception occurs that interferes with the servlet's normal operation
IOException:
if an input or output exception occurs