org.glassfish.grizzly.config.dom
Interface Http

All Superinterfaces:
org.jvnet.hk2.config.ConfigBeanProxy, org.jvnet.hk2.component.Injectable, org.jvnet.hk2.config.types.PropertyBag

public interface Http
extends org.jvnet.hk2.config.ConfigBeanProxy, org.jvnet.hk2.component.Injectable, org.jvnet.hk2.config.types.PropertyBag

Created Jan 8, 2009

Author:
Justin Lee

Nested Class Summary
static class Http.Duck
           
 
Field Summary
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 KEEP_ALIVE_TIMEOUT
           
static int MAX_CONNECTIONS
           
static int MAX_HEADERS
           
static int MAX_POST_SIZE
           
static int MAX_REQUEST_PARAMETERS
           
static boolean RCM_SUPPORT_ENABLED
           
static int REQUEST_TIMEOUT
           
static String SCHEME_PATTERN
           
static int SEND_BUFFER_LENGTH
           
static int TIMEOUT
           
static boolean TIMEOUT_ENABLED
           
static boolean TRACE_ENABLED
           
static boolean UPLOAD_TIMEOUT_ENABLED
           
static String URI_ENCODING
           
static String VERSION
           
static boolean WEBSOCKET_SUPPORT_ENABLED
           
static int WEBSOCKETS_TIMEOUT
           
static boolean XPOWERED_BY
           
 
Method Summary
 String getAdapter()
           
 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()
           
 String getCompression()
           
 String getCompressionMinSizeBytes()
           
 String getConnectionUploadTimeoutMillis()
           
 String getDefaultResponseType()
          Deprecated. 
 String getDefaultVirtualServer()
          The id attribute of the default virtual server for this particular connection group.
 String getDnsLookupEnabled()
           
 String getEncodedSlashEnabled()
           
 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 getJkConfigurationFile()
           
 String getJkEnabled()
          If true, a jk listener is enabled
 String getMaxConnections()
          Max number of connection in the Keep Alive mode
 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 getNoCompressionUserAgents()
           
 Protocol getParent()
           
 String getRcmSupportEnabled()
           
 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()
           
 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 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 getVersion()
          The version of the HTTP protocol used by the HTTP Service
 String getWebsocketsSupportEnabled()
           
 String getWebsocketsTimeoutSeconds()
          Max time a connection may be idle before being closed.
 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 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)
          Deprecated. 
 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 setJkConfigurationFile(String file)
           
 void setJkEnabled(String enabled)
           
 void setMaxConnections(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 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 setServerName(String serverName)
           
 void setTimeoutSeconds(String timeout)
           
 void setTraceEnabled(String enabled)
           
 void setUploadTimeoutEnabled(String disable)
           
 void setUriEncoding(String encoding)
           
 void setVersion(String version)
           
 void setWebsocketsSupportEnabled(String enabled)
           
 void setWebsocketsTimeoutSeconds(String timeout)
           
 void setXpoweredBy(String xpoweredBy)
           
 
Methods inherited from interface org.jvnet.hk2.config.ConfigBeanProxy
createChild, deepCopy, getParent
 
Methods inherited from interface org.jvnet.hk2.component.Injectable
injectedInto
 
Methods inherited from interface org.jvnet.hk2.config.types.PropertyBag
getProperty, getProperty, getPropertyValue, getPropertyValue
 

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

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

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

VERSION

static final String VERSION
See Also:
Constant Field Values

SCHEME_PATTERN

static final String SCHEME_PATTERN
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+")
String getCompression()

setCompression

void setCompression(String compression)

getCompressionMinSizeBytes

String getCompressionMinSizeBytes()

setCompressionMinSizeBytes

void setCompressionMinSizeBytes(String size)

getConnectionUploadTimeoutMillis

String getConnectionUploadTimeoutMillis()

setConnectionUploadTimeoutMillis

void setConnectionUploadTimeoutMillis(String timeout)

getDefaultResponseType

@Deprecated
String getDefaultResponseType()
Deprecated. 

Setting the default response-type. Specified as a semi-colon delimited string consisting of content-type, encoding, language, charset


setDefaultResponseType

@Deprecated
void setDefaultResponseType(String defaultResponseType)
Deprecated. 


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
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)

getMaxPostSizeBytes

String getMaxPostSizeBytes()

setMaxPostSizeBytes

void setMaxPostSizeBytes(String max)

getNoCompressionUserAgents

String getNoCompressionUserAgents()

setNoCompressionUserAgents

void setNoCompressionUserAgents(String agents)

getRcmSupportEnabled

String getRcmSupportEnabled()

setRcmSupportEnabled

void setRcmSupportEnabled(String enable)

getRedirectPort

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)

getVersion

String getVersion()
The version of the HTTP protocol used by the HTTP Service


setVersion

void setVersion(String version)

getScheme

@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)

getParent

@DuckTyped
Protocol getParent()
Specified by:
getParent in interface org.jvnet.hk2.config.ConfigBeanProxy


Copyright © 2013 Oracle Corporation. All Rights Reserved.