Package org.apache.coyote.http11

Class AbstractHttp11Protocol<S>

java.lang.Object
org.apache.coyote.AbstractProtocol<S>
org.apache.coyote.http11.AbstractHttp11Protocol<S>
All Implemented Interfaces:
MBeanRegistration, ProtocolHandler
Direct Known Subclasses:
AbstractHttp11JsseProtocol, Http11AprProtocol
public abstract class AbstractHttp11Protocol<S> extends AbstractProtocol<S>

  • Field Details

  • Constructor Details

    • AbstractHttp11Protocol

      public AbstractHttp11Protocol(AbstractEndpoint<S,?> endpoint)

  • Method Details

    • init

      public void init() throws Exception
      Description copied from interface: ProtocolHandler
      Initialise the protocol.
      Specified by:
      init in interface ProtocolHandler
      Overrides:
      init in class AbstractProtocol<S>
      Throws:
      Exception - If the protocol handler fails to initialise

    • destroy

      public void destroy() throws Exception
      Description copied from interface: ProtocolHandler
      Destroy the protocol (optional).
      Specified by:
      destroy in interface ProtocolHandler
      Overrides:
      destroy in class AbstractProtocol<S>
      Throws:
      Exception - If the protocol handler fails to destroy

    • getProtocolName

      protected String getProtocolName()
      Description copied from class: AbstractProtocol
      Obtain the name of the protocol, (Http, Ajp, etc.). Used with JMX.
      Specified by:
      getProtocolName in class AbstractProtocol<S>
      Returns:
      the protocol name

    • getEndpoint

      protected AbstractEndpoint<S,?> getEndpoint()

      Over-ridden here to make the method visible to nested classes.

      Overrides:
      getEndpoint in class AbstractProtocol<S>

    • getContinueResponseTiming

      public String getContinueResponseTiming()

    • setContinueResponseTiming

      public void setContinueResponseTiming(String continueResponseTiming)

    • getContinueResponseTimingInternal

      public ContinueResponseTiming getContinueResponseTimingInternal()

    • getUseKeepAliveResponseHeader

      public boolean getUseKeepAliveResponseHeader()

    • setUseKeepAliveResponseHeader

      public void setUseKeepAliveResponseHeader(boolean useKeepAliveResponseHeader)

    • getRelaxedPathChars

      public String getRelaxedPathChars()

    • setRelaxedPathChars

      public void setRelaxedPathChars(String relaxedPathChars)

    • getRelaxedQueryChars

      public String getRelaxedQueryChars()

    • setRelaxedQueryChars

      public void setRelaxedQueryChars(String relaxedQueryChars)

    • getAllowHostHeaderMismatch

      @Deprecated public boolean getAllowHostHeaderMismatch()
      Deprecated.
      This will removed in Tomcat 11 onwards where allowHostHeaderMismatch will be hard-coded to false.
      Will Tomcat accept an HTTP 1.1 request where the host header does not agree with the host specified (if any) in the request line?
      Returns:
      true if Tomcat will allow such requests, otherwise false

    • setAllowHostHeaderMismatch

      @Deprecated public void setAllowHostHeaderMismatch(boolean allowHostHeaderMismatch)
      Deprecated.
      This will removed in Tomcat 11 onwards where allowHostHeaderMismatch will be hard-coded to false.
      Will Tomcat accept an HTTP 1.1 request where the host header does not agree with the host specified (if any) in the request line?
      Parameters:
      allowHostHeaderMismatch - true to allow such requests, false to reject them with a 400

    • getRejectIllegalHeader

      @Deprecated public boolean getRejectIllegalHeader()
      Deprecated.
      This will removed in Tomcat 11 onwards where allowHostHeaderMismatch will be hard-coded to true.
      If an HTTP request is received that contains an illegal header name or value (e.g. the header name is not a token) will the request be rejected (with a 400 response) or will the illegal header be ignored?
      Returns:
      true if the request will be rejected or false if the header will be ignored

    • setRejectIllegalHeader

      @Deprecated public void setRejectIllegalHeader(boolean rejectIllegalHeader)
      Deprecated.
      This will removed in Tomcat 11 onwards where allowHostHeaderMismatch will be hard-coded to true.
      If an HTTP request is received that contains an illegal header name or value (e.g. the header name is not a token) should the request be rejected (with a 400 response) or should the illegal header be ignored?
      Parameters:
      rejectIllegalHeader - true to reject requests with illegal header names or values, false to ignore the header

    • getRejectIllegalHeaderName

      @Deprecated public boolean getRejectIllegalHeaderName()
      Deprecated.
      Now an alias for getRejectIllegalHeader(). Will be removed in Tomcat 10 onwards.
      If an HTTP request is received that contains an illegal header name or value (e.g. the header name is not a token) will the request be rejected (with a 400 response) or will the illegal header be ignored?
      Returns:
      true if the request will be rejected or false if the header will be ignored

    • setRejectIllegalHeaderName

      @Deprecated public void setRejectIllegalHeaderName(boolean rejectIllegalHeaderName)
      Deprecated.
      Now an alias for setRejectIllegalHeader(boolean). Will be removed in Tomcat 10 onwards.
      If an HTTP request is received that contains an illegal header name or value (e.g. the header name is not a token) should the request be rejected (with a 400 response) or should the illegal header be ignored?
      Parameters:
      rejectIllegalHeaderName - true to reject requests with illegal header names or values, false to ignore the header

    • getMaxSavePostSize

      public int getMaxSavePostSize()
      Return the maximum size of the post which will be saved during FORM or CLIENT-CERT authentication.
      Returns:
      The size in bytes

    • setMaxSavePostSize

      public void setMaxSavePostSize(int maxSavePostSize)
      Set the maximum size of a POST which will be buffered during FORM or CLIENT-CERT authentication. When a POST is received where the security constraints require a client certificate, the POST body needs to be buffered while an SSL handshake takes place to obtain the certificate. A similar buffering is required during FORM auth.
      Parameters:
      maxSavePostSize - The maximum size POST body to buffer in bytes

    • getMaxHttpHeaderSize

      public int getMaxHttpHeaderSize()

    • setMaxHttpHeaderSize

      public void setMaxHttpHeaderSize(int valueI)

    • getMaxHttpRequestHeaderSize

      public int getMaxHttpRequestHeaderSize()

    • setMaxHttpRequestHeaderSize

      public void setMaxHttpRequestHeaderSize(int valueI)

    • getMaxHttpResponseHeaderSize

      public int getMaxHttpResponseHeaderSize()

    • setMaxHttpResponseHeaderSize

      public void setMaxHttpResponseHeaderSize(int valueI)

    • getConnectionUploadTimeout

      public int getConnectionUploadTimeout()
      Specifies a different (usually longer) connection timeout during data upload. Default is 5 minutes as in Apache HTTPD server.
      Returns:
      The timeout in milliseconds

    • setConnectionUploadTimeout

      public void setConnectionUploadTimeout(int timeout)
      Set the upload timeout.
      Parameters:
      timeout - Upload timeout in milliseconds

    • getDisableUploadTimeout

      public boolean getDisableUploadTimeout()
      Get the flag that controls upload time-outs. If true, the connectionUploadTimeout will be ignored and the regular socket timeout will be used for the full duration of the connection.
      Returns:
      true if the separate upload timeout is disabled

    • setDisableUploadTimeout

      public void setDisableUploadTimeout(boolean isDisabled)
      Set the flag to control whether a separate connection timeout is used during upload of a request body.
      Parameters:
      isDisabled - true if the separate upload timeout should be disabled

    • setCompression

      public void setCompression(String compression)

    • getCompression

      public String getCompression()

    • getNoCompressionUserAgents

      public String getNoCompressionUserAgents()

    • setNoCompressionUserAgents

      public void setNoCompressionUserAgents(String noCompressionUserAgents)

    • getCompressableMimeType

      @Deprecated public String getCompressableMimeType()
      Deprecated.
      Use getCompressibleMimeType()
      Returns:
      See getCompressibleMimeType()

    • setCompressableMimeType

      @Deprecated public void setCompressableMimeType(String valueS)
      Deprecated.
      Use setCompressibleMimeType(String)
      Parameters:
      valueS - See setCompressibleMimeType(String)

    • getCompressableMimeTypes

      @Deprecated public String[] getCompressableMimeTypes()
      Deprecated.
      Use getCompressibleMimeTypes()
      Returns:
      See getCompressibleMimeTypes()

    • getCompressibleMimeType

      public String getCompressibleMimeType()

    • setCompressibleMimeType

      public void setCompressibleMimeType(String valueS)

    • getCompressibleMimeTypes

      public String[] getCompressibleMimeTypes()

    • getCompressionMinSize

      public int getCompressionMinSize()

    • setCompressionMinSize

      public void setCompressionMinSize(int compressionMinSize)

    • getNoCompressionStrongETag

      @Deprecated public boolean getNoCompressionStrongETag()
      Deprecated.

    • setNoCompressionStrongETag

      @Deprecated public void setNoCompressionStrongETag(boolean noCompressionStrongETag)
      Deprecated.

    • useCompression

      public boolean useCompression(Request request, Response response)

    • getRestrictedUserAgents

      public String getRestrictedUserAgents()

    • setRestrictedUserAgents

      public void setRestrictedUserAgents(String valueS)

    • getServer

      public String getServer()

    • setServer

      public void setServer(String server)
      Set the server header name.
      Parameters:
      server - The new value to use for the server header

    • getServerRemoveAppProvidedValues

      public boolean getServerRemoveAppProvidedValues()
      Should application provider values for the HTTP Server header be removed. Note that if server is set, any application provided value will be over-ridden.
      Returns:
      true if application provided values should be removed, otherwise false

    • setServerRemoveAppProvidedValues

      public void setServerRemoveAppProvidedValues(boolean serverRemoveAppProvidedValues)

    • getMaxTrailerSize

      public int getMaxTrailerSize()

    • setMaxTrailerSize

      public void setMaxTrailerSize(int maxTrailerSize)

    • getMaxExtensionSize

      public int getMaxExtensionSize()

    • setMaxExtensionSize

      public void setMaxExtensionSize(int maxExtensionSize)

    • getMaxSwallowSize

      public int getMaxSwallowSize()

    • setMaxSwallowSize

      public void setMaxSwallowSize(int maxSwallowSize)

    • getSecure

      public boolean getSecure()

    • setSecure

      public void setSecure(boolean b)

    • setAllowedTrailerHeaders

      public void setAllowedTrailerHeaders(String commaSeparatedHeaders)

    • getAllowedTrailerHeadersInternal

      protected Set<String> getAllowedTrailerHeadersInternal()

    • getAllowedTrailerHeaders

      public String getAllowedTrailerHeaders()

    • addAllowedTrailerHeader

      public void addAllowedTrailerHeader(String header)

    • removeAllowedTrailerHeader

      public void removeAllowedTrailerHeader(String header)

    • addUpgradeProtocol

      public void addUpgradeProtocol(UpgradeProtocol upgradeProtocol)
      Description copied from interface: ProtocolHandler
      Add a new protocol for used by HTTP/1.1 upgrade or ALPN.
      Parameters:
      upgradeProtocol - the protocol

    • findUpgradeProtocols

      public UpgradeProtocol[] findUpgradeProtocols()
      Description copied from interface: ProtocolHandler
      Return all configured upgrade protocols.
      Returns:
      the protocols

    • getNegotiatedProtocol

      public UpgradeProtocol getNegotiatedProtocol(String negotiatedName)
      Description copied from class: AbstractProtocol
      Find a suitable handler for the protocol negotiated at the network layer.
      Specified by:
      getNegotiatedProtocol in class AbstractProtocol<S>
      Parameters:
      negotiatedName - The name of the requested negotiated protocol.
      Returns:
      The instance where UpgradeProtocol.getAlpnName() matches the requested protocol

    • getUpgradeProtocol

      public UpgradeProtocol getUpgradeProtocol(String upgradedName)
      Description copied from class: AbstractProtocol
      Find a suitable handler for the protocol upgraded name specified. This is used for direct connection protocol selection.
      Specified by:
      getUpgradeProtocol in class AbstractProtocol<S>
      Parameters:
      upgradedName - The name of the requested negotiated protocol.
      Returns:
      The instance where UpgradeProtocol.getAlpnName() matches the requested protocol

    • getUpgradeGroupInfo

      public UpgradeGroupInfo getUpgradeGroupInfo(String upgradeProtocol)

    • getONameForUpgrade

      public ObjectName getONameForUpgrade(String upgradeProtocol)

    • isSSLEnabled

      public boolean isSSLEnabled()

    • setSSLEnabled

      public void setSSLEnabled(boolean SSLEnabled)

    • getUseSendfile

      public boolean getUseSendfile()

    • setUseSendfile

      public void setUseSendfile(boolean useSendfile)

    • getMaxKeepAliveRequests

      public int getMaxKeepAliveRequests()
      Returns:
      The maximum number of requests which can be performed over a keep-alive connection. The default is the same as for Apache HTTP Server (100).

    • setMaxKeepAliveRequests

      public void setMaxKeepAliveRequests(int mkar)
      Set the maximum number of Keep-Alive requests to allow. This is to safeguard from DoS attacks. Setting to a negative value disables the limit.
      Parameters:
      mkar - The new maximum number of Keep-Alive requests allowed

    • getDefaultSSLHostConfigName

      public String getDefaultSSLHostConfigName()

    • setDefaultSSLHostConfigName

      public void setDefaultSSLHostConfigName(String defaultSSLHostConfigName)

    • addSslHostConfig

      public void addSslHostConfig(SSLHostConfig sslHostConfig)
      Description copied from interface: ProtocolHandler
      Add a new SSL configuration for a virtual host.
      Parameters:
      sslHostConfig - the configuration

    • addSslHostConfig

      public void addSslHostConfig(SSLHostConfig sslHostConfig, boolean replace)
      Description copied from interface: ProtocolHandler
      Add a new SSL configuration for a virtual host.
      Parameters:
      sslHostConfig - the configuration
      replace - If true replacement of an existing configuration is permitted, otherwise any such attempted replacement will trigger an exception

    • findSslHostConfigs

      public SSLHostConfig[] findSslHostConfigs()
      Description copied from interface: ProtocolHandler
      Find all configured SSL virtual host configurations which will be used by SNI.
      Returns:
      the configurations

    • reloadSslHostConfigs

      public void reloadSslHostConfigs()

    • reloadSslHostConfig

      public void reloadSslHostConfig(String hostName)

    • getSslEnabledProtocols

      public String getSslEnabledProtocols()

    • setSslEnabledProtocols

      public void setSslEnabledProtocols(String enabledProtocols)

    • getSSLProtocol

      public String getSSLProtocol()

    • setSSLProtocol

      public void setSSLProtocol(String sslProtocol)

    • getKeystoreFile

      public String getKeystoreFile()

    • setKeystoreFile

      public void setKeystoreFile(String keystoreFile)

    • getSSLCertificateChainFile

      public String getSSLCertificateChainFile()

    • setSSLCertificateChainFile

      public void setSSLCertificateChainFile(String certificateChainFile)

    • getSSLCertificateFile

      public String getSSLCertificateFile()

    • setSSLCertificateFile

      public void setSSLCertificateFile(String certificateFile)

    • getSSLCertificateKeyFile

      public String getSSLCertificateKeyFile()

    • setSSLCertificateKeyFile

      public void setSSLCertificateKeyFile(String certificateKeyFile)

    • getAlgorithm

      public String getAlgorithm()

    • setAlgorithm

      public void setAlgorithm(String keyManagerAlgorithm)

    • getClientAuth

      public String getClientAuth()

    • setClientAuth

      public void setClientAuth(String certificateVerification)

    • getSSLVerifyClient

      public String getSSLVerifyClient()

    • setSSLVerifyClient

      public void setSSLVerifyClient(String certificateVerification)

    • getTrustMaxCertLength

      public int getTrustMaxCertLength()

    • setTrustMaxCertLength

      public void setTrustMaxCertLength(int certificateVerificationDepth)

    • getSSLVerifyDepth

      public int getSSLVerifyDepth()

    • setSSLVerifyDepth

      public void setSSLVerifyDepth(int certificateVerificationDepth)

    • getUseServerCipherSuitesOrder

      public String getUseServerCipherSuitesOrder()

    • setUseServerCipherSuitesOrder

      public void setUseServerCipherSuitesOrder(String honorCipherOrder)

    • getSSLHonorCipherOrder

      public String getSSLHonorCipherOrder()

    • setSSLHonorCipherOrder

      public void setSSLHonorCipherOrder(String honorCipherOrder)

    • getCiphers

      public String getCiphers()

    • setCiphers

      public void setCiphers(String ciphers)

    • getSSLCipherSuite

      public String getSSLCipherSuite()

    • setSSLCipherSuite

      public void setSSLCipherSuite(String ciphers)

    • getKeystorePass

      public String getKeystorePass()

    • setKeystorePass

      public void setKeystorePass(String certificateKeystorePassword)

    • getKeystorePassFile

      public String getKeystorePassFile()

    • setKeystorePassFile

      public void setKeystorePassFile(String certificateKeystorePasswordFile)

    • getKeyPass

      public String getKeyPass()

    • setKeyPass

      public void setKeyPass(String certificateKeyPassword)

    • getKeyPassFile

      public String getKeyPassFile()

    • setKeyPassFile

      public void setKeyPassFile(String certificateKeyPasswordFile)

    • getSSLPassword

      public String getSSLPassword()

    • setSSLPassword

      public void setSSLPassword(String certificateKeyPassword)

    • getSSLPasswordFile

      public String getSSLPasswordFile()

    • setSSLPasswordFile

      public void setSSLPasswordFile(String certificateKeyPasswordFile)

    • getCrlFile

      public String getCrlFile()

    • setCrlFile

      public void setCrlFile(String certificateRevocationListFile)

    • getSSLCARevocationFile

      public String getSSLCARevocationFile()

    • setSSLCARevocationFile

      public void setSSLCARevocationFile(String certificateRevocationListFile)

    • getSSLCARevocationPath

      public String getSSLCARevocationPath()

    • setSSLCARevocationPath

      public void setSSLCARevocationPath(String certificateRevocationListPath)

    • getKeystoreType

      public String getKeystoreType()

    • setKeystoreType

      public void setKeystoreType(String certificateKeystoreType)

    • getKeystoreProvider

      public String getKeystoreProvider()

    • setKeystoreProvider

      public void setKeystoreProvider(String certificateKeystoreProvider)

    • getKeyAlias

      public String getKeyAlias()

    • setKeyAlias

      public void setKeyAlias(String certificateKeyAlias)

    • getTruststoreAlgorithm

      public String getTruststoreAlgorithm()

    • setTruststoreAlgorithm

      public void setTruststoreAlgorithm(String truststoreAlgorithm)

    • getTruststoreFile

      public String getTruststoreFile()

    • setTruststoreFile

      public void setTruststoreFile(String truststoreFile)

    • getTruststorePass

      public String getTruststorePass()

    • setTruststorePass

      public void setTruststorePass(String truststorePassword)

    • getTruststoreType

      public String getTruststoreType()

    • setTruststoreType

      public void setTruststoreType(String truststoreType)

    • getTruststoreProvider

      public String getTruststoreProvider()

    • setTruststoreProvider

      public void setTruststoreProvider(String truststoreProvider)

    • getSslProtocol

      public String getSslProtocol()

    • setSslProtocol

      public void setSslProtocol(String sslProtocol)

    • getSessionCacheSize

      public int getSessionCacheSize()

    • setSessionCacheSize

      public void setSessionCacheSize(int sessionCacheSize)

    • getSessionTimeout

      public int getSessionTimeout()

    • setSessionTimeout

      public void setSessionTimeout(int sessionTimeout)

    • getSSLCACertificatePath

      public String getSSLCACertificatePath()

    • setSSLCACertificatePath

      public void setSSLCACertificatePath(String caCertificatePath)

    • getSSLCACertificateFile

      public String getSSLCACertificateFile()

    • setSSLCACertificateFile

      public void setSSLCACertificateFile(String caCertificateFile)

    • getSSLDisableCompression

      public boolean getSSLDisableCompression()

    • setSSLDisableCompression

      public void setSSLDisableCompression(boolean disableCompression)

    • getSSLDisableSessionTickets

      public boolean getSSLDisableSessionTickets()

    • setSSLDisableSessionTickets

      public void setSSLDisableSessionTickets(boolean disableSessionTickets)

    • getTrustManagerClassName

      public String getTrustManagerClassName()

    • setTrustManagerClassName

      public void setTrustManagerClassName(String trustManagerClassName)

    • createProcessor

      protected Processor createProcessor()
      Description copied from class: AbstractProtocol
      Create and configure a new Processor instance for the current protocol implementation.
      Specified by:
      createProcessor in class AbstractProtocol<S>
      Returns:
      A fully configured Processor instance that is ready to use

    • createUpgradeProcessor

      protected Processor createUpgradeProcessor(SocketWrapperBase<?> socket, UpgradeToken upgradeToken)
      Specified by:
      createUpgradeProcessor in class AbstractProtocol<S>