Top Description Fields Constructors Methods
org.apache.tomcat.websocket.pojo

public abstract Class PojoEndpointBase

extends Endpoint
Class Inheritance
Known Direct Subclasses
org.apache.tomcat.websocket.pojo.PojoEndpointClient, org.apache.tomcat.websocket.pojo.PojoEndpointServer
Imports
java.io.IOException, java.lang.reflect.InvocationTargetException, java.util.Map, .Set, jakarta.websocket.CloseReason, .Endpoint, .EndpointConfig, .MessageHandler, .Session, org.apache.juli.logging.Log, .LogFactory, org.apache.tomcat.util.ExceptionUtils, org.apache.tomcat.util.res.StringManager
Base implementation (client and server have different concrete implementations) of the wrapper that converts a POJO instance into a WebSocket endpoint instance.

Field Summary

Modifier and TypeField and Description
private final Log
log

private PojoMethodMapping
methodMapping

private final Map<String, String>
pathParameters

private Object
pojo

private static final StringManager
sm

Constructor Summary

AccessConstructor and Description
protected
PojoEndpointBase(Map<String, String> pathParameters)

Method Summary

Modifier and TypeMethod and Description
protected final void
doOnOpen(Session session, EndpointConfig config)

protected PojoMethodMapping
getMethodMapping()

protected Object
getPojo()

private void
handleOnOpenOrCloseError(Session session, Throwable t)

public final void
onClose(Session
The session
session, CloseReason
Why the session was closed
closeReason)

Overrides jakarta.websocket.Endpoint.onClose.

Event that is triggered when a session has closed.

public final void
onError(Session
The session.
session, Throwable
The exception.
throwable)

Overrides jakarta.websocket.Endpoint.onError.

Event that is triggered when a protocol error occurs.

protected void
setMethodMapping(PojoMethodMapping methodMapping)

protected void
setPojo(Object pojo)

Inherited from jakarta.websocket.Endpoint:
onOpen

Field Detail

logback to summary
private final Log log
methodMappingback to summary
private PojoMethodMapping methodMapping
pathParametersback to summary
private final Map<String, String> pathParameters
pojoback to summary
private Object pojo
smback to summary
private static final StringManager sm

Constructor Detail

PojoEndpointBaseback to summary
protected PojoEndpointBase(Map<String, String> pathParameters)

Method Detail

doOnOpenback to summary
protected final void doOnOpen(Session session, EndpointConfig config)
getMethodMappingback to summary
protected PojoMethodMapping getMethodMapping()
getPojoback to summary
protected Object getPojo()
handleOnOpenOrCloseErrorback to summary
private void handleOnOpenOrCloseError(Session session, Throwable t)
onCloseback to summary
public final void onClose(Session session, CloseReason closeReason)

Overrides jakarta.websocket.Endpoint.onClose.

Doc from jakarta.websocket.Endpoint.onClose.

Event that is triggered when a session has closed.

Parameters
session:Session

The session

closeReason:CloseReason

Why the session was closed

Annotations
@Override
onErrorback to summary
public final void onError(Session session, Throwable throwable)

Overrides jakarta.websocket.Endpoint.onError.

Doc from jakarta.websocket.Endpoint.onError.

Event that is triggered when a protocol error occurs.

Parameters
session:Session

The session.

throwable:Throwable

The exception.

Annotations
@Override
setMethodMappingback to summary
protected void setMethodMapping(PojoMethodMapping methodMapping)
setPojoback to summary
protected void setPojo(Object pojo)