core.tut.pori.websocket

Class SocketService

java.lang.Object

core.tut.pori.websocket.SocketService

Direct Known Subclasses:

TaskFinishedService

public abstract class SocketService
extends java.lang.Object

An abstract class for handling simple text/broadcast to users. Sub-classing this class will automatically add an instance to the WebSocketHandler, retrievable through ServiceInitializer.

Constructor Summary

Constructors

Constructor and Description
SocketService()

Method Summary

Modifier and Type	Method and Description
abstract boolean	accept()
boolean	accept(javax.websocket.Session session)
abstract boolean	accept(UserIdentity authenticatedUser)
void	broadcast(java.lang.String message) Send message to all connected users.
void	close(UserIdentity authorizedUser, javax.websocket.CloseReason closeReason) Close all sessions belonging to the given user identity.
abstract void	disconnected() An anonymous user has been disconnected.
abstract void	disconnected(UserIdentity authenticatedUser) The user has been disconnected.
abstract java.lang.String	getEndPointName() Note: the name is checked on initialization, changing the name run-time has no effect.
boolean	hasSessions(UserIdentity authenticatedUser)
void	onClose(javax.websocket.Session session, javax.websocket.CloseReason closeReason)
void	onError(javax.websocket.Session session, java.lang.Throwable throwable) The default implementation will simply print the exception to log and close the session.
void	received(javax.websocket.Session session, java.lang.String message)
abstract void	received(java.lang.String message) Message received for an anonymous user.
abstract void	received(UserIdentity authenticatedUser, java.lang.String message)
void	send(java.lang.String message) Send message to all unauthorized users
boolean	send(UserIdentity authenticatedUser, java.lang.String message) Send message to the given authorized user

Methods inherited from class java.lang.Object

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

Constructor Detail

SocketService

public SocketService()

Method Detail

onError

public void onError(javax.websocket.Session session,
                    java.lang.Throwable throwable)

The default implementation will simply print the exception to log and close the session.

Parameters:

session -

throwable -

close

public void close(UserIdentity authorizedUser,
                  javax.websocket.CloseReason closeReason)

Close all sessions belonging to the given user identity. Note that calling this method may or may not cause disconnected() to be called depending on whether the user has active sessions or not.

Parameters:

authorizedUser -

closeReason -

accept

public boolean accept(javax.websocket.Session session)

Parameters:

session -

Returns:

true on successful accept, false on rejection. Upon rejection the session will be automatically closed.

onClose

public void onClose(javax.websocket.Session session,
                    javax.websocket.CloseReason closeReason)

Parameters:

session -

closeReason -

received

public void received(javax.websocket.Session session,
                     java.lang.String message)

Parameters:

session -

message -

send

public boolean send(UserIdentity authenticatedUser,
                    java.lang.String message)

Send message to the given authorized user

Parameters:

authenticatedUser -

message -

Returns:

true if the message was successfully sent to at least one of the user's sessions

send

public void send(java.lang.String message)

Send message to all unauthorized users

Parameters:

message -

broadcast

public void broadcast(java.lang.String message)

Send message to all connected users.

Parameters:

message -

hasSessions

public boolean hasSessions(UserIdentity authenticatedUser)

Parameters:

authenticatedUser -

Returns:

true if the given user has active sessions. Note that in this case "active" is loosely defined, it is possible that the session has timed out, but the socket service has not yet registered the drop.

accept

public abstract boolean accept(UserIdentity authenticatedUser)

Parameters:

authenticatedUser -

Returns:

true if the connection for the given user should be accepted, otherwise, the connection will be closed

accept

public abstract boolean accept()

Returns:

true if an anonymous connection should be accepted, otherwise, the connection will be closed

received

public abstract void received(UserIdentity authenticatedUser,
                              java.lang.String message)

Parameters:

authenticatedUser -

message -

received

public abstract void received(java.lang.String message)

Message received for an anonymous user.

Parameters:

message -

disconnected

public abstract void disconnected(UserIdentity authenticatedUser)

The user has been disconnected.

Parameters:

authenticatedUser -

disconnected

public abstract void disconnected()

An anonymous user has been disconnected.

getEndPointName

public abstract java.lang.String getEndPointName()

Note: the name is checked on initialization, changing the name run-time has no effect.

Returns:

the end point name