org.spincast.plugins.httpclient.websocket.builders

Class WebsocketRequestBuilder

java.lang.Object

org.spincast.plugins.httpclient.builders.SpincastHttpRequestBuilderBase<IWebsocketRequestBuilder>

org.spincast.plugins.httpclient.websocket.builders.WebsocketRequestBuilder

All Implemented Interfaces:

IHttpRequestBuilder<IWebsocketRequestBuilder>, IWebsocketRequestBuilder

public class WebsocketRequestBuilder
extends SpincastHttpRequestBuilderBase<IWebsocketRequestBuilder>
implements IWebsocketRequestBuilder

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
WebsocketRequestBuilder(String url, ICookieFactory cookieFactory, IHttpResponseFactory spincastHttpResponseFactory, ISpincastHttpClientWithWebsocketUtils spincastHttpClientWithWebsocketUtils, ISpincastHttpClientWithWebsocketConfig spincastHttpClientWithWebsocketConfig) Constructor

Method Summary

Modifier and Type	Method and Description
protected void	addCustomCookies(Map<String,List<String>> headers)
protected void	addCustomHeaders(Map<String,List<String>> headers)
protected void	addHttpAuthHeaders(Map<String,List<String>> headers)
protected void	addSslContext(io.undertow.websockets.client.WebSocketClient.ConnectionBuilder connectionBuilder)
protected void	addWebsocketRequestHeaders()
IWebsocketClientWriter	connect(IWebsocketClientHandler websocketClientHandler) Sends the request and establish the WebSocket connection.
protected io.undertow.server.DefaultByteBufferPool	createByteBufferPool()
protected io.undertow.websockets.client.WebSocketClient.ConnectionBuilder	createConnectionBuilder(org.xnio.XnioWorker worker, io.undertow.server.DefaultByteBufferPool bufferPool, String url)
protected org.spincast.shaded.org.apache.http.client.methods.HttpRequestBase	createMethodSpecificHttpRequest(String url) Creates the HttpRequestBase depending on the HTTP method.
protected List<io.undertow.websockets.WebSocketExtension>	createSupportedExtensions()
protected List<String>	createSupportedSubProtocols()
protected io.undertow.websockets.core.WebSocketChannel	createWebSocketChannel()
protected io.undertow.websockets.core.WebSocketChannel	createWebSocketChannel(org.xnio.XnioWorker worker, io.undertow.server.DefaultByteBufferPool bufferPool, String url, int redirectionNbr)
protected URI	createWebsocketUri(String url)
protected org.xnio.XnioWorker	createXnioWorker()
protected int	getMaxRedirectionNbr() The maximum number of allowed redirections.
protected int	getPingsIntervalSeconds()
protected ISpincastHttpClientWithWebsocketConfig	getSpincastHttpClientWithWebsocketConfig()
protected ISpincastHttpClientWithWebsocketUtils	getSpincastHttpClientWithWebsocketUtils()
protected SSLContext	getSslContext()
protected ExecutorService	getThreadExecutorForClientEvents() The ExecutorService to use to send events to the client.
protected int	getThreadExecutorForClientEventsThreadNumber() The maximum number of concurrent threads used when sending events to the application.
protected ThreadFactory	getThreadExecutorForClientEventsThreadThreadFactory() The ThreadFactory to use for the Executor that sends events to the client.
protected int	getThreadExecutorForClientEventsTimeoutAmount() The timeout amount before cancelling a task when sending events to the application.
protected TimeUnit	getThreadExecutorForClientEventsTimeoutTimeUnit() The timeout asdasd before cancelling a task when sending events to the application.
protected IWebsocketClientHandler	getWebsocketClientReader()
protected io.undertow.websockets.core.WebSocketCallback<Void>	getWebsocketWriteCallback(IWebsocketClientHandler reader)
protected org.xnio.Xnio	getXnio()
IWebsocketRequestBuilder	ping(int seconds) You can use this to configure the pings that are automatically sent to the Websocket endpoint every X seconds.
IHttpResponse	send() Sends the request and gets the HTTP response.
protected void	sendClientEventInNewThread(Runnable runnable) Sends an event to the client in a separated thread.
protected void	sendConnectionClosedAppEvent(IWebsocketClientHandler reader)
protected void	sendOnBytesMessageClientEvent(byte[] message) Sends a "Bytes message" event to the app.
protected void	sendOnConnectionClosedMessageClientEvent(int code, String reason) Sends a "Connection closed message" event to the app.
protected void	sendOnStringMessageClientEvent(String message) Sends a "String message" event to the app.
protected void	startSendingPings(ISpincastWebsocketClientWriter writer)

Methods inherited from class org.spincast.plugins.httpclient.builders.SpincastHttpRequestBuilderBase

addCookie, addCookie, addCookies, addHeaderValue, addHeaderValues, addHTMLAcceptHeader, addJsonAcceptHeader, addPlainTextAcceptHeader, addXMLAcceptHeader, convertToApacheCookie, createHttpClient, createHttpClientBuilder, disableSslCertificateErrors, getCookieEncoding, getCookieFactory, getCookieStore, getHeaders, getHttpAuthPassword, getHttpAuthUsername, getHttpClient, getHttpClientBuilder, getHttpRequestExecutor, getRequestConfig, getSpincastHttpClientConfig, getSpincastHttpClientUtils, getSpincastHttpResponseFactory, getUrl, isDisableSslCertificateErrors, sendGetRawResponse, setCookieStore, setHeaders, setHeaderValues, setHttpAuthCredentials, setHttpClientBuilder, setRequestConfig

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.spincast.plugins.httpclient.IHttpRequestBuilder

addCookie, addCookie, addCookies, addHeaderValue, addHeaderValues, addHTMLAcceptHeader, addJsonAcceptHeader, addPlainTextAcceptHeader, addXMLAcceptHeader, disableSslCertificateErrors, setHeaders, setHeaderValues, setHttpAuthCredentials, setHttpClientBuilder, setRequestConfig

Field Detail

logger

protected final org.slf4j.Logger logger

Constructor Detail

WebsocketRequestBuilder

public WebsocketRequestBuilder(String url,
                               ICookieFactory cookieFactory,
                               IHttpResponseFactory spincastHttpResponseFactory,
                               ISpincastHttpClientWithWebsocketUtils spincastHttpClientWithWebsocketUtils,
                               ISpincastHttpClientWithWebsocketConfig spincastHttpClientWithWebsocketConfig)

Constructor

Method Detail

getSpincastHttpClientWithWebsocketConfig

protected ISpincastHttpClientWithWebsocketConfig getSpincastHttpClientWithWebsocketConfig()

getSpincastHttpClientWithWebsocketUtils

protected ISpincastHttpClientWithWebsocketUtils getSpincastHttpClientWithWebsocketUtils()

createMethodSpecificHttpRequest

protected org.spincast.shaded.org.apache.http.client.methods.HttpRequestBase createMethodSpecificHttpRequest(String url)

Description copied from class: SpincastHttpRequestBuilderBase

Creates the HttpRequestBase depending on the HTTP method.

Specified by:

createMethodSpecificHttpRequest in class SpincastHttpRequestBuilderBase<IWebsocketRequestBuilder>

getPingsIntervalSeconds

protected int getPingsIntervalSeconds()

getWebsocketClientReader

protected IWebsocketClientHandler getWebsocketClientReader()

ping

public IWebsocketRequestBuilder ping(int seconds)

Description copied from interface: IWebsocketRequestBuilder

You can use this to configure the pings that are automatically sent to the Websocket endpoint every X seconds. IWebsocketClientHandler#onConnectionClosed() will be called if the connection is closed.

Use a value <= 0 to disable the pings.

The automatic pings and their default interval are also configurable using: ISpincastHttpClientWithWebsocketConfig#isWebsocketAutomaticPingEnabled()
and
ISpincastHttpClientWithWebsocketConfig#getWebsocketAutomaticPingIntervalSeconds()

Pings are enabled by default.

Specified by:

ping in interface IWebsocketRequestBuilder

Parameters:

seconds - the interval in seconds or <= 0 to disable the pings.

send

public IHttpResponse send()

Description copied from interface: IHttpRequestBuilder

Sends the request and gets the HTTP response.

Specified by:

send in interface IHttpRequestBuilder<IWebsocketRequestBuilder>

Specified by:

send in interface IWebsocketRequestBuilder

Overrides:

send in class SpincastHttpRequestBuilderBase<IWebsocketRequestBuilder>

Returns:

A object containg the parsed information of the response.

addWebsocketRequestHeaders

protected void addWebsocketRequestHeaders()

connect

public IWebsocketClientWriter connect(IWebsocketClientHandler websocketClientHandler)

Description copied from interface: IWebsocketRequestBuilder

Sends the request and establish the WebSocket connection.

Specified by:

connect in interface IWebsocketRequestBuilder

Parameters:

websocketClientHandler - The handler that is responsible to handle the various WebSocket events.

Returns:

a writer to send WebSocket messages to the connected endpoint.

getWebsocketWriteCallback

protected io.undertow.websockets.core.WebSocketCallback<Void> getWebsocketWriteCallback(IWebsocketClientHandler reader)

startSendingPings

protected void startSendingPings(ISpincastWebsocketClientWriter writer)

getXnio

protected org.xnio.Xnio getXnio()

createXnioWorker

protected org.xnio.XnioWorker createXnioWorker()

getSslContext

protected SSLContext getSslContext()

createByteBufferPool

protected io.undertow.server.DefaultByteBufferPool createByteBufferPool()

createWebSocketChannel

protected io.undertow.websockets.core.WebSocketChannel createWebSocketChannel()

createWebSocketChannel

protected io.undertow.websockets.core.WebSocketChannel createWebSocketChannel(org.xnio.XnioWorker worker,
                                                                              io.undertow.server.DefaultByteBufferPool bufferPool,
                                                                              String url,
                                                                              int redirectionNbr)

getMaxRedirectionNbr

protected int getMaxRedirectionNbr()

The maximum number of allowed redirections.

createConnectionBuilder

protected io.undertow.websockets.client.WebSocketClient.ConnectionBuilder createConnectionBuilder(org.xnio.XnioWorker worker,
                                                                                                  io.undertow.server.DefaultByteBufferPool bufferPool,
                                                                                                  String url)

addSslContext

protected void addSslContext(io.undertow.websockets.client.WebSocketClient.ConnectionBuilder connectionBuilder)

createWebsocketUri

protected URI createWebsocketUri(String url)

addCustomHeaders

protected void addCustomHeaders(Map<String,List<String>> headers)

addCustomCookies

protected void addCustomCookies(Map<String,List<String>> headers)

addHttpAuthHeaders

protected void addHttpAuthHeaders(Map<String,List<String>> headers)

createSupportedSubProtocols

protected List<String> createSupportedSubProtocols()

createSupportedExtensions

protected List<io.undertow.websockets.WebSocketExtension> createSupportedExtensions()

sendConnectionClosedAppEvent

protected void sendConnectionClosedAppEvent(IWebsocketClientHandler reader)

sendOnStringMessageClientEvent

protected void sendOnStringMessageClientEvent(String message)

Sends a "String message" event to the app.

sendOnBytesMessageClientEvent

protected void sendOnBytesMessageClientEvent(byte[] message)

Sends a "Bytes message" event to the app.

sendOnConnectionClosedMessageClientEvent

protected void sendOnConnectionClosedMessageClientEvent(int code,
                                                        String reason)

Sends a "Connection closed message" event to the app.

sendClientEventInNewThread

protected void sendClientEventInNewThread(Runnable runnable)

Sends an event to the client in a separated thread.

getThreadExecutorForClientEventsTimeoutAmount

protected int getThreadExecutorForClientEventsTimeoutAmount()

The timeout amount before cancelling a task when sending events to the application.

getThreadExecutorForClientEventsTimeoutTimeUnit

protected TimeUnit getThreadExecutorForClientEventsTimeoutTimeUnit()

The timeout asdasd before cancelling a task when sending events to the application.

getThreadExecutorForClientEvents

protected ExecutorService getThreadExecutorForClientEvents()

The ExecutorService to use to send events to the client.

getThreadExecutorForClientEventsThreadNumber

protected int getThreadExecutorForClientEventsThreadNumber()

The maximum number of concurrent threads used when sending events to the application.

getThreadExecutorForClientEventsThreadThreadFactory

protected ThreadFactory getThreadExecutorForClientEventsThreadThreadFactory()

The ThreadFactory to use for the Executor that sends events to the client.

Returns:

the ThreadFactory to use or null to use the default one.