Tyrus 2.2.0 · org.glassfish.tyrus.client.ClientManager

Modifier and Type	Class and Description
private static interface	ClientManager.ClientActivityListener A listener listening for events that indicate when a client has started to be active and when it stopped to be active.
private static interface	ClientManager.ClientManagerHandshakeListener
public static class	ClientManager.ReconnectHandler Reconnect handler.
private static class	ClientManager.RetryAfterReconnectHandler
private static class	ClientManager.SameThreadExecutorService Executor service which just executes provided `Runnable` in the very same thread.

Modifier and Type	Field and Description
private final ClientManager.ClientActivityListener	clientActivityListener
private final ComponentProviderService	componentProvider
private final ClientContainer	container
private static final String	CONTAINER_PROVIDER_CLASSNAME Default `org.glassfish.tyrus.spi.ServerContainerFactory` class name.
private volatile long	defaultAsyncSendTimeout
private volatile long	defaultMaxSessionIdleTimeout
public static final String	HANDSHAKE_TIMEOUT Deprecated please use `org.glassfish.tyrus.client.ClientProperties#HANDSHAKE_TIMEOUT`. Property usable in `getProperties()`.
private static final Logger	LOGGER Hides org.glassfish.tyrus.core.BaseContainer.LOGGER.
private volatile int	maxBinaryMessageBufferSize
private volatile int	maxTextMessageBufferSize
private final Map<String, Object>	properties
public static final String	PROXY_HEADERS Deprecated please use `org.glassfish.tyrus.client.ClientProperties#PROXY_HEADERS`. Client-side user property to set additional proxy headers.
public static final String	PROXY_URI Deprecated please use `org.glassfish.tyrus.client.ClientProperties#PROXY_URI`. Client-side user property to set proxy URI.
public static final String	RECONNECT_HANDLER Deprecated please use `org.glassfish.tyrus.client.ClientProperties#RECONNECT_HANDLER`. Property usable in `getProperties()`.
public static final String	SSL_ENGINE_CONFIGURATOR Deprecated please use `org.glassfish.tyrus.client.ClientProperties#SSL_ENGINE_CONFIGURATOR`. Property usable in `getProperties()` as a key for SSL configuration.
private final WebSocketContainer	webSocketContainer
public static final String	WLS_HOSTNAME_VERIFIER_CLASS
public static final String	WLS_IGNORE_HOSTNAME_VERIFICATION
public static final String	WLS_MAX_THREADS
public static final String	WLS_PROXY_HOST
public static final String	WLS_PROXY_PASSWORD
public static final String	WLS_PROXY_PORT
public static final String	WLS_PROXY_USERNAME
public static final String	WLS_SSL_PROTOCOLS_PROPERTY
public static final String	WLS_SSL_TRUSTSTORE_PROPERTY
public static final String	WLS_SSL_TRUSTSTORE_PWD_PROPERTY

Access	Constructor and Description
public	ClientManager() Create new `ClientManager` instance.
private	ClientManager(String containerProviderClassName, WebSocketContainer webSocketContainer)

Method Summary

Modifier and Type	Method and Description
public Future<Session>	Returns: Future for the Session created if the connection is successful. asyncConnectToServer(Class<?> the annotated websocket client endpoint. annotatedEndpointClass, URI the complete path to the server endpoint. path) Non-blocking version of `WebSocketContainer#connectToServer(Class, java.net.URI)`.
public Future<Session>	Returns: the Session created if the connection is successful. asyncConnectToServer(Class<? extends Endpoint> the programmatic client endpoint class `Endpoint`. endpointClass, ClientEndpointConfig the configuration used to configure the programmatic endpoint. cec, URI the complete path to the server endpoint. path) Non-blocking version of `WebSocketContainer#connectToServer(Class, jakarta.websocket.ClientEndpointConfig, java.net.URI)`.
public Future<Session>	Returns: the Session created if the connection is successful. asyncConnectToServer(Endpoint the programmatic client endpoint instance `Endpoint`. endpointInstance, ClientEndpointConfig the configuration used to configure the programmatic endpoint. cec, URI the complete path to the server endpoint. path) Non-blocking version of `WebSocketContainer#connectToServer(jakarta.websocket.Endpoint, jakarta.websocket.ClientEndpointConfig, java.net.URI)`.
public Future<Session>	Returns: the Session created if the connection is successful. asyncConnectToServer(Object the annotated websocket client endpoint instance. obj, URI the complete path to the server endpoint. path) Non-blocking version of `WebSocketContainer#connectToServer(Object, java.net.URI)`.
public Session	connectToServer(final Class<T> the annotated websocket client endpoint. annotatedEndpointClass, final URI the complete path to the server endpoint. path) Implements jakarta.websocket.WebSocketContainer.connectToServer. Connect the supplied annotated endpoint to its server.
public Session	connectToServer(final Class<? extends Endpoint> the programmatic client endpoint class `Endpoint`. endpointClass, final ClientEndpointConfig the configuration used to configure the programmatic endpoint. cec, final URI the complete path to the server endpoint. path) Implements jakarta.websocket.WebSocketContainer.connectToServer. Connect the supplied programmatic endpoint to its server with the given configuration.
public Session	connectToServer(final Endpoint the programmatic client endpoint instance `Endpoint`. endpointInstance, final ClientEndpointConfig the configuration used to configure the programmatic endpoint. cec, final URI the complete path to the server endpoint. path) Implements jakarta.websocket.WebSocketContainer.connectToServer. Connect the supplied programmatic client endpoint instance to its server with the given configuration.
public Session	connectToServer(final Object the annotated websocket client endpoint instance. obj, final URI the complete path to the server endpoint. path) Implements jakarta.websocket.WebSocketContainer.connectToServer. Connect the supplied annotated endpoint instance to its server.
pack-priv Future<Session>	Returns: Future which will return `Session` instance when available. connectToServer(final Object the endpoint. o, final ClientEndpointConfig of the endpoint. configuration, final String to which the client will connect. url, boolean if `true` connect will be executed synchronously, if `false` connect will be executed asynchronously. synchronous) Connects client endpoint o to the specified url.
public static ClientManager	Returns: created client manager. createClient() Create new `ClientManager` instance.
public static ClientManager	Returns: created client manager. createClient(WebSocketContainer websocket container. webSocketContainer) Create new ClientManager instance on top of provided `WebSocketContainer` instance.
public static ClientManager	Returns: new ClientManager instance. createClient(String classname of container provider. It will be loaded using context class loader. containerProviderClassName) Create new ClientManager instance.
public static ClientManager	Returns: new ClientManager instance. createClient(String classname of container provider. It will be loaded using context class loader. containerProviderClassName, WebSocketContainer websocket container. webSocketContainer) Create new ClientManager instance on top of provided `WebSocketContainer` instance.
public long	getDefaultAsyncSendTimeout() Implements jakarta.websocket.WebSocketContainer.getDefaultAsyncSendTimeout. Return the number of milliseconds the implementation will timeout attempting to send a websocket message for all RemoteEndpoints associated with this container.
public int	getDefaultMaxBinaryMessageBufferSize() Implements jakarta.websocket.WebSocketContainer.getDefaultMaxBinaryMessageBufferSize. Returns the default maximum size of incoming binary message that this container will buffer.
public long	getDefaultMaxSessionIdleTimeout() Implements jakarta.websocket.WebSocketContainer.getDefaultMaxSessionIdleTimeout. Return the default time in milliseconds after which any web socket sessions in this container will be closed if it has been inactive.
public int	getDefaultMaxTextMessageBufferSize() Implements jakarta.websocket.WebSocketContainer.getDefaultMaxTextMessageBufferSize. Returns the default maximum size of incoming text message that this container will buffer.
private int	getHandshakeTimeout()
public Set<Extension>	getInstalledExtensions() Implements jakarta.websocket.WebSocketContainer.getInstalledExtensions. Return the set of Extensions installed in the container.
public Map<String, Object>	Returns: map containing container properties. getProperties() Container properties.
public void	setAsyncSendTimeout(long the timeout in milliseconds; use zero or negative value for no timeout timeoutmillis) Implements jakarta.websocket.WebSocketContainer.setAsyncSendTimeout. Sets the number of milliseconds the implementation will timeout attempting to send a websocket message for all RemoteEndpoints associated with this container.
public void	setDefaultMaxBinaryMessageBufferSize(int the maximum size of binary message in number of bytes. i) Implements jakarta.websocket.WebSocketContainer.setDefaultMaxBinaryMessageBufferSize. Sets the default maximum size of incoming binary message that this container will buffer.
public void	setDefaultMaxSessionIdleTimeout(long the maximum time in milliseconds; use zero or negative value for no timeout defaultMaxSessionIdleTimeout) Implements jakarta.websocket.WebSocketContainer.setDefaultMaxSessionIdleTimeout. Sets the default time in milliseconds after which any web socket sessions in this container will be closed if it has been inactive.
public void	setDefaultMaxTextMessageBufferSize(int the maximum size of text message in number of bytes. i) Implements jakarta.websocket.WebSocketContainer.setDefaultMaxTextMessageBufferSize. Sets the maximum size of incoming text message that this container will buffer.
private Session	tryCatchInterruptedExecutionEx(SupplierWithEx<Future<Session>, DeploymentException> supplier)

Inherited from org.glassfish.tyrus.core.BaseContainer:: getExecutorService getScheduledExecutorService shutdown shutdown

public Class ClientManager

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary