Modifier and Type	Class and Description
public static class	ProxyServlet.Transparent Transparent Proxy.

Modifier and Type	Field and Description
protected ServletConfig	_config
protected ServletContext	_context
protected HashSet<E>	_DontProxyHeaders

Access	Constructor and Description
public	ProxyServlet()

Method Summary

Modifier and Type	Method 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.
protected URL	Returns: The URL to which the request should be proxied. proxyHttpURL(String The scheme of the received request. scheme, String The server encoded in the received request(which may be from an absolute URL in the request line). serverName, int The server port of the received request (which may be from an absolute URL in the request line). serverPort, String The URI of the received request. uri) Resolve requested URL to the Proxied URL
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:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

_config	back to summary
protected ServletConfig _config

_context	back to summary
protected ServletContext _context

_DontProxyHeaders	back to summary
protected HashSet<E> _DontProxyHeaders

Constructor Detail

ProxyServlet	back to summary
public ProxyServlet()

Method Detail

destroy back to summary

destroy	back 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.

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.

getServletConfig back to summary

getServletConfig	back 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

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

getServletInfo back to summary

getServletInfo	back 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

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

handleConnect	back to summary
public void handleConnect(HttpServletRequest request, HttpServletResponse response) throws IOException

init back to summary

init	back 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 Throws a `ServletException` 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

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

Throws a ServletException
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

proxyHttpURL	back to summary
protected URL proxyHttpURL(String scheme, String serverName, int serverPort, String uri) throws MalformedURLException Resolve requested URL to the Proxied URL Parameters scheme:String The scheme of the received request. serverName:String The server encoded in the received request(which may be from an absolute URL in the request line). serverPort:int The server port of the received request (which may be from an absolute URL in the request line). uri:String The URI of the received request. Returns:URL The URL to which the request should be proxied.

proxyHttpURL

back to summary

protected URL proxyHttpURL(String scheme, String serverName, int serverPort, String uri) throws MalformedURLException

Resolve requested URL to the Proxied URL

Parameters

scheme:String: The scheme of the received request.
serverName:String: The server encoded in the received request(which may be from an absolute URL in the request line).
serverPort:int: The server port of the received request (which may be from an absolute URL in the request line).
uri:String: The URI of the received request.

Returns:URL

The URL to which the request should be proxied.

service back to summary

service	back 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

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

org.mortbay.servlet back to summary

public Class ProxyServlet.Transparent

Class Inheritance

extends ProxyServlet

java.lang.Object
org.mortbay.servlet.ProxyServlet
org.mortbay.servlet.ProxyServlet.Transparent

Transparent Proxy. This convenience extension to AsyncProxyServlet configures the servlet as a transparent proxy. The servlet is configured with init parameter:

ProxyTo - a URI like http://host:80/context to which the request is proxied.
Prefix - a URI prefix that is striped from the start of the forwarded URI.

For example, if a request was received at /foo/bar and the ProxyTo was http://host:80/context and the Prefix was /foo, then the request would be proxied to http://host:80/context/bar

Field Summary

Modifier and Type	Field and Description
pack-priv String	_prefix
pack-priv String	_proxyTo

Inherited from org.mortbay.servlet.ProxyServlet:: _config _context _DontProxyHeaders

Constructor Summary

Access	Constructor and Description
public	Transparent()
public	Transparent(String prefix, String server, int port)

Method Summary

Modifier and Type Method and Description

Modifier and Type	Method and Description
public void	init(ServletConfig a `ServletConfig` object containing the servlet's configuration and initialization parameters config) Overrides org.mortbay.servlet.ProxyServlet.init. Implements javax.servlet.Servlet.init. Called by the servlet container to indicate to a servlet that the servlet is being placed into service.
protected URL	proxyHttpURL(final String The scheme of the received request. scheme, final String The server encoded in the received request(which may be from an absolute URL in the request line). serverName, int The server port of the received request (which may be from an absolute URL in the request line). serverPort, final String The URI of the received request. uri) Overrides org.mortbay.servlet.ProxyServlet.proxyHttpURL. Resolve requested URL to the Proxied URL

public void

init(ServletConfig

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

config)

Overrides org.mortbay.servlet.ProxyServlet.init.

Implements javax.servlet.Servlet.init.

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

protected URL

proxyHttpURL(final String

The scheme of the received request.

scheme, final String

The server encoded in the received request(which may be from an absolute URL in the request line).

serverName, int

The server port of the received request (which may be from an absolute URL in the request line).

serverPort, final String

The URI of the received request.

uri)

Overrides org.mortbay.servlet.ProxyServlet.proxyHttpURL.

Resolve requested URL to the Proxied URL

Inherited from org.mortbay.servlet.ProxyServlet:: destroy getServletConfig getServletInfo handleConnect service

Field Detail

_prefix	back to summary
pack-priv String _prefix

_proxyTo	back to summary
pack-priv String _proxyTo

Constructor Detail

Transparent	back to summary
public Transparent()

Transparent	back to summary
public Transparent(String prefix, String server, int port)

Method Detail

init back to summary

init	back to summary
public void init(ServletConfig config) throws ServletException Overrides org.mortbay.servlet.ProxyServlet.init. 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 Throws a `ServletException` 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

public void init(ServletConfig config) throws ServletException

Overrides org.mortbay.servlet.ProxyServlet.init.

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

Throws a ServletException
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

proxyHttpURL	back to summary
protected URL proxyHttpURL(final String scheme, final String serverName, int serverPort, final String uri) throws MalformedURLException Overrides org.mortbay.servlet.ProxyServlet.proxyHttpURL. Doc from org.mortbay.servlet.ProxyServlet.proxyHttpURL. Resolve requested URL to the Proxied URL Parameters scheme:String The scheme of the received request. serverName:String The server encoded in the received request(which may be from an absolute URL in the request line). serverPort:int The server port of the received request (which may be from an absolute URL in the request line). uri:String The URI of the received request. Returns:URL The URL to which the request should be proxied.

proxyHttpURL

back to summary

protected URL proxyHttpURL(final String scheme, final String serverName, int serverPort, final String uri) throws MalformedURLException

Overrides org.mortbay.servlet.ProxyServlet.proxyHttpURL.

Doc from org.mortbay.servlet.ProxyServlet.proxyHttpURL.

Resolve requested URL to the Proxied URL

Parameters

scheme:String: The scheme of the received request.
serverName:String: The server encoded in the received request(which may be from an absolute URL in the request line).
serverPort:int: The server port of the received request (which may be from an absolute URL in the request line).
uri:String: The URI of the received request.

Returns:URL

The URL to which the request should be proxied.

public Class ProxyServlet

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class ProxyServlet.Transparent

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail