Package no.polaric.core.httpd

Class WsNotifier

java.lang.Object

no.polaric.core.httpd.ServerBase

no.polaric.core.httpd.WsNotifier

All Implemented Interfaces:

SesNotifier

Direct Known Subclasses:

NodeWs, PubSub

public abstract class WsNotifier
extends ServerBase
implements SesNotifier

Abstract base class for websocket services.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	WsNotifier.Client	Client

Nested classes/interfaces inherited from interface no.polaric.core.httpd.SesNotifier

SesNotifier.SHandler

Field Summary

Fields

Modifier and Type	Field	Description
protected final Map<io.javalin.websocket.WsContext,WsNotifier.Client>	_clients

Fields inherited from class no.polaric.core.httpd.ServerBase

_conf, _encoding, a, localTime, mapper, utcTime

Constructor Summary

Constructors

Constructor	Description
WsNotifier(ServerConfig conf)

Method Summary

Modifier and Type	Method	Description
AuthInfo	authenticate(String qstring)	Do authentication based on URL query-string.
Collection<WsNotifier.Client>	clients()	Return collection of clients
protected void	closeSes(io.javalin.websocket.WsContext ctx)	Close the client session.
int	nClients()	Return number of clients.
abstract WsNotifier.Client	newClient(io.javalin.websocket.WsContext ctx)	Factory method
int	nLoggedIn()	Return number of logged-in users
long	nLogins()	Return number of logins
long	nVisits()	Return number of visits
void	onCloseSes(SesNotifier.SHandler h)	Register a callback for close-session events
void	onOpenSes(SesNotifier.SHandler h)	Register a callback for open-session events
void	postText(String txt, Predicate<WsNotifier.Client> pred)	Distribute a text to the clients for which the predicate evaluates to true.
void	postText(Function<WsNotifier.Client,String> txt, Predicate<WsNotifier.Client> pred)	Distribute a text to the clients for which the predicate evaluates to true.
static String	sesId(io.javalin.websocket.WsContext ctx)	Return session id.
void	start(String uri)	Start the websocket service
protected boolean	subscribe(io.javalin.websocket.WsContext ctx, WsNotifier.Client client)	Subscribe a client to the service.

Methods inherited from class no.polaric.core.httpd.ServerBase

addSubtype, cleanPath, clientIpAddr, conf, deserializeJson, fixText, fromJson, getAuthInfo, icon, metaTag, protect, protect, roundDeg, serializeJson, systemNotification, toJson, urlDecode, wServer

Methods inherited from class java.lang.Object

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

Field Details

_clients

protected final Map<io.javalin.websocket.WsContext,WsNotifier.Client> _clients

Constructor Details

WsNotifier

public WsNotifier(ServerConfig conf)

Method Details

newClient

public abstract WsNotifier.Client newClient(io.javalin.websocket.WsContext ctx)

Factory method

nClients

public int nClients()

Return number of clients.

nVisits

public long nVisits()

Return number of visits

nLogins

public long nLogins()

Return number of logins

nLoggedIn

public int nLoggedIn()

Return number of logged-in users

clients

public Collection<WsNotifier.Client> clients()

Return collection of clients

authenticate

public AuthInfo authenticate(String qstring)

Do authentication based on URL query-string. Return an AuthInfo object if success. Return null if failure. The query string have 3 or 4 parameters: (1) userid, (2) nonce, (3) hmac, (4) role (optional). When computing the hmac the data field is empty.

closeSes

protected void closeSes(io.javalin.websocket.WsContext ctx)

Close the client session.

onOpenSes

public void onOpenSes(SesNotifier.SHandler h)

Register a callback for open-session events

Specified by:

onOpenSes in interface SesNotifier

onCloseSes

public void onCloseSes(SesNotifier.SHandler h)

Register a callback for close-session events

Specified by:

onCloseSes in interface SesNotifier

subscribe

protected boolean subscribe(io.javalin.websocket.WsContext ctx,
 WsNotifier.Client client)

Subscribe a client to the service. Should be overridden in subclass. This may include authorization, preferences, etc..

Returns:

true if subscription is accepted. False if rejected.

postText

public void postText(Function<WsNotifier.Client,String> txt,
 Predicate<WsNotifier.Client> pred)

Distribute a text to the clients for which the predicate evaluates to true. Text is generated by the given function.

postText

public void postText(String txt,
 Predicate<WsNotifier.Client> pred)

Distribute a text to the clients for which the predicate evaluates to true.

sesId

public static String sesId(io.javalin.websocket.WsContext ctx)

Return session id. The id is the last 8 digits of the session-id @ hostname

start

public void start(String uri)

Start the websocket service