org.eclipse.jetty.websocket.client.WebSocketClient Maven / Gradle / Ivy
//
// ========================================================================
// Copyright (c) 1995-2019 Mort Bay Consulting Pty. Ltd.
// ------------------------------------------------------------------------
// All rights reserved. This program and the accompanying materials
// are made available under the terms of the Eclipse Public License v1.0
// and Apache License v2.0 which accompanies this distribution.
//
// The Eclipse Public License is available at
// http://www.eclipse.org/legal/epl-v10.html
//
// The Apache License v2.0 is available at
// http://www.opensource.org/licenses/apache2.0.php
//
// You may elect to redistribute this code under either of these licenses.
// ========================================================================
//
package org.eclipse.jetty.websocket.client;
import java.io.IOException;
import java.net.CookieStore;
import java.net.SocketAddress;
import java.net.URI;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Locale;
import java.util.Objects;
import java.util.Set;
import java.util.concurrent.Executor;
import java.util.concurrent.Future;
import java.util.function.Supplier;
import org.eclipse.jetty.client.HttpClient;
import org.eclipse.jetty.io.ByteBufferPool;
import org.eclipse.jetty.util.DecoratedObjectFactory;
import org.eclipse.jetty.util.StringUtil;
import org.eclipse.jetty.util.component.ContainerLifeCycle;
import org.eclipse.jetty.util.log.Log;
import org.eclipse.jetty.util.log.Logger;
import org.eclipse.jetty.util.ssl.SslContextFactory;
import org.eclipse.jetty.util.thread.Scheduler;
import org.eclipse.jetty.util.thread.ShutdownThread;
import org.eclipse.jetty.websocket.api.Session;
import org.eclipse.jetty.websocket.api.WebSocketBehavior;
import org.eclipse.jetty.websocket.api.WebSocketPolicy;
import org.eclipse.jetty.websocket.api.extensions.ExtensionConfig;
import org.eclipse.jetty.websocket.api.extensions.ExtensionFactory;
import org.eclipse.jetty.websocket.client.io.ConnectionManager;
import org.eclipse.jetty.websocket.client.io.UpgradeListener;
import org.eclipse.jetty.websocket.client.masks.Masker;
import org.eclipse.jetty.websocket.client.masks.RandomMasker;
import org.eclipse.jetty.websocket.common.SessionFactory;
import org.eclipse.jetty.websocket.common.WebSocketSession;
import org.eclipse.jetty.websocket.common.WebSocketSessionFactory;
import org.eclipse.jetty.websocket.common.WebSocketSessionListener;
import org.eclipse.jetty.websocket.common.events.EventDriverFactory;
import org.eclipse.jetty.websocket.common.extensions.WebSocketExtensionFactory;
import org.eclipse.jetty.websocket.common.scopes.SimpleContainerScope;
import org.eclipse.jetty.websocket.common.scopes.WebSocketContainerScope;
/**
* WebSocketClient provides a means of establishing connections to remote websocket endpoints.
*/
public class WebSocketClient extends ContainerLifeCycle implements WebSocketContainerScope, WebSocketSessionListener
{
private static final Logger LOG = Log.getLogger(WebSocketClient.class);
// From HttpClient
private final HttpClient httpClient;
// CDI layer
private final Supplier objectFactorySupplier;
// WebSocket Specifics
private final WebSocketPolicy policy;
private final WebSocketExtensionFactory extensionRegistry;
private final EventDriverFactory eventDriverFactory;
private final SessionFactory sessionFactory;
private final List sessionListeners = new ArrayList<>();
// defaults to true for backwards compatibility
private boolean stopAtShutdown = true;
/**
* Instantiate a WebSocketClient with defaults
*/
public WebSocketClient()
{
this((HttpClient)null);
}
/**
* Instantiate a WebSocketClient using HttpClient for defaults
*
* @param httpClient
* the HttpClient to base internal defaults off of
*/
public WebSocketClient(HttpClient httpClient)
{
this(httpClient, null);
}
/**
* Instantiate a WebSocketClient using HttpClient for defaults
*
* @param httpClient
* the HttpClient to base internal defaults off of
* @param objectFactory
* the DecoratedObjectFactory for all client instantiated classes
*/
public WebSocketClient(HttpClient httpClient, DecoratedObjectFactory objectFactory)
{
this(new SimpleContainerScope(new WebSocketPolicy(WebSocketBehavior.CLIENT), null, null, null, objectFactory), null, null, httpClient);
}
/**
* Create a new WebSocketClient
*
* @param sslContextFactory
* ssl context factory to use
* @deprecated use {@link #WebSocketClient(HttpClient)} instead
*/
@Deprecated
public WebSocketClient(SslContextFactory sslContextFactory)
{
this(sslContextFactory,null, null);
}
/**
* Create a new WebSocketClient
*
* @param executor
* the executor to use
* @deprecated use {@link #WebSocketClient(HttpClient)} instead
*/
public WebSocketClient(Executor executor)
{
this(null, executor, null);
}
/**
* Create a new WebSocketClient
*
* @param bufferPool
* byte buffer pool to use
* @deprecated use {@link #WebSocketClient(HttpClient)} instead
*/
@Deprecated
public WebSocketClient(ByteBufferPool bufferPool)
{
this(null, null, bufferPool);
}
/**
* Create a new WebSocketClient
*
* @param sslContextFactory
* ssl context factory to use
* @param executor
* the executor to use
* @deprecated use {@link #WebSocketClient(HttpClient)} instead
*/
@Deprecated
public WebSocketClient(SslContextFactory sslContextFactory, Executor executor)
{
this(sslContextFactory, executor, null);
}
/**
* Create WebSocketClient other Container Scope, to allow sharing of
* internal features like Executor, ByteBufferPool, SSLContextFactory, etc.
*
* @param scope
* the Container Scope
*/
public WebSocketClient(WebSocketContainerScope scope)
{
this(scope, null, null, null);
}
/**
* Create WebSocketClient other Container Scope, to allow sharing of
* internal features like Executor, ByteBufferPool, SSLContextFactory, etc.
*
* @param scope
* the Container Scope
* @param sslContextFactory
* SSL ContextFactory to use in preference to one from
* {@link WebSocketContainerScope#getSslContextFactory()}
*/
public WebSocketClient(WebSocketContainerScope scope, SslContextFactory sslContextFactory)
{
this(sslContextFactory, scope.getExecutor(), scope.getBufferPool(), scope.getObjectFactory());
}
/**
* Create WebSocketClient using sharing instances of SSLContextFactory
* Executor, and ByteBufferPool
*
* @param sslContextFactory
* shared SSL ContextFactory
* @param executor
* shared Executor
* @param bufferPool
* shared ByteBufferPool
*/
public WebSocketClient(SslContextFactory sslContextFactory, Executor executor, ByteBufferPool bufferPool)
{
this(sslContextFactory, executor, bufferPool, null);
}
/**
* Create WebSocketClient using sharing instances of SSLContextFactory
* Executor, and ByteBufferPool
*
* @param sslContextFactory
* shared SSL ContextFactory
* @param executor
* shared Executor
* @param bufferPool
* shared ByteBufferPool
* @param objectFactory
* shared DecoratedObjectFactory
*/
private WebSocketClient(SslContextFactory sslContextFactory, Executor executor, ByteBufferPool bufferPool, DecoratedObjectFactory objectFactory)
{
this(new SimpleContainerScope(new WebSocketPolicy(WebSocketBehavior.CLIENT), bufferPool, executor, sslContextFactory, objectFactory));
addBean(this.httpClient);
}
/**
* Create WebSocketClient based on pre-existing Container Scope, to allow sharing of
* internal features like Executor, ByteBufferPool, SSLContextFactory, etc.
*
* @param scope
* the Container Scope
* @param eventDriverFactory
* the EventDriver Factory to use
* @param sessionFactory
* the SessionFactory to use
*/
public WebSocketClient(final WebSocketContainerScope scope, EventDriverFactory eventDriverFactory, SessionFactory sessionFactory)
{
this(scope, eventDriverFactory, sessionFactory, null);
}
/**
* Create WebSocketClient based on pre-existing Container Scope, to allow sharing of
* internal features like Executor, ByteBufferPool, SSLContextFactory, etc.
*
* @param scope
* the Container Scope
* @param eventDriverFactory
* the EventDriver Factory to use
* @param sessionFactory
* the SessionFactory to use
* @param httpClient
* the httpClient to use
*/
public WebSocketClient(final WebSocketContainerScope scope, EventDriverFactory eventDriverFactory, SessionFactory sessionFactory, HttpClient httpClient)
{
if (httpClient == null)
{
this.httpClient = HttpClientProvider.get(scope);
addBean(this.httpClient);
}
else
{
this.httpClient = httpClient;
}
this.addSessionListener(this);
// Ensure we get a Client version of the policy.
this.policy = scope.getPolicy().delegateAs(WebSocketBehavior.CLIENT);
// Support Late Binding of Object Factory (for CDI)
this.objectFactorySupplier = () -> scope.getObjectFactory();
this.extensionRegistry = new WebSocketExtensionFactory(this);
this.eventDriverFactory = eventDriverFactory == null ? new EventDriverFactory(this) : eventDriverFactory;
this.sessionFactory = sessionFactory == null ? new WebSocketSessionFactory(this) : sessionFactory;
}
public Future connect(Object websocket, URI toUri) throws IOException
{
ClientUpgradeRequest request = new ClientUpgradeRequest(toUri);
request.setRequestURI(toUri);
request.setLocalEndpoint(websocket);
return connect(websocket,toUri,request);
}
/**
* Connect to remote websocket endpoint
*
* @param websocket
* the websocket object
* @param toUri
* the websocket uri to connect to
* @param request
* the upgrade request information
* @return the future for the session, available on success of connect
* @throws IOException
* if unable to connect
*/
public Future connect(Object websocket, URI toUri, ClientUpgradeRequest request) throws IOException
{
return connect(websocket,toUri,request,(UpgradeListener)null);
}
/**
* Connect to remote websocket endpoint
*
* @param websocket
* the websocket object
* @param toUri
* the websocket uri to connect to
* @param request
* the upgrade request information
* @param upgradeListener
* the upgrade listener
* @return the future for the session, available on success of connect
* @throws IOException
* if unable to connect
*/
public Future connect(Object websocket, URI toUri, ClientUpgradeRequest request, UpgradeListener upgradeListener) throws IOException
{
/* Note: UpgradeListener is used by javax.websocket.ClientEndpointConfig.Configurator
* See: org.eclipse.jetty.websocket.jsr356.JsrUpgradeListener
*/
if (!isStarted())
{
throw new IllegalStateException(WebSocketClient.class.getSimpleName() + "@" + this.hashCode() + " is not started");
}
// Validate websocket URI
if (!toUri.isAbsolute())
{
throw new IllegalArgumentException("WebSocket URI must be absolute");
}
if (StringUtil.isBlank(toUri.getScheme()))
{
throw new IllegalArgumentException("WebSocket URI must include a scheme");
}
String scheme = toUri.getScheme().toLowerCase(Locale.ENGLISH);
if (("ws".equals(scheme) == false) && ("wss".equals(scheme) == false))
{
throw new IllegalArgumentException("WebSocket URI scheme only supports [ws] and [wss], not [" + scheme + "]");
}
if ("wss".equals(scheme))
{
// test for ssl context
if (httpClient.getSslContextFactory() == null)
{
throw new IllegalStateException("HttpClient has no SslContextFactory, wss:// URI's are not supported in this configuration");
}
}
request.setRequestURI(toUri);
request.setLocalEndpoint(websocket);
// Validate Requested Extensions
for (ExtensionConfig reqExt : request.getExtensions())
{
if (!extensionRegistry.isAvailable(reqExt.getName()))
{
throw new IllegalArgumentException("Requested extension [" + reqExt.getName() + "] is not installed");
}
}
if (LOG.isDebugEnabled())
LOG.debug("connect websocket {} to {}",websocket,toUri);
init();
WebSocketUpgradeRequest wsReq = new WebSocketUpgradeRequest(this,httpClient,request);
wsReq.setUpgradeListener(upgradeListener);
return wsReq.sendAsync();
}
@Override
protected void doStart() throws Exception
{
Objects.requireNonNull(httpClient, "Provided HttpClient is null");
super.doStart();
if (!httpClient.isRunning())
throw new IllegalStateException("HttpClient is not running (did you forget to start it?): " + httpClient);
}
@Override
protected void doStop() throws Exception
{
if (LOG.isDebugEnabled())
LOG.debug("Stopping {}",this);
ShutdownThread.deregister(this);
super.doStop();
if (LOG.isDebugEnabled())
LOG.debug("Stopped {}",this);
}
@Deprecated
public boolean isDispatchIO()
{
return httpClient.isDispatchIO();
}
/**
* Return the number of milliseconds for a timeout of an attempted write operation.
*
* @return number of milliseconds for timeout of an attempted write operation
*/
public long getAsyncWriteTimeout()
{
return getPolicy().getAsyncWriteTimeout();
}
public SocketAddress getBindAddress()
{
return httpClient.getBindAddress();
}
@Override
public ByteBufferPool getBufferPool()
{
return httpClient.getByteBufferPool();
}
@Deprecated
public ConnectionManager getConnectionManager()
{
throw new UnsupportedOperationException("ConnectionManager is no longer supported");
}
public long getConnectTimeout()
{
return httpClient.getConnectTimeout();
}
public CookieStore getCookieStore()
{
return httpClient.getCookieStore();
}
public EventDriverFactory getEventDriverFactory()
{
return eventDriverFactory;
}
@Override
public Executor getExecutor()
{
return httpClient.getExecutor();
}
public ExtensionFactory getExtensionFactory()
{
return extensionRegistry;
}
/**
* @deprecated not used, no replacement
* @return a {@link RandomMasker} instance
*/
@Deprecated
public Masker getMasker()
{
return new RandomMasker();
}
/**
* Get the maximum size for buffering of a binary message.
*
* @return the maximum size of a binary message buffer.
*/
public int getMaxBinaryMessageBufferSize()
{
return getPolicy().getMaxBinaryMessageBufferSize();
}
/**
* Get the maximum size for a binary message.
*
* @return the maximum size of a binary message.
*/
public long getMaxBinaryMessageSize()
{
return getPolicy().getMaxBinaryMessageSize();
}
/**
* Get the max idle timeout for new connections.
*
* @return the max idle timeout in milliseconds for new connections.
*/
public long getMaxIdleTimeout()
{
return getPolicy().getIdleTimeout();
}
/**
* Get the maximum size for buffering of a text message.
*
* @return the maximum size of a text message buffer.
*/
public int getMaxTextMessageBufferSize()
{
return getPolicy().getMaxTextMessageBufferSize();
}
/**
* Get the maximum size for a text message.
*
* @return the maximum size of a text message.
*/
public long getMaxTextMessageSize()
{
return getPolicy().getMaxTextMessageSize();
}
@Override
public DecoratedObjectFactory getObjectFactory()
{
return this.objectFactorySupplier.get();
}
public Set getOpenSessions()
{
return Collections.unmodifiableSet(new HashSet<>(getBeans(WebSocketSession.class)));
}
@Override
public WebSocketPolicy getPolicy()
{
return this.policy;
}
public Scheduler getScheduler()
{
return httpClient.getScheduler();
}
public SessionFactory getSessionFactory()
{
return sessionFactory;
}
/**
* @return the {@link SslContextFactory} that manages TLS encryption
* @see #WebSocketClient(SslContextFactory)
*/
@Override
public SslContextFactory getSslContextFactory()
{
return httpClient.getSslContextFactory();
}
@Override
public void addSessionListener(WebSocketSessionListener listener)
{
this.sessionListeners.add(listener);
}
@Override
public void removeSessionListener(WebSocketSessionListener listener)
{
this.sessionListeners.remove(listener);
}
@Override
public Collection getSessionListeners()
{
return this.sessionListeners;
}
private synchronized void init()
{
if (isStopAtShutdown() && !ShutdownThread.isRegistered(this))
{
ShutdownThread.register(this);
}
}
/**
* Factory method for new ConnectionManager
*
* @return the ConnectionManager instance to use
* @deprecated use HttpClient instead
*/
@Deprecated
protected ConnectionManager newConnectionManager()
{
throw new UnsupportedOperationException("ConnectionManager is no longer supported");
}
@Override
public void onSessionClosed(WebSocketSession session)
{
if (LOG.isDebugEnabled())
LOG.debug("Session Closed: {}",session);
removeBean(session);
}
@Override
public void onSessionOpened(WebSocketSession session)
{
if (LOG.isDebugEnabled())
LOG.debug("Session Opened: {}",session);
addManaged(session);
}
public void setAsyncWriteTimeout(long ms)
{
getPolicy().setAsyncWriteTimeout(ms);
}
/**
* @param bindAddress the address to bind to
* @deprecated (this is a bad bad bad typo) use {@link HttpClient#setBindAddress(SocketAddress)}
* on instance passed to {@link #WebSocketClient(HttpClient)}
*/
@Deprecated
public void setBindAdddress(SocketAddress bindAddress)
{
setBindAddress(bindAddress);
}
/**
* @param bindAddress the address to bind to
* @deprecated Use {@link HttpClient#setBindAddress(SocketAddress)}
* on instance passed to {@link #WebSocketClient(HttpClient)}
*/
@Deprecated
public void setBindAddress(SocketAddress bindAddress)
{
this.httpClient.setBindAddress(bindAddress);
}
/**
* @param bufferPool The buffer pool
* @deprecated Use {@link HttpClient#setByteBufferPool(ByteBufferPool)}
* on the instance passed to {@link #WebSocketClient(HttpClient)}
*/
public void setBufferPool(ByteBufferPool bufferPool)
{
this.httpClient.setByteBufferPool(bufferPool);
}
/**
* Set the timeout for connecting to the remote server.
* @param ms the timeout in millisecondspool
* @deprecated Use {@link HttpClient#setConnectTimeout(long)}
* on the instance passed to {@link #WebSocketClient(HttpClient)}
*/
public void setConnectTimeout(long ms)
{
this.httpClient.setConnectTimeout(ms);
}
/**
* @param cookieStore The cookie store
* @deprecated Use {@link HttpClient#setCookieStore(CookieStore)} on the HttpClient instance passed
* to {@link #WebSocketClient(HttpClient)}
*/
@Deprecated
public void setCookieStore(CookieStore cookieStore)
{
this.httpClient.setCookieStore(cookieStore);
}
/**
* @deprecated not used, configure threading in HttpClient instead
* @param daemon do nothing
*/
@Deprecated
public void setDaemon(boolean daemon)
{
// do nothing
}
@Deprecated
public void setDispatchIO(boolean dispatchIO)
{
this.httpClient.setDispatchIO(dispatchIO);
}
/**
* @param executor The executor to use
* @deprecated Use {@link HttpClient#setExecutor(Executor)}
* on the instance passed to {@link #WebSocketClient(HttpClient)}
*/
@Deprecated
public void setExecutor(Executor executor)
{
this.httpClient.setExecutor(executor);
}
/**
* @deprecated not used, no replacement
* @param masker do nothing
*/
@Deprecated
public void setMasker(Masker masker)
{
/* do nothing */
}
public void setMaxBinaryMessageBufferSize(int max)
{
getPolicy().setMaxBinaryMessageBufferSize(max);
}
/**
* Set the max idle timeout for new connections.
*
* Existing connections will not have their max idle timeout adjusted.
*
* @param ms the timeout in milliseconds
*/
public void setMaxIdleTimeout(long ms)
{
getPolicy().setIdleTimeout(ms);
this.httpClient.setIdleTimeout(ms);
}
public void setMaxTextMessageBufferSize(int max)
{
getPolicy().setMaxTextMessageBufferSize(max);
}
public HttpClient getHttpClient()
{
return this.httpClient;
}
/**
* Set JVM shutdown behavior.
* @param stop If true, this client instance will be explicitly stopped when the
* JVM is shutdown. Otherwise the application is responsible for maintaining the WebSocketClient lifecycle.
* @see Runtime#addShutdownHook(Thread)
* @see ShutdownThread
*/
public synchronized void setStopAtShutdown(boolean stop)
{
if (stop)
{
if (!stopAtShutdown && isStarted() && !ShutdownThread.isRegistered(this))
ShutdownThread.register(this);
}
else
ShutdownThread.deregister(this);
stopAtShutdown = stop;
}
public boolean isStopAtShutdown()
{
return stopAtShutdown;
}
@Override
public boolean equals(Object o)
{
if (this == o) return true;
if (!(o instanceof WebSocketClient)) return false;
WebSocketClient that = (WebSocketClient) o;
return Objects.equals(this.httpClient, that.httpClient) &&
Objects.equals(this.policy, that.policy);
}
@Override
public int hashCode()
{
return Objects.hash(httpClient, policy);
}
@Override
public String toString()
{
final StringBuilder sb = new StringBuilder("WebSocketClient@");
sb.append(Integer.toHexString(hashCode()));
sb.append("[httpClient=").append(httpClient);
sb.append(",openSessions.size=");
sb.append(getOpenSessions().size());
sb.append(']');
return sb.toString();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy