com.mulesoft.connectors.ws.internal.connection

Class FluxCapacitor

java.lang.Object

com.mulesoft.connectors.ws.internal.connection.FluxCapacitor

public class FluxCapacitor
extends Object

Concentrates, routes and distributes data streams and events that are concurrently generated due to the full duplex nature of the WebSockets protocol. So in summary, it capacitates fluxes.

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
FluxCapacitor(WebSocketServer webSocketServer, WebSocketClient webSocketClient, org.mule.runtime.http.api.HttpService httpService, org.mule.runtime.api.scheduler.Scheduler reconnectionScheduler)

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Void>	broadcast(org.mule.runtime.api.metadata.TypedValue<InputStream> content, String path, Predicate<org.mule.runtime.http.api.ws.WebSocket> socketFilter, org.mule.runtime.core.api.retry.policy.RetryPolicyTemplate retryPolicyTemplate, BiConsumer<org.mule.runtime.http.api.ws.WebSocket,Throwable> errorCallback)
CompletableFuture<Void>	bulkCloseSockets(Predicate<org.mule.runtime.http.api.ws.WebSocket> socketFilter, org.mule.runtime.http.api.ws.WebSocketCloseCode closeCode, String reason)
void	close() Closes this capacitor, closing all the registered sockets using an WebSocketCloseCode.ENDPOINT_GOING_DOWN code and stopping the underlying HttpClient.
CompletableFuture<Void>	close(String socketId, org.mule.runtime.http.api.ws.WebSocketCloseCode closeCode, String reason) Closes the socket of the given socketId.
Optional<ForwardingWebSocketHandler>	getInboundHandler(String path) Returns the ForwardingWebSocketHandler associated to the given path if present.
OutboundSocketListener	getOutboundSocketListener()
Optional<WebSocketClient>	getWebSocketClient()
Optional<WebSocketServer>	getWebSocketServer()
org.mule.runtime.http.api.ws.WebSocket	lookupWebSocket(String socketId) Returns the WebSocket for the given socketId
void	notifyClosed(org.mule.runtime.http.api.ws.WebSocket socket, org.mule.runtime.http.api.ws.WebSocketCloseCode code, String reason, boolean unregister) Notifies that the given socket has just been closed.
void	notifyOpen(WebSocketState state) Notifies that a socket has been opened.
CompletableFuture<WebSocketAttributes>	openOutboundSocket(WebSocketsConnector config, org.mule.runtime.http.api.client.HttpClient client, org.mule.runtime.http.api.domain.message.request.HttpRequest request, List<String> defaultGroups, Optional<String> socketId, int responseTimeout) Opens an outbound socket
CompletableFuture<org.mule.runtime.http.api.ws.WebSocket>	reconnectOnFailure(String socketId, org.mule.runtime.http.api.ws.exception.WebSocketConnectionException e, org.mule.runtime.core.api.retry.policy.RetryPolicyTemplate retryPolicyTemplate) Reconnects the referenced socket, provided it supports reconnection to begin with.
CompletableFuture<org.mule.runtime.http.api.ws.WebSocket>	reconnectOnFailure(String socketId, org.mule.runtime.http.api.ws.exception.WebSocketConnectionException e, org.mule.runtime.core.api.retry.policy.RetryPolicyTemplate retryPolicyTemplate, org.mule.runtime.api.scheduler.Scheduler scheduler) Reconnects the referenced socket, provided it supports reconnection to begin with.
void	registerInboundHandler(String path, ForwardingWebSocketHandler handler) Registers the given handler to the given path.
void	registerOnCloseCallback(String path, OnCloseCallback callback) Registers a callback that will be invoked whenever a WebSocket with a matching path is closed.
CompletableFuture<Void>	send(String socketId, InputStream content, org.mule.runtime.api.metadata.MediaType mediaType) Sends the given content through the socket of the given socketId.
CompletableFuture<Void>	send(org.mule.runtime.http.api.ws.WebSocket socket, InputStream content, org.mule.runtime.api.metadata.MediaType mediaType) Sends the given content through the socket of the given socket.
void	subscribeGroups(org.mule.runtime.http.api.ws.WebSocket socket, List<String> groups) Subscribes the given socket to the specified groups
void	unregisterInboundHandler(String path) Unregisters the ForwardingWebSocketHandler of the given path
void	unregisterOnCloseCallback(String path, OnCloseCallback callback) Unregisters the given callback, provided that it has previously been registered through registerOnCloseCallback(String, OnCloseCallback) with an equivalent path.
WebSocketClient	unsafeGetWebSocketClient(WebSocketsConnector config)
WebSocketServer	unsafeGetWebSocketServer(WebSocketsConnector config)
void	unsubscribeGroups(org.mule.runtime.http.api.ws.WebSocket socket, List<String> groups) Unsubscribe the given socket from the specified groups

Methods inherited from class java.lang.Object

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

Constructor Detail

FluxCapacitor

public FluxCapacitor(WebSocketServer webSocketServer,
                     WebSocketClient webSocketClient,
                     org.mule.runtime.http.api.HttpService httpService,
                     org.mule.runtime.api.scheduler.Scheduler reconnectionScheduler)

Method Detail

openOutboundSocket

public CompletableFuture<WebSocketAttributes> openOutboundSocket(WebSocketsConnector config,
                                                                 org.mule.runtime.http.api.client.HttpClient client,
                                                                 org.mule.runtime.http.api.domain.message.request.HttpRequest request,
                                                                 List<String> defaultGroups,
                                                                 Optional<String> socketId,
                                                                 int responseTimeout)

Opens an outbound socket

Parameters:

config - the connector's config

client - the HttpClient used to open the connection

request - the initiating HttpRequest

defaultGroups - the groups to which the socket should be initially subscribed to.

responseTimeout - connection timeout

Returns:

a future WebSocketAttributes

send

public CompletableFuture<Void> send(String socketId,
                                    InputStream content,
                                    org.mule.runtime.api.metadata.MediaType mediaType)

Sends the given content through the socket of the given socketId. This method works for both inbound and outbound sockets

Parameters:

socketId - the socket id

content - the content to be sent

mediaType - the content's MediaType

Returns:

a CompletableFuture

Throws:

NoSuchSocketException - if no socket matches the socketId

send

public CompletableFuture<Void> send(org.mule.runtime.http.api.ws.WebSocket socket,
                                    InputStream content,
                                    org.mule.runtime.api.metadata.MediaType mediaType)

Sends the given content through the socket of the given socket. This method works for both inbound and outbound sockets

Parameters:

socket - the socket

content - the content to be sent

mediaType - the content's MediaType

Returns:

a CompletableFuture

Throws:

NoSuchSocketException - if no socket matches the socketId

broadcast

public CompletableFuture<Void> broadcast(org.mule.runtime.api.metadata.TypedValue<InputStream> content,
                                         String path,
                                         Predicate<org.mule.runtime.http.api.ws.WebSocket> socketFilter,
                                         org.mule.runtime.core.api.retry.policy.RetryPolicyTemplate retryPolicyTemplate,
                                         BiConsumer<org.mule.runtime.http.api.ws.WebSocket,Throwable> errorCallback)

bulkCloseSockets

public CompletableFuture<Void> bulkCloseSockets(Predicate<org.mule.runtime.http.api.ws.WebSocket> socketFilter,
                                                org.mule.runtime.http.api.ws.WebSocketCloseCode closeCode,
                                                String reason)

registerOnCloseCallback

public void registerOnCloseCallback(String path,
                                    OnCloseCallback callback)

Registers a callback that will be invoked whenever a WebSocket with a matching path is closed.

Multiple invocations to equivalent paths are allowed, in which case the callbacks will be executed in order. Both inbound and outbound sockets will be matched

Parameters:

path - the socket path to match

callback - the callback

unregisterOnCloseCallback

public void unregisterOnCloseCallback(String path,
                                      OnCloseCallback callback)

Unregisters the given callback, provided that it has previously been registered through registerOnCloseCallback(String, OnCloseCallback) with an equivalent path.

Parameters:

path - the socket path to match

callback - the callback

close

public CompletableFuture<Void> close(String socketId,
                                     org.mule.runtime.http.api.ws.WebSocketCloseCode closeCode,
                                     String reason)

Closes the socket of the given socketId. This method works for both inbound and outbound sockets

Parameters:

socketId - the id of the socket to close

closeCode - the WebSocketCloseCode

reason - the reason phrase

Returns:

a CompletableFuture

Throws:

NoSuchSocketException - if no socket matches the socketId

registerInboundHandler

public void registerInboundHandler(String path,
                                   ForwardingWebSocketHandler handler)

Registers the given handler to the given path.

Parameters:

path - the endpoint's path

handler - a ForwardingWebSocketHandler

unregisterInboundHandler

public void unregisterInboundHandler(String path)

Unregisters the ForwardingWebSocketHandler of the given path

Parameters:

path - the endpoint's path

getInboundHandler

public Optional<ForwardingWebSocketHandler> getInboundHandler(String path)

Returns the ForwardingWebSocketHandler associated to the given path if present.

Parameters:

path - the endpoint's path

Returns:

an Optional ForwardingWebSocketHandler

subscribeGroups

public void subscribeGroups(org.mule.runtime.http.api.ws.WebSocket socket,
                            List<String> groups)

Subscribes the given socket to the specified groups

Parameters:

socket - a WebSocket

groups - a list of groups

reconnectOnFailure

public CompletableFuture<org.mule.runtime.http.api.ws.WebSocket> reconnectOnFailure(String socketId,
                                                                                    org.mule.runtime.http.api.ws.exception.WebSocketConnectionException e,
                                                                                    org.mule.runtime.core.api.retry.policy.RetryPolicyTemplate retryPolicyTemplate)

Reconnects the referenced socket, provided it supports reconnection to begin with.

Parameters:

socketId - the id of the socket to be reconnected

e - the exception that triggered the need to reconnect

retryPolicyTemplate - the reconnection policy

Returns:

a CompletableFuture with the newly obtained socket

reconnectOnFailure

public CompletableFuture<org.mule.runtime.http.api.ws.WebSocket> reconnectOnFailure(String socketId,
                                                                                    org.mule.runtime.http.api.ws.exception.WebSocketConnectionException e,
                                                                                    org.mule.runtime.core.api.retry.policy.RetryPolicyTemplate retryPolicyTemplate,
                                                                                    org.mule.runtime.api.scheduler.Scheduler scheduler)

Reconnects the referenced socket, provided it supports reconnection to begin with.

Parameters:

socketId - the id of the socket to be reconnected

e - the exception that triggered the need to reconnect

retryPolicyTemplate - the reconnection policy

scheduler - the scheduler on which reconnection work is to be submitted

Returns:

a CompletableFuture with the newly obtained socket

unsubscribeGroups

public void unsubscribeGroups(org.mule.runtime.http.api.ws.WebSocket socket,
                              List<String> groups)

Unsubscribe the given socket from the specified groups

Parameters:

socket - a WebSocket

groups - a list of groups

getOutboundSocketListener

public OutboundSocketListener getOutboundSocketListener()

Returns:

the OutboundSocketListener

notifyOpen

public void notifyOpen(WebSocketState state)

Notifies that a socket has been opened. This method MUST be invoked for all opened sockets, regardless of their types.

Parameters:

state - a just opened WebSocketState

notifyClosed

public void notifyClosed(org.mule.runtime.http.api.ws.WebSocket socket,
                         org.mule.runtime.http.api.ws.WebSocketCloseCode code,
                         String reason,
                         boolean unregister)

Notifies that the given socket has just been closed. This method MUST be invoked for all closed sockets, regardless of their types.

Parameters:

socket - a just closed WebSocket

code - the close code

reason - the reason phrase

unregister - whether the socket should be unregister or a reference to it should still be kept

close

public void close()

Closes this capacitor, closing all the registered sockets using an WebSocketCloseCode.ENDPOINT_GOING_DOWN code and stopping the underlying HttpClient.

This operation is irreversible, a new FluxCapacitor must be created after this.

lookupWebSocket

public org.mule.runtime.http.api.ws.WebSocket lookupWebSocket(String socketId)

Returns the WebSocket for the given socketId

Parameters:

socketId - the socket's id

Returns:

a WebSocket

Throws:

NoSuchSocketException - if the socket doesn't exists

getWebSocketServer

public Optional<WebSocketServer> getWebSocketServer()

getWebSocketClient

public Optional<WebSocketClient> getWebSocketClient()

unsafeGetWebSocketServer

public WebSocketServer unsafeGetWebSocketServer(WebSocketsConnector config)

unsafeGetWebSocketClient

public WebSocketClient unsafeGetWebSocketClient(WebSocketsConnector config)