org.adroitlogic.ultraesb.api.mediation

Interface WebSocketSupport

public interface WebSocketSupport

Mediation support for WebSocket communication related meditations

Author:

Sajith Dilshan

Method Summary

Methods

Modifier and Type	Method and Description
WebSocketMessage.Opcode	getOpcode(Message msg)
String[]	getOriginatedPeerLogicalGroups(Message msg)
String	getOriginatedPeerSubscribedPath(Message msg)
String	getOriginPeerID(Message msg)
int	getPayloadLength(Message msg)
void	setRecipientLogicalGroups(Message msg, List<String> logicalGroupList) Marks the message to be sent to all the WebSocketPeers which belongs to given logical groups.
void	setRecipientPeers(Message msg, String... peerIdList) Marks the message to be sent to all the WebSocketPeers which corresponds to the given peerIds.
void	setRecipientSubscriberPaths(Message msg, List<String> subscriberPathList) Marks a message to be sent to all the WebSocketPeers which are connected to given subscriber paths.

Method Detail

getOriginPeerID

String getOriginPeerID(Message msg)

Parameters:

msg - Message which contains a WebSocketMessage as its current payload

Returns:

the peerID of the WebSocketPeer which originated this message. If the current payload of this message is not a WebSocketMessage from inception this method will return null

getOriginatedPeerLogicalGroups

String[] getOriginatedPeerLogicalGroups(Message msg)

Parameters:

msg - Message which contains a WebSocketMessage as its current payload

Returns:

an array of strings which contains the logical groups where the WebSocketPeer which originated this message belongs to. If the current payload of this message is not a WebSocketMessage from inception, this method will return null

getOriginatedPeerSubscribedPath

String getOriginatedPeerSubscribedPath(Message msg)

Parameters:

msg - Message which contains a WebSocketMessage as its current payload

Returns:

the subscribed path of the WebSocketPeer which originated this message. If the current payload of this message is not a WebSocketMessage from inception, this method will return null

getOpcode

WebSocketMessage.Opcode getOpcode(Message msg)

Parameters:

msg - Message which contains a WebSocketMessage as its current payload

Returns:

the WebSocketMessage.Opcode of the WebSocketMessage

getPayloadLength

int getPayloadLength(Message msg)

Parameters:

msg - Message which contains a WebSocketMessage as its current payload

Returns:

the actual number of bytes in the unmasked payload of the WebSocketMessage

setRecipientSubscriberPaths

void setRecipientSubscriberPaths(Message msg,
                               List<String> subscriberPathList)

Marks a message to be sent to all the WebSocketPeers which are connected to given subscriber paths.

E.g: If multiple WebSocketPeers are connected to the ws://demo.foo.com/sports URL, then using this method the given message can be marked to be sent to 'sports' subscriber path. In-order to do so a list of Strings which contains 'sports' should be passed into this method along with the message.

NOTE : The subscriber paths which was set by this methods will be valid only when the given message is sent to an endpoint with an address type of 'prefix' and the address being 'ws://broadcast/subscribers'. i.e. this method will prepare the suffix of the address.

Parameters:

msg - message which should be sent to the subscriber paths

subscriberPathList - List of Strings which contains the subscriberPaths.

setRecipientLogicalGroups

void setRecipientLogicalGroups(Message msg,
                             List<String> logicalGroupList)

Marks the message to be sent to all the WebSocketPeers which belongs to given logical groups.

This method will work only when the WebSocketPeer authentication is enabled.

NOTE : The logical groups which was set by this method will be valid only when the given message is sent to an endpoint with an address type of 'prefix' and the address being 'ws://broadcast/groups'. i.e. this method will prepare the suffix of the address

Parameters:

msg - message which should be sent to the logical groups

logicalGroupList - List of Strings which contains valid name of logical groups

setRecipientPeers

void setRecipientPeers(Message msg,
                     String... peerIdList)

Marks the message to be sent to all the WebSocketPeers which corresponds to the given peerIds.

NOTE : The peerIds which was set by this method will be valid only when the given message is sent to an endpoint with an address type of 'prefix' and the address being 'ws://individualpeers'. i.e. this method will prepare the suffix of the address

Parameters:

msg - message which should be sent to the peers

peerIdList - List of Strings, or comma separated list of Strings, or array of String which contains the peerIDs or a single String which contains the peerId