Top Description Fields Constructors Methods
org.apache.tomcat.websocket

public Class Constants

extends Object
Class Inheritance
Imports
java.util.ArrayList, .Collections, .List, java.util.concurrent.TimeUnit, jakarta.websocket.ClientEndpointConfig, .Extension
Internal implementation constants.

Field Summary

Modifier and TypeField and Description
public static final String
AUTHORIZATION_HEADER_NAME

public static final String
BLOCKING_SEND_TIMEOUT_PROPERTY

public static final String
CONNECTION_HEADER_NAME

public static final String
CONNECTION_HEADER_VALUE

public static final long
DEFAULT_BLOCKING_SEND_TIMEOUT

pack-priv static final int
DEFAULT_BUFFER_SIZE

pack-priv static final String
DEFAULT_ORIGIN_HEADER_VALUE

pack-priv static final int
DEFAULT_PROCESS_PERIOD

public static final long
DEFAULT_SESSION_CLOSE_TIMEOUT

public static final int
FOUND

public static final String
HOST_HEADER_NAME

public static final List<Extension>
INSTALLED_EXTENSIONS

pack-priv static final byte
INTERNAL_OPCODE_FLUSH

public static final long
IO_TIMEOUT_MS_DEFAULT

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.

public static final String
LOCATION_HEADER_NAME

public static final int
MAX_REDIRECTIONS_DEFAULT

public static final String
MAX_REDIRECTIONS_PROPERTY

public static final int
MOVED_PERMANENTLY

public static final int
MULTIPLE_CHOICES

public static final byte
OPCODE_BINARY

public static final byte
OPCODE_CLOSE

public static final byte
OPCODE_CONTINUATION

public static final byte
OPCODE_PING

public static final byte
OPCODE_PONG

public static final byte
OPCODE_TEXT

public static final String
ORIGIN_HEADER_NAME

public static final String
PROXY_AUTHENTICATE_HEADER_NAME

public static final int
PROXY_AUTHENTICATION_REQUIRED

public static final String
PROXY_AUTHORIZATION_HEADER_NAME

public static final String
READ_IDLE_TIMEOUT_MS

public static final int
SEE_OTHER

public static final String
SESSION_CLOSE_TIMEOUT_PROPERTY

public static final String
SSL_CONTEXT_PROPERTY

Deprecated for removal since Tomcat 10.1.x. This will be removed in Tomcat 11. Use ClientEndpointConfig#getSSLContext()
Property name to set to configure used SSLContext.
public static final String
SSL_PROTOCOLS_PROPERTY

Deprecated for removal since Tomcat 10.1.x. This will be removed in Tomcat 11. Use ClientEndpointConfig#getSSLContext()
Property name to set to configure the value that is passed to javax.net.ssl.SSLEngine#setEnabledProtocols(String[]).
public static final String
SSL_TRUSTSTORE_PROPERTY

Deprecated for removal since Tomcat 10.1.x.
public static final String
SSL_TRUSTSTORE_PWD_DEFAULT

Deprecated for removal since Tomcat 10.1.x.
public static final String
SSL_TRUSTSTORE_PWD_PROPERTY

Deprecated for removal since Tomcat 10.1.x.
public static final int
TEMPORARY_REDIRECT

public static final int
UNAUTHORIZED

public static final String
UPGRADE_HEADER_NAME

public static final String
UPGRADE_HEADER_VALUE

public static final int
USE_PROXY

public static final String
WRITE_IDLE_TIMEOUT_MS

public static final String
WS_AUTHENTICATION_PASSWORD

public static final String
WS_AUTHENTICATION_PROXY_PASSWORD

public static final String
WS_AUTHENTICATION_PROXY_REALM

public static final String
WS_AUTHENTICATION_PROXY_USER_NAME

public static final String
WS_AUTHENTICATION_REALM

public static final String
WS_AUTHENTICATION_USER_NAME

public static final String
WS_EXTENSIONS_HEADER_NAME

public static final String
WS_KEY_HEADER_NAME

public static final String
WS_PROTOCOL_HEADER_NAME

public static final String
WS_VERSION_HEADER_NAME

public static final String
WS_VERSION_HEADER_VALUE

public static final String
WWW_AUTHENTICATE_HEADER_NAME

Constructor Summary

AccessConstructor and Description
private
Constants()

Method Summary

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

AUTHORIZATION_HEADER_NAMEback to summary
public static final String AUTHORIZATION_HEADER_NAME
BLOCKING_SEND_TIMEOUT_PROPERTYback to summary
public static final String BLOCKING_SEND_TIMEOUT_PROPERTY
CONNECTION_HEADER_NAMEback to summary
public static final String CONNECTION_HEADER_NAME
CONNECTION_HEADER_VALUEback to summary
public static final String CONNECTION_HEADER_VALUE
DEFAULT_BLOCKING_SEND_TIMEOUTback to summary
public static final long DEFAULT_BLOCKING_SEND_TIMEOUT
DEFAULT_BUFFER_SIZEback to summary
pack-priv static final int DEFAULT_BUFFER_SIZE
DEFAULT_ORIGIN_HEADER_VALUEback to summary
pack-priv static final String DEFAULT_ORIGIN_HEADER_VALUE
DEFAULT_PROCESS_PERIODback to summary
pack-priv static final int DEFAULT_PROCESS_PERIOD
DEFAULT_SESSION_CLOSE_TIMEOUTback to summary
public static final long DEFAULT_SESSION_CLOSE_TIMEOUT
FOUNDback to summary
public static final int FOUND
HOST_HEADER_NAMEback to summary
public static final String HOST_HEADER_NAME
INSTALLED_EXTENSIONSback to summary
public static final List<Extension> INSTALLED_EXTENSIONS
INTERNAL_OPCODE_FLUSHback to summary
pack-priv static final byte INTERNAL_OPCODE_FLUSH
IO_TIMEOUT_MS_DEFAULTback to summary
public static final long IO_TIMEOUT_MS_DEFAULT
IO_TIMEOUT_MS_PROPERTYback to summary
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.

LOCATION_HEADER_NAMEback to summary
public static final String LOCATION_HEADER_NAME
MAX_REDIRECTIONS_DEFAULTback to summary
public static final int MAX_REDIRECTIONS_DEFAULT
MAX_REDIRECTIONS_PROPERTYback to summary
public static final String MAX_REDIRECTIONS_PROPERTY
MOVED_PERMANENTLYback to summary
public static final int MOVED_PERMANENTLY
MULTIPLE_CHOICESback to summary
public static final int MULTIPLE_CHOICES
OPCODE_BINARYback to summary
public static final byte OPCODE_BINARY
OPCODE_CLOSEback to summary
public static final byte OPCODE_CLOSE
OPCODE_CONTINUATIONback to summary
public static final byte OPCODE_CONTINUATION
OPCODE_PINGback to summary
public static final byte OPCODE_PING
OPCODE_PONGback to summary
public static final byte OPCODE_PONG
OPCODE_TEXTback to summary
public static final byte OPCODE_TEXT
ORIGIN_HEADER_NAMEback to summary
public static final String ORIGIN_HEADER_NAME
PROXY_AUTHENTICATE_HEADER_NAMEback to summary
public static final String PROXY_AUTHENTICATE_HEADER_NAME
PROXY_AUTHENTICATION_REQUIREDback to summary
public static final int PROXY_AUTHENTICATION_REQUIRED
PROXY_AUTHORIZATION_HEADER_NAMEback to summary
public static final String PROXY_AUTHORIZATION_HEADER_NAME
READ_IDLE_TIMEOUT_MSback to summary
public static final String READ_IDLE_TIMEOUT_MS
SEE_OTHERback to summary
public static final int SEE_OTHER
SESSION_CLOSE_TIMEOUT_PROPERTYback to summary
public static final String SESSION_CLOSE_TIMEOUT_PROPERTY
SSL_CONTEXT_PROPERTYback to summary
public static final String SSL_CONTEXT_PROPERTY

Deprecated

for removal since Tomcat 10.1.x.

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.

Annotations
@Deprecated
forRemoval:true
since:Tomcat 10.1.x
SSL_PROTOCOLS_PROPERTYback to summary
public static final String SSL_PROTOCOLS_PROPERTY

Deprecated

for removal since Tomcat 10.1.x.

This will be removed in Tomcat 11. Use ClientEndpointConfig#getSSLContext()

Property name to set to configure the value that is passed to javax.net.ssl.SSLEngine#setEnabledProtocols(String[]). The value should be a comma separated string.

Annotations
@Deprecated
forRemoval:true
since:Tomcat 10.1.x
SSL_TRUSTSTORE_PROPERTYback to summary
public static final String SSL_TRUSTSTORE_PROPERTY

Deprecated

for removal since Tomcat 10.1.x.

Annotations
@Deprecated
forRemoval:true
since:Tomcat 10.1.x
SSL_TRUSTSTORE_PWD_DEFAULTback to summary
public static final String SSL_TRUSTSTORE_PWD_DEFAULT

Deprecated

for removal since Tomcat 10.1.x.

Annotations
@Deprecated
forRemoval:true
since:Tomcat 10.1.x
SSL_TRUSTSTORE_PWD_PROPERTYback to summary
public static final String SSL_TRUSTSTORE_PWD_PROPERTY

Deprecated

for removal since Tomcat 10.1.x.

Annotations
@Deprecated
forRemoval:true
since:Tomcat 10.1.x
TEMPORARY_REDIRECTback to summary
public static final int TEMPORARY_REDIRECT
UNAUTHORIZEDback to summary
public static final int UNAUTHORIZED
UPGRADE_HEADER_NAMEback to summary
public static final String UPGRADE_HEADER_NAME
UPGRADE_HEADER_VALUEback to summary
public static final String UPGRADE_HEADER_VALUE
USE_PROXYback to summary
public static final int USE_PROXY
WRITE_IDLE_TIMEOUT_MSback to summary
public static final String WRITE_IDLE_TIMEOUT_MS
WS_AUTHENTICATION_PASSWORDback to summary
public static final String WS_AUTHENTICATION_PASSWORD
WS_AUTHENTICATION_PROXY_PASSWORDback to summary
public static final String WS_AUTHENTICATION_PROXY_PASSWORD
WS_AUTHENTICATION_PROXY_REALMback to summary
public static final String WS_AUTHENTICATION_PROXY_REALM
WS_AUTHENTICATION_PROXY_USER_NAMEback to summary
public static final String WS_AUTHENTICATION_PROXY_USER_NAME
WS_AUTHENTICATION_REALMback to summary
public static final String WS_AUTHENTICATION_REALM
WS_AUTHENTICATION_USER_NAMEback to summary
public static final String WS_AUTHENTICATION_USER_NAME
WS_EXTENSIONS_HEADER_NAMEback to summary
public static final String WS_EXTENSIONS_HEADER_NAME
WS_KEY_HEADER_NAMEback to summary
public static final String WS_KEY_HEADER_NAME
WS_PROTOCOL_HEADER_NAMEback to summary
public static final String WS_PROTOCOL_HEADER_NAME
WS_VERSION_HEADER_NAMEback to summary
public static final String WS_VERSION_HEADER_NAME
WS_VERSION_HEADER_VALUEback to summary
public static final String WS_VERSION_HEADER_VALUE
WWW_AUTHENTICATE_HEADER_NAMEback to summary
public static final String WWW_AUTHENTICATE_HEADER_NAME

Constructor Detail

Constantsback to summary
private Constants()