Http (Payara Project 5.193 API)

All Superinterfaces:

ConfigBeanProxy, PropertyBag
```
public interface Http
extends ConfigBeanProxy, PropertyBag
```
Created Jan 8, 2009

Author:

Justin Lee

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class Http.Duck

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Http.Duck`

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`ALLOW_PAYLOAD_FOR_UNDEFINED_HTTP_METHODS`
`static boolean`	`AUTH_PASS_THROUGH_ENABLED`
`static boolean`	`CHUNKING_ENABLED`
`static boolean`	`COMET_SUPPORT_ENABLED`
`static String`	`COMPRESSABLE_MIME_TYPE`
`static String`	`COMPRESSION`
`static int`	`COMPRESSION_MIN_SIZE`
`static String`	`COMPRESSION_PATTERN`
`static int`	`CONNECTION_UPLOAD_TIMEOUT`
`static String`	`DEFAULT_ADAPTER`
`static boolean`	`DNS_LOOKUP_ENABLED`
`static boolean`	`ENCODED_SLASH_ENABLED`
`static int`	`HEADER_BUFFER_LENGTH`
`static int`	`HTTP2_CLEAN_FREQUENCY_CHECK`
`static float`	`HTTP2_CLEAN_PERCENTAGE`
`static boolean`	`HTTP2_DISABLE_CIPHER_CHECK`
`static boolean`	`HTTP2_ENABLED`
`static int`	`HTTP2_INITIAL_WINDOW_SIZE_IN_BYTES`
`static int`	`HTTP2_MAX_CONCURRENT_STREAMS`
`static int`	`HTTP2_MAX_FRAME_PAYLOAD_SIZE_IN_BYTES`
`static int`	`HTTP2_MAX_HEADER_LIST_SIZE_IN_BYTES`
`static boolean`	`HTTP2_PUSH_ENABLED`
`static float`	`HTTP2_STREAMS_HIGH_WATER_MARK`
`static int`	`KEEP_ALIVE_TIMEOUT`
`static int`	`MAX_CONNECTIONS`
`static int`	`MAX_FORM_POST_SIZE`
`static int`	`MAX_HEADERS`
`static int`	`MAX_POST_SIZE`
`static int`	`MAX_REQUEST_PARAMETERS`
`static int`	`MAX_SAVE_POST_SIZE`
`static long`	`MAX_SWALLOWING_INPUT_BYTES`
`static boolean`	`RCM_SUPPORT_ENABLED`
`static int`	`REQUEST_TIMEOUT`
`static String`	`SCHEME_PATTERN`
`static int`	`SEND_BUFFER_LENGTH`
`static boolean`	`SERVER_HEADER`
`static int`	`TIMEOUT`
`static boolean`	`TIMEOUT_ENABLED`
`static boolean`	`TRACE_ENABLED`
`static boolean`	`UPLOAD_TIMEOUT_ENABLED`
`static String`	`URI_ENCODING`
`static boolean`	`WEBSOCKET_SUPPORT_ENABLED`
`static int`	`WEBSOCKETS_TIMEOUT`
`static boolean`	`XFRAME_OPTIONS`
`static boolean`	`XPOWERED_BY`

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`String`	`getAdapter()`
`String`	`getAllowPayloadForUndefinedHttpMethods()`
`String`	`getAuthPassThroughEnabled()` Enable pass through of authentication from any front-end server
`String`	`getChunkingEnabled()`
`String`	`getCometSupportEnabled()` Enable comet support for this http instance.
`String`	`getCompressableMimeType()`
`@Pattern(regexp="on\|off\|force\|\\d+") String`	`getCompression()`
`String`	`getCompressionMinSizeBytes()`
`String`	`getConnectionUploadTimeoutMillis()`
`String`	`getDefaultResponseType()` Setting the default response-type.
`String`	`getDefaultVirtualServer()` The id attribute of the default virtual server for this particular connection group.
`String`	`getDnsLookupEnabled()`
`String`	`getEncodedSlashEnabled()`
`@NotNull FileCache`	`getFileCache()` Gets the value of the fileCache property.
`String`	`getForcedResponseType()` Deprecated.
`String`	`getHeaderBufferLengthBytes()` The size of the buffer used by the request processing threads for reading the request data
`String`	`getHttp2CleanFrequencyCheck()` The number of streams that must be closed before checking if the number of streams exceeds the `HTTP2_STREAMS_HIGH_WATER_MARK`.
`@Pattern(regexp="[01](?:(?=\\.)\\.\\d+f?\|f?)",message="Must be a valid float between 0 and 1") String`	`getHttp2CleanPercentage()` The number of streams to process when the `HTTP2_STREAMS_HIGH_WATER_MARK` is exceeded.
`String`	`getHttp2DisableCipherCheck()` Controls whether or not insecure cipher suites are allowed to establish TLS connections.
`String`	`getHttp2Enabled()` Controls whether or not HTTP/2 is enabled.
`String`	`getHttp2InitialWindowSizeInBytes()` Configures the initial window size in bytes.
`String`	`getHttp2MaxConcurrentStreams()` Configures the number of concurrent streams allowed per HTTP2 connection.
`String`	`getHttp2MaxFramePayloadSizeInBytes()` Configures the maximum size of the HTTP2 frame payload to be accepted.
`String`	`getHttp2MaxHeaderListSizeInBytes()` Configures the maximum size, in bytes, of the header list.
`String`	`getHttp2PushEnabled()` Controls whether or not push is allowed by the server endpoints.
`@Pattern(regexp="[01](?:(?=\\.)\\.\\d+f?\|f?)",message="Must be a valid float between 0 and 1") String`	`getHttp2StreamsHighWaterMark()` Streams are periodically cleaned when the stream count exceeds this value, as a proportion of the `HTTP2_MAX_CONCURRENT_STREAMS`.
`String`	`getJkConfigurationFile()`
`String`	`getJkEnabled()` If true, a jk listener is enabled
`String`	`getMaxConnections()` Max number of connection in the Keep Alive mode
`String`	`getMaxFormPostSizeBytes()`
`String`	`getMaxPostSizeBytes()`
`String`	`getMaxRequestHeaders()` Returns the maximum number of headers allowed for a request.
`String`	`getMaxRequestParameters()` Returns the maximum number of parameters allowed per request.
`String`	`getMaxResponseHeaders()` Returns the maximum number of headers allowed for a response.
`String`	`getMaxSavePostSizeBytes()`
`String`	`getMaxSwallowingInputBytes()`
`String`	`getNoCompressionUserAgents()`
`Protocol`	`getParent()` Returns the parent element of this configuration element.
`String`	`getRcmSupportEnabled()` Deprecated.
`String`	`getRedirectPort()` if the connector is supporting non-SSL requests and a request is received for which a matching security-constraint requires SSL transport catalina will automatically redirect the request to the port number specified here
`String`	`getRemoteUserMapping()` Returns the HTTP request header name, whose value (if non-null) would be used to set the name of the remote user that has been authenticated for HTTP Request.
`String`	`getRequestTimeoutSeconds()` Time after which the request times out in seconds
`String`	`getRestrictedUserAgents()`
`@Pattern(regexp="http\|https") String`	`getScheme()` The HTTP scheme (http or https) to override HTTP request scheme picked up by Grizzly or web-container during HTTP request processing.
`String`	`getSchemeMapping()` Returns the HTTP request header name, whose value (if non-null) would be used to override default protocol scheme picked up by framework during request processing.
`String`	`getSendBufferSizeBytes()` Size of the buffer for response bodies in bytes
`String`	`getServerHeader()`
`String`	`getServerName()` Tells the server what to put in the host name section of any URLs it sends to the client.
`String`	`getTimeoutSeconds()` Keep Alive timeout, max time a connection can be deemed as idle and kept in the keep-alive state
`String`	`getTraceEnabled()`
`String`	`getUploadTimeoutEnabled()`
`String`	`getUriEncoding()`
`String`	`getWebsocketsSupportEnabled()`
`String`	`getWebsocketsTimeoutSeconds()` Max time a connection may be idle before being closed.
`String`	`getXframeOptions()`
`String`	`getXpoweredBy()` The Servlet 2.4 spec defines a special X-Powered-By: Servlet/2.4 header, which containers may add to servlet-generated responses.
`void`	`setAdapter(String adapter)`
`void`	`setAllowPayloadForUndefinedHttpMethods(String allowPayloadForUndefinedHttpMethods)`
`void`	`setAuthPassThroughEnabled(String bool)`
`void`	`setChunkingEnabled(String enabled)`
`void`	`setCometSupportEnabled(String enable)`
`void`	`setCompressableMimeType(String type)`
`void`	`setCompression(String compression)`
`void`	`setCompressionMinSizeBytes(String size)`
`void`	`setConnectionUploadTimeoutMillis(String timeout)`
`void`	`setDefaultResponseType(String defaultResponseType)`
`void`	`setDefaultVirtualServer(String defaultVirtualServer)`
`void`	`setDnsLookupEnabled(String enable)`
`void`	`setEncodedSlashEnabled(String enabled)`
`void`	`setFileCache(FileCache value)`
`void`	`setForcedResponseType(String forcedResponseType)` Deprecated.
`void`	`setHeaderBufferLengthBytes(String length)`
`void`	`setHttp2CleanFrequencyCheck(String cleanFrequencyCheck)`
`void`	`setHttp2CleanPercentage(String cleanPercentage)`
`void`	`setHttp2DisableCipherCheck(String disableCipherCheck)`
`void`	`setHttp2Enabled(String http2Enabled)`
`void`	`setHttp2InitialWindowSizeInBytes(String initialWindowSizeInBytes)`
`void`	`setHttp2MaxConcurrentStreams(String maxConcurrentStreams)`
`void`	`setHttp2MaxFramePayloadSizeInBytes(String maxFramePayloadSizeInBytes)`
`void`	`setHttp2MaxHeaderListSizeInBytes(String maxHeaderListSizeInBytes)`
`void`	`setHttp2PushEnabled(String pushEnabled)`
`void`	`setHttp2StreamsHighWaterMark(String streamsHighWaterMark)`
`void`	`setJkConfigurationFile(String file)`
`void`	`setJkEnabled(String enabled)`
`void`	`setMaxConnections(String max)`
`void`	`setMaxFormPostSizeBytes(String max)`
`void`	`setMaxPostSizeBytes(String max)`
`void`	`setMaxRequestHeaders(String maxRequestHeaders)`
`void`	`setMaxRequestParameters()` Sets the maximum number of parameters allowed for a request.
`void`	`setMaxResponseHeaders(String maxRequestHeaders)`
`void`	`setMaxSavePostSizeBytes(String max)`
`void`	`setMaxSwallowingInputBytes(String max)`
`void`	`setNoCompressionUserAgents(String agents)`
`void`	`setRcmSupportEnabled(String enable)`
`void`	`setRedirectPort(String redirectPort)`
`void`	`setRemoteUserMapping(String remoteUserMapping)`
`void`	`setRequestTimeoutSeconds(String timeout)`
`void`	`setRestrictedUserAgents(String agents)`
`void`	`setScheme(String scheme)`
`void`	`setSchemeMapping(String schemeMapping)`
`void`	`setSendBufferSizeBytes(String size)`
`void`	`setServerHeader(String serverHeader)`
`void`	`setServerName(String serverName)`
`void`	`setTimeoutSeconds(String timeout)`
`void`	`setTraceEnabled(String enabled)`
`void`	`setUploadTimeoutEnabled(String disable)`
`void`	`setUriEncoding(String encoding)`
`void`	`setWebsocketsSupportEnabled(String enabled)`
`void`	`setWebsocketsTimeoutSeconds(String timeout)`
`void`	`setXframeOptions(String xframeOptions)`
`void`	`setXpoweredBy(String xpoweredBy)`

Methods inherited from interface org.jvnet.hk2.config.ConfigBeanProxy
createChild, deepCopy, getParent

Methods inherited from interface org.jvnet.hk2.config.types.PropertyBag
addProperty, getProperty, getProperty, getPropertyValue, getPropertyValue, lookupProperty, removeProperty, removeProperty

- Field Detail
  - AUTH_PASS_THROUGH_ENABLED
```
static final boolean AUTH_PASS_THROUGH_ENABLED
```
    See Also:
    
    Constant Field Values
  - CHUNKING_ENABLED
```
static final boolean CHUNKING_ENABLED
```
    See Also:
    
    Constant Field Values
  - COMET_SUPPORT_ENABLED
```
static final boolean COMET_SUPPORT_ENABLED
```
    See Also:
    
    Constant Field Values
  - ENCODED_SLASH_ENABLED
```
static final boolean ENCODED_SLASH_ENABLED
```
    See Also:
    
    Constant Field Values
  - DNS_LOOKUP_ENABLED
```
static final boolean DNS_LOOKUP_ENABLED
```
    See Also:
    
    Constant Field Values
  - RCM_SUPPORT_ENABLED
```
static final boolean RCM_SUPPORT_ENABLED
```
    See Also:
    
    Constant Field Values
  - TIMEOUT_ENABLED
```
static final boolean TIMEOUT_ENABLED
```
    See Also:
    
    Constant Field Values
  - TRACE_ENABLED
```
static final boolean TRACE_ENABLED
```
    See Also:
    
    Constant Field Values
  - UPLOAD_TIMEOUT_ENABLED
```
static final boolean UPLOAD_TIMEOUT_ENABLED
```
    See Also:
    
    Constant Field Values
  - WEBSOCKET_SUPPORT_ENABLED
```
static final boolean WEBSOCKET_SUPPORT_ENABLED
```
    See Also:
    
    Constant Field Values
  - XPOWERED_BY
```
static final boolean XPOWERED_BY
```
    See Also:
    
    Constant Field Values
  - SERVER_HEADER
```
static final boolean SERVER_HEADER
```
    See Also:
    
    Constant Field Values
  - XFRAME_OPTIONS
```
static final boolean XFRAME_OPTIONS
```
    See Also:
    
    Constant Field Values
  - ALLOW_PAYLOAD_FOR_UNDEFINED_HTTP_METHODS
```
static final boolean ALLOW_PAYLOAD_FOR_UNDEFINED_HTTP_METHODS
```
    See Also:
    
    Constant Field Values
  - COMPRESSION_MIN_SIZE
```
static final int COMPRESSION_MIN_SIZE
```
    See Also:
    
    Constant Field Values
  - CONNECTION_UPLOAD_TIMEOUT
```
static final int CONNECTION_UPLOAD_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - HEADER_BUFFER_LENGTH
```
static final int HEADER_BUFFER_LENGTH
```
    See Also:
    
    Constant Field Values
  - KEEP_ALIVE_TIMEOUT
```
static final int KEEP_ALIVE_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - MAX_CONNECTIONS
```
static final int MAX_CONNECTIONS
```
    See Also:
    
    Constant Field Values
  - MAX_POST_SIZE
```
static final int MAX_POST_SIZE
```
    See Also:
    
    Constant Field Values
  - MAX_FORM_POST_SIZE
```
static final int MAX_FORM_POST_SIZE
```
    See Also:
    
    Constant Field Values
  - MAX_SAVE_POST_SIZE
```
static final int MAX_SAVE_POST_SIZE
```
    See Also:
    
    Constant Field Values
  - MAX_SWALLOWING_INPUT_BYTES
```
static final long MAX_SWALLOWING_INPUT_BYTES
```
    See Also:
    
    Constant Field Values
  - REQUEST_TIMEOUT
```
static final int REQUEST_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - SEND_BUFFER_LENGTH
```
static final int SEND_BUFFER_LENGTH
```
    See Also:
    
    Constant Field Values
  - TIMEOUT
```
static final int TIMEOUT
```
    See Also:
    
    Constant Field Values
  - WEBSOCKETS_TIMEOUT
```
static final int WEBSOCKETS_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - MAX_REQUEST_PARAMETERS
```
static final int MAX_REQUEST_PARAMETERS
```
    See Also:
    
    Constant Field Values
  - MAX_HEADERS
```
static final int MAX_HEADERS
```
    See Also:
    
    Constant Field Values
  - COMPRESSABLE_MIME_TYPE
```
static final String COMPRESSABLE_MIME_TYPE
```
    See Also:
    
    Constant Field Values
  - COMPRESSION
```
static final String COMPRESSION
```
    See Also:
    
    Constant Field Values
  - COMPRESSION_PATTERN
```
static final String COMPRESSION_PATTERN
```
    See Also:
    
    Constant Field Values
  - DEFAULT_ADAPTER
```
static final String DEFAULT_ADAPTER
```
    See Also:
    
    Constant Field Values
  - URI_ENCODING
```
static final String URI_ENCODING
```
    See Also:
    
    Constant Field Values
  - SCHEME_PATTERN
```
static final String SCHEME_PATTERN
```
    See Also:
    
    Constant Field Values
  - HTTP2_ENABLED
```
static final boolean HTTP2_ENABLED
```
    See Also:
    
    Constant Field Values
  - HTTP2_MAX_CONCURRENT_STREAMS
```
static final int HTTP2_MAX_CONCURRENT_STREAMS
```
    See Also:
    
    Constant Field Values
  - HTTP2_INITIAL_WINDOW_SIZE_IN_BYTES
```
static final int HTTP2_INITIAL_WINDOW_SIZE_IN_BYTES
```
    See Also:
    
    Constant Field Values
  - HTTP2_MAX_FRAME_PAYLOAD_SIZE_IN_BYTES
```
static final int HTTP2_MAX_FRAME_PAYLOAD_SIZE_IN_BYTES
```
    See Also:
    
    Constant Field Values
  - HTTP2_MAX_HEADER_LIST_SIZE_IN_BYTES
```
static final int HTTP2_MAX_HEADER_LIST_SIZE_IN_BYTES
```
    See Also:
    
    Constant Field Values
  - HTTP2_STREAMS_HIGH_WATER_MARK
```
static final float HTTP2_STREAMS_HIGH_WATER_MARK
```
    See Also:
    
    Constant Field Values
  - HTTP2_CLEAN_PERCENTAGE
```
static final float HTTP2_CLEAN_PERCENTAGE
```
    See Also:
    
    Constant Field Values
  - HTTP2_CLEAN_FREQUENCY_CHECK
```
static final int HTTP2_CLEAN_FREQUENCY_CHECK
```
    See Also:
    
    Constant Field Values
  - HTTP2_DISABLE_CIPHER_CHECK
```
static final boolean HTTP2_DISABLE_CIPHER_CHECK
```
    See Also:
    
    Constant Field Values
  - HTTP2_PUSH_ENABLED
```
static final boolean HTTP2_PUSH_ENABLED
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getAdapter
```
String getAdapter()
```
  - setAdapter
```
void setAdapter(String adapter)
```
  - getAuthPassThroughEnabled
```
String getAuthPassThroughEnabled()
```
    Enable pass through of authentication from any front-end server
  - setAuthPassThroughEnabled
```
void setAuthPassThroughEnabled(String bool)
```
  - getChunkingEnabled
```
String getChunkingEnabled()
```
  - setChunkingEnabled
```
void setChunkingEnabled(String enabled)
```
  - getCometSupportEnabled
```
String getCometSupportEnabled()
```
    Enable comet support for this http instance. The default for this is false until enabling comet support but not using it can be verified as harmless. Currently it is unclear what the performance impact of enabling this feature is.
  - setCometSupportEnabled
```
void setCometSupportEnabled(String enable)
```
  - getCompressableMimeType
```
String getCompressableMimeType()
```
  - setCompressableMimeType
```
void setCompressableMimeType(String type)
```
  - getCompression
```
@Pattern(regexp="on|off|force|\\d+")
@Pattern(regexp="on|off|force|\\d+") String getCompression()
```
  - setCompression
```
void setCompression(String compression)
```
  - getCompressionMinSizeBytes
```
String getCompressionMinSizeBytes()
```
  - setCompressionMinSizeBytes
```
void setCompressionMinSizeBytes(String size)
```
  - getConnectionUploadTimeoutMillis
```
String getConnectionUploadTimeoutMillis()
```
  - setConnectionUploadTimeoutMillis
```
void setConnectionUploadTimeoutMillis(String timeout)
```
  - getDefaultResponseType
```
String getDefaultResponseType()
```
    Setting the default response-type. Specified as a semi-colon delimited string consisting of content-type, encoding, language, charset
  - setDefaultResponseType
```
void setDefaultResponseType(String defaultResponseType)
```
  - getDefaultVirtualServer
```
String getDefaultVirtualServer()
```
    The id attribute of the default virtual server for this particular connection group.
  - setDefaultVirtualServer
```
void setDefaultVirtualServer(String defaultVirtualServer)
```
  - getDnsLookupEnabled
```
String getDnsLookupEnabled()
```
  - setDnsLookupEnabled
```
void setDnsLookupEnabled(String enable)
```
  - getEncodedSlashEnabled
```
String getEncodedSlashEnabled()
```
  - setEncodedSlashEnabled
```
void setEncodedSlashEnabled(String enabled)
```
  - getFileCache
```
@NotNull
@NotNull FileCache getFileCache()
```
    Gets the value of the fileCache property.
  - setFileCache
```
void setFileCache(FileCache value)
```
  - getForcedResponseType
```
@Deprecated
String getForcedResponseType()
```
    Deprecated.
    
    The response type to be forced if the content served cannot be matched by any of the MIME mappings for extensions. Specified as a semi-colon delimited string consisting of content-type, encoding, language, charset
  - setForcedResponseType
```
@Deprecated
void setForcedResponseType(String forcedResponseType)
```
    Deprecated.
  - getHeaderBufferLengthBytes
```
String getHeaderBufferLengthBytes()
```
    The size of the buffer used by the request processing threads for reading the request data
  - setHeaderBufferLengthBytes
```
void setHeaderBufferLengthBytes(String length)
```
  - getMaxConnections
```
String getMaxConnections()
```
    Max number of connection in the Keep Alive mode
  - setMaxConnections
```
void setMaxConnections(String max)
```
  - getMaxFormPostSizeBytes
```
String getMaxFormPostSizeBytes()
```
  - setMaxFormPostSizeBytes
```
void setMaxFormPostSizeBytes(String max)
```
  - getMaxPostSizeBytes
```
String getMaxPostSizeBytes()
```
  - setMaxPostSizeBytes
```
void setMaxPostSizeBytes(String max)
```
  - getMaxSavePostSizeBytes
```
String getMaxSavePostSizeBytes()
```
  - setMaxSavePostSizeBytes
```
void setMaxSavePostSizeBytes(String max)
```
  - getMaxSwallowingInputBytes
```
String getMaxSwallowingInputBytes()
```
  - setMaxSwallowingInputBytes
```
void setMaxSwallowingInputBytes(String max)
```
  - getNoCompressionUserAgents
```
String getNoCompressionUserAgents()
```
  - setNoCompressionUserAgents
```
void setNoCompressionUserAgents(String agents)
```
  - getRcmSupportEnabled
```
@Deprecated
String getRcmSupportEnabled()
```
    Deprecated.
  - setRcmSupportEnabled
```
void setRcmSupportEnabled(String enable)
```
  - getRedirectPort
```
@Range(min=0,
       max=65535)
String getRedirectPort()
```
    if the connector is supporting non-SSL requests and a request is received for which a matching security-constraint requires SSL transport catalina will automatically redirect the request to the port number specified here
  - setRedirectPort
```
void setRedirectPort(String redirectPort)
```
  - getRequestTimeoutSeconds
```
String getRequestTimeoutSeconds()
```
    Time after which the request times out in seconds
  - setRequestTimeoutSeconds
```
void setRequestTimeoutSeconds(String timeout)
```
  - getRestrictedUserAgents
```
String getRestrictedUserAgents()
```
  - setRestrictedUserAgents
```
void setRestrictedUserAgents(String agents)
```
  - getSendBufferSizeBytes
```
String getSendBufferSizeBytes()
```
    Size of the buffer for response bodies in bytes
  - setSendBufferSizeBytes
```
void setSendBufferSizeBytes(String size)
```
  - getServerName
```
String getServerName()
```
    Tells the server what to put in the host name section of any URLs it sends to the client. This affects URLs the server automatically generates; it doesn't affect the URLs for directories and files stored in the server. This name should be the alias name if your server uses an alias. If you append a colon and port number, that port will be used in URLs the server sends to the client.
  - setServerName
```
void setServerName(String serverName)
```
  - getTimeoutSeconds
```
String getTimeoutSeconds()
```
    Keep Alive timeout, max time a connection can be deemed as idle and kept in the keep-alive state
  - setTimeoutSeconds
```
void setTimeoutSeconds(String timeout)
```
  - getWebsocketsTimeoutSeconds
```
String getWebsocketsTimeoutSeconds()
```
    Max time a connection may be idle before being closed.
    
    Since:
    
    2.1.5
  - setWebsocketsTimeoutSeconds
```
void setWebsocketsTimeoutSeconds(String timeout)
```
  - getTraceEnabled
```
String getTraceEnabled()
```
  - setTraceEnabled
```
void setTraceEnabled(String enabled)
```
  - getUploadTimeoutEnabled
```
String getUploadTimeoutEnabled()
```
  - setUploadTimeoutEnabled
```
void setUploadTimeoutEnabled(String disable)
```
  - getUriEncoding
```
String getUriEncoding()
```
  - setUriEncoding
```
void setUriEncoding(String encoding)
```
  - getScheme
```
@Pattern(regexp="http|https")
@Pattern(regexp="http|https") String getScheme()
```
    The HTTP scheme (http or https) to override HTTP request scheme picked up by Grizzly or web-container during HTTP request processing.
  - setScheme
```
void setScheme(String scheme)
```
  - getSchemeMapping
```
String getSchemeMapping()
```
    Returns the HTTP request header name, whose value (if non-null) would be used to override default protocol scheme picked up by framework during request processing.
  - setSchemeMapping
```
void setSchemeMapping(String schemeMapping)
```
  - getRemoteUserMapping
```
String getRemoteUserMapping()
```
    Returns the HTTP request header name, whose value (if non-null) would be used to set the name of the remote user that has been authenticated for HTTP Request.
  - setRemoteUserMapping
```
void setRemoteUserMapping(String remoteUserMapping)
```
  - getWebsocketsSupportEnabled
```
String getWebsocketsSupportEnabled()
```
  - setWebsocketsSupportEnabled
```
void setWebsocketsSupportEnabled(String enabled)
```
  - getJkConfigurationFile
```
String getJkConfigurationFile()
```
  - setJkConfigurationFile
```
void setJkConfigurationFile(String file)
```
  - getJkEnabled
```
String getJkEnabled()
```
    If true, a jk listener is enabled
  - setJkEnabled
```
void setJkEnabled(String enabled)
```
  - getMaxRequestParameters
```
String getMaxRequestParameters()
```
    Returns the maximum number of parameters allowed per request. If the value less than zero, then there will be no limit on parameters. If not explicitly configured, this returns 10000.
    
    Returns:
    
    the maximum number of parameters or 10000 if not explicitly configured.
    
    Since:
    
    2.2.8
  - setMaxRequestParameters
```
void setMaxRequestParameters()
```
    Sets the maximum number of parameters allowed for a request. If the value is zero or less, then there will be no limit on parameters.
    
    Since:
    
    2.2.8
  - getMaxRequestHeaders
```
String getMaxRequestHeaders()
```
    Returns the maximum number of headers allowed for a request.
    
    Since:
    
    2.2.11
  - setMaxRequestHeaders
```
void setMaxRequestHeaders(String maxRequestHeaders)
```
  - getMaxResponseHeaders
```
String getMaxResponseHeaders()
```
    Returns the maximum number of headers allowed for a response.
    
    Since:
    
    2.2.11
  - setMaxResponseHeaders
```
void setMaxResponseHeaders(String maxRequestHeaders)
```
  - getXpoweredBy
```
String getXpoweredBy()
```
    The Servlet 2.4 spec defines a special X-Powered-By: Servlet/2.4 header, which containers may add to servlet-generated responses. This is complemented by the JSP 2.0 spec, which defines a X-Powered-By: JSP/2.0 header to be added (on an optional basis) to responses utilizing JSP technology. The goal of these headers is to aid in gathering statistical data about the use of Servlet and JSP technology. If true, these headers will be added.
  - setXpoweredBy
```
void setXpoweredBy(String xpoweredBy)
```
  - getServerHeader
```
String getServerHeader()
```
  - setServerHeader
```
void setServerHeader(String serverHeader)
```
  - getXframeOptions
```
String getXframeOptions()
```
  - setXframeOptions
```
void setXframeOptions(String xframeOptions)
```
  - getAllowPayloadForUndefinedHttpMethods
```
String getAllowPayloadForUndefinedHttpMethods()
```
    Returns:
    
    true, if payload will be allowed for HTTP methods, for which spec doesn't state explicitly if payload allowed or not.
    
    Since:
    
    4.2
  - setAllowPayloadForUndefinedHttpMethods
```
void setAllowPayloadForUndefinedHttpMethods(String allowPayloadForUndefinedHttpMethods)
```
  - getHttp2Enabled
```
String getHttp2Enabled()
```
    Controls whether or not HTTP/2 is enabled. The default is true.
    
    Returns:
  - setHttp2Enabled
```
void setHttp2Enabled(String http2Enabled)
```
  - getHttp2MaxConcurrentStreams
```
String getHttp2MaxConcurrentStreams()
```
    Configures the number of concurrent streams allowed per HTTP2 connection. The default is 100.
  - setHttp2MaxConcurrentStreams
```
void setHttp2MaxConcurrentStreams(String maxConcurrentStreams)
```
  - getHttp2InitialWindowSizeInBytes
```
String getHttp2InitialWindowSizeInBytes()
```
    Configures the initial window size in bytes. The default is 64K - 1.
  - setHttp2InitialWindowSizeInBytes
```
void setHttp2InitialWindowSizeInBytes(String initialWindowSizeInBytes)
```
  - getHttp2MaxFramePayloadSizeInBytes
```
String getHttp2MaxFramePayloadSizeInBytes()
```
    Configures the maximum size of the HTTP2 frame payload to be accepted. The default is 2^24 - 1.
  - setHttp2MaxFramePayloadSizeInBytes
```
void setHttp2MaxFramePayloadSizeInBytes(String maxFramePayloadSizeInBytes)
```
  - getHttp2MaxHeaderListSizeInBytes
```
String getHttp2MaxHeaderListSizeInBytes()
```
    Configures the maximum size, in bytes, of the header list. The default is 4096.
  - setHttp2MaxHeaderListSizeInBytes
```
void setHttp2MaxHeaderListSizeInBytes(String maxHeaderListSizeInBytes)
```
  - getHttp2StreamsHighWaterMark
```
@Pattern(regexp="[01](?:(?=\\.)\\.\\d+f?|f?)",
         message="Must be a valid float between 0 and 1")
@Pattern(regexp="[01](?:(?=\\.)\\.\\d+f?|f?)",message="Must be a valid float between 0 and 1") String getHttp2StreamsHighWaterMark()
```
    Streams are periodically cleaned when the stream count exceeds this value, as a proportion of the HTTP2_MAX_CONCURRENT_STREAMS. The default is 0.5.
  - setHttp2StreamsHighWaterMark
```
void setHttp2StreamsHighWaterMark(String streamsHighWaterMark)
```
  - getHttp2CleanPercentage
```
@Pattern(regexp="[01](?:(?=\\.)\\.\\d+f?|f?)",
         message="Must be a valid float between 0 and 1")
@Pattern(regexp="[01](?:(?=\\.)\\.\\d+f?|f?)",message="Must be a valid float between 0 and 1") String getHttp2CleanPercentage()
```
    The number of streams to process when the HTTP2_STREAMS_HIGH_WATER_MARK is exceeded. Only closed streams will be removed. The default is 0.5.
  - setHttp2CleanPercentage
```
void setHttp2CleanPercentage(String cleanPercentage)
```
  - getHttp2CleanFrequencyCheck
```
String getHttp2CleanFrequencyCheck()
```
    The number of streams that must be closed before checking if the number of streams exceeds the HTTP2_STREAMS_HIGH_WATER_MARK. The default is 50.
  - setHttp2CleanFrequencyCheck
```
void setHttp2CleanFrequencyCheck(String cleanFrequencyCheck)
```
  - getHttp2DisableCipherCheck
```
String getHttp2DisableCipherCheck()
```
    Controls whether or not insecure cipher suites are allowed to establish TLS connections. The default is false.
  - setHttp2DisableCipherCheck
```
void setHttp2DisableCipherCheck(String disableCipherCheck)
```
  - getHttp2PushEnabled
```
String getHttp2PushEnabled()
```
    Controls whether or not push is allowed by the server endpoints. The default is true.
  - setHttp2PushEnabled
```
void setHttp2PushEnabled(String pushEnabled)
```
  - getParent
```
@DuckTyped
Protocol getParent()
```
    Description copied from interface: ConfigBeanProxy
    
    Returns the parent element of this configuration element. It is possible to return a not null parent while the parent knows nothing of this child element. This could happen when the child element was removed from the configuration tree, yet it's parent would not have been reset.
    
    Specified by:
    
    getParent in interface ConfigBeanProxy
    
    Returns:
    
    the parent configuration node.

Interface Http

Nested Class Summary

Field Summary

Method Summary

Methods inherited from interface org.jvnet.hk2.config.ConfigBeanProxy

Methods inherited from interface org.jvnet.hk2.config.types.PropertyBag

Field Detail

AUTH_PASS_THROUGH_ENABLED

CHUNKING_ENABLED

COMET_SUPPORT_ENABLED

ENCODED_SLASH_ENABLED

DNS_LOOKUP_ENABLED

RCM_SUPPORT_ENABLED

TIMEOUT_ENABLED

TRACE_ENABLED

UPLOAD_TIMEOUT_ENABLED

WEBSOCKET_SUPPORT_ENABLED

XPOWERED_BY

SERVER_HEADER

XFRAME_OPTIONS

ALLOW_PAYLOAD_FOR_UNDEFINED_HTTP_METHODS

COMPRESSION_MIN_SIZE

CONNECTION_UPLOAD_TIMEOUT

HEADER_BUFFER_LENGTH

KEEP_ALIVE_TIMEOUT

MAX_CONNECTIONS

MAX_POST_SIZE

MAX_FORM_POST_SIZE

MAX_SAVE_POST_SIZE

MAX_SWALLOWING_INPUT_BYTES

REQUEST_TIMEOUT

SEND_BUFFER_LENGTH

TIMEOUT

WEBSOCKETS_TIMEOUT

MAX_REQUEST_PARAMETERS

MAX_HEADERS

COMPRESSABLE_MIME_TYPE

COMPRESSION

COMPRESSION_PATTERN

DEFAULT_ADAPTER

URI_ENCODING

SCHEME_PATTERN

HTTP2_ENABLED

HTTP2_MAX_CONCURRENT_STREAMS

HTTP2_INITIAL_WINDOW_SIZE_IN_BYTES

HTTP2_MAX_FRAME_PAYLOAD_SIZE_IN_BYTES

HTTP2_MAX_HEADER_LIST_SIZE_IN_BYTES

HTTP2_STREAMS_HIGH_WATER_MARK

HTTP2_CLEAN_PERCENTAGE

HTTP2_CLEAN_FREQUENCY_CHECK

HTTP2_DISABLE_CIPHER_CHECK

HTTP2_PUSH_ENABLED

Method Detail

getAdapter

setAdapter

getAuthPassThroughEnabled

setAuthPassThroughEnabled

getChunkingEnabled

setChunkingEnabled

getCometSupportEnabled

setCometSupportEnabled

getCompressableMimeType

setCompressableMimeType

getCompression

setCompression

getCompressionMinSizeBytes

setCompressionMinSizeBytes

getConnectionUploadTimeoutMillis

setConnectionUploadTimeoutMillis

getDefaultResponseType

setDefaultResponseType

getDefaultVirtualServer

setDefaultVirtualServer

getDnsLookupEnabled

setDnsLookupEnabled

getEncodedSlashEnabled

setEncodedSlashEnabled

getFileCache

setFileCache

getForcedResponseType