Modifier and Type	Class and Description
private static class	JdkClientContainer.TimeoutHandlerProxy

Modifier and Type	Field and Description
private static final int	INPUT_BUFFER_SIZE Input buffer that is used by `org.glassfish.tyrus.container.jdk.client.TransportFilter` when SSL is not turned on.
private static final Logger	LOGGER
private static final int	SSL_INPUT_BUFFER_SIZE Input buffer that is used by `org.glassfish.tyrus.container.jdk.client.TransportFilter` when SSL is turned on.

Access	Constructor and Description
public	JdkClientContainer()

Method Summary

Modifier and Type	Method and Description
private void	addProxies(ProxySelector proxySelector, URI uri, String scheme, List<Proxy> proxies)
private void	connectSynchronously(ClientFilter clientFilter, final SocketAddress address, boolean proxy) `org.glassfish.tyrus.container.jdk.client.ClientFilter#connect(java.net.SocketAddress, boolean, CompletionHandler)` is asynchronous, this method will block until it either succeeds or fails.
private ClientFilter	createClientFilter(Map<String, Object> properties, Filter downstreamFilter, ClientEngine clientEngine, Callable<Void> jdkConnector, UpgradeRequest upgradeRequest)
private SslFilter	createSslFilter(ClientEndpointConfig cec, Map<String, Object> properties, TransportFilter transportFilter, URI uri)
private TaskQueueFilter	createTaskQueueFilter(Filter downstreamFilter)
private TransportFilter	createTransportFilter(int sslInputBufferSize, ThreadPoolConfig threadPoolConfig, Integer containerIdleTimeout, InetAddress bindingAddress)
private URI	getProxyUri(URI wsUri, String scheme)
private SocketAddress	getServerAddress(URI uri)
public void	openClientSocket(final ClientEndpointConfig endpoint configuration. SPI consumer can access user properties, `jakarta.websocket.ClientEndpointConfig.Configurator`, extensions and subprotocol configuration, etc.. cec, final Map<String, Object> properties passed from client container. Don't mix up this with `jakarta.websocket.ClientEndpointConfig#getUserProperties()`, these are Tyrus proprietary. properties, final ClientEngine one instance equals to one connection, cannot be reused. Implementation is expected to call `ClientEngine#createUpgradeRequest(ClientEngine.TimeoutHandler)` and `ClientEngine#processResponse(UpgradeResponse, Writer, org.glassfish.tyrus.spi.Connection.CloseListener)` (in that order). clientEngine) Implements org.glassfish.tyrus.spi.ClientContainer.openClientSocket. Open client socket - connect to endpoint specified with `url` parameter.
private List<Proxy>	processProxy(Map<String, Object> properties, URI uri)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

INPUT_BUFFER_SIZE	back to summary
private static final int INPUT_BUFFER_SIZE Input buffer that is used by `org.glassfish.tyrus.container.jdk.client.TransportFilter` when SSL is not turned on.

LOGGER	back to summary
private static final Logger LOGGER

SSL_INPUT_BUFFER_SIZE back to summary

SSL_INPUT_BUFFER_SIZE	back to summary
private static final int SSL_INPUT_BUFFER_SIZE Input buffer that is used by `org.glassfish.tyrus.container.jdk.client.TransportFilter` when SSL is turned on. The size cannot be smaller than a maximal size of a SSL packet, which is 16kB for payload + header, because `org.glassfish.tyrus.container.jdk.client.SslFilter` does not have its own buffer for buffering incoming `org.glassfish.tyrus.container.jdk.client.SslFilter` does not have its own buffer for buffering incoming data and therefore the entire SSL packet must fit into `org.glassfish.tyrus.container.jdk.client.TransportFilter` input buffer.

private static final int SSL_INPUT_BUFFER_SIZE

Input buffer that is used by org.glassfish.tyrus.container.jdk.client.TransportFilter when SSL is turned on. The size cannot be smaller than a maximal size of a SSL packet, which is 16kB for payload + header, because org.glassfish.tyrus.container.jdk.client.SslFilter does not have its own buffer for buffering incoming org.glassfish.tyrus.container.jdk.client.SslFilter does not have its own buffer for buffering incoming data and therefore the entire SSL packet must fit into org.glassfish.tyrus.container.jdk.client.TransportFilter input buffer.

Constructor Detail

JdkClientContainer	back to summary
public JdkClientContainer()

Method Detail

addProxies	back to summary
private void addProxies(ProxySelector proxySelector, URI uri, String scheme, List<Proxy> proxies)

connectSynchronously	back to summary
private void connectSynchronously(ClientFilter clientFilter, final SocketAddress address, boolean proxy) throws Throwable `org.glassfish.tyrus.container.jdk.client.ClientFilter#connect(java.net.SocketAddress, boolean, CompletionHandler)` is asynchronous, this method will block until it either succeeds or fails.

createClientFilter	back to summary
private ClientFilter createClientFilter(Map<String, Object> properties, Filter downstreamFilter, ClientEngine clientEngine, Callable<Void> jdkConnector, UpgradeRequest upgradeRequest) throws DeploymentException

createSslFilter	back to summary
private SslFilter createSslFilter(ClientEndpointConfig cec, Map<String, Object> properties, TransportFilter transportFilter, URI uri)

createTaskQueueFilter	back to summary
private TaskQueueFilter createTaskQueueFilter(Filter downstreamFilter)

createTransportFilter	back to summary
private TransportFilter createTransportFilter(int sslInputBufferSize, ThreadPoolConfig threadPoolConfig, Integer containerIdleTimeout, InetAddress bindingAddress)

getProxyUri	back to summary
private URI getProxyUri(URI wsUri, String scheme)

getServerAddress	back to summary
private SocketAddress getServerAddress(URI uri) throws DeploymentException

openClientSocket back to summary

openClientSocket	back to summary
public void openClientSocket(final ClientEndpointConfig cec, final Map<String, Object> properties, final ClientEngine clientEngine) throws DeploymentException, IOException Implements org.glassfish.tyrus.spi.ClientContainer.openClientSocket. Doc from org.glassfish.tyrus.spi.ClientContainer.openClientSocket. Open client socket - connect to endpoint specified with `url` parameter. Called from ClientManager when `jakarta.websocket.WebSocketContainer#connectToServer(Class, jakarta.websocket.ClientEndpointConfig, java.net.URI)` is invoked. Parameters cec:ClientEndpointConfig endpoint configuration. SPI consumer can access user properties, `jakarta.websocket.ClientEndpointConfig.Configurator`, extensions and subprotocol configuration, etc.. properties:Map<String, Object> properties passed from client container. Don't mix up this with `jakarta.websocket.ClientEndpointConfig#getUserProperties()`, these are Tyrus proprietary. clientEngine:ClientEngine one instance equals to one connection, cannot be reused. Implementation is expected to call `ClientEngine#createUpgradeRequest(ClientEngine.TimeoutHandler)` and `ClientEngine#processResponse(UpgradeResponse, Writer, org.glassfish.tyrus.spi.Connection.CloseListener)` (in that order). Annotations @Override Exceptions DeploymentException: when the client endpoint is invalid or when there is any other (not specified) connection problem. IOException: when there is any I/O issue related to opening client socket or connecting to remote endpoint.

public void openClientSocket(final ClientEndpointConfig cec, final Map<String, Object> properties, final ClientEngine clientEngine) throws DeploymentException, IOException

Implements org.glassfish.tyrus.spi.ClientContainer.openClientSocket.

Doc from org.glassfish.tyrus.spi.ClientContainer.openClientSocket.

Open client socket - connect to endpoint specified with url parameter.

Called from ClientManager when jakarta.websocket.WebSocketContainer#connectToServer(Class, jakarta.websocket.ClientEndpointConfig, java.net.URI) is invoked.

Parameters

cec:ClientEndpointConfig: endpoint configuration. SPI consumer can access user properties, jakarta.websocket.ClientEndpointConfig.Configurator, extensions and subprotocol configuration, etc..
properties:Map<String, Object>: properties passed from client container. Don't mix up this with jakarta.websocket.ClientEndpointConfig#getUserProperties(), these are Tyrus proprietary.
clientEngine:ClientEngine: one instance equals to one connection, cannot be reused. Implementation is expected to call ClientEngine#createUpgradeRequest(ClientEngine.TimeoutHandler) and ClientEngine#processResponse(UpgradeResponse, Writer, org.glassfish.tyrus.spi.Connection.CloseListener) (in that order).

Annotations

@Override

Exceptions

DeploymentException:: when the client endpoint is invalid or when there is any other (not specified) connection problem.
IOException:: when there is any I/O issue related to opening client socket or connecting to remote endpoint.

processProxy	back to summary
private List<Proxy> processProxy(Map<String, Object> properties, URI uri) throws DeploymentException

org.glassfish.tyrus.container.jdk.client back to summary

private Class JdkClientContainer.TimeoutHandlerProxy

Class Inheritance

extends Object
implements TimeoutHandler

java.lang.Object
org.glassfish.tyrus.container.jdk.client.JdkClientContainer.TimeoutHandlerProxy

All Implemented Interfaces

org.glassfish.tyrus.spi.ClientEngine.TimeoutHandler

Field Summary

Modifier and Type	Field and Description
private volatile ClientEngine.TimeoutHandler	handler

Constructor Summary

Access	Constructor and Description
private	TimeoutHandlerProxy()

Method Summary

Modifier and Type	Method and Description
public void	handleTimeout() Implements org.glassfish.tyrus.spi.ClientEngine.TimeoutHandler.handleTimeout. Invoked when timeout is reached.
public void	setHandler(ClientEngine.TimeoutHandler handler)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

handler	back to summary
private volatile ClientEngine.TimeoutHandler handler

Constructor Detail

TimeoutHandlerProxy	back to summary
private TimeoutHandlerProxy()

Method Detail

handleTimeout back to summary

handleTimeout	back to summary
public void handleTimeout() Implements org.glassfish.tyrus.spi.ClientEngine.TimeoutHandler.handleTimeout. Doc from org.glassfish.tyrus.spi.ClientEngine.TimeoutHandler.handleTimeout. Invoked when timeout is reached. Container is supposed to clean all resources related to `ClientEngine` instance. Annotations @Override

public void handleTimeout()

Implements org.glassfish.tyrus.spi.ClientEngine.TimeoutHandler.handleTimeout.

Doc from org.glassfish.tyrus.spi.ClientEngine.TimeoutHandler.handleTimeout.

Invoked when timeout is reached. Container is supposed to clean all resources related to ClientEngine instance.

Annotations

@Override

setHandler	back to summary
public void setHandler(ClientEngine.TimeoutHandler handler)

public Class JdkClientContainer

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class JdkClientContainer.TimeoutHandlerProxy

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail