org.glassfish.tyrus.platform

Class EndpointAdapter

java.lang.Object

javax.net.websocket.Endpoint

org.glassfish.tyrus.platform.EndpointAdapter

public class EndpointAdapter
extends Endpoint

Adapter to make the implementation easy for developers.

Author:

Stepan Kopriva (stepan.kopriva at oracle.com)

Constructor Summary

Constructors

Constructor and Description
EndpointAdapter()

Method Summary

Methods

Modifier and Type	Method and Description
void	onClose(Session session, CloseReason closeReason) Developers may implement this method to be notified when an active conversation has just been terminated.
void	onError(Throwable thr, Session s) Developers may implement this method when a web socket connection, represented by the session, creates some kind of error that is not modeled in the web socket protocol.
void	onOpen(Session session) Developers may implement this method to be notified when a new conversation has just begun.

Methods inherited from class java.lang.Object

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

Constructor Detail

EndpointAdapter

public EndpointAdapter()

Method Detail

onOpen

public void onOpen(Session session)

Description copied from class: Endpoint

Developers may implement this method to be notified when a new conversation has just begun.

Specified by:

onOpen in class Endpoint

onClose

public void onClose(Session session,
           CloseReason closeReason)

Description copied from class: Endpoint

Developers may implement this method to be notified when an active conversation has just been terminated.

Overrides:

onClose in class Endpoint

onError

public void onError(Throwable thr,
           Session s)

Description copied from class: Endpoint

Developers may implement this method when a web socket connection, represented by the session, creates some kind of error that is not modeled in the web socket protocol. This may for example be a notification that an incoming message is too big to handle, or that the incoming message could not be encoded.

There are a number of categories of exception that this method is (currently) defined to handle:-
- connection problems, for example, a socket failure that occurs before the web socket connection can be formally closed.
- errors thrown by developer create message handlers calls.
- conversion errors encoding incoming messages before any message handler has been called.
TBD We may come up with less of a 'catch-all' mechanism for handling exceptions, especially given the varying nature of these categories of exception.

Overrides:

onError in class Endpoint