| Links Top Level Elements Executors Connectors Containers Nested Components Cluster Elements web.xml Other | The HTTP Connector| Introduction |  | 
  The HTTP Connector element represents a
  Connector component that supports the HTTP/1.1 protocol.
  It enables Catalina to function as a stand-alone web server, in addition
  to its ability to execute servlets and JSP pages.  A particular instance
  of this component listens for connections on a specific TCP port number
  on the server.  One or more such Connectors can be
  configured as part of a single Service, each
  forwarding to the associated Engine to perform
  request processing and create the response. If you wish to configure the Connector that is used
  for connections to web servers using the AJP protocol (such as the
  mod_jk 1.2.xconnector for Apache 1.3), please refer to the
  AJP Connector documentation. Each incoming request requires
  a thread for the duration of that request.  If more simultaneous requests
  are received than can be handled by the currently available request
  processing threads, additional threads will be created up to the
  configured maximum (the value of the maxThreadsattribute).
  If still more simultaneous requests are received, they are stacked up
  inside the server socket created by the Connector, up to
  the configured maximum (the value of theacceptCountattribute).  Any further simultaneous requests will receive "connection
  refused" errors, until resources are available to process them. | 
 | Attributes |  | 
  | Common Attributes |  | 
  All implementations of Connector
  support the following attributes: | Attribute | Description | 
|---|
 | allowTrace | A boolean value which can be used to enable or disable the TRACE
      HTTP method. If not specified, this attribute is set to false. |  | asyncTimeout | The default timeout for asynchronous requests in milliseconds. If not
      specified, this attribute is set to 10000 (10 seconds). |  | discardFacades | A boolean value which can be used to enable or disable the recycling
      of the facade objects that isolate the container internal request
      processing objects. If set to truethe facades will be
      set for garbage collection after every request, otherwise they will be
      reused. This setting has no effect when the security manager is enabled.
      If not specified, this attribute is set to the value of theorg.apache.catalina.connector.RECYCLE_FACADESsystem
      property, orfalseif not set. |  | enableLookups | Set to trueif you want calls torequest.getRemoteHost()to perform DNS lookups in
      order to return the actual host name of the remote client.  Set
      tofalseto skip the DNS lookup and return the IP
      address in String form instead (thereby improving performance).
      By default, DNS lookups are disabled. |  | maxHeaderCount | The maximum number of headers in a request that are allowed by the
      container. A request that contains more headers than the specified limit
      will be rejected. A value of less than 0 means no limit.
      If not specified, a default of 100 is used. |  | maxParameterCount | The maximum number of parameter and value pairs (GET plus POST) which
      will be automatically parsed by the container. Parameter and value pairs
      beyond this limit will be ignored. A value of less than 0 means no limit.
      If not specified, a default of 10000 is used. Note that
      FailedRequestFilterfilter can be
      used to reject requests that hit the limit. |  | maxPostSize | The maximum size in bytes of the POST which will be handled by
      the container FORM URL parameter parsing. The limit can be disabled by
      setting this attribute to a value less than zero. If not specified, this
      attribute is set to 2097152 (2 megabytes). Note that the
      FailedRequestFiltercan be used to reject requests that exceed this limit. |  | maxSavePostSize | The maximum size in bytes of the POST which will be saved/buffered by
      the container during FORM or CLIENT-CERT authentication. For both types
      of authentication, the POST will be saved/buffered before the user is
      authenticated. For CLIENT-CERT authentication, the POST is buffered for
      the duration of the SSL handshake and the buffer emptied when the request
      is processed. For FORM authentication the POST is saved whilst the user
      is re-directed to the login form and is retained until the user
      successfully authenticates or the session associated with the
      authentication request expires. The limit can be disabled by setting this
      attribute to -1. Setting the attribute to zero will disable the saving of
      POST data during authentication. If not specified, this attribute is set
      to 4096 (4 kilobytes). |  | parseBodyMethods | A comma-separated list of HTTP methods for which request
      bodies using application/x-www-form-urlencodedwill be parsed
      for request parameters identically to POST. This is useful in RESTful
      applications that want to support POST-style semantics for PUT requests.
      Note that any setting other thanPOSTcauses Tomcat
      to behave in a way that goes against the intent of the servlet
      specification.
      The HTTP method TRACE is specifically forbidden here in accordance
      with the HTTP specification.
      The default isPOST |  | port | The TCP port number on which this Connector
      will create a server socket and await incoming connections.  Your
      operating system will allow only one server application to listen
      to a particular port number on a particular IP address. If the special
      value of 0 (zero) is used, then Tomcat will select a free port at random
      to use for this connector. This is typically only useful in embedded and
      testing applications. |  | protocol | Sets the protocol to handle incoming traffic. The default value is
        HTTP/1.1which uses an auto-switching mechanism to select
        either a blocking Java based connector or an APR/native based connector.
        If thePATH(Windows) orLD_LIBRARY_PATH(on
        most unix systems) environment variables contain the Tomcat native
        library, the APR/native connector will be used. If the native library
        cannot be found, the blocking Java based connector will be used. Note
        that the APR/native connector has different settings for HTTPS than the
        Java connectors.To use an explicit protocol rather than rely on the auto-switching
        mechanism described above, the following values may be used:
 
 org.apache.coyote.http11.Http11Protocol-
              blocking Java connector
 org.apache.coyote.http11.Http11NioProtocol-
              non blocking Java connector
 org.apache.coyote.http11.Http11AprProtocol-
              the APR/native connector.Custom implementations may also be used.
 Take a look at our Connector
        Comparison chart. The configuration for both Java connectors is
        identical, for http and https.
 For more information on the APR connector and APR specific SSL settings
        please  visit the APR documentation
 |  | proxyName | If this Connector is being used in a proxy
      configuration, configure this attribute to specify the server name
      to be returned for calls to request.getServerName().
      See Proxy Support for more
      information. |  | proxyPort | If this Connector is being used in a proxy
      configuration, configure this attribute to specify the server port
      to be returned for calls to request.getServerPort().
      See Proxy Support for more
      information. |  | redirectPort | If this 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. |  | scheme | Set this attribute to the name of the protocol you wish to have
      returned by calls to request.getScheme().  For
      example, you would set this attribute to "https"
      for an SSL Connector.  The default value is "http". |  | secure | Set this attribute to trueif you wish to have
      calls torequest.isSecure()to returntruefor requests received by this Connector. You would want this on an
      SSL Connector or a non SSL connector that is receiving data from a
      SSL accelerator, like a crypto card, an SSL appliance or even a webserver.
      The default value isfalse. |  | URIEncoding | This specifies the character encoding used to decode the URI bytes,
      after %xx decoding the URL. If not specified, ISO-8859-1 will be used.
       |  | useBodyEncodingForURI | This specifies if the encoding specified in contentType should be used
      for URI query parameters, instead of using the URIEncoding. This
      setting is present for compatibility with Tomcat 4.1.x, where the
      encoding specified in the contentType, or explicitly set using
      Request.setCharacterEncoding method was also used for the parameters from
      the URL. The default value is false. Notes: 1) This setting is applied only to the
      query string of a request. Unlike URIEncodingit does not
      affect the path portion of a request URI. 2) If request character
      encoding is not known (is not provided by a browser and is not set bySetCharacterEncodingFilteror a similar filter using
      Request.setCharacterEncoding method), the default encoding is always
      "ISO-8859-1". TheURIEncodingsetting has no effect on
      this default. |  | useIPVHosts | Set this attribute to trueto cause Tomcat to use
      the IP address that the request was received on to determine the Host
      to send the request to.  The default value isfalse. |  | xpoweredBy | Set this attribute to trueto cause Tomcat to advertise
      support for the Servlet specification using the header recommended in the
      specification.  The default value isfalse. | 
 | 
 | Standard Implementation |  | 
  The standard HTTP connectors (BIO, NIO and APR/native) all support the
  following attributes in addition to the common Connector attributes listed
  above. | Attribute | Description | 
|---|
 | acceptCount | The maximum queue length for incoming connection requests when
      all possible request processing threads are in use.  Any requests
      received when the queue is full will be refused.  The default
      value is 100. |  | acceptorThreadCount | The number of threads to be used to accept connections. Increase this
      value on a multi CPU machine, although you would never really need more
      than 2. Also, with a lot of non keep alive connections, you
      might want to increase this value as well. Default value is1. |  | acceptorThreadPriority | The priority of the acceptor threads. The threads used to accept
      new connections. The default value is 5(the value of thejava.lang.Thread.NORM_PRIORITYconstant). See the JavaDoc
      for thejava.lang.Threadclass for more details on what
      this priority means. |  | address | For servers with more than one IP address, this attribute specifies
      which address will be used for listening on the specified port. By
      default, the connector will listen all local addresses. Unless the JVM is
      configured otherwise using system properties, the Java based connectors
      (BIO, NIO) will listen on both IPv4 and IPv6 addresses when configured
      with either 0.0.0.0or::. The APR/native
      connector will only listen on IPv4 addresses if configured with0.0.0.0and will listen on IPv6 addresses and the equivalent
      IPv4 address if present when configured with::. |  | allowHostHeaderMismatch | By default Tomcat will allow requests that specify a host in the
      request line but specify a different host in the host header. This
      check can be enabled by setting this attribute to false. If
      not specified, the default istrue. |  | allowedTrailerHeaders | By default Tomcat will ignore all trailer headers when processing
      chunked input. For a header to be processed, it must be added to this
      comma-separated list of header names. |  | bindOnInit | Controls when the socket used by the connector is bound. By default it
      is bound when the connector is initiated and unbound when the connector is
      destroyed. If set to false, the socket will be bound when the
      connector is started and unbound when it is stopped. |  | compressibleMimeType | The value is a comma separated list of MIME types for which HTTP
      compression may be used.
      The default value is
      
      text/html,text/xml,text/plain,text/css,text/javascript,application/javascript
      . |  | compression | The Connector may use HTTP/1.1 GZIP compression in
      an attempt to save server bandwidth. The acceptable values for the
      parameter is "off" (disable compression), "on" (allow compression, which
      causes text data to be compressed), "force" (forces compression in all
      cases), or a numerical integer value (which is equivalent to "on", but
      specifies the minimum amount of data before the output is compressed). If
      the content-length is not known and compression is set to "on" or more
      aggressive, the output will also be compressed. If not specified, this
      attribute is set to "off". Note: There is a tradeoff between using compression (saving
      your bandwidth) and using the sendfile feature (saving your CPU cycles).
      If the connector supports the sendfile feature, e.g. the NIO connector,
      using sendfile will take precedence over compression. The symptoms will
      be that static files greater that 48 Kb will be sent uncompressed.
      You can turn off sendfile by setting useSendfileattribute
      of the connector, as documented below, or change the sendfile usage
      threshold in the configuration of the
      DefaultServlet in the defaultconf/web.xmlor in theweb.xmlof your web
      application. |  | compressionMinSize | If compression is set to "on" then this attribute
      may be used to specify the minimum amount of data before the output is
      compressed. If not specified, this attribute is defaults to "2048". |  | connectionLinger | The number of seconds during which the sockets used by this
      Connector will linger when they are closed. The default
      value is -1which disables socket linger. |  | connectionTimeout | The number of milliseconds this Connector will wait,
      after accepting a connection, for the request URI line to be
      presented. Use a value of -1 to indicate no (i.e. infinite) timeout.
      The default value is 60000 (i.e. 60 seconds) but note that the standard
      server.xml that ships with Tomcat sets this to 20000 (i.e. 20 seconds).
      Unless disableUploadTimeout is set to false,
      this timeout will also be used when reading the request body (if any). |  | connectionUploadTimeout | Specifies the timeout, in milliseconds, to use while a data upload is
      in progress. This only takes effect if
      disableUploadTimeout is set to false. |  | disableUploadTimeout | This flag allows the servlet container to use a different, usually
      longer connection timeout during data upload. If not specified, this
      attribute is set to truewhich disables this longer timeout. |  | executor | A reference to the name in an Executor
      element. If this attribute is set, and the named executor exists, the
      connector will use the executor, and all the other thread attributes will
      be ignored. Note that if a shared executor is not specified for a
      connector then the connector will use a private, internal executor to
      provide the thread pool. |  | executorTerminationTimeoutMillis | The time that the private internal executor will wait for request
      processing threads to terminate before continuing with the process of
      stopping the connector. If not set, the default is 0(zero)
      for the BIO connector and5000(5 seconds) for the NIO and
      APR/native connectors. |  | keepAliveTimeout | The number of milliseconds this Connector will wait
      for another HTTP request before closing the connection. The default value
      is to use the value that has been set for the
      connectionTimeout attribute.
      Use a value of -1 to indicate no (i.e. infinite) timeout. |  | maxConnections | The maximum number of connections that the server will accept and
      process at any given time. When this number has been reached, the server
      will accept, but not process, one further connection. This additional
      connection be blocked until the number of connections being processed
      falls below maxConnections at which point the server will
      start accepting and processing new connections again. Note that once the
      limit has been reached, the operating system may still accept connections
      based on the acceptCountsetting. The default value varies by
      connector type. For BIO the default is the value of
      maxThreads unless an Executor
      is used in which case the default will be the value of maxThreads from the
      executor. For NIO the default is10000.
      For APR/native, the default is8192. For NIO only, setting the value to -1, will disable the
      maxConnections feature and connections will not be counted. |  | maxCookieCount | The maximum number of cookies that are permitted for a request. A value
      of less than zero means no limit. If not specified, a default value of 200
      will be used. |  | maxExtensionSize | Limits the total length of chunk extensions in chunked HTTP requests.
      If the value is -1, no limit will be imposed. If not
      specified, the default value of8192will be used. |  | maxHttpHeaderSize | The maximum size of the request and response HTTP header, specified
      in bytes. If not specified, this attribute is set to 8192 (8 KB). |  | maxKeepAliveRequests | The maximum number of HTTP requests which can be pipelined until
      the connection is closed by the server. Setting this attribute to 1 will
      disable HTTP/1.0 keep-alive, as well as HTTP/1.1 keep-alive and
      pipelining. Setting this to -1 will allow an unlimited amount of
      pipelined or keep-alive HTTP requests.
      If not specified, this attribute is set to 100. |  | maxSwallowSize | The maximum number of request body bytes (excluding transfer encoding
      overhead) that will be swallowed by Tomcat for an aborted upload. An
      aborted upload is when Tomcat knows that the request body is going to be
      ignored but the client still sends it. If Tomcat does not swallow the body
      the client is unlikely to see the response. If not specified the default
      of 2097152 (2 megabytes) will be used. A value of less than zero indicates
      that no limit should be enforced. |  | maxThreads | The maximum number of request processing threads to be created
      by this Connector, which therefore determines the
      maximum number of simultaneous requests that can be handled.  If
      not specified, this attribute is set to 200. If an executor is associated
      with this connector, this attribute is ignored as the connector will
      execute tasks using the executor rather than an internal thread pool. Note
      that if an executor is configured any value set for this attribute will be
      recorded correctly but it will be reported (e.g. via JMX) as
      -1to make clear that it is not used. |  | maxTrailerSize | Limits the total length of trailing headers in the last chunk of
      a chunked HTTP request. If the value is -1, no limit will be
      imposed. If not specified, the default value of8192will be
      used. |  | minSpareThreads | The minimum number of threads always kept running.  This includes both
      active and idle threads. If not specified, the default of 10is used. If an executor is associated with this connector, this attribute
      is ignored as the connector will execute tasks using the executor rather
      than an internal thread pool. Note that if an executor is configured any
      value set for this attribute will be recorded correctly but it will be
      reported (e.g. via JMX) as-1to make clear that it is not
      used. |  | noCompressionStrongETag | This flag configures whether resources with a stong ETag will be
      considered for compression. If true, resources with a strong
      ETag will not be compressed. The default value istrue. This attribute is deprecated. It will be removed in Tomcat 10 onwards
      where it will be hard-coded to true. |  | noCompressionUserAgents | The value is a regular expression (using java.util.regex)
      matching theuser-agentheader of HTTP clients for which
      compression should not be used,
      because these clients, although they do advertise support for the
      feature, have a broken implementation.
      The default value is an empty String (regexp matching disabled). |  | processorCache | The protocol handler caches Processor objects to speed up performance.
      This setting dictates how many of these objects get cached.
      -1means unlimited, default is200. If not using
      Servlet 3.0 asynchronous processing, a good default is to use the same as
      the maxThreads setting. If using Servlet 3.0 asynchronous processing, a
      good default is to use the larger of maxThreads and the maximum number of
      expected concurrent requests (synchronous and asynchronous). |  | rejectIllegalHeader | If an HTTP request is received that contains an illegal header name or
      value (e.g. the header name is not a token) this setting determines if the
      request will be rejected with a 400 response (true) or if the
      illegal header be ignored (false). The default value isfalsewhich will cause the request to be processed but the
      illegal header will be ignored. |  | rejectIllegalHeaderName | This attribute is deprecated. It will be removed in Tomcat 10 onwards.
      It is now an alias for rejectIllegalHeader. |  | relaxedPathChars | The HTTP/1.1
      specification requires that certain characters are %nn encoded when
      used in URI paths. Unfortunately, many user agents including all the major
      browsers are not compliant with this specification and use these
      characters in unencoded form. To prevent Tomcat rejecting such requests,
      this attribute may be used to specify the additional characters to allow.
      If not specified, no additional characters will be allowed. The value may
      be any combination of the following characters:
      " < > [ \ ] ^ ` { | }. Any other characters
      present in the value will be ignored. |  | relaxedQueryChars | The HTTP/1.1
      specification requires that certain characters are %nn encoded when
      used in URI query strings. Unfortunately, many user agents including all
      the major browsers are not compliant with this specification and use these
      characters in unencoded form. To prevent Tomcat rejecting such requests,
      this attribute may be used to specify the additional characters to allow.
      If not specified, no additional characters will be allowed. The value may
      be any combination of the following characters:
      " < > [ \ ] ^ ` { | }. Any other characters
      present in the value will be ignored. |  | restrictedUserAgents | The value is a regular expression (using java.util.regex)
      matching theuser-agentheader of HTTP clients for which
      HTTP/1.1 or HTTP/1.0 keep alive should not be used, even if the clients
      advertise support for these features.
      The default value is an empty String (regexp matching disabled). |  | server | Overrides the Server header for the http response. If set, the value
      for this attribute overrides the Tomcat default and any Server header set
      by a web application. If not set, any value specified by the application
      is used. If the application does not specify a value then
      Apache-Coyote/1.1is used. Unless you are paranoid, you won't
      need this feature. |  | socketBuffer | The size (in bytes) of the buffer to be provided for socket
      output buffering. -1 can be specified to disable the use of a buffer.
      By default, a buffers of 9000 bytes will be used. |  | SSLEnabled | Use this attribute to enable SSL traffic on a connector.
      To turn on SSL handshake/encryption/decryption on a connector
      set this value to true.
      The default value isfalse.
      When turning this valuetrueyou will want to set theschemeand thesecureattributes as well
      to pass the correctrequest.getScheme()andrequest.isSecure()values to the servlets
      See SSL Support for more information. |  | tcpNoDelay | If set to true, the TCP_NO_DELAY option will be
      set on the server socket, which improves performance under most
      circumstances.  This is set totrueby default. |  | threadPriority | The priority of the request processing threads within the JVM.
      The default value is 5(the value of thejava.lang.Thread.NORM_PRIORITYconstant). See the JavaDoc
      for thejava.lang.Threadclass for more details on what
      this priority means. If an executor is associated
      with this connector, this attribute is ignored as the connector will
      execute tasks using the executor rather than an internal thread pool. Note
      that if an executor is configured any value set for this attribute will be
      recorded correctly but it will be reported (e.g. via JMX) as-1to make clear that it is not used. |  | upgradeAsyncWriteBufferSize | The default size of the buffer to allocate to for asynchronous writes
      that can not be completed in a single operation, specified in bytes. Data that can't be
      written immediately will be stored in this buffer until it can be written.
      If more data needs to be stored than space is available in the buffer than
      the size of the buffer will be increased for the duration of the write. If
      not specified the default value of 8192 will be used. | 
 | 
 | Java TCP socket attributes |  | 
    The BIO and NIO implementation support the following Java TCP socket
    attributes in addition to the common Connector and HTTP attributes listed
    above. | Attribute | Description | 
|---|
 | socket.rxBufSize | (int)The socket receive buffer (SO_RCVBUF) size in bytes. JVM default
        used if not set. |  | socket.txBufSize | (int)The socket send buffer (SO_SNDBUF) size in bytes. JVM default
        used if not set. Care should be taken if explicitly setting this value.
        Very poor performance has been observed on some JVMs with values less
        than ~8k. |  | socket.tcpNoDelay | (bool)This is equivalent to standard attribute
        tcpNoDelay. |  | socket.soKeepAlive | (bool)Boolean value for the socket's keep alive setting
        (SO_KEEPALIVE). JVM default used if not set. |  | socket.ooBInline | (bool)Boolean value for the socket OOBINLINE setting. JVM default
        used if not set. |  | socket.soReuseAddress | (bool)Boolean value for the sockets reuse address option
        (SO_REUSEADDR). JVM default used if not set. |  | socket.soLingerOn | (bool)Boolean value for the sockets so linger option (SO_LINGER).
        A value for the standard attribute connectionLinger
        that is >=0 is equivalent to setting this to true.
        A value for the standard attribute connectionLinger
        that is <0 is equivalent to setting this tofalse.
        Both this attribute andsoLingerTimemust be set else the
        JVM defaults will be used for both. |  | socket.soLingerTime | (int)Value in seconds for the sockets so linger option (SO_LINGER).
        This is equivalent to standard attribute
        connectionLinger.
        Both this attribute and soLingerOnmust be set else the
        JVM defaults will be used for both. |  | socket.soTimeout | This is equivalent to standard attribute
        connectionTimeout. |  | socket.performanceConnectionTime | (int)The first value for the performance settings. See
        Socket Performance Options.
        All three performance attributes must be set else the JVM defaults will
        be used for all three. |  | socket.performanceLatency | (int)The second value for the performance settings. See
        Socket Performance Options.
        All three performance attributes must be set else the JVM defaults will
        be used for all three. |  | socket.performanceBandwidth | (int)The third value for the performance settings. See
        Socket Performance Options.
        All three performance attributes must be set else the JVM defaults will
        be used for all three. |  | socket.unlockTimeout | (int) The timeout for a socket unlock. When a connector is stopped, it will try to release the acceptor thread by opening a connector to itself.
           The default value is 250and the value is in milliseconds | 
 | 
 | BIO specific configuration |  | 
    The following attributes are specific to the BIO connector. | Attribute | Description | 
|---|
 | disableKeepAlivePercentage | The percentage of processing threads that have to be in use before
        HTTP keep-alives are disabled to improve scalability. Values less than
        0will be changed to0and values greater than100will be changed to100. If not specified,
        the default value is75. | 
 | 
 | NIO specific configuration |  | 
    The following attributes are specific to the NIO connector. | Attribute | Description | 
|---|
 | pollerThreadCount | (int)The number of threads to be used to run for the polling events.
        Default value is 1per processor up to and including version 7.0.27.
        Default value as of version 7.0.28 is1per processor but not more than 2.When accepting a socket, the operating system holds a global lock. So the benefit of
        going above 2 threads diminishes rapidly. Having more than one thread is for
        system that need to accept connections very rapidly. However usually just
        increasing
 acceptCountwill solve that problem.
        Increasing this value may also be beneficial when a large amount of send file
        operations are going on. |  | pollerThreadPriority | (int)The priority of the poller threads.
        The default value is 5(the value of thejava.lang.Thread.NORM_PRIORITYconstant). See the JavaDoc
        for thejava.lang.Threadclass for more details on what
        this priority means. |  | selectorTimeout | (int)The time in milliseconds to timeout on a select() for the
        poller. This value is important, since connection clean up is done on
        the same thread, so do not set this value to an extremely high one. The
        default value is 1000milliseconds. |  | useComet | (bool)Whether to allow comet servlets or not. Default value is
        true. |  | useSendfile | (bool)Use this attribute to enable or disable sendfile capability.
        The default value is true. |  | socket.directBuffer | (bool)Boolean value, whether to use direct ByteBuffers or java mapped
        ByteBuffers. If truethenjava.nio.ByteBuffer.allocateDirect()is used to allocate
        the buffers, iffalsethenjava.nio.ByteBuffer.allocate()is used. The default value
        isfalse.When you are using direct buffers, make sure you allocate the
        appropriate amount of memory for the direct memory space. On Sun's JDK
        that would be something like
 -XX:MaxDirectMemorySize=256m. |  | socket.appReadBufSize | (int)Each connection that is opened up in Tomcat get associated with
        a read ByteBuffer. This attribute controls the size of this buffer. By
        default this read buffer is sized at 8192bytes. For lower
        concurrency, you can increase this to buffer more data. For an extreme
        amount of keep alive connections, decrease this number or increase your
        heap size. |  | socket.appWriteBufSize | (int)Each connection that is opened up in Tomcat get associated with
        a write ByteBuffer. This attribute controls the size of this buffer. By
        default this write buffer is sized at 8192bytes. For low
        concurrency you can increase this to buffer more response data. For an
        extreme amount of keep alive connections, decrease this number or
        increase your heap size.The default value here is pretty low, you should up it if you are not
        dealing with tens of thousands concurrent connections.
 |  | socket.bufferPool | (int)The NIO connector uses a class called NioChannel that holds
        elements linked to a socket. To reduce garbage collection, the NIO
        connector caches these channel objects. This value specifies the size of
        this cache. The default value is 500, and represents that
        the cache will hold 500 NioChannel objects. Other values are-1for unlimited cache and0for no cache. |  | socket.bufferPoolSize | (int)The NioChannel pool can also be size based, not used object
        based. The size is calculated as follows:NioChannel
 buffer size = read buffer size + write buffer sizeSecureNioChannel
 buffer size = application read buffer size +
        application write buffer size + network read buffer size +
        network write buffer sizeThe value is in bytes, the default value is
 1024*1024*100(100MB). |  | socket.processorCache | (int)Tomcat will cache SocketProcessor objects to reduce garbage
        collection. The integer value specifies how many objects to keep in the
        cache at most. The default is 500. Other values are-1for unlimited cache and0for no cache. |  | socket.keyCache | (int)Tomcat will cache KeyAttachment objects to reduce garbage
        collection. The integer value specifies how many objects to keep in the
        cache at most. The default is 500. Other values are-1for unlimited cache and0for no cache. |  | socket.eventCache | (int)Tomcat will cache PollerEvent objects to reduce garbage
        collection. The integer value specifies how many objects to keep in the
        cache at most. The default is 500. Other values are-1for unlimited cache and0for no cache. |  | selectorPool.maxSelectors | (int)The max selectors to be used in the pool, to reduce selector
        contention. Use this option when the command line
        org.apache.tomcat.util.net.NioSelectorSharedvalue is set
        to false. Default value is200. |  | selectorPool.maxSpareSelectors | (int)The max spare selectors to be used in the pool, to reduce
        selector contention. When a selector is returned to the pool, the system
        can decide to keep it or let it be GC'd. Use this option when the
        command line org.apache.tomcat.util.net.NioSelectorSharedvalue is set to false. Default value is-1(unlimited). |  | command-line-options | The following command line options are available for the NIO
        connector:
 -Dorg.apache.tomcat.util.net.NioSelectorShared=true|false- default istrue. Set this value tofalseif you wish to
        use a selector for each thread. When you set it tofalse, you can
        control the size of the pool of selectors by using the
        selectorPool.maxSelectors attribute. |  | oomParachute | (int)The NIO connector implements an OutOfMemoryError strategy called
        parachute. It holds a chunk of data as a byte array. In case of an OOM,
        this chunk of data is released and the error is reported. This will give
        the VM enough room to clean up. The oomParachuterepresents
        the size in bytes of the parachute(the byte array). The default value is1024*1024(1MB). Please note, this only works for OOM errors
        regarding the Java Heap space, and there is absolutely no  guarantee
        that you will be able to recover at all. If you have an OOM outside of
        the Java Heap, then this parachute trick will not help. | 
 | 
 | APR/native specific configuration |  | 
    The following attributes are specific to the APR/native connector. | Attribute | Description | 
|---|
 | deferAccept | Sets the TCP_DEFER_ACCEPTflag on the listening socket
        for this connector. The default value istruewhereTCP_DEFER_ACCEPTis supported by the operating system,
        otherwise it isfalse. |  | pollerSize | Amount of sockets that the poller responsible for polling kept alive
        connections can hold at a given time. Extra connections will be closed
        right away. The default value is 8192, corresponding to 8192 keep-alive
        connections. This is a synonym for maxConnections. |  | pollTime | Duration of a poll call in microseconds. Lowering this value will
        slightly decrease latency of connections being kept alive in some cases,
        but will use more CPU as more poll calls are being made. The default
        value is 2000 (2ms). |  | sendfileSize | Amount of sockets that the poller responsible for sending static
        files asynchronously can hold at a given time. Extra connections will be
        closed right away without any data being sent (resulting in a zero
        length file on the client side). Note that in most cases, sendfile is a
        call that will return right away (being taken care of "synchronously" by
        the kernel), and the sendfile poller will not be used, so the amount of
        static files which can be sent concurrently is much larger than the
        specified amount. The default value is 1024. |  | threadPriority | (int)The priority of the acceptor and poller threads.
        The default value is 5(the value of thejava.lang.Thread.NORM_PRIORITYconstant). See the JavaDoc
        for thejava.lang.Threadclass for more details on what
        this priority means. |  | useComet | (bool)Whether to allow comet servlets or not. Default value is
        true. |  | useSendfile | (bool)Use this attribute to enable or disable sendfile capability.
        The default value is true. Note that the use of sendfile
        will disable any compression that Tomcat may otherwise have performed on
        the response. | 
 | 
 | 
 | Special Features |  | 
  | HTTP/1.1 and HTTP/1.0 Support |  | 
  This Connector supports all of the required features
  of the HTTP/1.1 protocol, as described in RFCs 7230-7235, including persistent
  connections, pipelining, expectations and chunked encoding.  If the client
  supports only HTTP/1.0 or HTTP/0.9, the
  Connector will gracefully fall back to supporting this
  protocol as well.  No special configuration is required to enable this
  support. The Connector also supports HTTP/1.0
  keep-alive. RFC 7230 requires that HTTP servers always begin their responses with
  the highest HTTP version that they claim to support.  Therefore, this
  Connector will always return HTTP/1.1at
  the beginning of its responses. | 
 | Proxy Support |  | 
  The proxyNameandproxyPortattributes can
  be used when Tomcat is run behind a proxy server.  These attributes
  modify the values returned to web applications that call therequest.getServerName()andrequest.getServerPort()methods, which are often used to construct absolute URLs for redirects.
  Without configuring these attributes, the values returned would reflect
  the server name and port on which the connection from the proxy server
  was received, rather than the server name and port to whom the client
  directed the original request. For more information, see the
  Proxy Support HOW-TO. | 
 | SSL Support |  | 
  You can enable SSL support for a particular instance of this
  Connector by setting the SSLEnabledattribute totrue. You will also need to set the schemeandsecureattributes to the valueshttpsandtruerespectively, to pass correct information to the servlets. The BIO and NIO connectors use the JSSE SSL whereas the APR/native
  connector uses OpenSSL. Therefore, in addition to using different attributes
  to configure SSL, the APR/native connector also requires keys and certificates
  to be provided in a different format. For more information, see the
  SSL Configuration HOW-TO. | SSL Support - BIO and NIO |  | 
  The BIO and NIO connectors use the following attributes to configure SSL:
   | Attribute | Description | 
|---|
 | algorithm | The certificate encoding algorithm to be used. This defaults to
      KeyManagerFactory.getDefaultAlgorithm()which returnsSunX509for Sun JVMs. IBM JVMs returnIbmX509. For other vendors, consult the JVM
      documentation for the default value. |  | allowUnsafeLegacyRenegotiation | Is unsafe legacy TLS renegotiation allowed which is likely to expose
      users to CVE-2009-3555, a man-in-the-middle vulnerability in the TLS
      protocol that allows an attacker to inject arbitrary data into the user's
      request. If not specified, a default of falseis used. This
      attribute only has an effect if the JVM does not support RFC 5746 as
      indicated by the presence of the pseudo-ciphersuite
      TLS_EMPTY_RENEGOTIATION_INFO_SCSV. This is available JRE/JDK 6 update 22
      onwards. Where RFC 5746 is supported the renegotiation - including support
      for unsafe legacy renegotiation - is controlled by the JVM configuration. |  | useServerCipherSuitesOrder | 
        Set to trueto enforce the server's cipher order
        (from thecipherssetting). Set tofalseto choose the first acceptable cipher suite presented by the client.
        Use of this feature requires Java 8 or later.
        Default is undefined, leaving the choice up to the JSSE
        implementation. |  | ciphers | The comma separated list of encryption ciphers to support for HTTPS
      connections. If specified, only the ciphers that are listed and supported
      by the SSL implementation will be used. By default, the default ciphers
      for the JVM will be used less those considered to be insecure. Note that
      with older JVMs this will result in a very limited set of ciphers being
      available by default. The ciphers are specified using the JSSE cipher
      naming convention. The special value of ALLwill enable all
      supported ciphers. This will include many that are not secure.ALLis intended for testing purposes only. |  | clientAuth | Set to trueif you want the SSL stack to require a
      valid certificate chain from the client before accepting a connection.
      Set towantif you want the SSL stack to request a client
      Certificate, but not fail if one isn't presented. Afalsevalue (which is the default) will not require a certificate chain
      unless the client requests a resource protected by a security
      constraint that usesCLIENT-CERTauthentication. |  | clientCertProvider | When client certificate information is presented in a form other than
      instances of java.security.cert.X509Certificateit needs to
      be converted before it can be used and this property controls which JSSE
      provider is used to perform the conversion. For example it is used with
      the AJP connectors, the HTTP APR connector and
      with the 
      org.apache.catalina.valves.SSLValve. If not specified, the default
      provider will be used. |  | crlFile | The certificate revocation list to be used to verify client
      certificates. If not defined, client certificates will not be checked
      against a certificate revocation list. The file may be specified using a
      URL, an absolute path or a relative (to CATALINA_BASE) path. |  | keyAlias | The alias used for the server key and certificate in the keystore. If
      not specified, the first key read from the keystore will be used. The
      order in which keys are read from the keystore is implementation
      dependent. It may not be the case that keys are read from the keystore in
      the same order as they were added. If more than one key is present in the
      keystore it is strongly recommended that a keyAlias is configured to
      ensure that the correct key is used. |  | keyPass | The password used to access the server certificate from the
      specified keystore file.  The default value is "changeit". |  | keystoreFile | The pathname of the keystore file where you have stored the
      server certificate to be loaded.  By default, the pathname is
      the file ".keystore" in the operating system home
      directory of the user that is running Tomcat. If yourkeystoreTypedoesn't need a file use""(empty string) for this parameter. The file may be specified using a
      URL, an absolute path or a relative (to CATALINA_BASE) path. |  | keystorePass | The password used to access the specified keystore file. The default
      value is the value of the keyPassattribute. |  | keystoreProvider | The name of the keystore provider to be used for the server
      certificate. If not specified, the list of registered providers is
      traversed in preference order and the first provider that supports the
      keystoreTypeis used. |  | keystoreType | The type of keystore file to be used for the server certificate.
      If not specified, the default value is "JKS". |  | sessionCacheSize | The number of SSL sessions to maintain in the session cache. Specify
      -1to use the implementation default. Values of zero and
      above are passed to the implementation. Zero is used to specify an
      unlimited cache size and is not recommended. If not specified, a default
      of-1is used. |  | sessionTimeout | The time, in seconds, after the creation of an SSL session that it will
      timeout. Specify -1to use the implementation default. Values
      of zero and above are passed to the implementation. Zero is used to
      specify an unlimited timeout and is not recommended. If not specified, a
      default of 86400 (24 hours) is used. |  | sslEnabledProtocols | The comma separated list of SSL protocols to support for HTTPS
      connections. If specified, only the protocols that are listed and
      supported by the SSL implementation will be enabled.  If not specified,
      the JVM default (excluding SSLv2 and SSLv3 if the JVM enables either or
      both of them by default) is used. The permitted values may be obtained from the
      JVM documentation for the allowed values for
      SSLSocket.setEnabledProtocols()e.g.
      
      Oracle Java 6 and
      
      Oracle Java 7. Note: There is overlap between this attribute andsslProtocol. |  | sslImplementationName | The class name of the SSL implementation to use. If not specified, the
      default of org.apache.tomcat.util.net.jsse.JSSEImplementationwill be used which wraps JVM's default JSSE provider. Note that the
      JVM can be configured to use a different JSSE provider as the default. |  | sslProtocol | The SSL protocol(s) to use (a single value may enable multiple
      protocols - see the JVM documentation for details). If not specified, the
      default is TLS. The permitted values may be obtained from the
      JVM documentation for the allowed values for algorithm when creating anSSLContextinstance e.g.
      
      Oracle Java 6 and
      
      Oracle Java 7. Note: There is overlap between this attribute andsslEnabledProtocols. |  | trustManagerClassName | The name of a custom trust manager class to use to validate client
      certificates. The class must have a zero argument constructor and must
      also implement javax.net.ssl.X509TrustManager. If this
      attribute is set, the trust store attributes may be ignored. |  | trustMaxCertLength | The maximum number of intermediate certificates that will be allowed
      when validating client certificates. If not specified, the default value
      of 5 will be used. |  | truststoreAlgorithm | The algorithm to use for truststore. If not specified, the default
      value returned by
      javax.net.ssl.TrustManagerFactory.getDefaultAlgorithm()is
      used. |  | truststoreFile | The trust store file to use to validate client certificates. The
      default is the value of the javax.net.ssl.trustStoresystem
      property. If neither this attribute nor the default system property is
      set, no trust store will be configured. The file may be specified using a
      URL, an absolute path or a relative (to CATALINA_BASE) path. |  | truststorePass | The password to access the trust store. The default is the value of the
      javax.net.ssl.trustStorePasswordsystem property. If that
      property is null, no trust store password will be configured. If an
      invalid trust store password is specified, a warning will be logged and an
      attempt will be made to access the trust store without a password which
      will skip validation of the trust store contents. |  | truststoreProvider | The name of the truststore provider to be used for the server
      certificate. The default is the value of the
      javax.net.ssl.trustStoreProvidersystem property. If
      that property is null, the value ofkeystoreProvideris used
      as the default. If neither this attribute, the default system property norkeystoreProvideris set, the list of registered providers is
      traversed in preference order and the first provider that supports thetruststoreTypeis used. |  | truststoreType | The type of key store used for the trust store. The default is the
      value of the javax.net.ssl.trustStoreTypesystem property. If
      that property is null, the value ofkeystoreTypeis used as
      the default. | 
 | 
 | SSL Support - APR/Native |  | 
  When APR/native is enabled, the HTTPS connector will use a socket poller
  for keep-alive, increasing scalability of the server. It also uses OpenSSL,
  which may be more optimized than JSSE depending on the processor being used,
  and can be complemented with many commercial accelerator components. Unlike
  the HTTP connector, the HTTPS connector cannot use sendfile to optimize static
  file processing. The HTTPS APR/native connector has the same attributes than the HTTP
  APR/native connector, but adds OpenSSL specific ones. For the full details on
  using OpenSSL, please refer to OpenSSL documentations and the many books
  available for it (see the Official OpenSSL
  website). The SSL specific attributes for the APR/native connector are:
   | Attribute | Description | 
|---|
 | SSLCACertificateFile | See 
      the mod_ssl documentation. |  | SSLCACertificatePath | See 
      the mod_ssl documentation. |  | SSLCARevocationFile | See 
      the mod_ssl documentation. |  | SSLCARevocationPath | See 
      the mod_ssl documentation. |  | SSLCertificateChainFile | See 
      the mod_ssl documentation. |  | SSLCACertificateFile | Name of the file that contains the concatenated certificates for the
      trusted certificate authorities. The format is PEM-encoded. |  | SSLCACertificatePath | Name of the directory that contains the certificates for the trusted
      certificate authorities. The format is PEM-encoded. |  | SSLCARevocationFile | Name of the file that contains the concatenated certificate revocation
      lists for the certificate authorities. The format is PEM-encoded. |  | SSLCARevocationPath | Name of the directory that contains the certificate revocation lists
      for the certificate authorities. The format is PEM-encoded. |  | SSLCertificateChainFile | Name of the file that contains concatenated certifcates for the
      certificate authorities which form the certifcate chain for the server
      certificate. The format is PEM-encoded. |  | SSLCertificateFile | Name of the file that contains the server certificate. The format is
      PEM-encoded. In addition to the certificate, the file can also contain as optional
      elements DH parameters and/or an EC curve name for ephemeral keys, as
      generated by openssl dhparamandopenssl ecparam,
      respectively. The output of the respective OpenSSL command can simply
      be concatenated to the certificate file. This feature needs APR/native
      version 1.1.34 or later. |  | SSLCertificateKeyFile | Name of the file that contains the server private key. The format is
      PEM-encoded. The default value is the value of "SSLCertificateFile" and in
      this case both certificate and private key have to be in this file (NOT
      RECOMMENDED). |  | SSLCipherSuite | Ciphers which may be used for communicating with clients. The default
      is "HIGH:!aNULL:!eNULL:!EXPORT:!DES:!RC4:!MD5:!kRSA". See the OpenSSL
      documentation for details of the cipher configuration options. |  | SSLDisableCompression | Disables compression if set to trueand OpenSSL supports
      disabling compression. Default isfalsewhich inherits the
      default compression setting in OpenSSL. |  | SSLHonorCipherOrder | Set to trueto enforce the server's cipher order
      (from theSSLCipherSuitesetting) instead of allowing
      the client to choose the cipher (which is the default). |  | SSLPassword | Pass phrase for the encrypted private key. If "SSLPassword" is not
      provided, the callback function should prompt for the pass phrase. |  | SSLProtocol | The names of the protocols to support when communicating with clients.
      This should be a list of any combination of the following:
       SSLv2SSLv3TLSv1TLSv1.1TLSv1.2TLSv1.3all
 Each token in the list can be prefixed with a plus sign ("+")
      or a minus sign ("-"). A plus sign adds the protocol, a minus sign
      removes it form the current list. The list is built starting from
      an empty list. The token allis an alias forTLSv1+TLSv1.1+TLSv1.2+TLSv1.3. If more than one protocol is specified for an OpenSSL
      based secure connector it will always support SSLv2Hello. If a
      single protocol is specified it will not supportSSLv2Hello. Note that SSLv2andSSLv3are inherently
      unsafe. If not specified, the default value of allwill be
      used. |  | SSLVerifyClient | Ask client for certificate. The default is "none", meaning the client
      will not have the opportunity to submit a certificate. Other acceptable
      values include "optional", "require" and "optionalNoCA". |  | SSLVerifyDepth | Maximum verification depth for client certificates. The default is
      "10". | 
 | 
 | 
 | Connector Comparison |  | 
    Below is a small chart that shows how the connectors differ. 
                       Java Blocking Connector   Java Non Blocking Connector   APR/native Connector
                                 BIO                         NIO                       APR
    Classname              Http11Protocol             Http11NioProtocol         Http11AprProtocol
    Tomcat Version           3.x onwards                 6.x onwards              5.5.x onwards
    Support Polling              NO                          YES                       YES
    Polling Size                 N/A                   maxConnections             maxConnections
    Read Request Headers      Blocking                  Non Blocking                 Blocking
    Read Request Body         Blocking                    Blocking                   Blocking
    Write Response            Blocking                    Blocking                   Blocking
    Wait for next Request     Blocking                  Non Blocking               Non Blocking
    SSL Support               Java SSL                    Java SSL                   OpenSSL
    SSL Handshake             Blocking                  Non blocking                 Blocking
    Max Connections        maxConnections              maxConnections             maxConnections
    
 | 
 | 
 |