org.jwebsocket.api

Interface WebSocketTokenClient

All Superinterfaces:

WebSocketClient

All Known Implementing Classes:

BaseTokenClient

public interface WebSocketTokenClient
extends WebSocketClient

Base interface that represents the Token based jWebSocket client. This interface defines all the methods that handles the basic jWebSocket specific protocol.

Version:

$Id: WebSocketTokenClient.java 697 2010-07-17 21:43:50Z mailtopuran@gmail.com $

Author:

puran

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 aText) Broadcast the text to all the connected clients to jWebSocket server
void	disconnect() Disconnect from the jWebSocket server
void	getConnections() Send the token to get the number of connected clients
String	getUsername()
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
void	ping(boolean aEcho) Ping the jWebSocket server
void	removeTokenClientListener(WebSocketClientTokenListener aTokenListener) Remove the token client listener
void	sendText(String aTargetId, String aText) Send the text data

Methods inherited from interface org.jwebsocket.api.WebSocketClient

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

Method Detail

getUsername

String getUsername()

Returns:

the loggedIn user name

login

void login(String aUsername,
         String aPassword)
           throws WebSocketException

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

Parameters:

username - the user name

password - the password string

Throws:

WebSocketException - if there's any exception while login

logout

void logout()
            throws WebSocketException

Logout the user

Throws:

WebSocketException - if exception while logging out

isAuthenticated

boolean isAuthenticated()

Checks if for this client a user already is authenticated.

broadcastText

void broadcastText(String aText)
                   throws WebSocketException

Broadcast the text to all the connected clients to jWebSocket server

Parameters:

text - the text value to broadcast

Throws:

WebSocketException - if exception while broadcasting

ping

void ping(boolean aEcho)
          throws WebSocketException

Ping the jWebSocket server

Parameters:

echo - flag to enable/disable echo

Throws:

WebSocketException - if exception while doing a ping

sendText

void sendText(String aTargetId,
            String aText)
              throws WebSocketException

Send the text data

Parameters:

target - the target

message - the actual message to send

Throws:

WebSocketException - if exception while sending text

disconnect

void disconnect()
                throws WebSocketException

Disconnect from the jWebSocket server

Throws:

WebSocketException - if error while disconnecting

getConnections

void getConnections()
                    throws WebSocketException

Send the token to get the number of connected clients

Throws:

WebSocketException

addTokenClientListener

void addTokenClientListener(WebSocketClientTokenListener aTokenListener)

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

Parameters:

tokenListener - the token listener object

removeTokenClientListener

void removeTokenClientListener(WebSocketClientTokenListener aTokenListener)

Remove the token client listener

Parameters:

tokenListener - the token client listener