Package org.glassfish.grizzly.config.dom
Interface Http
- All Superinterfaces:
org.jvnet.hk2.config.ConfigBeanProxy,org.jvnet.hk2.config.types.PropertyBag
public interface Http
extends org.jvnet.hk2.config.ConfigBeanProxy, org.jvnet.hk2.config.types.PropertyBag
Created Jan 8, 2009
- Author:
- Justin Lee
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final booleanstatic final booleanstatic final booleanstatic final booleanstatic final Stringstatic final Stringstatic final intstatic final Stringstatic final intstatic final Stringstatic final booleanstatic final booleanstatic final booleanstatic final intstatic final booleanstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final longstatic final booleanstatic final intstatic final Stringstatic final intstatic final intstatic final booleanstatic final booleanstatic final booleanstatic final Stringstatic final Stringstatic final booleanstatic final intstatic final boolean -
Method Summary
Modifier and TypeMethodDescriptionEnable pass through of authentication from any front-end serverEnable comet support for this http instance.@Pattern(regexp="on|off|force|\\d+",message="Pattern: on|off|force|\\d+") StringSetting the default response-type.The id attribute of the default virtual server for this particular connection group.@NotNull FileCacheGets the value of the fileCache property.Deprecated.The size of the buffer used by the request processing threads for reading the request dataintConfigures the initial window size in bytes.intConfigures the number of concurrent streams allowed per HTTP2 connection.intConfigures the maximum size of the HTTP2 frame payload to be accepted.intConfigures the maximum size, in bytes, of the header list.If true, a jk listener is enabledMax number of connection in the Keep Alive modeReturns the maximum number of headers allowed for a request.Returns the maximum number of parameters allowed per request.Returns the maximum number of headers allowed for a response.Deprecated.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 hereReturns 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.Time after which the request times out in seconds@Pattern(regexp="http|https") StringThe HTTP scheme (http or https) to override HTTP request scheme picked up by Grizzly or web-container during HTTP request processing.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.Size of the buffer for response bodies in bytesTells the server what to put in the host name section of any URLs it sends to the client.Keep Alive timeout, max time a connection can be deemed as idle and kept in the keep-alive stateThe version of the HTTP protocol used by the HTTP ServiceMax time a connection may be idle before being closed.The Servlet 2.4 spec defines a special X-Powered-By: Servlet/2.4 header, which containers may add to servlet-generated responses.booleanControls whether or not insecure cipher suites are allowed to establish TLS connections.booleanControls whether or not HTTP/2 is enabled..voidsetAdapter(String adapter) voidsetAllowPayloadForUndefinedHttpMethods(String allowPayloadForUndefinedHttpMethods) voidvoidsetChunkingEnabled(String enabled) voidsetCometSupportEnabled(String enable) voidvoidsetCompression(String compression) voidvoidsetConnectionUploadTimeoutMillis(String timeout) voidsetDefaultResponseType(String defaultResponseType) voidsetDefaultVirtualServer(String defaultVirtualServer) voidsetDnsLookupEnabled(String enable) voidsetEncodedSlashEnabled(String enabled) voidsetFileCache(FileCache value) voidsetForcedResponseType(String forcedResponseType) Deprecated.voidsetHeaderBufferLengthBytes(String length) voidsetHttp2DisableCipherCheck(boolean disableCipherCheck) voidsetHttp2Enabled(boolean http2Enabled) voidsetHttp2InitialWindowSizeInBytes(int initialWindowSizeInBytes) voidsetHttp2MaxConcurrentStreams(int maxConcurrentStreams) voidsetHttp2MaxFramePayloadSizeInBytes(int maxFramePayloadSizeInBytes) voidsetHttp2MaxHeaderListSizeInBytes(int maxHeaderListSizeInBytes) voidsetJkConfigurationFile(String file) voidsetJkEnabled(String enabled) voidsetMaxConnections(String max) voidvoidvoidsetMaxRequestHeaders(String maxRequestHeaders) voidSets the maximum number of parameters allowed for a request.voidsetMaxResponseHeaders(String maxRequestHeaders) voidvoidvoidsetNoCompressionUserAgents(String agents) voidsetRcmSupportEnabled(String enable) voidsetRedirectPort(String redirectPort) voidsetRemoteUserMapping(String remoteUserMapping) voidsetRequestTimeoutSeconds(String timeout) voidsetRestrictedUserAgents(String agents) voidvoidsetSchemeMapping(String schemeMapping) voidsetSendBufferSizeBytes(String size) voidsetServerName(String serverName) voidsetTimeoutSeconds(String timeout) voidsetTraceEnabled(String enabled) voidsetUploadTimeoutEnabled(String disable) voidsetUriEncoding(String encoding) voidsetVersion(String version) voidsetWebsocketsSupportEnabled(String enabled) voidsetWebsocketsTimeoutSeconds(String timeout) voidsetXpoweredBy(String xpoweredBy) Methods inherited from interface org.jvnet.hk2.config.ConfigBeanProxy
createChild, deepCopy, getParentMethods inherited from interface org.jvnet.hk2.config.types.PropertyBag
addProperty, getProperty, getProperty, getPropertyValue, getPropertyValue, lookupProperty, removeProperty, removeProperty
-
Field Details
-
AUTH_PASS_THROUGH_ENABLED
static final boolean AUTH_PASS_THROUGH_ENABLED- See Also:
-
CHUNKING_ENABLED
static final boolean CHUNKING_ENABLED- See Also:
-
COMET_SUPPORT_ENABLED
static final boolean COMET_SUPPORT_ENABLED- See Also:
-
ENCODED_SLASH_ENABLED
static final boolean ENCODED_SLASH_ENABLED- See Also:
-
DNS_LOOKUP_ENABLED
static final boolean DNS_LOOKUP_ENABLED- See Also:
-
RCM_SUPPORT_ENABLED
static final boolean RCM_SUPPORT_ENABLED- See Also:
-
TIMEOUT_ENABLED
static final boolean TIMEOUT_ENABLED- See Also:
-
TRACE_ENABLED
static final boolean TRACE_ENABLED- See Also:
-
UPLOAD_TIMEOUT_ENABLED
static final boolean UPLOAD_TIMEOUT_ENABLED- See Also:
-
WEBSOCKET_SUPPORT_ENABLED
static final boolean WEBSOCKET_SUPPORT_ENABLED- See Also:
-
XPOWERED_BY
static final boolean XPOWERED_BY- See Also:
-
ALLOW_PAYLOAD_FOR_UNDEFINED_HTTP_METHODS
static final boolean ALLOW_PAYLOAD_FOR_UNDEFINED_HTTP_METHODS- See Also:
-
COMPRESSION_MIN_SIZE
static final int COMPRESSION_MIN_SIZE- See Also:
-
CONNECTION_UPLOAD_TIMEOUT
static final int CONNECTION_UPLOAD_TIMEOUT- See Also:
-
HEADER_BUFFER_LENGTH
static final int HEADER_BUFFER_LENGTH- See Also:
-
KEEP_ALIVE_TIMEOUT
static final int KEEP_ALIVE_TIMEOUT- See Also:
-
MAX_CONNECTIONS
static final int MAX_CONNECTIONS- See Also:
-
MAX_POST_SIZE
static final int MAX_POST_SIZE- See Also:
-
MAX_FORM_POST_SIZE
static final int MAX_FORM_POST_SIZE- See Also:
-
MAX_SAVE_POST_SIZE
static final int MAX_SAVE_POST_SIZE- See Also:
-
MAX_SWALLOWING_INPUT_BYTES
static final long MAX_SWALLOWING_INPUT_BYTES- See Also:
-
REQUEST_TIMEOUT
static final int REQUEST_TIMEOUT- See Also:
-
SEND_BUFFER_LENGTH
static final int SEND_BUFFER_LENGTH- See Also:
-
TIMEOUT
static final int TIMEOUT- See Also:
-
WEBSOCKETS_TIMEOUT
static final int WEBSOCKETS_TIMEOUT- See Also:
-
MAX_REQUEST_PARAMETERS
static final int MAX_REQUEST_PARAMETERS- See Also:
-
MAX_HEADERS
static final int MAX_HEADERS- See Also:
-
COMPRESSABLE_MIME_TYPE
- See Also:
-
COMPRESSION
- See Also:
-
COMPRESSION_PATTERN
- See Also:
-
DEFAULT_ADAPTER
- See Also:
-
URI_ENCODING
- See Also:
-
VERSION
- See Also:
-
SCHEME_PATTERN
- See Also:
-
HTTP2_ENABLED
static final boolean HTTP2_ENABLED- See Also:
-
MAX_CONCURRENT_STREAMS
static final int MAX_CONCURRENT_STREAMS- See Also:
-
INITIAL_WINDOW_SIZE_IN_BYTES
static final int INITIAL_WINDOW_SIZE_IN_BYTES- See Also:
-
MAX_FRAME_PAYLOAD_SIZE_IN_BYTES
static final int MAX_FRAME_PAYLOAD_SIZE_IN_BYTES- See Also:
-
MAX_HEADER_LIST_SIZE_IN_BYTES
static final int MAX_HEADER_LIST_SIZE_IN_BYTES- See Also:
-
DISABLE_CIPHER_CHECK
static final boolean DISABLE_CIPHER_CHECK- See Also:
-
-
Method Details
-
getAdapter
String getAdapter() -
setAdapter
-
getAuthPassThroughEnabled
String getAuthPassThroughEnabled()Enable pass through of authentication from any front-end server -
setAuthPassThroughEnabled
-
getChunkingEnabled
String getChunkingEnabled() -
setChunkingEnabled
-
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
-
getCompressableMimeType
String getCompressableMimeType() -
setCompressableMimeType
-
getCompression
@Pattern(regexp="on|off|force|\\d+", message="Pattern: on|off|force|\\d+") @Pattern(regexp="on|off|force|\\d+",message="Pattern: on|off|force|\\d+") String getCompression() -
setCompression
-
getCompressionMinSizeBytes
String getCompressionMinSizeBytes() -
setCompressionMinSizeBytes
-
getConnectionUploadTimeoutMillis
String getConnectionUploadTimeoutMillis() -
setConnectionUploadTimeoutMillis
-
getDefaultResponseType
String getDefaultResponseType()Setting the default response-type. Specified as a semi-colon delimited string consisting of content-type, encoding, language, charset -
setDefaultResponseType
-
getDefaultVirtualServer
String getDefaultVirtualServer()The id attribute of the default virtual server for this particular connection group. -
setDefaultVirtualServer
-
getDnsLookupEnabled
String getDnsLookupEnabled() -
setDnsLookupEnabled
-
getEncodedSlashEnabled
String getEncodedSlashEnabled() -
setEncodedSlashEnabled
-
getFileCache
Gets the value of the fileCache property. -
setFileCache
-
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. -
getHeaderBufferLengthBytes
String getHeaderBufferLengthBytes()The size of the buffer used by the request processing threads for reading the request data -
setHeaderBufferLengthBytes
-
getMaxConnections
String getMaxConnections()Max number of connection in the Keep Alive mode -
setMaxConnections
-
getMaxFormPostSizeBytes
String getMaxFormPostSizeBytes() -
setMaxFormPostSizeBytes
-
getMaxPostSizeBytes
String getMaxPostSizeBytes() -
setMaxPostSizeBytes
-
getMaxSavePostSizeBytes
String getMaxSavePostSizeBytes() -
setMaxSavePostSizeBytes
-
getMaxSwallowingInputBytes
String getMaxSwallowingInputBytes() -
setMaxSwallowingInputBytes
-
getNoCompressionUserAgents
String getNoCompressionUserAgents() -
setNoCompressionUserAgents
-
getRcmSupportEnabled
Deprecated. -
setRcmSupportEnabled
-
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
-
getRequestTimeoutSeconds
String getRequestTimeoutSeconds()Time after which the request times out in seconds -
setRequestTimeoutSeconds
-
getRestrictedUserAgents
String getRestrictedUserAgents() -
setRestrictedUserAgents
-
getSendBufferSizeBytes
String getSendBufferSizeBytes()Size of the buffer for response bodies in bytes -
setSendBufferSizeBytes
-
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
-
getTimeoutSeconds
String getTimeoutSeconds()Keep Alive timeout, max time a connection can be deemed as idle and kept in the keep-alive state -
setTimeoutSeconds
-
getWebsocketsTimeoutSeconds
String getWebsocketsTimeoutSeconds()Max time a connection may be idle before being closed.- Since:
- 2.1.5
-
setWebsocketsTimeoutSeconds
-
getTraceEnabled
String getTraceEnabled() -
setTraceEnabled
-
getUploadTimeoutEnabled
String getUploadTimeoutEnabled() -
setUploadTimeoutEnabled
-
getUriEncoding
String getUriEncoding() -
setUriEncoding
-
getVersion
String getVersion()The version of the HTTP protocol used by the HTTP Service -
setVersion
-
getScheme
The HTTP scheme (http or https) to override HTTP request scheme picked up by Grizzly or web-container during HTTP request processing. -
setScheme
-
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
-
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
-
getWebsocketsSupportEnabled
String getWebsocketsSupportEnabled() -
setWebsocketsSupportEnabled
-
getJkConfigurationFile
String getJkConfigurationFile() -
setJkConfigurationFile
-
getJkEnabled
String getJkEnabled()If true, a jk listener is enabled -
setJkEnabled
-
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
-
getMaxResponseHeaders
String getMaxResponseHeaders()Returns the maximum number of headers allowed for a response.- Since:
- 2.2.11
-
setMaxResponseHeaders
-
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
-
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
-
getHttp2MaxConcurrentStreams
int getHttp2MaxConcurrentStreams()Configures the number of concurrent streams allowed per HTTP2 connection. The default is 100. -
setHttp2MaxConcurrentStreams
void setHttp2MaxConcurrentStreams(int maxConcurrentStreams) -
getHttp2InitialWindowSizeInBytes
int getHttp2InitialWindowSizeInBytes()Configures the initial window size in bytes. The default is 64K - 1. -
setHttp2InitialWindowSizeInBytes
void setHttp2InitialWindowSizeInBytes(int initialWindowSizeInBytes) -
getHttp2MaxFramePayloadSizeInBytes
int getHttp2MaxFramePayloadSizeInBytes()Configures the maximum size of the HTTP2 frame payload to be accepted. The default is 2^24 - 1. -
setHttp2MaxFramePayloadSizeInBytes
void setHttp2MaxFramePayloadSizeInBytes(int maxFramePayloadSizeInBytes) -
getHttp2MaxHeaderListSizeInBytes
int getHttp2MaxHeaderListSizeInBytes()Configures the maximum size, in bytes, of the header list. -
setHttp2MaxHeaderListSizeInBytes
void setHttp2MaxHeaderListSizeInBytes(int maxHeaderListSizeInBytes) -
isHttp2DisableCipherCheck
boolean isHttp2DisableCipherCheck()Controls whether or not insecure cipher suites are allowed to establish TLS connections. -
setHttp2DisableCipherCheck
void setHttp2DisableCipherCheck(boolean disableCipherCheck) -
isHttp2Enabled
boolean isHttp2Enabled()Controls whether or not HTTP/2 is enabled.. -
setHttp2Enabled
void setHttp2Enabled(boolean http2Enabled) -
getParent
- Specified by:
getParentin interfaceorg.jvnet.hk2.config.ConfigBeanProxy
-