org.apache.geronimo.management.geronimo
Interface WebConnector

All Superinterfaces:

NetworkConnector

All Known Subinterfaces:

JettySecureConnector, JettyWebConnector, SecureConnector, TomcatSecureConnector

All Known Implementing Classes:

AJP13Connector, HTTPBlockingConnector, HTTPSelectChannelConnector, HTTPSocketConnector, HTTPSSelectChannelConnector, HTTPSSocketConnector, JettyConnector

public interface WebConnector
extends NetworkConnector

The common configuration settings for a web container network connector -- that is, the protocol and network settings used to connect to the web container (with a variety of tuning arguments as well). http://jakarta.apache.org/tomcat/tomcat-5.5-doc/config/http.html http://mortbay.org/javadoc/org/mortbay/http/SocketListener.html

Method Summary

int	getAcceptQueueSize() Gets the maximum number of connections that may be queued while all threads are busy.
int	getBufferSizeBytes() Gets the size of the buffer used to handle network data for this connector.
String	getConnectUrl() Gets a URL used to connect to the web server via this connector.
int	getLingerMillis() Gets the amount of time the socket used by this connector will linger after being closed
int	getMaxThreads() Gets the maximum number of threads used to service connections from this connector.
int	getRedirectPort() Gets the network port to which traffic will be redirected if this connector handles insecure traffic and the request requires a secure connection.
boolean	isTcpNoDelay() Gets whether the TCP_NODELAY flag is set for the sockets used by this connector.
void	setAcceptQueueSize(int size) Sets the maximum number of connections that may be queued while all threads are busy.
void	setBufferSizeBytes(int bytes) Gets the size of the buffer used to handle network data for this connector.
void	setLingerMillis(int millis) Sets the amount of time the socket used by this connector will linger after being closed.
void	setMaxThreads(int threads) Sets the maximum number of threads used to service connections from this connector.
void	setRedirectPort(int port) Gets the network port to which traffic will be redirected if this connector handles insecure traffic and the request requires a secure connection.
void	setTcpNoDelay(boolean enable) Sets whether the TCP_NODELAY flag is set for the sockets used by this connector.

Methods inherited from interface org.apache.geronimo.management.geronimo.NetworkConnector

getHost, getListenAddress, getPort, getProtocol, setHost, setPort

Method Detail

getBufferSizeBytes

int getBufferSizeBytes()

Gets the size of the buffer used to handle network data for this connector.

setBufferSizeBytes

void setBufferSizeBytes(int bytes)

Gets the size of the buffer used to handle network data for this connector.

getMaxThreads

int getMaxThreads()

Gets the maximum number of threads used to service connections from this connector.

setMaxThreads

void setMaxThreads(int threads)

Sets the maximum number of threads used to service connections from this connector.

getAcceptQueueSize

int getAcceptQueueSize()

Gets the maximum number of connections that may be queued while all threads are busy. Any requests received while the queue is full will be rejected.

setAcceptQueueSize

void setAcceptQueueSize(int size)

Sets the maximum number of connections that may be queued while all threads are busy. Any requests received while the queue is full will be rejected.

getLingerMillis

int getLingerMillis()

Gets the amount of time the socket used by this connector will linger after being closed. -1 indicates that socket linger is disabled.

setLingerMillis

void setLingerMillis(int millis)

Sets the amount of time the socket used by this connector will linger after being closed. Use -1 to disable socket linger.

isTcpNoDelay

boolean isTcpNoDelay()

Gets whether the TCP_NODELAY flag is set for the sockets used by this connector. This usually enhances performance, so it should typically be set.

setTcpNoDelay

void setTcpNoDelay(boolean enable)

Sets whether the TCP_NODELAY flag is set for the sockets used by this connector. This usually enhances performance, so it should typically be set.

getRedirectPort

int getRedirectPort()

Gets the network port to which traffic will be redirected if this connector handles insecure traffic and the request requires a secure connection. Needless to say, this should point to another connector configured for SSL.

setRedirectPort

void setRedirectPort(int port)

Gets the network port to which traffic will be redirected if this connector handles insecure traffic and the request requires a secure connection. Needless to say, this should point to another connector configured for SSL. If no SSL connector is available, any port can be used as they all fail equally well. :)

getConnectUrl

String getConnectUrl()

Gets a URL used to connect to the web server via this connector. This is not guaranteed to work (for example, if the server is located behind a proxy), but it should give a reasonable value if possible. The form of the returned String should be http://hostname or http://hostname:port (in other words, suitable for appending a context path).