Package org.eclipse.jetty.server

Class HttpConfiguration

java.lang.Object

org.eclipse.jetty.server.HttpConfiguration

All Implemented Interfaces:

Dumpable

@ManagedObject("HTTP Configuration")
public class HttpConfiguration
extends Object
implements Dumpable

HTTP Configuration.

This class is a holder of HTTP configuration for use by the HttpChannel class. Typically an HTTPConfiguration instance is instantiated and passed to a HttpConfiguration.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	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.

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Dumpable

Dumpable.DumpableContainer

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVER_VERSION

Fields inherited from interface org.eclipse.jetty.util.component.Dumpable

KEY

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	addCustomizer(HttpConfiguration.Customizer customizer)	Adds a HttpConfiguration.Customizer that is invoked for every request received.
void	addFormEncodedMethod(String method)	Adds a form encoded HTTP Method
String	dump()
void	dump(Appendable out, String indent)	Dump this object (and children) into an Appendable using the provided indent after any new lines.
<T> T	getCustomizer(Class<T> type)
List<HttpConfiguration.Customizer>	getCustomizers()
Set<String>	getFormEncodedMethods()
int	getHeaderCacheSize()
HttpCompliance	getHttpCompliance()
long	getIdleTimeout()	The max idle time is applied to an HTTP request for IO operations and delayed dispatch.
SocketAddress	getLocalAddress()	Get the SocketAddress override to be reported as the local address of all connections
int	getMaxErrorDispatches()
long	getMinRequestDataRate()
long	getMinResponseDataRate()
MultiPartFormDataCompliance	getMultipartFormDataCompliance()
int	getOutputAggregationSize()
int	getOutputBufferSize()
CookieCompliance	getRequestCookieCompliance()
int	getRequestHeaderSize()
CookieCompliance	getResponseCookieCompliance()
int	getResponseHeaderSize()
int	getSecurePort()
String	getSecureScheme()
boolean	getSendDateHeader()	Indicates if the Date header will be sent in responses.
boolean	getSendServerVersion()
boolean	getSendXPoweredBy()
HostPort	getServerAuthority()	Get the Server authority override to be used if no authority is provided by a request.
UriCompliance	getUriCompliance()
boolean	isDelayDispatchUntilContent()
boolean	isFormEncodedMethod(String method)	Tests whether the HTTP method supports x-www-form-urlencoded content
boolean	isHeaderCacheCaseSensitive()
boolean	isNotifyRemoteAsyncErrors()
boolean	isPersistentConnectionsEnabled()
boolean	isRelativeRedirectAllowed()
boolean	isUseInputDirectByteBuffers()
boolean	isUseOutputDirectByteBuffers()
void	setCustomizers(List<HttpConfiguration.Customizer> customizers)	Sets the HttpConfiguration.Customizers that are invoked for every request received.
void	setDelayDispatchUntilContent(boolean delay)
void	setFormEncodedMethods(String... methods)	Sets the form encoded HTTP methods.
void	setHeaderCacheCaseSensitive(boolean headerCacheCaseSensitive)
void	setHeaderCacheSize(int headerCacheSize)
void	setHttpCompliance(HttpCompliance httpCompliance)
void	setIdleTimeout(long timeoutMs)	The max idle time is applied to an HTTP request for IO operations and delayed dispatch.
void	setLocalAddress(SocketAddress localAddress)	Specify the connection local address used within application API layer when identifying the local host name/port of a connected endpoint.
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	setRelativeRedirectAllowed(boolean allowed)
void	setRequestCookieCompliance(CookieCompliance cookieCompliance)
void	setRequestHeaderSize(int requestHeaderSize)	Sets the maximum allowed size in bytes for the HTTP request line and HTTP request headers.
void	setResponseCookieCompliance(CookieCompliance cookieCompliance)
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(String secureScheme)	Set the URI scheme used for CONFIDENTIAL and INTEGRAL redirections.
void	setSendDateHeader(boolean sendDateHeader)	Indicates if the Date header should be sent in responses.
void	setSendServerVersion(boolean sendServerVersion)
void	setSendXPoweredBy(boolean sendXPoweredBy)
void	setServerAuthority(HostPort authority)	Specify the connection server authority (name/port) used within application API layer when identifying the server host name/port of a connected endpoint.
void	setUriCompliance(UriCompliance uriCompliance)
void	setUseInputDirectByteBuffers(boolean useInputDirectByteBuffers)
void	setUseOutputDirectByteBuffers(boolean useOutputDirectByteBuffers)
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

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable

dumpSelf

Field Details

SERVER_VERSION

public static final String SERVER_VERSION

Constructor Details

HttpConfiguration

public HttpConfiguration()

HttpConfiguration

public HttpConfiguration(HttpConfiguration config)

Creates a configuration from another.

Parameters:

config - The configuration to copy.

Method Details

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 List<HttpConfiguration.Customizer> getCustomizers()

getCustomizer

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

getOutputBufferSize

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

getOutputAggregationSize

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

getRequestHeaderSize

@ManagedAttribute("The maximum allowed size in bytes for the HTTP request line and HTTP request headers")
public int getRequestHeaderSize()

getResponseHeaderSize

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

getHeaderCacheSize

@ManagedAttribute("The maximum allowed size in Trie nodes for an HTTP header field cache")
public int getHeaderCacheSize()

isHeaderCacheCaseSensitive

@ManagedAttribute("True if the header field cache is case sensitive")
public boolean isHeaderCacheCaseSensitive()

getSecurePort

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

getSecureScheme

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

isPersistentConnectionsEnabled

@ManagedAttribute("Whether persistent connections are enabled")
public boolean isPersistentConnectionsEnabled()

getIdleTimeout

@ManagedAttribute("The idle timeout in ms for I/O operations during the handling of an HTTP request")
public long getIdleTimeout()

The max idle time is applied to an 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 an 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.

setPersistentConnectionsEnabled

public void setPersistentConnectionsEnabled(boolean persistentConnectionsEnabled)

setSendServerVersion

public void setSendServerVersion(boolean sendServerVersion)

getSendServerVersion

@ManagedAttribute("Whether to 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("Whether to send the X-Powered-By header in responses")
public boolean getSendXPoweredBy()

setSendDateHeader

public void setSendDateHeader(boolean sendDateHeader)

Indicates if the Date header should be sent in responses.

Parameters:

sendDateHeader - true if the Date header should be sent in responses

See Also:

• HTTP/1.1 Standard Header: Date
• getSendDateHeader()

getSendDateHeader

@ManagedAttribute("Whether to send the Date header in responses")
public boolean getSendDateHeader()

Indicates if the Date header will be sent in responses.

Returns:

true by default

setDelayDispatchUntilContent

public void setDelayDispatchUntilContent(boolean delay)

Parameters:

delay - if true, delays the application dispatch until content is available (defaults to true)

isDelayDispatchUntilContent

@ManagedAttribute("Whether to delay the application dispatch until content is available")
public boolean isDelayDispatchUntilContent()

setUseInputDirectByteBuffers

public void setUseInputDirectByteBuffers(boolean useInputDirectByteBuffers)

Parameters:

useInputDirectByteBuffers - whether to use direct ByteBuffers for reading

isUseInputDirectByteBuffers

@ManagedAttribute("Whether to use direct ByteBuffers for reading")
public boolean isUseInputDirectByteBuffers()

setUseOutputDirectByteBuffers

public void setUseOutputDirectByteBuffers(boolean useOutputDirectByteBuffers)

Parameters:

useOutputDirectByteBuffers - whether to use direct ByteBuffers for writing

isUseOutputDirectByteBuffers

@ManagedAttribute("Whether to use direct ByteBuffers for writing")
public boolean isUseOutputDirectByteBuffers()

setCustomizers

public void setCustomizers(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)

Sets the maximum allowed size in bytes for the HTTP request line and HTTP request headers.

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 allowed size in bytes for the HTTP request line and HTTP request headers

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 of the header field cache, in terms of unique characters branches in the lookup Index.Mutable and associated data structures.

setHeaderCacheCaseSensitive

public void setHeaderCacheCaseSensitive(boolean headerCacheCaseSensitive)

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

Set the URI scheme used for CONFIDENTIAL and INTEGRAL redirections.

Parameters:

secureScheme - A scheme string like "https"

setFormEncodedMethods

public void setFormEncodedMethods(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 Set<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(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(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

@ManagedAttribute("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

getMinRequestDataRate

@ManagedAttribute("The minimum request content data rate in bytes per second")
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

@ManagedAttribute("The minimum response content data rate in bytes per second")
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

getHttpCompliance

public HttpCompliance getHttpCompliance()

setHttpCompliance

public void setHttpCompliance(HttpCompliance httpCompliance)

getUriCompliance

public UriCompliance getUriCompliance()

setUriCompliance

public void setUriCompliance(UriCompliance uriCompliance)

getRequestCookieCompliance

public CookieCompliance getRequestCookieCompliance()

Returns:

The CookieCompliance used for parsing request Cookie headers.

See Also:

• getResponseCookieCompliance()

setRequestCookieCompliance

public void setRequestCookieCompliance(CookieCompliance cookieCompliance)

Parameters:

cookieCompliance - The CookieCompliance to use for parsing request Cookie headers.

getResponseCookieCompliance

public CookieCompliance getResponseCookieCompliance()

Returns:

The CookieCompliance used for generating response Set-Cookie headers

See Also:

• getRequestCookieCompliance()

setResponseCookieCompliance

public void setResponseCookieCompliance(CookieCompliance cookieCompliance)

Parameters:

cookieCompliance - The CookieCompliance to use for generating response Set-Cookie headers

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

@ManagedAttribute("Whether remote errors, when detected, are notified to async applications")
public boolean isNotifyRemoteAsyncErrors()

Returns:

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

setRelativeRedirectAllowed

public void setRelativeRedirectAllowed(boolean allowed)

Parameters:

allowed - True if relative redirection locations are allowed

isRelativeRedirectAllowed

@ManagedAttribute("Whether relative redirection locations are allowed")
public boolean isRelativeRedirectAllowed()

Returns:

True if relative redirection locations are allowed

getLocalAddress

@ManagedAttribute("Local SocketAddress override")
public SocketAddress getLocalAddress()

Get the SocketAddress override to be reported as the local address of all connections

Returns:

Returns the connection local address override or null.

setLocalAddress

public void setLocalAddress(SocketAddress localAddress)

Specify the connection local address used within application API layer when identifying the local host name/port of a connected endpoint.

This allows an override of higher level APIs, such as ServletRequest.getLocalName(), ServletRequest.getLocalAddr(), and ServletRequest.getLocalPort().

Parameters:

localAddress - the address to use for host/addr/port, or null to reset to default behavior

getServerAuthority

@ManagedAttribute("The server authority if none provided by requests")
public HostPort getServerAuthority()

Get the Server authority override to be used if no authority is provided by a request.

Returns:

Returns the connection server authority (name/port) or null

setServerAuthority

public void setServerAuthority(HostPort authority)

Specify the connection server authority (name/port) used within application API layer when identifying the server host name/port of a connected endpoint.

This allows an override of higher level APIs, such as ServletRequest.getServerName(), and ServletRequest.getServerPort().

Parameters:

authority - the authority host (and optional port), or null to reset to default behavior

dump

public String dump()

Specified by:

dump in interface Dumpable

dump

public void dump(Appendable out,
 String indent)
          throws IOException

Description copied from interface: Dumpable

Dump this object (and children) into an Appendable using the provided indent after any new lines. The indent should not be applied to the first object dumped.

Specified by:

dump in interface Dumpable

Parameters:

out - The appendable to dump to

indent - The indent to apply after any new lines.

Throws:

IOException - if unable to write to Appendable

toString

public String toString()

Overrides:

toString in class Object