com.neovisionaries.ws.client

Class WebSocketFactory

java.lang.Object

com.neovisionaries.ws.client.WebSocketFactory

public class WebSocketFactory
extends Object

Factory to create WebSocket instances.

Constructor Summary

Constructors

Constructor and Description
WebSocketFactory()

Method Summary

Modifier and Type	Method and Description
WebSocket	createSocket(String uri) Create a web socket.
WebSocket	createSocket(String uri, int timeout) Create a web socket.
WebSocket	createSocket(URI uri) Create a web socket.
WebSocket	createSocket(URI uri, int timeout) Create a web socket.
WebSocket	createSocket(URL url) Create a web socket.
WebSocket	createSocket(URL url, int timeout) Create a web socket.
int	getConnectionTimeout() Get the timeout value in milliseconds for socket connection.
ProxySettings	getProxySettings() Get the proxy settings.
SocketFactory	getSocketFactory() Get the socket factory that has been set by setSocketFactory(SocketFactory).
SSLContext	getSSLContext() Get the SSL context that has been set by setSSLContext(SSLContext).
SSLSocketFactory	getSSLSocketFactory() Get the SSL socket factory that has been set by setSSLSocketFactory(SSLSocketFactory).
WebSocketFactory	setConnectionTimeout(int timeout) Set the timeout value in milliseconds for socket connection.
WebSocketFactory	setSocketFactory(SocketFactory factory) Set a socket factory.
WebSocketFactory	setSSLContext(SSLContext context) Set an SSL context to get a socket factory.
WebSocketFactory	setSSLSocketFactory(SSLSocketFactory factory) Set an SSL socket factory.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WebSocketFactory

public WebSocketFactory()

Method Detail

getSocketFactory

public SocketFactory getSocketFactory()

Get the socket factory that has been set by setSocketFactory(SocketFactory).

Returns:

The socket factory.

setSocketFactory

public WebSocketFactory setSocketFactory(SocketFactory factory)

Set a socket factory. See createSocket(URI) for details.

Parameters:

factory - A socket factory.

Returns:

this instance.

getSSLSocketFactory

public SSLSocketFactory getSSLSocketFactory()

Get the SSL socket factory that has been set by setSSLSocketFactory(SSLSocketFactory).

Returns:

The SSL socket factory.

setSSLSocketFactory

public WebSocketFactory setSSLSocketFactory(SSLSocketFactory factory)

Set an SSL socket factory. See createSocket(URI) for details.

Parameters:

factory - An SSL socket factory.

Returns:

this instance.

getSSLContext

public SSLContext getSSLContext()

Get the SSL context that has been set by setSSLContext(SSLContext).

Returns:

The SSL context.

setSSLContext

public WebSocketFactory setSSLContext(SSLContext context)

Set an SSL context to get a socket factory. See createSocket(URI) for details.

Parameters:

context - An SSL context.

Returns:

this instance.

getProxySettings

public ProxySettings getProxySettings()

Get the proxy settings.

Returns:

The proxy settings.

Since:

1.3

See Also:

ProxySettings

getConnectionTimeout

public int getConnectionTimeout()

Get the timeout value in milliseconds for socket connection. The default value is 0 and it means an infinite timeout.

When a createSocket method which does not have timeout argument is called, the value returned by this method is used as a timeout value for socket connection.

Returns:

The connection timeout value in milliseconds.

Since:

1.10

setConnectionTimeout

public WebSocketFactory setConnectionTimeout(int timeout)

Set the timeout value in milliseconds for socket connection. A timeout of zero is interpreted as an infinite timeout.

Parameters:

timeout - The connection timeout value in milliseconds.

Returns:

this object.

Throws:

IllegalArgumentException - The given timeout value is negative.

Since:

1.10

createSocket

public WebSocket createSocket(String uri)
                       throws IOException

Create a web socket.

This method is an alias of createSocket(uri, getConnectionTimeout()).

Parameters:

uri - The URI of the web socket endpoint on the server side.

Returns:

A web socket.

Throws:

IllegalArgumentException - The given URI is null or violates RFC 2396.

IOException - Failed to create a socket. Or, HTTP proxy handshake or SSL handshake failed.

createSocket

public WebSocket createSocket(String uri,
                              int timeout)
                       throws IOException

Create a web socket.

This method is an alias of createSocket(URI.create(uri), timeout).

Parameters:

uri - The URI of the web socket endpoint on the server side.

timeout - The timeout value in milliseconds for socket connection. A timeout of zero is interpreted as an infinite timeout.

Returns:

A web socket.

Throws:

IllegalArgumentException - The given URI is null or violates RFC 2396, or the given timeout value is negative.

IOException - Failed to create a socket. Or, HTTP proxy handshake or SSL handshake failed.

Since:

1.10

createSocket

public WebSocket createSocket(URL url)
                       throws IOException

Create a web socket.

This method is an alias of createSocket(url, getConnectionTimeout()).

Parameters:

url - The URL of the web socket endpoint on the server side.

Returns:

A web socket.

Throws:

IllegalArgumentException - The given URL is null or failed to be converted into a URI.

IOException - Failed to create a socket. Or, HTTP proxy handshake or SSL handshake failed.

createSocket

public WebSocket createSocket(URL url,
                              int timeout)
                       throws IOException

Create a web socket.

This method is an alias of createSocket(url.toURI(), timeout).

Parameters:

url - The URL of the web socket endpoint on the server side.

timeout - The timeout value in milliseconds for socket connection.

Returns:

A web socket.

Throws:

IllegalArgumentException - The given URL is null or failed to be converted into a URI, or the given timeout value is negative.

IOException - Failed to create a socket. Or, HTTP proxy handshake or SSL handshake failed.

Since:

1.10

createSocket

public WebSocket createSocket(URI uri)
                       throws IOException

Create a web socket. This method is an alias of createSocket(uri, getConnectionTimeout()).

A socket factory (= a SocketFactory instance) to create a raw socket (= a Socket instance) is determined as described below.

1. If the scheme of the URI is either wss or https,
   1. If an SSLContext instance has been set by setSSLContext(SSLContext), the value returned from SSLContext.getSocketFactory() method of the instance is used.
   2. Otherwise, if an SSLSocketFactory instance has been set by setSSLSocketFactory(SSLSocketFactory), the instance is used.
   3. Otherwise, the value returned from SSLSocketFactory.getDefault() is used.
2. Otherwise (= the scheme of the URI is either ws or http),
   1. If a SocketFactory instance has been set by setSocketFactory(SocketFactory), the instance is used.
   2. Otherwise, the value returned from SocketFactory.getDefault() is used.

Parameters:

uri - The URI of the web socket endpoint on the server side. The scheme part of the URI must be one of ws, wss, http and https (case-insensitive).

Returns:

A web socket.

Throws:

IllegalArgumentException - The given URI is null or violates RFC 2396.

IOException - Failed to create a socket. Or, HTTP proxy handshake or SSL handshake failed.

createSocket

public WebSocket createSocket(URI uri,
                              int timeout)
                       throws IOException

Create a web socket.

A socket factory (= a SocketFactory instance) to create a raw socket (= a Socket instance) is determined as described below.

1. If the scheme of the URI is either wss or https,
   1. If an SSLContext instance has been set by setSSLContext(SSLContext), the value returned from SSLContext.getSocketFactory() method of the instance is used.
   2. Otherwise, if an SSLSocketFactory instance has been set by setSSLSocketFactory(SSLSocketFactory), the instance is used.
   3. Otherwise, the value returned from SSLSocketFactory.getDefault() is used.
2. Otherwise (= the scheme of the URI is either ws or http),
   1. If a SocketFactory instance has been set by setSocketFactory(SocketFactory), the instance is used.
   2. Otherwise, the value returned from SocketFactory.getDefault() is used.

Parameters:

uri - The URI of the web socket endpoint on the server side. The scheme part of the URI must be one of ws, wss, http and https (case-insensitive).

timeout - The timeout value in milliseconds for socket connection.

Returns:

A web socket.

Throws:

IllegalArgumentException - The given URI is null or violates RFC 2396, or the given timeout value is negative.

IOException - Failed to create a socket. Or, HTTP proxy handshake or SSL handshake failed.

Since:

1.10