public class BaseTokenClient extends BaseWebSocketClient implements WebSocketTokenClient
JWebSocketClientDATA_CLOSE_CLIENT, DATA_CLOSE_ERROR, DATA_CLOSE_SERVER, DATA_CLOSE_SHUTDOWN, EVENT_CLOSE, EVENT_OPEN, mStatus| Constructor and Description |
|---|
BaseTokenClient()
Default constructor
|
BaseTokenClient(ReliabilityOptions aReliabilityOptions) |
BaseTokenClient(String aSubProt,
WebSocketEncoding aEncoding) |
BaseTokenClient(WebSocketSubProtocol aSubProt) |
| 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) |
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, setVersionclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitaddListener, addSubProtocol, getListeners, getNegotiatedEncoding, getNegotiatedSubProtocol, getStatus, isConnected, notifyClosed, notifyOpened, notifyPacket, notifyReconnecting, open, removeListener, send, send, send, setVersionpublic BaseTokenClient()
public BaseTokenClient(ReliabilityOptions aReliabilityOptions)
aReliabilityOptions - public BaseTokenClient(String aSubProt, WebSocketEncoding aEncoding)
aSubProt - aEncoding - public BaseTokenClient(WebSocketSubProtocol aSubProt)
aSubProt - public void addTokenClientListener(WebSocketClientTokenListener aTokenListener)
WebSocketTokenClientaddTokenClientListener in interface WebSocketTokenClientpublic void removeTokenClientListener(WebSocketClientTokenListener aTokenListener)
WebSocketTokenClientremoveTokenClientListener in interface WebSocketTokenClientpublic void close()
close in interface WebSocketClientclose in class BaseWebSocketClientpublic String getUsername()
getUsername in interface WebSocketTokenClientpublic void setUsername(String aUsername)
public boolean isAuthenticated()
WebSocketTokenClientisAuthenticated in interface WebSocketTokenClientpublic String getClientId()
public Token packetToToken(WebSocketPacket aPacket)
aPacket - public WebSocketPacket tokenToPacket(Token aToken)
aToken - public void sendToken(Token aToken) throws WebSocketException
aToken - WebSocketExceptionpublic void sendToken(Token aToken, WebSocketResponseTokenListener aResponseListener) throws WebSocketException
aToken - aResponseListener - WebSocketExceptionpublic void login(String aUsername, String aPassword) throws WebSocketException
WebSocketTokenClientlogin in interface WebSocketTokenClientWebSocketException - if there's any exception while loginpublic void logout()
throws WebSocketException
WebSocketTokenClientlogout in interface WebSocketTokenClientWebSocketException - if exception while logging outpublic void ping(boolean aEcho)
throws WebSocketException
WebSocketTokenClientping in interface WebSocketTokenClientWebSocketException - if exception while doing a pingpublic void sendText(String aTarget, String aData) throws WebSocketException
WebSocketTokenClientsendText in interface WebSocketTokenClientWebSocketException - if exception while sending textpublic void broadcastText(String aData) throws WebSocketException
WebSocketTokenClientbroadcastText in interface WebSocketTokenClientWebSocketException - if exception while broadcastingpublic void saveFile(byte[] aData,
String aFilename,
String aScope,
Boolean aNotify)
throws WebSocketException
aData - aFilename - aScope - aNotify - WebSocketExceptionpublic void sendFile(String aHeader, byte[] aData, String aFilename, String aTarget) throws WebSocketException
aHeader - aData - aFilename - aTarget - WebSocketExceptionpublic void disconnect()
throws WebSocketException
WebSocketTokenClientdisconnect in interface WebSocketTokenClientWebSocketException - if error while disconnectingpublic void shutdown()
throws WebSocketException
WebSocketExceptionpublic void getConnections()
throws WebSocketException
WebSocketTokenClientgetConnections in interface WebSocketTokenClientWebSocketExceptionpublic void getUserRights(String aUsername) throws WebSocketException
aUsername - WebSocketExceptionpublic void getUserRoles(String aUsername) throws WebSocketException
aUsername - WebSocketExceptionCopyright © 2013. All Rights Reserved.