Package org.apache.tomcat.websocket.pojo

Class PojoMessageHandlerWholeBase<T>

java.lang.Object

org.apache.tomcat.websocket.pojo.PojoMessageHandlerBase<T>

org.apache.tomcat.websocket.pojo.PojoMessageHandlerWholeBase<T>

Type Parameters:

T - The type of message to handle

All Implemented Interfaces:

MessageHandler, MessageHandler.Whole<T>, WrappedMessageHandler

Direct Known Subclasses:

PojoMessageHandlerWholeBinary, PojoMessageHandlerWholePong, PojoMessageHandlerWholeText

public abstract class PojoMessageHandlerWholeBase<T>
extends PojoMessageHandlerBase<T>
implements MessageHandler.Whole<T>

Common implementation code for the POJO whole message handlers. All the real work is done in this class and in the superclass.

Nested Class Summary

Nested classes/interfaces inherited from interface jakarta.websocket.MessageHandler

MessageHandler.Partial<T>, MessageHandler.Whole<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.List<Decoder>	decoders	The list of decoders for this message handler.

Fields inherited from class org.apache.tomcat.websocket.pojo.PojoMessageHandlerBase

convert, indexPayload, indexSession, maxMessageSize, method, params, pojo, session

Constructor Summary

Constructors

Constructor	Description
PojoMessageHandlerWholeBase(java.lang.Object pojo, java.lang.reflect.Method method, Session session, java.lang.Object[] params, int indexPayload, boolean convert, int indexSession, long maxMessageSize)	Create a whole message handler.

Method Summary

Modifier and Type	Method	Description
protected java.lang.Object	convert(T message)	Convert the message to the type expected by the target method.
protected Decoder	createDecoderInstance(java.lang.Class<? extends Decoder> clazz)	Create an instance of the given decoder class.
protected abstract java.lang.Object	decode(T message)	Decode the message using the registered decoders.
protected void	onClose()	Called when the WebSocket session is closed.
void	onMessage(T message)	Called when a whole message is available to be processed.

Methods inherited from class org.apache.tomcat.websocket.pojo.PojoMessageHandlerBase

getMaxMessageSize, getWrappedHandler, handlePojoMethodException, processResult

Methods inherited from class java.lang.Object

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

Field Detail

decoders

protected final java.util.List<Decoder> decoders

The list of decoders for this message handler.

Constructor Detail

PojoMessageHandlerWholeBase

public PojoMessageHandlerWholeBase(java.lang.Object pojo,
                                   java.lang.reflect.Method method,
                                   Session session,
                                   java.lang.Object[] params,
                                   int indexPayload,
                                   boolean convert,
                                   int indexSession,
                                   long maxMessageSize)

Create a whole message handler.

Parameters:

pojo - POJO instance

method - Method to invoke

session - WebSocket session

params - Pre-populated parameter array

indexPayload - Index of the payload parameter

convert - Convert the message before passing to the method

indexSession - Index of the session parameter

maxMessageSize - Maximum message size

Method Detail

createDecoderInstance

protected Decoder createDecoderInstance(java.lang.Class<? extends Decoder> clazz)
                                 throws java.lang.ReflectiveOperationException,
                                        javax.naming.NamingException

Create an instance of the given decoder class.

Parameters:

clazz - Decoder class

Returns:

New decoder instance

Throws:

java.lang.ReflectiveOperationException - If the decoder cannot be instantiated

javax.naming.NamingException - If the instance manager fails to create the decoder

onMessage

public final void onMessage(T message)

Description copied from interface: jakarta.websocket.MessageHandler.Whole

Called when a whole message is available to be processed.

Specified by:

onMessage in interface MessageHandler.Whole<T>

Parameters:

message - The message

onClose

protected void onClose()

Called when the WebSocket session is closed. Destroys all decoders.

convert

protected java.lang.Object convert(T message)

Convert the message to the type expected by the target method.

Parameters:

message - Message to convert

Returns:

Converted message

decode

protected abstract java.lang.Object decode(T message)
                                    throws DecodeException

Decode the message using the registered decoders.

Parameters:

message - Message to decode

Returns:

Decoded message or null if no decoder could decode it

Throws:

DecodeException - If the message cannot be decoded