Core :: Server 12.0.6 · org.eclipse.jetty.server.HttpConfiguration

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

Modifier and Type	Field and Description
private final List<ComplianceViolation.Listener>	_complianceViolationListeners
private final List<HttpConfiguration.Customizer>	_customizers
private boolean	_delayDispatchUntilContent
private final Index.Mutable<Boolean>	_formEncodedMethods
private boolean	_headerCacheCaseSensitive
private int	_headerCacheSize
private HttpCompliance	_httpCompliance
private long	_idleTimeout
private SocketAddress	_localAddress
private int	_maxErrorDispatches
private int	_maxUnconsumedRequestContentReads
private long	_minRequestDataRate
private long	_minResponseDataRate
private MultiPartCompliance	_multiPartCompliance
private boolean	_notifyRemoteAsyncErrors
private int	_outputAggregationSize
private int	_outputBufferSize
private boolean	_persistentConnectionsEnabled
private boolean	_relativeRedirectAllowed
private CookieCompliance	_requestCookieCompliance
private int	_requestHeaderSize
private CookieCompliance	_responseCookieCompliance
private int	_responseHeaderSize
private int	_securePort
private String	_secureScheme
private boolean	_sendDateHeader
private boolean	_sendServerVersion
private boolean	_sendXPoweredBy
private HostPort	_serverAuthority
private UriCompliance	_uriCompliance
private boolean	_useInputDirectByteBuffers
private boolean	_useOutputDirectByteBuffers
public static final String	SERVER_VERSION

Access	Constructor and Description
public	HttpConfiguration()
public	HttpConfiguration(HttpConfiguration The configuration to copy. config) Creates a configuration from another.

Method Summary

Modifier and Type	Method and Description
public void	addComplianceViolationListener(ComplianceViolation.Listener the listener to add listener) Add a `ComplianceViolation.Listener` to the configuration
public void	addCustomizer(HttpConfiguration.Customizer A request customizer customizer) Adds a `Customizer` that is invoked for every request received.
public void	addFormEncodedMethod(String the HTTP method of requests that can be decoded as `x-www-form-urlencoded` content. method) Adds a form encoded HTTP Method
public String	dump() Overrides default org.eclipse.jetty.util.component.Dumpable.dump.
public void	dump(Appendable The appendable to dump to out, String The indent to apply after any new lines. indent) Implements org.eclipse.jetty.util.component.Dumpable.dump. Dump this object (and children) into an Appendable using the provided indent after any new lines.
public List<ComplianceViolation.Listener>	Returns: the list of configured listeners getComplianceViolationListeners() Get the list of configured `ComplianceViolation.Listener` to use.
public <T> T	getCustomizer(Class<T> type)
public List<HttpConfiguration.Customizer>	getCustomizers()
public Set<String>	Returns: the set of HTTP methods of requests that can be decoded as `x-www-form-urlencoded` content. getFormEncodedMethods()
public int	getHeaderCacheSize()
public HttpCompliance	getHttpCompliance()
public long	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. getIdleTimeout() The max idle time is applied to an HTTP request for IO operations and delayed dispatch.
public SocketAddress	Returns: Returns the connection local address override or null. getLocalAddress() Get the SocketAddress override to be reported as the local address of all connections
public int	Returns: The maximum error dispatches for a request to prevent looping on an error getMaxErrorDispatches()
public int	Returns: the maximum amount of reads for unconsumed content or -1 for unlimited. getMaxUnconsumedRequestContentReads() Gets the maximum amount of `HttpStream#read()`s that can be done by the `HttpStream` if the content is not fully consumed by the application.
public long	Returns: The minimum request data rate in bytes per second; or <=0 for no limit getMinRequestDataRate()
public long	Returns: The minimum response data rate in bytes per second; or <=0 for no limit getMinResponseDataRate()
public MultiPartCompliance	Returns: the `MultiPartCompliance` used for validating multipart form syntax. getMultiPartCompliance()
public int	getOutputAggregationSize()
public int	getOutputBufferSize()
public CookieCompliance	Returns: The CookieCompliance used for parsing request `Cookie` headers. getRequestCookieCompliance()
public int	getRequestHeaderSize()
public CookieCompliance	Returns: The CookieCompliance used for generating response `Set-Cookie` headers getResponseCookieCompliance()
public int	getResponseHeaderSize()
public int	getSecurePort()
public String	getSecureScheme()
public boolean	Returns: true by default getSendDateHeader() Indicates if the `Date` header will be sent in responses.
public boolean	getSendServerVersion()
public boolean	getSendXPoweredBy()
public HostPort	Returns: Returns the connection server authority (name/port) or null getServerAuthority() Get the Server authority override to be used if no authority is provided by a request.
public UriCompliance	getUriCompliance()
public boolean	isDelayDispatchUntilContent()
public boolean	Returns: true if requests with this method can be decoded as `x-www-form-urlencoded` content. isFormEncodedMethod(String the HTTP method method) Tests whether the HTTP method supports `x-www-form-urlencoded` content
public boolean	isHeaderCacheCaseSensitive()
public boolean	Returns: whether remote errors, when detected, are notified to async applications isNotifyRemoteAsyncErrors()
public boolean	isPersistentConnectionsEnabled()
public boolean	Returns: True if relative redirection locations are allowed isRelativeRedirectAllowed()
public boolean	isUseInputDirectByteBuffers()
public boolean	isUseOutputDirectByteBuffers()
public boolean	Returns: `true` if this list contained the specified element removeComplianceViolationListener(ComplianceViolation.Listener the listener to remove listener) Remove a `ComplianceViolation.Listener` from the configuration
public boolean	removeCustomizer(HttpConfiguration.Customizer customizer)
public void	setCustomizers(List<HttpConfiguration.Customizer> the list of customizers customizers) Sets the `Customizer`s that are invoked for every request received.
public void	setDelayDispatchUntilContent(boolean if true, delays the application dispatch until content is available (defaults to true) delay) Set if true, delays the application dispatch until content is available (defaults to true).
public void	setFormEncodedMethods(String... the HTTP methods of requests that can be decoded as `x-www-form-urlencoded` content. methods) Sets the form encoded HTTP methods.
public void	setHeaderCacheCaseSensitive(boolean headerCacheCaseSensitive)
public void	setHeaderCacheSize(int The size of the header field cache, in terms of unique characters branches in the lookup `Index.Mutable` and associated data structures. headerCacheSize)
public void	setHttpCompliance(HttpCompliance httpCompliance)
public void	setIdleTimeout(long 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. timeoutMs) The max idle time is applied to an HTTP request for IO operations and delayed dispatch.
public void	setLocalAddress(SocketAddress the address to use for host/addr/port, or null to reset to default behavior localAddress) Specify the connection local address used within application API layer when identifying the local host name/port of a connected endpoint.
public void	setMaxErrorDispatches(int The maximum error dispatches for a request to prevent looping on an error max)
public void	setMaxUnconsumedRequestContentReads(int the maximum amount of reads for unconsumed content or -1 for unlimited. maxUnconsumedRequestContentReads) Sets the maximum amount of `HttpStream#read()`s that can be done by the `HttpStream` if the content is not fully consumed by the application.
public void	setMinRequestDataRate(long The minimum request data rate in bytes per second; or <=0 for no limit bytesPerSecond)
public void	setMinResponseDataRate(long The minimum response data rate in bytes per second; or <=0 for no limit bytesPerSecond) Sets an minimum response content data rate.
public void	setMultiPartCompliance(MultiPartCompliance the `MultiPartCompliance` used for validating multipart form syntax. multiPartCompliance)
public void	setNotifyRemoteAsyncErrors(boolean whether remote errors, when detected, are notified to async applications notifyRemoteAsyncErrors) Set whether remote errors, when detected, are notified to async applications.
public void	setOutputAggregationSize(int the max write size that is aggregated outputAggregationSize) Set the max size of the response content write that is copied into the aggregate buffer.
public void	setOutputBufferSize(int buffer size in bytes. outputBufferSize) Set the size of the buffer into which response content is aggregated before being sent to the client.
public void	setPersistentConnectionsEnabled(boolean persistentConnectionsEnabled)
public void	setRelativeRedirectAllowed(boolean True if relative redirection locations are allowed allowed)
public void	setRequestCookieCompliance(CookieCompliance The CookieCompliance to use for parsing request `Cookie` headers. cookieCompliance)
public void	setRequestHeaderSize(int the maximum size in bytes of the request header requestHeaderSize) Larger headers will allow for more and/or larger cookies plus larger form content encoded in a URL.
public void	setResponseCookieCompliance(CookieCompliance The CookieCompliance to use for generating response `Set-Cookie` headers cookieCompliance)
public void	setResponseHeaderSize(int the maximum size in bytes of the response header responseHeaderSize) Larger headers will allow for more and/or larger cookies and longer HTTP headers (eg for redirection).
public void	setSecurePort(int the secure port to redirect to. securePort) Sets the TCP/IP port used for CONFIDENTIAL and INTEGRAL redirections.
public void	setSecureScheme(String A scheme string like "https" secureScheme) Set the URI scheme used for CONFIDENTIAL and INTEGRAL redirections.
public void	setSendDateHeader(boolean true if the `Date` header should be sent in responses sendDateHeader) Indicates if the `Date` header should be sent in responses.
public void	setSendServerVersion(boolean sendServerVersion)
public void	setSendXPoweredBy(boolean sendXPoweredBy)
public void	setServerAuthority(HostPort the authority host (and optional port), or null to reset to default behavior authority) Specify the connection server authority (name/port) used within application API layer when identifying the server host name/port of a connected endpoint.
public void	setUriCompliance(UriCompliance uriCompliance)
public void	setUseInputDirectByteBuffers(boolean whether to use direct ByteBuffers for reading useInputDirectByteBuffers) Set whether to use direct ByteBuffers for reading.
public void	setUseOutputDirectByteBuffers(boolean whether to use direct ByteBuffers for writing useOutputDirectByteBuffers) Set whether to use direct ByteBuffers for writing.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public void	writePoweredBy(Appendable out, String preamble, String postamble)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

public Class HttpConfiguration

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary