org.glassfish.tyrus.client.ClientManager Maven / Gradle / Ivy
/*
* Copyright (c) 2011, 2024 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package org.glassfish.tyrus.client;
import java.io.IOException;
import java.net.URI;
import java.net.URISyntaxException;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.AbstractExecutorService;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Future;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.logging.Logger;
import jakarta.websocket.ClientEndpoint;
import jakarta.websocket.ClientEndpointConfig;
import jakarta.websocket.CloseReason;
import jakarta.websocket.DeploymentException;
import jakarta.websocket.Endpoint;
import jakarta.websocket.Extension;
import jakarta.websocket.Session;
import jakarta.websocket.WebSocketContainer;
import org.glassfish.tyrus.client.exception.Exceptions;
import org.glassfish.tyrus.core.AnnotatedEndpoint;
import org.glassfish.tyrus.core.BaseContainer;
import org.glassfish.tyrus.core.ComponentProviderService;
import org.glassfish.tyrus.core.DebugContext;
import org.glassfish.tyrus.core.ErrorCollector;
import org.glassfish.tyrus.core.ReflectionHelper;
import org.glassfish.tyrus.core.TyrusEndpointWrapper;
import org.glassfish.tyrus.core.TyrusFuture;
import org.glassfish.tyrus.core.TyrusSession;
import org.glassfish.tyrus.core.Utils;
import org.glassfish.tyrus.core.collection.SupplierWithEx;
import org.glassfish.tyrus.core.monitoring.EndpointEventListener;
import org.glassfish.tyrus.spi.ClientContainer;
import org.glassfish.tyrus.spi.ClientEngine;
/**
* ClientManager implementation.
*
* @author Stepan Kopriva
* @author Pavel Bucek
*/
public class ClientManager extends BaseContainer implements WebSocketContainer {
/**
* Property usable in {@link #getProperties()}.
*
* Value must be {@code int} and represents handshake timeout in milliseconds. Default value is 30000 (30 seconds).
*
* @deprecated please use {@link org.glassfish.tyrus.client.ClientProperties#HANDSHAKE_TIMEOUT}.
*/
@SuppressWarnings("UnusedDeclaration")
public static final String HANDSHAKE_TIMEOUT = ClientProperties.HANDSHAKE_TIMEOUT;
/**
* Property usable in {@link #getProperties()}.
*
* Value must be {@link org.glassfish.tyrus.client.ClientManager.ReconnectHandler} instance.
*
* @deprecated please use {@link org.glassfish.tyrus.client.ClientProperties#RECONNECT_HANDLER}.
*/
@SuppressWarnings("UnusedDeclaration")
public static final String RECONNECT_HANDLER = ClientProperties.RECONNECT_HANDLER;
/**
* Client-side user property to set proxy URI.
*
* Value is expected to be {@link String} and represent proxy URI. Protocol part is currently ignored
* but must be present ({@link URI#URI(String)} is used for parsing).
*
* client.getProperties().put(ClientManager.PROXY_URI, "http://my.proxy.com:80");
* client.connectToServer(...);
*
*
* @see jakarta.websocket.ClientEndpointConfig#getUserProperties()
* @deprecated please use {@link org.glassfish.tyrus.client.ClientProperties#PROXY_URI}.
*/
@SuppressWarnings("UnusedDeclaration")
public static final String PROXY_URI = ClientProperties.PROXY_URI;
/**
* Client-side user property to set additional proxy headers.
*
* Value is expected to be {@link Map}<{@link String}, {@link String}> and represent raw http headers
* to be added to initial request which is sent to proxy. Key corresponds to header name, value is header
* value.
*
* Sample below demonstrates use of this feature to set preemptive basic proxy authentication:
*
* final HashMap<String, String> proxyHeaders = new HashMap<String, String>();
* proxyHeaders.put("Proxy-Authorization", "Basic " +
* Base64.getEncoder().encodeToString("username:password".getBytes(Charset.forName("UTF-8"))));
*
* client.getProperties().put(GrizzlyClientSocket.PROXY_HEADERS, proxyHeaders);
* client.connectToServer(...);
*
* Please note that these headers will be used only when establishing proxy connection, for modifying
* WebSocket handshake headers, see {@link
* jakarta.websocket.ClientEndpointConfig.Configurator#beforeRequest(java.util.Map)}.
*
* @see jakarta.websocket.ClientEndpointConfig#getUserProperties()
* @deprecated please use {@link org.glassfish.tyrus.client.ClientProperties#PROXY_HEADERS}.
*/
@SuppressWarnings("UnusedDeclaration")
public static final String PROXY_HEADERS = ClientProperties.PROXY_HEADERS;
/**
* Property usable in {@link #getProperties()} as a key for SSL configuration.
*
* Value is expected to be either {@code org.glassfish.grizzly.ssl.SSLEngineConfigurator} when configuring Grizzly
* client or {@link org.glassfish.tyrus.client.SslEngineConfigurator} when configuring JDK client.
*
* Example configuration for JDK client:
*
* SslContextConfigurator sslContextConfigurator = new SslContextConfigurator();
* sslContextConfigurator.setTrustStoreFile("...");
* sslContextConfigurator.setTrustStorePassword("...");
* sslContextConfigurator.setTrustStoreType("...");
* sslContextConfigurator.setKeyStoreFile("...");
* sslContextConfigurator.setKeyStorePassword("...");
* sslContextConfigurator.setKeyStoreType("...");
* SslEngineConfigurator sslEngineConfigurator = new SslEngineConfigurator(sslContextConfigurator, true,
* false,
* false);
* client.getProperties().put(ClientManager.SSL_ENGINE_CONFIGURATOR, sslEngineConfigurator);
*
*
* @deprecated please use {@link org.glassfish.tyrus.client.ClientProperties#SSL_ENGINE_CONFIGURATOR}.
*/
@SuppressWarnings("UnusedDeclaration")
public static final String SSL_ENGINE_CONFIGURATOR = ClientProperties.SSL_ENGINE_CONFIGURATOR;
/**
* Default {@link org.glassfish.tyrus.spi.ServerContainerFactory} class name.
*
* Uses Grizzly as transport implementation.
*/
private static final String CONTAINER_PROVIDER_CLASSNAME =
"org.glassfish.tyrus.container.grizzly.client.GrizzlyClientContainer";
public static final String WLS_PROXY_HOST = "weblogic.websocket.client.PROXY_HOST";
public static final String WLS_PROXY_PORT = "weblogic.websocket.client.PROXY_PORT";
public static final String WLS_PROXY_USERNAME = "weblogic.websocket.client.PROXY_USERNAME";
public static final String WLS_PROXY_PASSWORD = "weblogic.websocket.client.PROXY_PASSWORD";
public static final String WLS_SSL_PROTOCOLS_PROPERTY = "weblogic.websocket.client.SSL_PROTOCOLS";
public static final String WLS_SSL_TRUSTSTORE_PROPERTY = "weblogic.websocket.client.SSL_TRUSTSTORE";
public static final String WLS_SSL_TRUSTSTORE_PWD_PROPERTY = "weblogic.websocket.client.SSL_TRUSTSTORE_PWD";
public static final String WLS_MAX_THREADS = "weblogic.websocket.client.max-aio-threads";
public static final String WLS_IGNORE_HOSTNAME_VERIFICATION = "weblogic.security.SSL.ignoreHostnameVerification";
public static final String WLS_HOSTNAME_VERIFIER_CLASS = "weblogic.security.SSL.HostnameVerifier";
private static final Logger LOGGER = Logger.getLogger(ClientManager.class.getName());
private final WebSocketContainer webSocketContainer;
private final ClientContainer container;
private final ComponentProviderService componentProvider;
private final Map properties = new HashMap();
private final ClientActivityListener clientActivityListener;
private volatile long defaultAsyncSendTimeout;
private volatile long defaultMaxSessionIdleTimeout;
private volatile int maxBinaryMessageBufferSize = Integer.MAX_VALUE;
private volatile int maxTextMessageBufferSize = Integer.MAX_VALUE;
/**
* Create new {@link ClientManager} instance.
*
* Uses {@link ClientManager#CONTAINER_PROVIDER_CLASSNAME} as container implementation, thus relevant module needs
* to be on classpath. Setting different container is possible via {@link ClientManager#createClient(String)}.
*
* @return created client manager.
* @see ClientManager#createClient(String)
*/
public static ClientManager createClient() {
return createClient(CONTAINER_PROVIDER_CLASSNAME);
}
/**
* Create new ClientManager instance on top of provided {@link WebSocketContainer} instance.
*
* Uses {@link ClientManager#CONTAINER_PROVIDER_CLASSNAME} as container implementation, thus relevant module needs
* to be on classpath. Setting different container is possible via {@link ClientManager#createClient(String)}.
*
* @param webSocketContainer websocket container.
* @return created client manager.
* @see ClientManager#createClient(String)
*/
public static ClientManager createClient(WebSocketContainer webSocketContainer) {
return createClient(CONTAINER_PROVIDER_CLASSNAME, webSocketContainer);
}
/**
* Create new ClientManager instance.
*
* @param containerProviderClassName classname of container provider. It will be loaded using context class loader.
* @return new ClientManager instance.
*/
public static ClientManager createClient(String containerProviderClassName) {
return new ClientManager(containerProviderClassName, null);
}
/**
* Create new ClientManager instance on top of provided {@link WebSocketContainer} instance.
*
* @param containerProviderClassName classname of container provider. It will be loaded using context class loader.
* @param webSocketContainer websocket container.
* @return new ClientManager instance.
*/
public static ClientManager createClient(String containerProviderClassName, WebSocketContainer webSocketContainer) {
return new ClientManager(containerProviderClassName, webSocketContainer);
}
/**
* Create new {@link ClientManager} instance.
*
* Uses {@link ClientManager#CONTAINER_PROVIDER_CLASSNAME} as container implementation, thus relevant module needs
* to be on classpath. Setting different container is possible via {@link ClientManager#createClient(String)}}.
*
* @see ClientManager#createClient(String)
*/
public ClientManager() {
this(CONTAINER_PROVIDER_CLASSNAME, null);
}
private ClientManager(String containerProviderClassName, WebSocketContainer webSocketContainer) {
final ErrorCollector collector = new ErrorCollector();
componentProvider = ComponentProviderService.createClient();
Class engineProviderClazz;
try {
engineProviderClazz = ReflectionHelper.classForNameWithException(containerProviderClassName);
} catch (ClassNotFoundException e) {
collector.addException(e);
throw new RuntimeException(collector.composeComprehensiveException());
}
LOGGER.config(String.format("Provider class loaded: %s", containerProviderClassName));
this.container = (ClientContainer) ReflectionHelper.getInstance(engineProviderClazz, collector);
if (!collector.isEmpty()) {
throw new RuntimeException(collector.composeComprehensiveException());
}
this.webSocketContainer = webSocketContainer;
//TODO this could be replaced by a "standalone" counter and one method. Keep or get rid of?
this.clientActivityListener = new ClientActivityListener() {
private final AtomicInteger activeClientCounter = new AtomicInteger(0);
@Override
public void onConnectionInitiated() {
activeClientCounter.incrementAndGet();
}
@Override
public void onConnectionTerminated() {
// if this is the last active client it needs to destroy the container executors
if (activeClientCounter.decrementAndGet() == 0) {
ClientManager.this.shutdown(new ShutDownCondition() {
@Override
public boolean evaluate() {
/* the condition is evaluated in synchronized block -> check that nothing changed while
the thread was waiting for the lock */
return activeClientCounter.get() == 0;
}
});
}
}
};
}
@Override
public Session connectToServer(final Class annotatedEndpointClass, final URI path) throws DeploymentException, IOException {
if (annotatedEndpointClass.getAnnotation(ClientEndpoint.class) == null) {
throw new DeploymentException(
String.format(
"Class argument in connectToServer(Class, URI) is to be annotated endpoint class. Class "
+ "%s does not have @ClientEndpoint", annotatedEndpointClass.getName()));
}
return tryCatchInterruptedExecutionEx(() -> connectToServer(annotatedEndpointClass, null, path.toString(), true));
}
@Override
public Session connectToServer(final Class endpointClass,
final ClientEndpointConfig cec,
final URI path) throws DeploymentException, IOException {
return tryCatchInterruptedExecutionEx(() -> connectToServer(endpointClass, cec, path.toString(), true));
}
@Override
public Session connectToServer(final Endpoint endpointInstance, final ClientEndpointConfig cec, final URI path) throws
DeploymentException, IOException {
return tryCatchInterruptedExecutionEx(() -> connectToServer(endpointInstance, cec, path.toString(), true));
}
@Override
public Session connectToServer(final Object obj, final URI path) throws DeploymentException, IOException {
return tryCatchInterruptedExecutionEx(() -> connectToServer(obj, null, path.toString(), true));
}
private Session tryCatchInterruptedExecutionEx(SupplierWithEx, DeploymentException> supplier)
throws DeploymentException, IOException {
try {
return supplier.get().get();
} catch (InterruptedException e) {
throw new DeploymentException(e.getMessage(), e);
} catch (ExecutionException e) {
final Throwable cause = e.getCause();
if (cause instanceof IOException) {
throw (IOException) cause;
} else {
throw Exceptions.deploymentException(cause.getMessage(), cause);
}
}
}
/**
* Non-blocking version of {@link WebSocketContainer#connectToServer(Class, java.net.URI)}.
*
* Only simple checks are performed in the main thread; client container is created in different thread, same
* applies to connecting etc.
*
* @param annotatedEndpointClass the annotated websocket client endpoint.
* @param path the complete path to the server endpoint.
* @return Future for the Session created if the connection is successful.
* @throws DeploymentException if the class is not a valid annotated endpoint class.
*/
public Future asyncConnectToServer(Class annotatedEndpointClass, URI path) throws DeploymentException {
if (annotatedEndpointClass.getAnnotation(ClientEndpoint.class) == null) {
throw new DeploymentException(
String.format(
"Class argument in connectToServer(Class, URI) is to be annotated endpoint class. Class "
+ "%s does not have @ClientEndpoint", annotatedEndpointClass.getName()));
}
return connectToServer(annotatedEndpointClass, null, path.toString(), false);
}
/**
* Non-blocking version of {@link WebSocketContainer#connectToServer(Class, jakarta.websocket.ClientEndpointConfig,
* java.net.URI)}.
*
* Only simple checks are performed in the main thread; client container is created in different thread, same
* applies to connecting etc.
*
* @param endpointClass the programmatic client endpoint class {@link Endpoint}.
* @param path the complete path to the server endpoint.
* @param cec the configuration used to configure the programmatic endpoint.
* @return the Session created if the connection is successful.
* @throws DeploymentException if the configuration is not valid
* @see WebSocketContainer#connectToServer(Class, jakarta.websocket.ClientEndpointConfig, java.net.URI)
*/
public Future asyncConnectToServer(Class endpointClass, ClientEndpointConfig cec,
URI path) throws DeploymentException {
return connectToServer(endpointClass, cec, path.toString(), false);
}
/**
* Non-blocking version of {@link WebSocketContainer#connectToServer(jakarta.websocket.Endpoint,
* jakarta.websocket.ClientEndpointConfig, java.net.URI)}.
*
* Only simple checks are performed in the main thread; client container is created in different thread, same
* applies to connecting etc.
*
* @param endpointInstance the programmatic client endpoint instance {@link Endpoint}.
* @param path the complete path to the server endpoint.
* @param cec the configuration used to configure the programmatic endpoint.
* @return the Session created if the connection is successful.
* @throws DeploymentException if the configuration is not valid
* @see WebSocketContainer#connectToServer(jakarta.websocket.Endpoint, jakarta.websocket.ClientEndpointConfig,
* java.net.URI)
*/
public Future asyncConnectToServer(Endpoint endpointInstance, ClientEndpointConfig cec, URI path) throws
DeploymentException {
return connectToServer(endpointInstance, cec, path.toString(), false);
}
/**
* Non-blocking version of {@link WebSocketContainer#connectToServer(Object, java.net.URI)}.
*
* Only simple checks are performed in the main thread; client container is created in different thread, same
* applies to connecting etc.
*
* @param obj the annotated websocket client endpoint instance.
* @param path the complete path to the server endpoint.
* @return the Session created if the connection is successful.
* @throws DeploymentException if the annotated endpoint instance is not valid.
* @see WebSocketContainer#connectToServer(Object, java.net.URI)
*/
public Future asyncConnectToServer(Object obj, URI path) throws DeploymentException {
return connectToServer(obj, null, path.toString(), false);
}
/**
* Connects client endpoint o to the specified url.
*
* @param o the endpoint.
* @param configuration of the endpoint.
* @param url to which the client will connect.
* @param synchronous if {@code true} connect will be executed synchronously, if {@code false} connect will be
* executed asynchronously.
* @return Future which will return {@link Session} instance when available.
* @throws DeploymentException if the endpoint or provided URL is not valid.
*/
Future connectToServer(final Object o, final ClientEndpointConfig configuration, final String url,
boolean synchronous) throws DeploymentException {
final Map copiedProperties = new HashMap(properties);
/* Client activity listener must be called before an executor service is obtained from the container, otherwise
the counter of active client won't be increased and the executor service might be shut down */
clientActivityListener.onConnectionInitiated();
final ExecutorService executorService;
if (synchronous) {
executorService = new SameThreadExecutorService();
} else {
executorService = getExecutorService();
}
final TyrusFuture future = new TyrusFuture() {
@Override
public void setFailure(Throwable throwable) {
super.setFailure(throwable);
// make sure that the number of active clients decreases each time an attempt to connect fails
clientActivityListener.onConnectionTerminated();
}
};
try {
URI uri = new URI(url);
String scheme = uri.getScheme();
if (scheme == null || !(scheme.equals("ws") || scheme.equals("wss"))) {
throw new DeploymentException("Incorrect scheme in WebSocket endpoint URI=" + url);
}
} catch (URISyntaxException e) {
throw new DeploymentException("Incorrect WebSocket endpoint URI=" + url, e);
}
final int handshakeTimeout = getHandshakeTimeout();
executorService.submit(new Runnable() {
@Override
public void run() {
final ErrorCollector collector = new ErrorCollector();
final ClientEndpointConfig config;
final Endpoint endpoint;
// incoming buffer size - max frame size possible to receive.
Integer tyrusIncomingBufferSize =
Utils.getProperty(copiedProperties, ClientProperties.INCOMING_BUFFER_SIZE, Integer.class);
Integer wlsIncomingBufferSize = configuration == null
? null
: Utils.getProperty(configuration.getUserProperties(), ClientContainer.WLS_INCOMING_BUFFER_SIZE,
Integer.class);
final int incomingBufferSize;
if (tyrusIncomingBufferSize == null && wlsIncomingBufferSize == null) {
incomingBufferSize = TyrusClientEngine.DEFAULT_INCOMING_BUFFER_SIZE;
} else if (wlsIncomingBufferSize != null) {
incomingBufferSize = wlsIncomingBufferSize;
} else {
incomingBufferSize = tyrusIncomingBufferSize;
}
try {
if (o instanceof Endpoint) {
endpoint = (Endpoint) o;
config = configuration == null ? ClientEndpointConfig.Builder.create().build() : configuration;
} else if (o instanceof Class) {
if (Endpoint.class.isAssignableFrom((Class) o)) {
//noinspection unchecked
endpoint = ReflectionHelper.getInstance(((Class) o), collector);
config = configuration == null
? ClientEndpointConfig.Builder.create().build()
: configuration;
} else if ((((Class) o).getAnnotation(ClientEndpoint.class) != null)) {
endpoint = AnnotatedEndpoint
.fromClass((Class) o, componentProvider, false, incomingBufferSize, collector,
EndpointEventListener.NO_OP,
getInstalledExtensions());
config = (ClientEndpointConfig) ((AnnotatedEndpoint) endpoint).getEndpointConfig();
} else {
collector.addException(new DeploymentException(String.format(
"Class %s in not Endpoint descendant and does not have @ClientEndpoint",
((Class) o).getName())));
endpoint = null;
config = null;
}
} else {
endpoint = AnnotatedEndpoint
.fromInstance(o, componentProvider, false, incomingBufferSize, collector,
getInstalledExtensions());
config = (ClientEndpointConfig) ((AnnotatedEndpoint) endpoint).getEndpointConfig();
}
// fail fast when there is some issue with client endpoint.
if (!collector.isEmpty()) {
future.setFailure(collector.composeComprehensiveException());
return;
}
} catch (Exception e) {
future.setFailure(e);
return;
}
final boolean retryAfterEnabled =
Utils.getProperty(copiedProperties, ClientProperties.RETRY_AFTER_SERVICE_UNAVAILABLE,
Boolean.class, false);
final ReconnectHandler userReconnectHandler =
Utils.getProperty(copiedProperties, ClientProperties.RECONNECT_HANDLER, ReconnectHandler.class);
final Runnable connector = new Runnable() {
private final ReconnectHandler reconnectHandler =
retryAfterEnabled ? new RetryAfterReconnectHandler(userReconnectHandler)
: userReconnectHandler;
@Override
public void run() {
do {
final CountDownLatch responseLatch = new CountDownLatch(1);
final DebugContext debugContext = new DebugContext();
final ClientManagerHandshakeListener listener = new ClientManagerHandshakeListener() {
private volatile Session session;
private volatile Throwable throwable;
@Override
public void onSessionCreated(Session session) {
this.session = session;
debugContext.flush();
responseLatch.countDown();
}
@Override
public void onError(Throwable exception) {
throwable = exception;
debugContext.flush();
responseLatch.countDown();
}
@Override
public Session getSession() {
return session;
}
@Override
public Throwable getThrowable() {
return throwable;
}
};
try {
final Runnable that = this;
TyrusEndpointWrapper clientEndpoint =
new TyrusEndpointWrapper(
endpoint, config, componentProvider,
webSocketContainer == null ? ClientManager.this
: webSocketContainer, url, null,
new TyrusEndpointWrapper.SessionListener() {
@Override
public void onClose(TyrusSession session,
CloseReason closeReason) {
if (reconnectHandler != null
&& reconnectHandler.onDisconnect(closeReason)) {
long delay = reconnectHandler.getDelay();
if (delay <= 0) {
run();
} else {
getScheduledExecutorService()
.schedule(that, delay, TimeUnit.SECONDS);
}
} else {
clientActivityListener.onConnectionTerminated();
}
}
}, null, null, null
);
final URI uri;
try {
uri = new URI(url);
} catch (URISyntaxException e) {
throw new DeploymentException("Invalid URI.", e);
}
TyrusClientEngine clientEngine =
new TyrusClientEngine(clientEndpoint, listener, copiedProperties, uri,
debugContext);
container.openClientSocket(config, copiedProperties, clientEngine);
try {
final boolean countedDown =
responseLatch.await(handshakeTimeout, TimeUnit.MILLISECONDS);
if (countedDown) {
final Throwable exception = listener.getThrowable();
if (exception != null) {
throw Exceptions.deploymentException("Handshake error.", exception);
}
future.setResult(listener.getSession());
return;
} else {
// timeout!
final ClientEngine.TimeoutHandler timeoutHandler =
clientEngine.getTimeoutHandler();
if (timeoutHandler != null) {
timeoutHandler.handleTimeout();
}
}
} catch (Exception e) {
throw Exceptions.deploymentException("Handshake response not received.", e);
}
throw new DeploymentException("Handshake response not received.");
} catch (Exception e) {
if (reconnectHandler == null || !reconnectHandler.onConnectFailure(e)) {
future.setFailure(e);
return;
} else {
long delay = reconnectHandler.getDelay();
if (delay > 0) {
getScheduledExecutorService().schedule(this, delay, TimeUnit.SECONDS);
return;
}
}
}
}
while (true);
}
};
connector.run();
}
});
return future;
}
private int getHandshakeTimeout() {
final Object o = properties.get(ClientProperties.HANDSHAKE_TIMEOUT);
if (o != null && o instanceof Integer) {
return (Integer) o;
} else {
// default value
return 30000;
}
}
private interface ClientManagerHandshakeListener extends TyrusClientEngine.ClientHandshakeListener {
Session getSession();
Throwable getThrowable();
}
@Override
public int getDefaultMaxBinaryMessageBufferSize() {
if (webSocketContainer == null) {
return maxBinaryMessageBufferSize;
} else {
return webSocketContainer.getDefaultMaxBinaryMessageBufferSize();
}
}
@Override
public void setDefaultMaxBinaryMessageBufferSize(int i) {
if (webSocketContainer == null) {
maxBinaryMessageBufferSize = i;
} else {
webSocketContainer.setDefaultMaxBinaryMessageBufferSize(i);
}
}
@Override
public int getDefaultMaxTextMessageBufferSize() {
if (webSocketContainer == null) {
return maxTextMessageBufferSize;
} else {
return webSocketContainer.getDefaultMaxTextMessageBufferSize();
}
}
@Override
public void setDefaultMaxTextMessageBufferSize(int i) {
if (webSocketContainer == null) {
maxTextMessageBufferSize = i;
} else {
webSocketContainer.setDefaultMaxTextMessageBufferSize(i);
}
}
@Override
public Set getInstalledExtensions() {
if (webSocketContainer == null) {
return Collections.emptySet();
} else {
return webSocketContainer.getInstalledExtensions();
}
}
@Override
public long getDefaultAsyncSendTimeout() {
if (webSocketContainer == null) {
return defaultAsyncSendTimeout;
} else {
return webSocketContainer.getDefaultAsyncSendTimeout();
}
}
@Override
public void setAsyncSendTimeout(long timeoutmillis) {
if (webSocketContainer == null) {
defaultAsyncSendTimeout = timeoutmillis;
} else {
webSocketContainer.setAsyncSendTimeout(timeoutmillis);
}
}
@Override
public long getDefaultMaxSessionIdleTimeout() {
if (webSocketContainer == null) {
return defaultMaxSessionIdleTimeout;
} else {
return webSocketContainer.getDefaultMaxSessionIdleTimeout();
}
}
@Override
public void setDefaultMaxSessionIdleTimeout(long defaultMaxSessionIdleTimeout) {
if (webSocketContainer == null) {
this.defaultMaxSessionIdleTimeout = defaultMaxSessionIdleTimeout;
} else {
webSocketContainer.setDefaultMaxSessionIdleTimeout(defaultMaxSessionIdleTimeout);
}
}
/**
* Container properties.
*
* Used to set container specific configuration as SSL truststore and keystore, HTTP Proxy configuration and
* maximum
* incoming buffer size. These properties cannot be shared among various containers due to constraints in WebSocket
* API, so if you need to have multiple configurations, you will need to create multiple ClientManager instances or
* synchronize connectToServer method invocations.
*
* @return map containing container properties.
* @see ClientProperties
*/
public Map getProperties() {
return properties;
}
/**
* Executor service which just executes provided {@link Runnable} in the very same thread.
*/
private static class SameThreadExecutorService extends AbstractExecutorService {
@Override
public void shutdown() {
// do nothing.
}
@Override
public List shutdownNow() {
// do nothing.
return Collections.emptyList();
}
@Override
public boolean isShutdown() {
return false;
}
@Override
public boolean isTerminated() {
return false;
}
@Override
public boolean awaitTermination(long timeout, TimeUnit unit) throws InterruptedException {
return false;
}
@Override
public void execute(Runnable command) {
command.run();
}
}
/**
* Reconnect handler.
*
* When implementing, be sure that you do have enough logic behind cancelling reconnect feature - even {@link
* jakarta.websocket.Session#close()} call will be treated just like any other disconnect resulting in reconnect.
*/
public static class ReconnectHandler {
private static final long RECONNECT_DELAY = 5L;
/**
* Called after {@link jakarta.websocket.OnClose} annotated method (or {@link
* Endpoint#onClose(jakarta.websocket.Session, jakarta.websocket.CloseReason)} is invoked.
*
* @param closeReason close reason passed to onClose method.
* @return When {@code true} is returned, client container will reconnect.
*/
public boolean onDisconnect(CloseReason closeReason) {
return false;
}
/**
* Called when there is a connection failure.
*
* Type of the failure is indicated by {@link Exception} parameter. Be cautious when implementing this method,
* you might easily cause DDoS like behaviour.
*
* @param exception Exception thrown during connection phase.
* @return When {@code true} is returned, client container will reconnect.
*/
public boolean onConnectFailure(Exception exception) {
return false;
}
/**
* Get reconnect delay.
*
* Called after {@link #onDisconnect(CloseReason)} or {@link #onConnectFailure(Exception)} when {@code true} is
* returned. When positive value is returned, next connection attempt will be made after that number of
* seconds.
*
* Default implementation returns {@value #RECONNECT_DELAY}.
*
* @return reconnect delay in seconds.
*/
public long getDelay() {
return RECONNECT_DELAY;
}
}
private static class RetryAfterReconnectHandler extends ReconnectHandler {
private static final int RETRY_AFTER_THRESHOLD = 5;
private static final int RETRY_AFTER_MAX_DELAY = 300;
private final AtomicInteger retryCounter = new AtomicInteger(0);
private final ReconnectHandler userReconnectHandler;
private long delay = 0;
RetryAfterReconnectHandler(final ReconnectHandler userReconnectHandler) {
this.userReconnectHandler = userReconnectHandler;
}
@Override
public boolean onDisconnect(CloseReason closeReason) {
return userReconnectHandler != null && userReconnectHandler.onDisconnect(closeReason);
}
@Override
public boolean onConnectFailure(final Exception exception) {
Throwable t = exception;
if (t instanceof DeploymentException) {
t = t.getCause();
if (t != null && t instanceof RetryAfterException) {
RetryAfterException retryAfterException = (RetryAfterException) t;
if (retryAfterException.getDelay() != null) {
if (retryCounter.getAndIncrement() < RETRY_AFTER_THRESHOLD
&& retryAfterException.getDelay() <= RETRY_AFTER_MAX_DELAY) {
delay = retryAfterException.getDelay() < 0 ? 0 : retryAfterException.getDelay();
return true;
}
}
}
}
return userReconnectHandler != null && userReconnectHandler.onConnectFailure(exception);
}
@Override
public long getDelay() {
return delay;
}
}
/**
* A listener listening for events that indicate when a client has started to be active and when it stopped to be
* active. It is used to determine the number of active clients.
*/
private static interface ClientActivityListener {
/**
* A connection has been initiated -> the number of active clients increases.
*/
void onConnectionInitiated();
/**
* A connection has been terminated -> the number of active clients decreases.
*
* This should be called either when the session is closed or an attempt to connect to the server fails.
*/
void onConnectionTerminated();
}
}