org.mortbay.http
public interface HttpListener extends LifeCycle, Serializable
Version: $Id: HttpListener.java,v 1.17 2005/03/15 10:03:40 gregwilkins Exp $
See Also: HttpConnection HttpServer
Field Summary | |
---|---|
static String | ATTRIBUTE |
Method Summary | |
---|---|
void | customizeRequest(HttpConnection connection, HttpRequest request) Customize a request for a listener/connection combination.
|
int | getBufferReserve() Get the size of the header reserve area.
|
int | getBufferSize() Get the size of the buffers used by connections from this listener. |
int | getConfidentialPort() Get the protocol port to use for confidential redirections.
|
String | getConfidentialScheme() Get the protocol scheme to use for confidential redirections.
|
String | getDefaultScheme() Get the default scheme for requests.
|
String | getHost() Get the host or IP of the interface used by this listener. |
HttpHandler | getHttpHandler() Get an optional HttpHandler for the listener.
|
HttpServer | getHttpServer() Get the HttpServer instance for this HttpListener. |
int | getIntegralPort() Get the protocol port to use for integral redirections.
|
String | getIntegralScheme() Get the protocol scheme to use for integral redirections.
|
int | getPort() Get the port number of the listener. |
boolean | isConfidential(HttpConnection connection) Get the confidential status of a connection. |
boolean | isIntegral(HttpConnection connection) Get the integral status of a connection. |
boolean | isLowOnResources() Get the low on resources state of the listener.
|
boolean | isOutOfResources() Get the out of resources state of the listener.
|
void | persistConnection(HttpConnection connection) Prepare a connection for persistance.
|
void | setHost(String host) Set the host or IP of the interface used by this listener. |
void | setHttpServer(HttpServer server) Set the HttpServer instance for this HttpListener.
|
void | setPort(int port) Set the port number of the listener. |
Parameters: connection The connection the request was received on, which must be a HttpConnection created by this listener. request The request to customize.
Returns: The default buffer reserve size in bytes.
Returns: The default buffer size in bytes.
Returns: The confidential port. For most implementations this is 443 for https
Returns: The confidential scheme. For most implementations this is "https"
Returns: The protocol scheme name (eg "http" or "https").
Returns: The hostname or IP address of the interface used by this listeners. If null or "0.0.0.0" then all available interfaces are used by this listener.
Returns: The HttpServer instance this HttpListener has been added to, or null if the listener is not added to any HttpServer.
Returns: The integral port. For most implementations this is 443 for https
Returns: The integral scheme. For most implementations this is "https"
Returns: The TCP/IP port number used by this listener.
Parameters: connection The connection to test.
Returns: True of the connection checks the integrity of the data. For most implementations this is true for https connections.
Parameters: connection The connection to test.
Returns: True of the connection checks the integrity of the data. For most implementations this is true for https connections.
Returns: True if the listener is out of resources.
Returns: True if the listener is out of resources.
Parameters: connection The perstent connection, which must be a HttpConnection created by this listener.
Parameters: host The hostname or IP address of the interface used by this listeners. If null or "0.0.0.0" then all available interfaces are used by this listener.
Parameters: server The HttpServer instance this HttpListener has been added to.
Parameters: port The TCP/IP port number to be used by this listener.