org.eclipse.jetty.server

Class HttpConfiguration

java.lang.Object

org.eclipse.jetty.server.HttpConfiguration

@ManagedObject(value="HTTP Configuration")
public class HttpConfiguration
extends 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 String	SERVER_VERSION

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addCustomizer(HttpConfiguration.Customizer customizer) Add a HttpConfiguration.Customizer that is invoked for every request received.
void	addFormEncodedMethod(String method) Add a form encoded HTTP Method
long	getBlockingTimeout() Get the timeout applied to blocking operations.
<T> T	getCustomizer(Class<T> type)
List<HttpConfiguration.Customizer>	getCustomizers()
Set<String>	getFormEncodedMethods()
int	getHeaderCacheSize()
int	getMaxErrorDispatches()
int	getOutputAggregationSize()
int	getOutputBufferSize()
int	getRequestHeaderSize()
int	getResponseHeaderSize()
int	getSecurePort()
String	getSecureScheme()
boolean	getSendDateHeader()
boolean	getSendServerVersion()
boolean	getSendXPoweredBy()
boolean	isDelayDispatchUntilContent()
boolean	isFormEncodedMethod(String method) Test if the method type supports x-www-form-urlencoded content
boolean	isPersistentConnectionsEnabled()
void	setBlockingTimeout(long blockingTimeout) Set the timeout applied to blocking operations.
void	setCustomizers(List<HttpConfiguration.Customizer> customizers) Set the HttpConfiguration.Customizers that are invoked for every request received.
void	setDelayDispatchUntilContent(boolean delay)
void	setFormEncodedMethods(String... methods) Set the form encoded methods.
void	setHeaderCacheSize(int headerCacheSize) Set the header field cache size.
void	setMaxErrorDispatches(int max)
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) Set the maximum size of a request header.
void	setResponseHeaderSize(int responseHeaderSize) Set the maximum size of a response header.
void	setSecurePort(int securePort) Set the TCP/IP port used for CONFIDENTIAL and INTEGRAL redirections.
void	setSecureScheme(String secureScheme) Set the URI scheme used for CONFIDENTIAL and INTEGRAL redirections.
void	setSendDateHeader(boolean sendDateHeader)
void	setSendServerVersion(boolean sendServerVersion)
void	setSendXPoweredBy(boolean sendXPoweredBy)
String	toString()
void	writePoweredBy(Appendable out, String preamble, 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 String SERVER_VERSION

Constructor Detail

HttpConfiguration

public HttpConfiguration()

HttpConfiguration

public HttpConfiguration(HttpConfiguration config)

Create a configuration from another.

Parameters:

config - The configuration to copy.

Method Detail

addCustomizer

public void addCustomizer(HttpConfiguration.Customizer customizer)

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

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

Parameters:

customizer - A request customizer

getCustomizers

public List<HttpConfiguration.Customizer> getCustomizers()

getCustomizer

public <T> T getCustomizer(Class<T> type)

getOutputBufferSize

@ManagedAttribute(value="The size in bytes of the output buffer used to aggregate HTTP output")
public int getOutputBufferSize()

getOutputAggregationSize

@ManagedAttribute(value="The maximum size in bytes for HTTP output to be aggregated")
public int getOutputAggregationSize()

getRequestHeaderSize

@ManagedAttribute(value="The maximum allowed size in bytes for a HTTP request header")
public int getRequestHeaderSize()

getResponseHeaderSize

@ManagedAttribute(value="The maximum allowed size in bytes for a HTTP response header")
public int getResponseHeaderSize()

getHeaderCacheSize

@ManagedAttribute(value="The maximum allowed size in bytes for a HTTP header field cache")
public int getHeaderCacheSize()

getSecurePort

@ManagedAttribute(value="The port to which Integral or Confidential security constraints are redirected")
public int getSecurePort()

getSecureScheme

@ManagedAttribute(value="The scheme with which Integral or Confidential security constraints are redirected")
public String getSecureScheme()

isPersistentConnectionsEnabled

@ManagedAttribute(value="True if HTTP/1 persistent connection are enabled")
public boolean isPersistentConnectionsEnabled()

getBlockingTimeout

@ManagedAttribute(value="Timeout in MS for blocking operations.")
public long getBlockingTimeout()

Get the timeout applied to blocking operations.

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).

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

public void setBlockingTimeout(long blockingTimeout)

Set the timeout applied to blocking operations.

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).

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

@ManagedAttribute(value="if true, send the Server header in responses")
public boolean getSendServerVersion()

writePoweredBy

public void writePoweredBy(Appendable out,
                           String preamble,
                           String postamble)
                    throws IOException

Throws:

IOException

setSendXPoweredBy

public void setSendXPoweredBy(boolean sendXPoweredBy)

getSendXPoweredBy

@ManagedAttribute(value="if true, send the X-Powered-By header in responses")
public boolean getSendXPoweredBy()

setSendDateHeader

public void setSendDateHeader(boolean sendDateHeader)

getSendDateHeader

@ManagedAttribute(value="if true, include the date in HTTP headers")
public boolean getSendDateHeader()

setDelayDispatchUntilContent

public void setDelayDispatchUntilContent(boolean delay)

Parameters:

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

isDelayDispatchUntilContent

@ManagedAttribute(value="if true, delay the application dispatch until content is available")
public boolean isDelayDispatchUntilContent()

setCustomizers

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

Set 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)

Set the maximum size of a request header.

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 - Max header size in bytes

setResponseHeaderSize

public void setResponseHeaderSize(int responseHeaderSize)

Set the maximum size of a response header.

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 - Response header size in bytes.

setHeaderCacheSize

public void setHeaderCacheSize(int headerCacheSize)

Set the header field cache size.

Parameters:

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

setSecurePort

public void setSecurePort(int securePort)

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

Parameters:

securePort - the secure port to redirect to.

setSecureScheme

public void setSecureScheme(String secureScheme)

Set the URI scheme used for CONFIDENTIAL and INTEGRAL redirections.

Parameters:

secureScheme - A scheme string like "https"

toString

public String toString()

Overrides:

toString in class Object

setFormEncodedMethods

public void setFormEncodedMethods(String... methods)

Set the form encoded methods.

Parameters:

methods - 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 Set<String> getFormEncodedMethods()

Returns:

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(String method)

Add a form encoded HTTP Method

Parameters:

method - 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(String method)

Test if the method type supports x-www-form-urlencoded content

Parameters:

method - the method type

Returns:

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

getMaxErrorDispatches

@ManagedAttribute(value="The maximum ERROR dispatches for a request for loop prevention (default 10)")
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