Top Inners Methods
jakarta.websocket

public Interface ClientEndpointConfig

extends EndpointConfig
Known Direct Implementers
jakarta.websocket.DefaultClientEndpointConfig
Imports
java.util.Collections, .List, .Map, javax.net.ssl.SSLContext

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
ClientEndpointConfig.Builder

public static class
ClientEndpointConfig.Configurator

Method Summary

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

public List<Extension>
getExtensions()

public List<String>
getPreferredSubprotocols()

public SSLContext
getSSLContext()

Inherited from jakarta.websocket.EndpointConfig:
getDecodersgetEncodersgetUserProperties

Method Detail

getConfiguratorback to summary
public ClientEndpointConfig.Configurator getConfigurator()
getExtensionsback to summary
public List<Extension> getExtensions()
getPreferredSubprotocolsback to summary
public List<String> getPreferredSubprotocols()
getSSLContextback to summary
public SSLContext getSSLContext()
jakarta.websocket back to summary

public final Class ClientEndpointConfig.Builder

extends Object
Class Inheritance

Field Summary

Modifier and TypeField and Description
private ClientEndpointConfig.Configurator
configurator

private List<Class<? extends Decoder>>
decoders

private static final ClientEndpointConfig.Configurator
DEFAULT_CONFIGURATOR

private List<Class<? extends Encoder>>
encoders

private List<Extension>
extensions

private List<String>
preferredSubprotocols

private SSLContext
sslContext

Constructor Summary

AccessConstructor and Description
private
Builder()

Method Summary

Modifier and TypeMethod and Description
public ClientEndpointConfig
build()

public ClientEndpointConfig.Builder
configurator(ClientEndpointConfig.Configurator configurator)

public static ClientEndpointConfig.Builder
create()

public ClientEndpointConfig.Builder
decoders(List<Class<? extends Decoder>> decoders)

public ClientEndpointConfig.Builder
encoders(List<Class<? extends Encoder>> encoders)

public ClientEndpointConfig.Builder
extensions(List<Extension> extensions)

public ClientEndpointConfig.Builder
preferredSubprotocols(List<String> preferredSubprotocols)

public ClientEndpointConfig.Builder
sslContext(SSLContext sslContext)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

configuratorback to summary
private ClientEndpointConfig.Configurator configurator
decodersback to summary
private List<Class<? extends Decoder>> decoders
DEFAULT_CONFIGURATORback to summary
private static final ClientEndpointConfig.Configurator DEFAULT_CONFIGURATOR
encodersback to summary
private List<Class<? extends Encoder>> encoders
extensionsback to summary
private List<Extension> extensions
preferredSubprotocolsback to summary
private List<String> preferredSubprotocols
sslContextback to summary
private SSLContext sslContext

Constructor Detail

Builderback to summary
private Builder()

Method Detail

buildback to summary
public ClientEndpointConfig build()
configuratorback to summary
public ClientEndpointConfig.Builder configurator(ClientEndpointConfig.Configurator configurator)
createback to summary
public static ClientEndpointConfig.Builder create()
decodersback to summary
public ClientEndpointConfig.Builder decoders(List<Class<? extends Decoder>> decoders)
encodersback to summary
public ClientEndpointConfig.Builder encoders(List<Class<? extends Encoder>> encoders)
extensionsback to summary
public ClientEndpointConfig.Builder extensions(List<Extension> extensions)
preferredSubprotocolsback to summary
public ClientEndpointConfig.Builder preferredSubprotocols(List<String> preferredSubprotocols)
sslContextback to summary
public ClientEndpointConfig.Builder sslContext(SSLContext sslContext)
jakarta.websocket back to summary

public Class ClientEndpointConfig.Configurator

extends Object
Class Inheritance

Constructor Summary

AccessConstructor and Description
public
Configurator()

Method Summary

Modifier and TypeMethod and Description
public void
afterResponse(HandshakeResponse
The response
handshakeResponse)

Provides the client with a mechanism to inspect the handshake response that is returned from the server.

public void
beforeRequest(Map<String, List<String>>
The HTTP headers
headers)

Provides the client with a mechanism to inspect and/or modify the headers that are sent to the server to start the WebSocket handshake.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

Configuratorback to summary
public Configurator()

Method Detail

afterResponseback to summary
public void afterResponse(HandshakeResponse handshakeResponse)

Provides the client with a mechanism to inspect the handshake response that is returned from the server.

Parameters
handshakeResponse:HandshakeResponse

The response

beforeRequestback to summary
public void beforeRequest(Map<String, List<String>> headers)

Provides the client with a mechanism to inspect and/or modify the headers that are sent to the server to start the WebSocket handshake.

Parameters
headers:Map<String, List<String>>

The HTTP headers