org.jwebsocket.client.java

Class BaseWebSocketClient

java.lang.Object

org.jwebsocket.client.java.BaseWebSocketClient

All Implemented Interfaces:

WebSocketClient

Direct Known Subclasses:

BaseTokenClient

public class BaseWebSocketClient
extends Object
implements WebSocketClient

Base WebSocket implementation based on http://weberknecht.googlecode.com by Roderick Baier. This uses thread model for handling WebSocket connection which is defined by the WebSocket protocol specification. http://www.whatwg.org/specs/web-socket-protocol/ http://www.w3.org/TR/websockets/

Author:

Roderick Baier, agali, puran, jang, aschulze, kyberneees

Field Summary

Fields

Modifier and Type	Field and Description
static String	DATA_CLOSE_CLIENT
static String	DATA_CLOSE_ERROR
static String	DATA_CLOSE_SERVER
static String	DATA_CLOSE_SHUTDOWN
static String	EVENT_CLOSE
static String	EVENT_OPEN
protected WebSocketStatus	mStatus represents the WebSocket status

Constructor Summary

Constructors

Constructor and Description
BaseWebSocketClient() Base constructor
BaseWebSocketClient(ReliabilityOptions aReliabilityOptions) Constructor including reliability options

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(WebSocketClientListener aListener) Adds the client listener to the lists of listener which are interested in receiving the jWebSocket connection and data events.
void	addSubProtocol(WebSocketSubProtocol aSubProt) Adds subprotocol to the list of supported protocols which are negotiated during handshake with web socket server.
void	close() Close the jWebSocket connection.
Socket	getConnectionSocket()
WebSocketStatus	getConnectionStatus()
Headers	getHeaders()
List<WebSocketClientListener>	getListeners() Returns the list of listeners registered.
WebSocketEncoding	getNegotiatedEncoding() If subprotocol was negotiated, then this method returns sub protocol format (json, csv, binary, custom)
String	getNegotiatedSubProtocol() If subprotocol was negotiated, then this method returns sub protocol name.
Object	getParam(String aKey)
Object	getParam(String aKey, Object aDefault)
ReliabilityOptions	getReliabilityOptions()
WebSocketStatus	getStatus() Method to return if the status of the jWebSocketClient
boolean	isConnected() Method to check if the jWebSocketClient is still connected to the jWebSocketServer
void	notifyClosed(WebSocketClientEvent aEvent) Notifies the jWebSocket client implementation about the connection being closed
void	notifyOpened(WebSocketClientEvent aEvent) Notifies the jWebSocket client implementation about the connection being opened to the jWebSocket server via WebSocket
void	notifyPacket(WebSocketClientEvent aEvent, WebSocketPacket aPacket) Notifies the jWebSocket client implementation about the packet being received from the WebSocket client.
void	notifyReconnecting(WebSocketClientEvent aEvent) Notifies the jWebSocket client implementation about the connection being re-established
void	open(int aVersion, String aURI)
void	open(int aVersion, String aURI, String aSubProtocols)
void	open(String aURI) Opens the jWebSocket connection
void	removeListener(WebSocketClientListener aListener) Remove the listener from the list of listeners, once the listener is removed it won't be notified of any jWebSocket events.
void	send(byte[] aData) Send the given byte data to the server
void	send(String aData, String aEncoding) Sends the data to the jWebSocket server, data has to be UTF-8 encoded.
void	send(WebSocketPacket aDataPacket) Sends the websocket data packet to the WebSocket client
void	setParam(String aKey, Object aValue)
void	setReliabilityOptions(ReliabilityOptions mReliabilityOptions)
void	setStatus(WebSocketStatus aStatus)
void	setVersion(int aVersion) Web socket protocol draft.

Methods inherited from class java.lang.Object

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

Field Detail

mStatus

protected volatile WebSocketStatus mStatus

represents the WebSocket status

EVENT_OPEN

public static String EVENT_OPEN

EVENT_CLOSE

public static String EVENT_CLOSE

DATA_CLOSE_ERROR

public static String DATA_CLOSE_ERROR

DATA_CLOSE_CLIENT

public static String DATA_CLOSE_CLIENT

DATA_CLOSE_SERVER

public static String DATA_CLOSE_SERVER

DATA_CLOSE_SHUTDOWN

public static String DATA_CLOSE_SHUTDOWN

Constructor Detail

BaseWebSocketClient

public BaseWebSocketClient()

Base constructor

BaseWebSocketClient

public BaseWebSocketClient(ReliabilityOptions aReliabilityOptions)

Constructor including reliability options

Method Detail

setStatus

public void setStatus(WebSocketStatus aStatus)
               throws Exception

Throws:

Exception

getParam

public Object getParam(String aKey,
              Object aDefault)

Parameters:

aKey -

aDefault -

Returns:

getParam

public Object getParam(String aKey)

Parameters:

aKey -

Returns:

setParam

public void setParam(String aKey,
            Object aValue)

Parameters:

aKey -

aValue -

open

public void open(String aURI)
          throws WebSocketException

Opens the jWebSocket connection

Specified by:

open in interface WebSocketClient

Parameters:

aURI -

Throws:

WebSocketException - if therre's an

open

public void open(int aVersion,
        String aURI)

Parameters:

aVersion -

aURI -

Throws:

WebSocketException

open

public void open(int aVersion,
        String aURI,
        String aSubProtocols)

Parameters:

aVersion -

aURI -

aSubProtocols -

Throws:

WebSocketException

send

public void send(byte[] aData)
          throws WebSocketException

Description copied from interface: WebSocketClient

Send the given byte data to the server

Specified by:

send in interface WebSocketClient

Parameters:

aData - the byte data

Throws:

WebSocketException - if exception occurs while sending the data

send

public void send(String aData,
        String aEncoding)
          throws WebSocketException

Sends the data to the jWebSocket server, data has to be UTF-8 encoded.

Specified by:

send in interface WebSocketClient

Parameters:

aData - the data to send

aEncoding - the encoding type

Throws:

WebSocketException - if there's any exception while sending the data

send

public void send(WebSocketPacket aDataPacket)
          throws WebSocketException

Sends the websocket data packet to the WebSocket client

Specified by:

send in interface WebSocketClient

Parameters:

aDataPacket -

Throws:

WebSocketException - if there's any exception while sending

close

public void close()

Description copied from interface: WebSocketClient

Close the jWebSocket connection. This method should perform all the cleanup operation to release the jWebSocket resources. Closing and connection which is already closed should not lead to any error.

Specified by:

close in interface WebSocketClient

isConnected

public boolean isConnected()

Method to check if the jWebSocketClient is still connected to the jWebSocketServer

Specified by:

isConnected in interface WebSocketClient

Returns:

true if there's a persistent connection false otherwise

getStatus

public WebSocketStatus getStatus()

Description copied from interface: WebSocketClient

Method to return if the status of the jWebSocketClient

Specified by:

getStatus in interface WebSocketClient

Returns:

Value of the WebSocketStatus enumeration.

getConnectionStatus

public WebSocketStatus getConnectionStatus()

Returns:

getConnectionSocket

public Socket getConnectionSocket()

Returns:

the client socket

addListener

public void addListener(WebSocketClientListener aListener)

Adds the client listener to the lists of listener which are interested in receiving the jWebSocket connection and data events. Listeners are good way to handle all the jWebSocket specific protocol and data format

Specified by:

addListener in interface WebSocketClient

Parameters:

aListener - the event listener object

removeListener

public void removeListener(WebSocketClientListener aListener)

Remove the listener from the list of listeners, once the listener is removed it won't be notified of any jWebSocket events.

Specified by:

removeListener in interface WebSocketClient

Parameters:

aListener - the listener object to remove

getListeners

public List<WebSocketClientListener> getListeners()

Returns the list of listeners registered.

Specified by:

getListeners in interface WebSocketClient

Returns:

the list of all listeners.

notifyOpened

public void notifyOpened(WebSocketClientEvent aEvent)

Notifies the jWebSocket client implementation about the connection being opened to the jWebSocket server via WebSocket

Specified by:

notifyOpened in interface WebSocketClient

Parameters:

aEvent - the websocket client event object

notifyPacket

public void notifyPacket(WebSocketClientEvent aEvent,
                WebSocketPacket aPacket)

Notifies the jWebSocket client implementation about the packet being received from the WebSocket client.

Specified by:

notifyPacket in interface WebSocketClient

Parameters:

aEvent - the websocket client event object

aPacket - the data packet received

notifyReconnecting

public void notifyReconnecting(WebSocketClientEvent aEvent)

Notifies the jWebSocket client implementation about the connection being re-established

Specified by:

notifyReconnecting in interface WebSocketClient

Parameters:

aEvent - the websocket client event object

getReliabilityOptions

public ReliabilityOptions getReliabilityOptions()

Returns:

the mReliabilityOptions

setReliabilityOptions

public void setReliabilityOptions(ReliabilityOptions mReliabilityOptions)

Parameters:

mReliabilityOptions - the mReliabilityOptions to set

getHeaders

public Headers getHeaders()

Returns:

the mHeaders

notifyClosed

public void notifyClosed(WebSocketClientEvent aEvent)

Notifies the jWebSocket client implementation about the connection being closed

Specified by:

notifyClosed in interface WebSocketClient

Parameters:

aEvent - the websocket client event object

addSubProtocol

public void addSubProtocol(WebSocketSubProtocol aSubProt)

Description copied from interface: WebSocketClient

Adds subprotocol to the list of supported protocols which are negotiated during handshake with web socket server.

Specified by:

addSubProtocol in interface WebSocketClient

Parameters:

aSubProt - sub protocol

getNegotiatedSubProtocol

public String getNegotiatedSubProtocol()

Description copied from interface: WebSocketClient

If subprotocol was negotiated, then this method returns sub protocol name.

Specified by:

getNegotiatedSubProtocol in interface WebSocketClient

Returns:

name of the subprotocol or null if no subprotocol was negotiated

getNegotiatedEncoding

public WebSocketEncoding getNegotiatedEncoding()

Description copied from interface: WebSocketClient

If subprotocol was negotiated, then this method returns sub protocol format (json, csv, binary, custom)

Specified by:

getNegotiatedEncoding in interface WebSocketClient

Returns:

format of the subprotocol or null if no subprotocol was negotiated

setVersion

public void setVersion(int aVersion)

Description copied from interface: WebSocketClient

Web socket protocol draft. Specification recommends using only draft number in relevant header, but anything may be used as long as server understands it. JWebSocket adheres to the specification and therefore understands only draft number as valid value, e.g. "Sec-WebSocket-Draft: 3". Anything else will probably fail on server side.

Specified by:

setVersion in interface WebSocketClient

Parameters:

aVersion - which draft to use for web socket protocol communication