Class HttpConfiguration
- All Implemented Interfaces:
Dumpable
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 ClassesModifier and TypeClassDescriptionstatic interface
static interface
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
FieldsModifier and TypeFieldDescriptionprivate long
private final List
<HttpConfiguration.Customizer> private boolean
private int
private long
private int
private long
private long
private MultiPartFormDataCompliance
private boolean
private int
private int
private boolean
private boolean
private CookieCompliance
private int
private CookieCompliance
private int
private int
private String
private boolean
private boolean
private boolean
private static final Logger
static final String
-
Constructor Summary
ConstructorsConstructorDescriptionHttpConfiguration
(HttpConfiguration config) Creates a configuration from another. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addCustomizer
(HttpConfiguration.Customizer customizer) Adds aHttpConfiguration.Customizer
that is invoked for every request received.void
addFormEncodedMethod
(String method) Adds a form encoded HTTP Methoddump()
void
dump
(Appendable out, String indent) Dump this object (and children) into an Appendable using the provided indent after any new lines.long
Deprecated.Deprecated.<T> T
getCustomizer
(Class<T> type) int
long
The max idle time is applied to an HTTP request for IO operations and delayed dispatch.int
long
long
int
int
int
int
int
boolean
Indicates if theDate
header will be sent in responses.boolean
boolean
boolean
isCookieCompliance
(CookieCompliance compliance) Deprecated.boolean
boolean
isFormEncodedMethod
(String method) Tests whether the HTTP method supportsx-www-form-urlencoded
contentboolean
boolean
boolean
void
setBlockingTimeout
(long blockingTimeout) Deprecated.Replaced bysetMinResponseDataRate(long)
andsetMinRequestDataRate(long)
void
setCookieCompliance
(CookieCompliance compliance) Deprecated.void
setCustomizers
(List<HttpConfiguration.Customizer> customizers) Sets theHttpConfiguration.Customizer
s that are invoked for every request received.void
setDelayDispatchUntilContent
(boolean delay) void
setFormEncodedMethods
(String... methods) Sets the form encoded HTTP methods.void
setHeaderCacheSize
(int headerCacheSize) void
setIdleTimeout
(long timeoutMs) The max idle time is applied to an 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
setRelativeRedirectAllowed
(boolean allowed) void
setRequestCookieCompliance
(CookieCompliance cookieCompliance) void
setRequestHeaderSize
(int requestHeaderSize) Larger headers will allow for more and/or larger cookies plus larger form content encoded in a URL.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 theDate
header should be sent in responses.void
setSendServerVersion
(boolean sendServerVersion) void
setSendXPoweredBy
(boolean sendXPoweredBy) toString()
void
writePoweredBy
(Appendable out, String preamble, String postamble)
-
Field Details
-
LOG
-
SERVER_VERSION
-
_customizers
-
_formEncodedMethods
-
_outputBufferSize
private int _outputBufferSize -
_outputAggregationSize
private int _outputAggregationSize -
_requestHeaderSize
private int _requestHeaderSize -
_responseHeaderSize
private int _responseHeaderSize -
_headerCacheSize
private int _headerCacheSize -
_securePort
private int _securePort -
_idleTimeout
private long _idleTimeout -
_blockingTimeout
private long _blockingTimeout -
_secureScheme
-
_sendServerVersion
private boolean _sendServerVersion -
_sendXPoweredBy
private boolean _sendXPoweredBy -
_sendDateHeader
private boolean _sendDateHeader -
_delayDispatchUntilContent
private boolean _delayDispatchUntilContent -
_persistentConnectionsEnabled
private boolean _persistentConnectionsEnabled -
_maxErrorDispatches
private int _maxErrorDispatches -
_minRequestDataRate
private long _minRequestDataRate -
_minResponseDataRate
private long _minResponseDataRate -
_requestCookieCompliance
-
_responseCookieCompliance
-
_multiPartCompliance
-
_notifyRemoteAsyncErrors
private boolean _notifyRemoteAsyncErrors -
_relativeRedirectAllowed
private boolean _relativeRedirectAllowed
-
-
Constructor Details
-
HttpConfiguration
public HttpConfiguration() -
HttpConfiguration
Creates a configuration from another.- Parameters:
config
- The configuration to copy.
-
-
Method Details
-
addCustomizer
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 (egSecureRequestCustomizer
).- Parameters:
customizer
- A request customizer
-
getCustomizers
-
getCustomizer
-
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 an HTTP request header") 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() -
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.
-
getBlockingTimeout
@ManagedAttribute(value="Total timeout in ms for blocking I/O operations. DEPRECATED!", readonly=true) @Deprecated public long getBlockingTimeout()Deprecated.Replaced bygetMinResponseDataRate()
andgetMinRequestDataRate()
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.Replaced bysetMinResponseDataRate(long)
andsetMinRequestDataRate(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
@ManagedAttribute("Whether to send the Server header in responses") public boolean getSendServerVersion() -
writePoweredBy
- 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 theDate
header should be sent in responses.- Parameters:
sendDateHeader
- true if theDate
header should be sent in responses- See Also:
-
getSendDateHeader
@ManagedAttribute("Whether to send the Date header in responses") public boolean getSendDateHeader()Indicates if theDate
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() -
setCustomizers
Sets the
HttpConfiguration.Customizer
s that are invoked for every request received.Customizers are often used to interpret optional headers (eg
ForwardedRequestCustomizer
) or optional protocol semantics (egSecureRequestCustomizer
).- 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 of the header field cache, in terms of unique characters branches in the lookupTrie
and associated data structures.
-
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
Set the URI scheme used for CONFIDENTIAL and INTEGRAL redirections.
- Parameters:
secureScheme
- A scheme string like "https"
-
setFormEncodedMethods
Sets the form encoded HTTP methods.- Parameters:
methods
- the HTTP methods of requests that can be decoded asx-www-form-urlencoded
content to be made available via theRequest.getParameter(String)
and associated APIs
-
getFormEncodedMethods
- Returns:
- the set of HTTP methods of requests that can be decoded as
x-www-form-urlencoded
content to be made available via theRequest.getParameter(String)
and associated APIs
-
addFormEncodedMethod
Adds a form encoded HTTP Method- Parameters:
method
- the HTTP method of requests that can be decoded asx-www-form-urlencoded
content to be made available via theRequest.getParameter(String)
and associated APIs
-
isFormEncodedMethod
Tests whether the HTTP method supportsx-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 theRequest.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
-
getRequestCookieCompliance
- Returns:
- The CookieCompliance used for parsing request
Cookie
headers. - See Also:
-
getResponseCookieCompliance
- Returns:
- The CookieCompliance used for generating response
Set-Cookie
headers - See Also:
-
setRequestCookieCompliance
- Parameters:
cookieCompliance
- The CookieCompliance to use for parsing requestCookie
headers.- See Also:
-
setResponseCookieCompliance
- Parameters:
cookieCompliance
- The CookieCompliance to use for generating responseSet-Cookie
headers- See Also:
-
setCookieCompliance
Deprecated. -
getCookieCompliance
Deprecated. -
isCookieCompliance
Deprecated. -
setMultiPartFormDataCompliance
Sets the compliance level for multipart/form-data handling.- Parameters:
multiPartCompliance
- The multipart/form-data compliance level.
-
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
-
dump
-
dump
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 interfaceDumpable
- Parameters:
out
- The appendable to dump toindent
- The indent to apply after any new lines.- Throws:
IOException
- if unable to write to Appendable
-
toString
-
getMinResponseDataRate()
andgetMinRequestDataRate()