org.eclipse.jetty.server

Class HttpConfiguration

java.lang.Object

org.eclipse.jetty.server.HttpConfiguration

public class HttpConfiguration
extends java.lang.Object

HTTP Configuration.

This class is a holder of HTTP configuration for use by the HttpChannel class. Typically a HTTPConfiguration instance is instantiated and passed to a ConnectionFactory that can create HTTP channels (e.g. HTTP, AJP or FCGI).

The configuration held by this class is not for the wire protocol, but for the interpretation and handling of HTTP requests that could be transported by a variety of protocols.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	HttpConfiguration.ConnectionFactory
static interface	HttpConfiguration.Customizer An interface that allows a request object to be customized for a particular HTTP connector configuration.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SERVER_VERSION

Constructor Summary

Constructors

Constructor and Description
HttpConfiguration()
HttpConfiguration(HttpConfiguration config) Creates a configuration from another.

Method Summary

Modifier and Type	Method and Description
void	addCustomizer(HttpConfiguration.Customizer customizer) Adds a HttpConfiguration.Customizer that is invoked for every request received.
void	addFormEncodedMethod(java.lang.String method) Adds a form encoded HTTP Method
long	getBlockingTimeout() Deprecated. Replaced by getMinResponseDataRate() and getMinRequestDataRate()
CookieCompliance	getCookieCompliance()
<T> T	getCustomizer(java.lang.Class<T> type)
java.util.List<HttpConfiguration.Customizer>	getCustomizers()
java.util.Set<java.lang.String>	getFormEncodedMethods()
int	getHeaderCacheSize()
long	getIdleTimeout() The max idle time is applied to a HTTP request for IO operations and delayed dispatch.
int	getMaxErrorDispatches()
long	getMinRequestDataRate()
long	getMinResponseDataRate()
MultiPartFormDataCompliance	getMultipartFormDataCompliance()
int	getOutputAggregationSize()
int	getOutputBufferSize()
int	getRequestHeaderSize()
int	getResponseHeaderSize()
int	getSecurePort()
java.lang.String	getSecureScheme()
boolean	getSendDateHeader()
boolean	getSendServerVersion()
boolean	getSendXPoweredBy()
boolean	isCookieCompliance(CookieCompliance compliance)
boolean	isDelayDispatchUntilContent()
boolean	isFormEncodedMethod(java.lang.String method) Tests whether the HTTP method supports x-www-form-urlencoded content
boolean	isNotifyRemoteAsyncErrors()
boolean	isPersistentConnectionsEnabled()
void	setBlockingTimeout(long blockingTimeout) Deprecated. Replaced by setMinResponseDataRate(long) and setMinRequestDataRate(long)
void	setCookieCompliance(CookieCompliance cookieCompliance)
void	setCustomizers(java.util.List<HttpConfiguration.Customizer> customizers) Sets the HttpConfiguration.Customizers that are invoked for every request received.
void	setDelayDispatchUntilContent(boolean delay)
void	setFormEncodedMethods(java.lang.String... methods) Sets the form encoded HTTP methods.
void	setHeaderCacheSize(int headerCacheSize)
void	setIdleTimeout(long timeoutMs) The max idle time is applied to a HTTP request for IO operations and delayed dispatch.
void	setMaxErrorDispatches(int max)
void	setMinRequestDataRate(long bytesPerSecond)
void	setMinResponseDataRate(long bytesPerSecond) Sets an minimum response content data rate.
void	setMultiPartFormDataCompliance(MultiPartFormDataCompliance multiPartCompliance) Sets the compliance level for multipart/form-data handling.
void	setNotifyRemoteAsyncErrors(boolean notifyRemoteAsyncErrors)
void	setOutputAggregationSize(int outputAggregationSize) Set the max size of the response content write that is copied into the aggregate buffer.
void	setOutputBufferSize(int outputBufferSize) Set the size of the buffer into which response content is aggregated before being sent to the client.
void	setPersistentConnectionsEnabled(boolean persistentConnectionsEnabled)
void	setRequestHeaderSize(int requestHeaderSize) Larger headers will allow for more and/or larger cookies plus larger form content encoded in a URL.
void	setResponseHeaderSize(int responseHeaderSize) Larger headers will allow for more and/or larger cookies and longer HTTP headers (eg for redirection).
void	setSecurePort(int securePort) Sets the TCP/IP port used for CONFIDENTIAL and INTEGRAL redirections.
void	setSecureScheme(java.lang.String secureScheme) Set the URI scheme used for CONFIDENTIAL and INTEGRAL redirections.
void	setSendDateHeader(boolean sendDateHeader)
void	setSendServerVersion(boolean sendServerVersion)
void	setSendXPoweredBy(boolean sendXPoweredBy)
java.lang.String	toString()
void	writePoweredBy(java.lang.Appendable out, java.lang.String preamble, java.lang.String postamble)

Methods inherited from class java.lang.Object

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

Field Detail

SERVER_VERSION

public static final java.lang.String SERVER_VERSION

Constructor Detail

HttpConfiguration

public HttpConfiguration()

HttpConfiguration

public HttpConfiguration(HttpConfiguration config)

Creates a configuration from another.

Parameters:

config - The configuration to copy.

Method Detail

addCustomizer

public void addCustomizer(HttpConfiguration.Customizer customizer)

Adds a HttpConfiguration.Customizer that is invoked for every request received.

Customizers are often used to interpret optional headers (eg ForwardedRequestCustomizer) or optional protocol semantics (eg SecureRequestCustomizer).

Parameters:

customizer - A request customizer

getCustomizers

public java.util.List<HttpConfiguration.Customizer> getCustomizers()

getCustomizer

public <T> T getCustomizer(java.lang.Class<T> type)

getOutputBufferSize

public int getOutputBufferSize()

getOutputAggregationSize

public int getOutputAggregationSize()

getRequestHeaderSize

public int getRequestHeaderSize()

getResponseHeaderSize

public int getResponseHeaderSize()

getHeaderCacheSize

public int getHeaderCacheSize()

getSecurePort

public int getSecurePort()

getSecureScheme

public java.lang.String getSecureScheme()

isPersistentConnectionsEnabled

public boolean isPersistentConnectionsEnabled()

getIdleTimeout

public long getIdleTimeout()

The max idle time is applied to a HTTP request for IO operations and delayed dispatch.

Returns:

the max idle time in ms or if == 0 implies an infinite timeout, <0 implies no HTTP channel timeout and the connection timeout is used instead.

setIdleTimeout

public void setIdleTimeout(long timeoutMs)

The max idle time is applied to a HTTP request for IO operations and delayed dispatch.

Parameters:

timeoutMs - the max idle time in ms or if == 0 implies an infinite timeout, <0 implies no HTTP channel timeout and the connection timeout is used instead.

getBlockingTimeout

@Deprecated
public long getBlockingTimeout()

Deprecated. Replaced by getMinResponseDataRate() and getMinRequestDataRate()

This timeout is in addition to the Connector.getIdleTimeout(), and applies to the total operation (as opposed to the idle timeout that applies to the time no data is being sent). This applies only to blocking operations and does not affect asynchronous read and write.

Returns:

-1, for no blocking timeout (default), 0 for a blocking timeout equal to the idle timeout; >0 for a timeout in ms applied to the total blocking operation.

setBlockingTimeout

@Deprecated
public void setBlockingTimeout(long blockingTimeout)

Deprecated. Replaced by setMinResponseDataRate(long) and setMinRequestDataRate(long)

This timeout is in addition to the Connector.getIdleTimeout(), and applies to the total operation (as opposed to the idle timeout that applies to the time no data is being sent).This applies only to blocking operations and does not affect asynchronous read and write.

Parameters:

blockingTimeout - -1, for no blocking timeout (default), 0 for a blocking timeout equal to the idle timeout; >0 for a timeout in ms applied to the total blocking operation.

setPersistentConnectionsEnabled

public void setPersistentConnectionsEnabled(boolean persistentConnectionsEnabled)

setSendServerVersion

public void setSendServerVersion(boolean sendServerVersion)

getSendServerVersion

public boolean getSendServerVersion()

writePoweredBy

public void writePoweredBy(java.lang.Appendable out,
                           java.lang.String preamble,
                           java.lang.String postamble)
                    throws java.io.IOException

Throws:

java.io.IOException

setSendXPoweredBy

public void setSendXPoweredBy(boolean sendXPoweredBy)

getSendXPoweredBy

public boolean getSendXPoweredBy()

setSendDateHeader

public void setSendDateHeader(boolean sendDateHeader)

getSendDateHeader

public boolean getSendDateHeader()

setDelayDispatchUntilContent

public void setDelayDispatchUntilContent(boolean delay)

Parameters:

delay - if true, delay the application dispatch until content is available (default false)

isDelayDispatchUntilContent

public boolean isDelayDispatchUntilContent()

setCustomizers

public void setCustomizers(java.util.List<HttpConfiguration.Customizer> customizers)

Sets the HttpConfiguration.Customizers that are invoked for every request received.

Customizers are often used to interpret optional headers (eg ForwardedRequestCustomizer) or optional protocol semantics (eg SecureRequestCustomizer).

Parameters:

customizers - the list of customizers

setOutputBufferSize

public void setOutputBufferSize(int outputBufferSize)

Set the size of the buffer into which response content is aggregated before being sent to the client. A larger buffer can improve performance by allowing a content producer to run without blocking, however larger buffers consume more memory and may induce some latency before a client starts processing the content.

Parameters:

outputBufferSize - buffer size in bytes.

setOutputAggregationSize

public void setOutputAggregationSize(int outputAggregationSize)

Set the max size of the response content write that is copied into the aggregate buffer. Writes that are smaller of this size are copied into the aggregate buffer, while writes that are larger of this size will cause the aggregate buffer to be flushed and the write to be executed without being copied.

Parameters:

outputAggregationSize - the max write size that is aggregated

setRequestHeaderSize

public void setRequestHeaderSize(int requestHeaderSize)

Larger headers will allow for more and/or larger cookies plus larger form content encoded in a URL. However, larger headers consume more memory and can make a server more vulnerable to denial of service attacks.

Parameters:

requestHeaderSize - the maximum size in bytes of the request header

setResponseHeaderSize

public void setResponseHeaderSize(int responseHeaderSize)

Larger headers will allow for more and/or larger cookies and longer HTTP headers (eg for redirection). However, larger headers will also consume more memory.

Parameters:

responseHeaderSize - the maximum size in bytes of the response header

setHeaderCacheSize

public void setHeaderCacheSize(int headerCacheSize)

Parameters:

headerCacheSize - The size in bytes of the header field cache.

setSecurePort

public void setSecurePort(int securePort)

Sets the TCP/IP port used for CONFIDENTIAL and INTEGRAL redirections.

Parameters:

securePort - the secure port to redirect to.

setSecureScheme

public void setSecureScheme(java.lang.String secureScheme)

Set the URI scheme used for CONFIDENTIAL and INTEGRAL redirections.

Parameters:

secureScheme - A scheme string like "https"

setFormEncodedMethods

public void setFormEncodedMethods(java.lang.String... methods)

Sets the form encoded HTTP methods.

Parameters:

methods - the HTTP methods of requests that can be decoded as x-www-form-urlencoded content to be made available via the Request.getParameter(String) and associated APIs

getFormEncodedMethods

public java.util.Set<java.lang.String> getFormEncodedMethods()

Returns:

the set of HTTP methods of requests that can be decoded as x-www-form-urlencoded content to be made available via the Request.getParameter(String) and associated APIs

addFormEncodedMethod

public void addFormEncodedMethod(java.lang.String method)

Adds a form encoded HTTP Method

Parameters:

method - the HTTP method of requests that can be decoded as x-www-form-urlencoded content to be made available via the Request.getParameter(String) and associated APIs

isFormEncodedMethod

public boolean isFormEncodedMethod(java.lang.String method)

Tests whether the HTTP method supports x-www-form-urlencoded content

Parameters:

method - the HTTP method

Returns:

true if requests with this method can be decoded as x-www-form-urlencoded content to be made available via the Request.getParameter(String) and associated APIs

getMaxErrorDispatches

public int getMaxErrorDispatches()

Returns:

The maximum error dispatches for a request to prevent looping on an error

setMaxErrorDispatches

public void setMaxErrorDispatches(int max)

Parameters:

max - The maximum error dispatches for a request to prevent looping on an error

getMinRequestDataRate

public long getMinRequestDataRate()

Returns:

The minimum request data rate in bytes per second; or <=0 for no limit

setMinRequestDataRate

public void setMinRequestDataRate(long bytesPerSecond)

Parameters:

bytesPerSecond - The minimum request data rate in bytes per second; or <=0 for no limit

getMinResponseDataRate

public long getMinResponseDataRate()

Returns:

The minimum response data rate in bytes per second; or <=0 for no limit

setMinResponseDataRate

public void setMinResponseDataRate(long bytesPerSecond)

Sets an minimum response content data rate.

The value is enforced only approximately - not precisely - due to the fact that for efficiency reasons buffer writes may be comprised of both response headers and response content.

Parameters:

bytesPerSecond - The minimum response data rate in bytes per second; or <=0 for no limit

getCookieCompliance

public CookieCompliance getCookieCompliance()

setCookieCompliance

public void setCookieCompliance(CookieCompliance cookieCompliance)

isCookieCompliance

public boolean isCookieCompliance(CookieCompliance compliance)

setMultiPartFormDataCompliance

public void setMultiPartFormDataCompliance(MultiPartFormDataCompliance multiPartCompliance)

Sets the compliance level for multipart/form-data handling.

Parameters:

multiPartCompliance - The multipart/form-data compliance level.

getMultipartFormDataCompliance

public MultiPartFormDataCompliance getMultipartFormDataCompliance()

setNotifyRemoteAsyncErrors

public void setNotifyRemoteAsyncErrors(boolean notifyRemoteAsyncErrors)

Parameters:

notifyRemoteAsyncErrors - whether remote errors, when detected, are notified to async applications

isNotifyRemoteAsyncErrors

public boolean isNotifyRemoteAsyncErrors()

Returns:

whether remote errors, when detected, are notified to async applications

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object