Top Fields Constructors Methods
org.eclipse.jetty.ee10.websocket.jakarta.common

public Class ClientEndpointConfigWrapper

extends EndpointConfigWrapper
implements ClientEndpointConfig
Class Inheritance
All Implemented Interfaces
jakarta.websocket.ClientEndpointConfig, jakarta.websocket.EndpointConfig
Imports
java.util.List, javax.net.ssl.SSLContext, jakarta.websocket.ClientEndpointConfig, .Extension

Field Summary

Modifier and TypeField and Description
private ClientEndpointConfig

Constructor Summary

AccessConstructor and Description
public
public

Method Summary

Modifier and TypeMethod and Description
public ClientEndpointConfig.Configurator
getConfigurator()

Implements jakarta.websocket.ClientEndpointConfig.getConfigurator.

Return the custom configurator for this configuration.

public List<Extension>
getExtensions()

Implements jakarta.websocket.ClientEndpointConfig.getExtensions.

Return the extensions, in order of preference, favorite first, that this client would like to use for its sessions.

public List<String>
getPreferredSubprotocols()

Implements jakarta.websocket.ClientEndpointConfig.getPreferredSubprotocols.

Return the ordered list of sub protocols a client endpoint would like to use, in order of preference, favorite first that this client would like to use for its sessions.

public SSLContext
getSSLContext()

Implements jakarta.websocket.ClientEndpointConfig.getSSLContext.

Return the SSLContext to be used to establish a WebSocket (wss) connection to the server.

public void
init(ClientEndpointConfig endpointConfig)

Inherited from org.eclipse.jetty.ee10.websocket.jakarta.common.EndpointConfigWrapper:
getDecodersgetEncodersgetPathParamsgetUserPropertiesinit

Field Detail

_endpointConfigback to summary
private ClientEndpointConfig _endpointConfig

Hides org.eclipse.jetty.ee10.websocket.jakarta.common.EndpointConfigWrapper._endpointConfig.

Constructor Detail

ClientEndpointConfigWrapperback to summary
public ClientEndpointConfigWrapper()
ClientEndpointConfigWrapperback to summary
public ClientEndpointConfigWrapper(ClientEndpointConfig endpointConfig)

Method Detail

getConfiguratorback to summary
public ClientEndpointConfig.Configurator getConfigurator()

Implements jakarta.websocket.ClientEndpointConfig.getConfigurator.

Doc from jakarta.websocket.ClientEndpointConfig.getConfigurator.

Return the custom configurator for this configuration. If the developer did not provide one, the platform default configurator is returned.

Returns:ClientEndpointConfig.Configurator

the configurator in use with this configuration.

Annotations
@Override
getExtensionsback to summary
public List<Extension> getExtensions()

Implements jakarta.websocket.ClientEndpointConfig.getExtensions.

Doc from jakarta.websocket.ClientEndpointConfig.getExtensions.

Return the extensions, in order of preference, favorite first, that this client would like to use for its sessions. These are the extensions that will be used to populate the Sec-WebSocket-Extensions header in the opening handshake for clients using this configuration. The first extension in the list is the most preferred extension. See Negotiating Extensions.

Returns:List<Extension>

the list of extensions, the empty list if there are none.

Annotations
@Override
getPreferredSubprotocolsback to summary
public List<String> getPreferredSubprotocols()

Implements jakarta.websocket.ClientEndpointConfig.getPreferredSubprotocols.

Doc from jakarta.websocket.ClientEndpointConfig.getPreferredSubprotocols.

Return the ordered list of sub protocols a client endpoint would like to use, in order of preference, favorite first that this client would like to use for its sessions. This list is used to generate the Sec-WebSocket-Protocol header in the opening handshake for clients using this configuration. The first protocol name is the most preferred. See Client Opening Handshake.

Returns:List<String>

the list of the preferred subprotocols, the empty list if there are none

Annotations
@Override
getSSLContextback to summary
public SSLContext getSSLContext()

Implements jakarta.websocket.ClientEndpointConfig.getSSLContext.

Doc from jakarta.websocket.ClientEndpointConfig.getSSLContext.

Return the SSLContext to be used to establish a WebSocket (wss) connection to the server. The SSLContext will have initialised. For insecure WebSocket (ws) connections, this will be null. If there is an existing connection to the server that uses the same SSLContext and that connection supports multiplexing WebSocket connections then the container may choose to re-use that connection rather than creating a new one. Containers may provide container specific configuration to control this behaviour.

Returns:SSLContext

the SSLContext to use to establish a secure connection to the server or null if an insecure connection should be established

Annotations
@Override
initback to summary
public void init(ClientEndpointConfig endpointConfig)