Class Constants

java.lang.Object
org.apache.tomcat.websocket.Constants
public class Constants extends Object
Internal implementation constants.

  • Field Details

    • OPCODE_CONTINUATION

      public static final byte OPCODE_CONTINUATION
      Continuation frame opcode.
      See Also:

    • OPCODE_TEXT

      public static final byte OPCODE_TEXT
      Text frame opcode.
      See Also:

    • OPCODE_BINARY

      public static final byte OPCODE_BINARY
      Binary frame opcode.
      See Also:

    • OPCODE_CLOSE

      public static final byte OPCODE_CLOSE
      Close frame opcode.
      See Also:

    • OPCODE_PING

      public static final byte OPCODE_PING
      Ping frame opcode.
      See Also:

    • OPCODE_PONG

      public static final byte OPCODE_PONG
      Pong frame opcode.
      See Also:

    • SSL_PROTOCOLS_PROPERTY

      @Deprecated(forRemoval=true, since="Tomcat 10.1.x") public static final String SSL_PROTOCOLS_PROPERTY
      Deprecated, for removal: This API element is subject to removal in a future version.
      This will be removed in Tomcat 11. Use ClientEndpointConfig.getSSLContext()
      Property name to set to configure the value that is passed to SSLEngine.setEnabledProtocols(String[]). The value should be a comma separated string.
      See Also:

    • SSL_TRUSTSTORE_PROPERTY

      @Deprecated(forRemoval=true, since="Tomcat 10.1.x") public static final String SSL_TRUSTSTORE_PROPERTY
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • SSL_TRUSTSTORE_PWD_PROPERTY

      @Deprecated(forRemoval=true, since="Tomcat 10.1.x") public static final String SSL_TRUSTSTORE_PWD_PROPERTY
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • SSL_TRUSTSTORE_PWD_DEFAULT

      @Deprecated(forRemoval=true, since="Tomcat 10.1.x") public static final String SSL_TRUSTSTORE_PWD_DEFAULT
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • SSL_CONTEXT_PROPERTY

      @Deprecated(forRemoval=true, since="Tomcat 10.1.x") public static final String SSL_CONTEXT_PROPERTY
      Deprecated, for removal: This API element is subject to removal in a future version.
      This will be removed in Tomcat 11. Use ClientEndpointConfig.getSSLContext()
      Property name to set to configure used SSLContext. The value should be an instance of SSLContext. If this property is present, the SSL_TRUSTSTORE* properties are ignored.
      See Also:

    • IO_TIMEOUT_MS_PROPERTY

      public static final String IO_TIMEOUT_MS_PROPERTY
      Property name to set to configure the timeout (in milliseconds) when establishing a WebSocket connection to server. The default is IO_TIMEOUT_MS_DEFAULT.
      See Also:

    • IO_TIMEOUT_MS_DEFAULT

      public static final long IO_TIMEOUT_MS_DEFAULT
      Default I/O timeout in milliseconds for WebSocket client connections.
      See Also:

    • MAX_REDIRECTIONS_PROPERTY

      public static final String MAX_REDIRECTIONS_PROPERTY
      Property name for maximum redirect count.
      See Also:

    • MAX_REDIRECTIONS_DEFAULT

      public static final int MAX_REDIRECTIONS_DEFAULT
      Default maximum number of redirects.
      See Also:

    • HOST_HEADER_NAME

      public static final String HOST_HEADER_NAME
      Host HTTP header name.
      See Also:

    • UPGRADE_HEADER_NAME

      public static final String UPGRADE_HEADER_NAME
      Upgrade HTTP header name.
      See Also:

    • UPGRADE_HEADER_VALUE

      public static final String UPGRADE_HEADER_VALUE
      Upgrade header value for WebSocket.
      See Also:

    • ORIGIN_HEADER_NAME

      public static final String ORIGIN_HEADER_NAME
      Origin HTTP header name.
      See Also:

    • CONNECTION_HEADER_NAME

      public static final String CONNECTION_HEADER_NAME
      Connection HTTP header name.
      See Also:

    • CONNECTION_HEADER_VALUE

      public static final String CONNECTION_HEADER_VALUE
      Connection header upgrade value.
      See Also:

    • LOCATION_HEADER_NAME

      public static final String LOCATION_HEADER_NAME
      Location HTTP header name.
      See Also:

    • AUTHORIZATION_HEADER_NAME

      public static final String AUTHORIZATION_HEADER_NAME
      Authorization HTTP header name.
      See Also:

    • WWW_AUTHENTICATE_HEADER_NAME

      public static final String WWW_AUTHENTICATE_HEADER_NAME
      WWW-Authenticate HTTP header name.
      See Also:

    • PROXY_AUTHORIZATION_HEADER_NAME

      public static final String PROXY_AUTHORIZATION_HEADER_NAME
      Proxy-Authorization HTTP header name.
      See Also:

    • PROXY_AUTHENTICATE_HEADER_NAME

      public static final String PROXY_AUTHENTICATE_HEADER_NAME
      Proxy-Authenticate HTTP header name.
      See Also:

    • WS_VERSION_HEADER_NAME

      public static final String WS_VERSION_HEADER_NAME
      Sec-WebSocket-Version HTTP header name.
      See Also:

    • WS_VERSION_HEADER_VALUE

      public static final String WS_VERSION_HEADER_VALUE
      Sec-WebSocket-Version header value.
      See Also:

    • WS_KEY_HEADER_NAME

      public static final String WS_KEY_HEADER_NAME
      Sec-WebSocket-Key HTTP header name.
      See Also:

    • WS_PROTOCOL_HEADER_NAME

      public static final String WS_PROTOCOL_HEADER_NAME
      Sec-WebSocket-Protocol HTTP header name.
      See Also:

    • WS_EXTENSIONS_HEADER_NAME

      public static final String WS_EXTENSIONS_HEADER_NAME
      Sec-WebSocket-Extensions HTTP header name.
      See Also:

    • MULTIPLE_CHOICES

      public static final int MULTIPLE_CHOICES
      HTTP 300 Multiple Choices.
      See Also:

    • MOVED_PERMANENTLY

      public static final int MOVED_PERMANENTLY
      HTTP 301 Moved Permanently.
      See Also:

    • FOUND

      public static final int FOUND
      HTTP 302 Found.
      See Also:

    • SEE_OTHER

      public static final int SEE_OTHER
      HTTP 303 See Other.
      See Also:

    • USE_PROXY

      public static final int USE_PROXY
      HTTP 305 Use Proxy.
      See Also:

    • TEMPORARY_REDIRECT

      public static final int TEMPORARY_REDIRECT
      HTTP 307 Temporary Redirect.
      See Also:

    • UNAUTHORIZED

      public static final int UNAUTHORIZED
      HTTP 401 Unauthorized.
      See Also:

    • PROXY_AUTHENTICATION_REQUIRED

      public static final int PROXY_AUTHENTICATION_REQUIRED
      HTTP 407 Proxy Authentication Required.
      See Also:

    • BLOCKING_SEND_TIMEOUT_PROPERTY

      public static final String BLOCKING_SEND_TIMEOUT_PROPERTY
      Property name for blocking send timeout configuration.
      See Also:

    • DEFAULT_BLOCKING_SEND_TIMEOUT

      public static final long DEFAULT_BLOCKING_SEND_TIMEOUT
      Default blocking send timeout in milliseconds (20 seconds).
      See Also:

    • SESSION_CLOSE_TIMEOUT_PROPERTY

      public static final String SESSION_CLOSE_TIMEOUT_PROPERTY
      Property name for session close timeout configuration.
      See Also:

    • DEFAULT_SESSION_CLOSE_TIMEOUT

      public static final long DEFAULT_SESSION_CLOSE_TIMEOUT
      Default session close timeout in milliseconds (30 seconds).

    • ABNORMAL_SESSION_CLOSE_SEND_TIMEOUT_PROPERTY

      public static final String ABNORMAL_SESSION_CLOSE_SEND_TIMEOUT_PROPERTY
      Property name for abnormal session close send timeout configuration.
      See Also:

    • DEFAULT_ABNORMAL_SESSION_CLOSE_SEND_TIMEOUT

      public static final long DEFAULT_ABNORMAL_SESSION_CLOSE_SEND_TIMEOUT
      Default abnormal session close send timeout in milliseconds (50ms).
      See Also:

    • READ_IDLE_TIMEOUT_MS

      public static final String READ_IDLE_TIMEOUT_MS
      Property name for read idle timeout in milliseconds on WebSocket sessions.
      See Also:

    • WRITE_IDLE_TIMEOUT_MS

      public static final String WRITE_IDLE_TIMEOUT_MS
      Property name for write idle timeout in milliseconds on WebSocket sessions.
      See Also:

    • WS_AUTHENTICATION_USER_NAME

      public static final String WS_AUTHENTICATION_USER_NAME
      Property name for WebSocket authentication username.
      See Also:

    • WS_AUTHENTICATION_PASSWORD

      public static final String WS_AUTHENTICATION_PASSWORD
      Property name for WebSocket authentication password.
      See Also:

    • WS_AUTHENTICATION_REALM

      public static final String WS_AUTHENTICATION_REALM
      Property name for WebSocket authentication realm.
      See Also:

    • WS_AUTHENTICATION_PROXY_USER_NAME

      public static final String WS_AUTHENTICATION_PROXY_USER_NAME
      Property name for WebSocket proxy authentication username.
      See Also:

    • WS_AUTHENTICATION_PROXY_PASSWORD

      public static final String WS_AUTHENTICATION_PROXY_PASSWORD
      Property name for WebSocket proxy authentication password.
      See Also:

    • WS_AUTHENTICATION_PROXY_REALM

      public static final String WS_AUTHENTICATION_PROXY_REALM
      Property name for WebSocket proxy authentication realm.
      See Also:

    • INSTALLED_EXTENSIONS

      public static final List<Extension> INSTALLED_EXTENSIONS
      List of installed WebSocket extensions.