Package org.apache.tomcat.websocket.pojo

Class PojoEndpointBase

java.lang.Object

jakarta.websocket.Endpoint

org.apache.tomcat.websocket.pojo.PojoEndpointBase

Direct Known Subclasses:

PojoEndpointClient, PojoEndpointServer

public abstract class PojoEndpointBase
extends Endpoint

Base implementation (client and server have different concrete implementations) of the wrapper that converts a POJO instance into a WebSocket endpoint instance.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PojoEndpointBase(java.util.Map<java.lang.String,java.lang.String> pathParameters)

Method Summary

Modifier and Type	Method	Description
protected void	doOnOpen(Session session, EndpointConfig config)
protected PojoMethodMapping	getMethodMapping()
protected java.lang.Object	getPojo()
void	onClose(Session session, CloseReason closeReason)	Event that is triggered when a session has closed.
void	onError(Session session, java.lang.Throwable throwable)	Event that is triggered when a protocol error occurs.
protected void	setMethodMapping(PojoMethodMapping methodMapping)
protected void	setPojo(java.lang.Object pojo)

Methods inherited from class jakarta.websocket.Endpoint

onOpen

Methods inherited from class java.lang.Object

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

Constructor Detail

PojoEndpointBase

protected PojoEndpointBase(java.util.Map<java.lang.String,java.lang.String> pathParameters)

Method Detail

doOnOpen

protected final void doOnOpen(Session session,
                              EndpointConfig config)

onClose

public final void onClose(Session session,
                          CloseReason closeReason)

Description copied from class: jakarta.websocket.Endpoint

Event that is triggered when a session has closed.

Overrides:

onClose in class Endpoint

Parameters:

session - The session

closeReason - Why the session was closed

onError

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

Description copied from class: jakarta.websocket.Endpoint

Event that is triggered when a protocol error occurs.

Overrides:

onError in class Endpoint

Parameters:

session - The session.

throwable - The exception.

getPojo

protected java.lang.Object getPojo()

setPojo

protected void setPojo(java.lang.Object pojo)

getMethodMapping

protected PojoMethodMapping getMethodMapping()

setMethodMapping

protected void setMethodMapping(PojoMethodMapping methodMapping)