Package org.silverpeas.core.webapi.notification.sse

Class SilverpeasServerEventWebSocket

java.lang.Object

org.silverpeas.core.webapi.notification.sse.SilverpeasServerEventWebSocket

Direct Known Subclasses:

CommonServerEventWebSocket

public abstract class SilverpeasServerEventWebSocket
extends Object

This abstraction defines the behavior the Servlets in charge of responding to EventSource JavaScript API must have.
Finally, adding a new URI to handle EventSource needs to extends this class and to parametrize the mapping! (see CommonServerSentEventServlet as an example)

Author:

Yohann Chastagnier

Constructor Summary

Constructors

Constructor	Description
SilverpeasServerEventWebSocket()

Method Summary

Modifier and Type	Method	Description
protected abstract SessionInfo	getSessionInfo(javax.websocket.Session session)	This method is called one time only, when onOpen(Session) is executed.
void	onClose(javax.websocket.Session session)
void	onError(javax.websocket.Session session, Throwable throwable)
void	onMessage(javax.websocket.Session session, String message)
void	onOpen(javax.websocket.Session session)
default void	prepareEventsOnOpening(org.silverpeas.core.webapi.notification.sse.SilverpeasServerEventWebAccess.WebAccessContext wac, Long initialLastServerEventId)
default void	send(org.silverpeas.core.webapi.notification.sse.SilverpeasServerEventWebAccess.WebAccessContext wac, SilverpeasServerEventContext context)

Methods inherited from class java.lang.Object

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

Constructor Detail

SilverpeasServerEventWebSocket

public SilverpeasServerEventWebSocket()

Method Detail

getSessionInfo

protected abstract SessionInfo getSessionInfo(javax.websocket.Session session)

This method is called one time only, when onOpen(Session) is executed.

Parameters:

session - a WebSocket session instance.

Returns:

a SessionInfo instance.

onOpen

public void onOpen(javax.websocket.Session session)
            throws IOException

Throws:

IOException

onClose

public void onClose(javax.websocket.Session session)

onError

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

onMessage

public void onMessage(javax.websocket.Session session,
                      String message)

prepareEventsOnOpening

public default void prepareEventsOnOpening(org.silverpeas.core.webapi.notification.sse.SilverpeasServerEventWebAccess.WebAccessContext wac,
                                           Long initialLastServerEventId)

send

public default void send(org.silverpeas.core.webapi.notification.sse.SilverpeasServerEventWebAccess.WebAccessContext wac,
                         SilverpeasServerEventContext context)
                  throws IOException

Throws:

IOException