com.mulesoft.connectors.ws.internal.operation

Class WebSocketOperations

java.lang.Object

com.mulesoft.connectors.ws.internal.operation.WebSocketOperations

public class WebSocketOperations
extends Object

Connector operations

Constructor Summary

Constructors

Constructor and Description
WebSocketOperations()

Method Summary

Modifier and Type	Method and Description
void	broadcast(org.mule.runtime.api.metadata.TypedValue<InputStream> content, FluxCapacitor fluxCapacitor, String path, BroadcastSocketType socketType, List<String> groups, org.mule.runtime.core.api.retry.policy.RetryPolicyTemplate retryPolicyTemplate, org.mule.runtime.extension.api.runtime.process.CompletionCallback<List<BroadcastFailure>,Void> completionCallback) Sends the given content to all the active WebSockets that match the path, socketType and groups criteria.
void	bulkCloseSockets(FluxCapacitor fluxCapacitor, BroadcastSocketType socketType, List<String> groups, org.mule.runtime.http.api.ws.WebSocketCloseCode closeCode, String reason, org.mule.runtime.extension.api.runtime.process.CompletionCallback<Void,Void> completionCallback)
void	closeSocket(String socketId, org.mule.runtime.http.api.ws.WebSocketCloseCode closeCode, String reason, FluxCapacitor fluxCapacitor, org.mule.runtime.extension.api.runtime.process.CompletionCallback<Void,Void> callback) Closes the socket
void	openOutboundSocket(String socketId, UriSettings uriSettings, WebSocketRequestBuilder connectionRequestBuilder, List<String> defaultGroups, WebSocketsConnector config, FluxCapacitor fluxCapacitor, org.mule.runtime.extension.api.runtime.process.CompletionCallback<String,WebSocketAttributes> callback) Opens a new outbound socket
void	send(String socketId, org.mule.runtime.api.metadata.TypedValue<InputStream> content, FluxCapacitor fluxCapacitor, org.mule.runtime.extension.api.runtime.process.CompletionCallback<Void,Void> callback, org.mule.runtime.core.api.retry.policy.RetryPolicyTemplate retryPolicyTemplate) Sends the given content through the given socket
void	subscribeGroups(FluxCapacitor fluxCapacitor, String socketId, List<String> groups) Subscribes the socket of the given socketId to the given groups.
void	unsubscribeGroups(FluxCapacitor fluxCapacitor, String socketId, List<String> groups) Unsubscribes the socket of the given socketId from the given groups.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebSocketOperations

public WebSocketOperations()

Method Detail

send

@Throws(value=DefaultErrorProvider.class)
public void send(String socketId,
                                                           @Content
                                                           org.mule.runtime.api.metadata.TypedValue<InputStream> content,
                                                           @Connection
                                                           FluxCapacitor fluxCapacitor,
                                                           org.mule.runtime.extension.api.runtime.process.CompletionCallback<Void,Void> callback,
                                                           org.mule.runtime.core.api.retry.policy.RetryPolicyTemplate retryPolicyTemplate)

Sends the given content through the given socket

Parameters:

socketId - the id of the socket through which data is to be sent

content - the content to be sent

fluxCapacitor - the acting flux capacitor

callback - completion callback

retryPolicyTemplate - the reconnection policy

broadcast

@Throws(value=BroadcastErrorProvider.class)
 @Execution(value=BLOCKING)
public void broadcast(@Content
                                                                                              org.mule.runtime.api.metadata.TypedValue<InputStream> content,
                                                                                              @Connection
                                                                                              FluxCapacitor fluxCapacitor,
                                                                                              String path,
                                                                                              @Optional(defaultValue="ALL")
                                                                                              BroadcastSocketType socketType,
                                                                                              @Optional @NullSafe
                                                                                              List<String> groups,
                                                                                              org.mule.runtime.core.api.retry.policy.RetryPolicyTemplate retryPolicyTemplate,
                                                                                              org.mule.runtime.extension.api.runtime.process.CompletionCallback<List<BroadcastFailure>,Void> completionCallback)

Sends the given content to all the active WebSockets that match the path, socketType and groups criteria. In the case of the path, the base path configured in the config will not be considered as you may be targeting both inbound and outbound sockets.

The message will be send to all the matching sockets, even though it's possible that delivery to some of them fail. The operation will return a list of BroadcastFailure containing details of each of the failures. If none fail, an empty list is returned

Parameters:

content - the content to be sent

fluxCapacitor - the acting FluxCapacitor

path - the path of the sockets to be matched

socketType - the type of sockets to be matched

groups - matches sockets that belong to any of these groups

completionCallback - the CompletionCallback

retryPolicyTemplate - the reconnection policy

bulkCloseSockets

@Throws(value=BroadcastErrorProvider.class)
 @Execution(value=BLOCKING)
public void bulkCloseSockets(@Connection
                                                                                                     FluxCapacitor fluxCapacitor,
                                                                                                     @Optional(defaultValue="ALL")
                                                                                                     BroadcastSocketType socketType,
                                                                                                     @Optional @NullSafe
                                                                                                     List<String> groups,
                                                                                                     @Optional(defaultValue="NORMAL_CLOSURE")
                                                                                                     org.mule.runtime.http.api.ws.WebSocketCloseCode closeCode,
                                                                                                     @Optional(defaultValue="")
                                                                                                     String reason,
                                                                                                     org.mule.runtime.extension.api.runtime.process.CompletionCallback<Void,Void> completionCallback)

openOutboundSocket

@MediaType(value="text/plain")
 @Throws(value=OpenOutboundSocketErrorTypeProvider.class)
public void openOutboundSocket(@Optional
                                                                                                                        String socketId,
                                                                                                                        @Placement(order=1) @ParameterGroup(name="URI Settings")
                                                                                                                        UriSettings uriSettings,
                                                                                                                        @Placement(order=2) @ParameterGroup(name="Connection Request")
                                                                                                                        WebSocketRequestBuilder connectionRequestBuilder,
                                                                                                                        @Optional @NullSafe
                                                                                                                        List<String> defaultGroups,
                                                                                                                        @Config
                                                                                                                        WebSocketsConnector config,
                                                                                                                        @Connection
                                                                                                                        FluxCapacitor fluxCapacitor,
                                                                                                                        org.mule.runtime.extension.api.runtime.process.CompletionCallback<String,WebSocketAttributes> callback)

Opens a new outbound socket

Parameters:

uriSettings - The path/url to connect to

connectionRequestBuilder - the request builder

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

config - the connector's config

fluxCapacitor - the acting flux capacitor

callback - the completion callback

closeSocket

@Throws(value=DefaultErrorProvider.class)
public void closeSocket(String socketId,
                                                                  @Optional(defaultValue="NORMAL_CLOSURE")
                                                                  org.mule.runtime.http.api.ws.WebSocketCloseCode closeCode,
                                                                  @Optional(defaultValue="")
                                                                  String reason,
                                                                  @Connection
                                                                  FluxCapacitor fluxCapacitor,
                                                                  org.mule.runtime.extension.api.runtime.process.CompletionCallback<Void,Void> callback)

Closes the socket

Parameters:

socketId - the id of the socket to be closed

closeCode - the close code

reason - the closing reason phrase

fluxCapacitor - the acting flux capacitor

callback - the completion callback

subscribeGroups

@Throws(value=GroupSubscriptionErrorProvider.class)
public void subscribeGroups(@Connection
                                                                                FluxCapacitor fluxCapacitor,
                                                                                String socketId,
                                                                                List<String> groups)
                                                                         throws Exception

Subscribes the socket of the given socketId to the given groups.

This operation can be used on the same socket as many times as necessary, each use being additive over previous ones.

Repeated groups will be ignored.

Works for both types INBOUND and OUTBOUND sockets.

Parameters:

fluxCapacitor - the FluxCapacitor

socketId - the id of the socket to be subscribed

groups - the groups that the socket will be subscribed to

Throws:

Exception

unsubscribeGroups

@Throws(value=GroupSubscriptionErrorProvider.class)
public void unsubscribeGroups(@Connection
                                                                                  FluxCapacitor fluxCapacitor,
                                                                                  String socketId,
                                                                                  List<String> groups)
                                                                           throws Exception

Unsubscribes the socket of the given socketId from the given groups.

This operation can be used on the same socket as many times as necessary, each use being additive over previous ones.

Works for both types INBOUND and OUTBOUND sockets.

Parameters:

fluxCapacitor - the FluxCapacitor

socketId - the id of the socket to be subscribed

groups - the groups that the socket will be unsubscribed from

Throws:

Exception