org.jwebsocket.client.token

Class BaseTokenClient

java.lang.Object

org.jwebsocket.client.java.BaseWebSocketClient

org.jwebsocket.client.token.BaseTokenClient

All Implemented Interfaces:

WebSocketClient, WebSocketTokenClient

public class BaseTokenClient
extends BaseWebSocketClient
implements WebSocketTokenClient

Token based implementation of JWebSocketClient

Version:

$Id:$

Author:

aschulze, puran, jang

Field Summary

Fields inherited from class org.jwebsocket.client.java.BaseWebSocketClient

DATA_CLOSE_CLIENT, DATA_CLOSE_ERROR, DATA_CLOSE_SERVER, DATA_CLOSE_SHUTDOWN, EVENT_CLOSE, EVENT_OPEN, mStatus

Constructor Summary

Constructors

Constructor and Description
BaseTokenClient() Default constructor
BaseTokenClient(ReliabilityOptions aReliabilityOptions)
BaseTokenClient(String aSubProt, WebSocketEncoding aEncoding)
BaseTokenClient(WebSocketSubProtocol aSubProt)

Method Summary

Methods

Modifier and Type	Method and Description
void	addTokenClientListener(WebSocketClientTokenListener aTokenListener) Add the token client listener which are interested in receiving only token based data.
void	broadcastText(String aData) Broadcast the text to all the connected clients to jWebSocket server
void	close() {@
void	disconnect() Disconnect from the jWebSocket server
String	getClientId()
void	getConnections() Send the token to get the number of connected clients
String	getUsername()
void	getUserRights(String aUsername)
void	getUserRoles(String aUsername)
boolean	isAuthenticated() Checks if for this client a user already is authenticated.
void	login(String aUsername, String aPassword) Login the client based on given username and password to the jWebSocket server
void	logout() Logout the user
Token	packetToToken(WebSocketPacket aPacket)
void	ping(boolean aEcho) Ping the jWebSocket server
void	removeTokenClientListener(WebSocketClientTokenListener aTokenListener) Remove the token client listener
void	saveFile(byte[] aData, String aFilename, String aScope, Boolean aNotify)
void	sendFile(String aHeader, byte[] aData, String aFilename, String aTarget)
void	sendText(String aTarget, String aData) Send the text data
void	sendToken(Token aToken)
void	sendToken(Token aToken, WebSocketResponseTokenListener aResponseListener)
void	setUsername(String aUsername)
void	shutdown()
WebSocketPacket	tokenToPacket(Token aToken)

Methods inherited from class org.jwebsocket.client.java.BaseWebSocketClient

addListener, addSubProtocol, getConnectionSocket, getConnectionStatus, getHeaders, getListeners, getNegotiatedEncoding, getNegotiatedSubProtocol, getParam, getParam, getReliabilityOptions, getStatus, isConnected, notifyClosed, notifyOpened, notifyPacket, notifyReconnecting, open, open, open, removeListener, send, send, send, setParam, setReliabilityOptions, setStatus, setVersion

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jwebsocket.api.WebSocketClient

addListener, addSubProtocol, getListeners, getNegotiatedEncoding, getNegotiatedSubProtocol, getStatus, isConnected, notifyClosed, notifyOpened, notifyPacket, notifyReconnecting, open, removeListener, send, send, send, setVersion

Constructor Detail

BaseTokenClient

public BaseTokenClient()

Default constructor

BaseTokenClient

public BaseTokenClient(ReliabilityOptions aReliabilityOptions)

Parameters:

aReliabilityOptions -

BaseTokenClient

public BaseTokenClient(String aSubProt,
               WebSocketEncoding aEncoding)

Parameters:

aSubProt -

aEncoding -

BaseTokenClient

public BaseTokenClient(WebSocketSubProtocol aSubProt)

Parameters:

aSubProt -

Method Detail

addTokenClientListener

public void addTokenClientListener(WebSocketClientTokenListener aTokenListener)

Description copied from interface: WebSocketTokenClient

Add the token client listener which are interested in receiving only token based data.

Specified by:

addTokenClientListener in interface WebSocketTokenClient

removeTokenClientListener

public void removeTokenClientListener(WebSocketClientTokenListener aTokenListener)

Description copied from interface: WebSocketTokenClient

Remove the token client listener

Specified by:

removeTokenClientListener in interface WebSocketTokenClient

close

public void close()

{@

Specified by:

close in interface WebSocketClient

Overrides:

close in class BaseWebSocketClient

getUsername

public String getUsername()

Specified by:

getUsername in interface WebSocketTokenClient

Returns:

the fUsername

setUsername

public void setUsername(String aUsername)

isAuthenticated

public boolean isAuthenticated()

Description copied from interface: WebSocketTokenClient

Checks if for this client a user already is authenticated.

Specified by:

isAuthenticated in interface WebSocketTokenClient

getClientId

public String getClientId()

Returns:

the fClientId

packetToToken

public Token packetToToken(WebSocketPacket aPacket)

Parameters:

aPacket -

Returns:

tokenToPacket

public WebSocketPacket tokenToPacket(Token aToken)

Parameters:

aToken -

Returns:

sendToken

public void sendToken(Token aToken)
               throws WebSocketException

Parameters:

aToken -

Throws:

WebSocketException

sendToken

public void sendToken(Token aToken,
             WebSocketResponseTokenListener aResponseListener)
               throws WebSocketException

Parameters:

aToken -

aResponseListener -

Throws:

WebSocketException

login

public void login(String aUsername,
         String aPassword)
           throws WebSocketException

Description copied from interface: WebSocketTokenClient

Login the client based on given username and password to the jWebSocket server

Specified by:

login in interface WebSocketTokenClient

Throws:

WebSocketException - if there's any exception while login

logout

public void logout()
            throws WebSocketException

Description copied from interface: WebSocketTokenClient

Logout the user

Specified by:

logout in interface WebSocketTokenClient

Throws:

WebSocketException - if exception while logging out

ping

public void ping(boolean aEcho)
          throws WebSocketException

Description copied from interface: WebSocketTokenClient

Ping the jWebSocket server

Specified by:

ping in interface WebSocketTokenClient

Throws:

WebSocketException - if exception while doing a ping

sendText

public void sendText(String aTarget,
            String aData)
              throws WebSocketException

Description copied from interface: WebSocketTokenClient

Send the text data

Specified by:

sendText in interface WebSocketTokenClient

Throws:

WebSocketException - if exception while sending text

broadcastText

public void broadcastText(String aData)
                   throws WebSocketException

Description copied from interface: WebSocketTokenClient

Broadcast the text to all the connected clients to jWebSocket server

Specified by:

broadcastText in interface WebSocketTokenClient

Throws:

WebSocketException - if exception while broadcasting

saveFile

public void saveFile(byte[] aData,
            String aFilename,
            String aScope,
            Boolean aNotify)
              throws WebSocketException

Parameters:

aData -

aFilename -

aScope -

aNotify -

Throws:

WebSocketException

sendFile

public void sendFile(String aHeader,
            byte[] aData,
            String aFilename,
            String aTarget)
              throws WebSocketException

Parameters:

aHeader -

aData -

aFilename -

aTarget -

Throws:

WebSocketException

disconnect

public void disconnect()
                throws WebSocketException

Description copied from interface: WebSocketTokenClient

Disconnect from the jWebSocket server

Specified by:

disconnect in interface WebSocketTokenClient

Throws:

WebSocketException - if error while disconnecting

shutdown

public void shutdown()
              throws WebSocketException

Throws:

WebSocketException

getConnections

public void getConnections()
                    throws WebSocketException

Description copied from interface: WebSocketTokenClient

Send the token to get the number of connected clients

Specified by:

getConnections in interface WebSocketTokenClient

Throws:

WebSocketException

getUserRights

public void getUserRights(String aUsername)
                   throws WebSocketException

Parameters:

aUsername -

Throws:

WebSocketException

getUserRoles

public void getUserRoles(String aUsername)
                  throws WebSocketException

Parameters:

aUsername -

Throws:

WebSocketException