Package org.apache.tomcat.websocket.pojo

Class PojoMessageHandlerWholeBinary

java.lang.Object

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

org.apache.tomcat.websocket.pojo.PojoMessageHandlerWholeBase<java.nio.ByteBuffer>

org.apache.tomcat.websocket.pojo.PojoMessageHandlerWholeBinary

All Implemented Interfaces:

MessageHandler, MessageHandler.Whole<java.nio.ByteBuffer>, WrappedMessageHandler

public class PojoMessageHandlerWholeBinary
extends PojoMessageHandlerWholeBase<java.nio.ByteBuffer>

ByteBuffer specific concrete implementation for handling whole messages.

Nested Class Summary

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

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

Field Summary

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

decoders

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

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

Constructor Summary

Constructors

Constructor	Description
PojoMessageHandlerWholeBinary(java.lang.Object pojo, java.lang.reflect.Method method, Session session, EndpointConfig config, java.util.List<java.lang.Class<? extends Decoder>> decoderClazzes, java.lang.Object[] params, int indexPayload, boolean convert, int indexSession, boolean isForInputStream, long maxMessageSize)	Create a whole binary message handler.

Method Summary

Modifier and Type	Method	Description
protected java.lang.Object	convert(java.nio.ByteBuffer message)	Convert the message to the type expected by the target method.
protected java.lang.Object	decode(java.nio.ByteBuffer message)	Decode the message using the registered decoders.

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

createDecoderInstance, onClose, onMessage

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

Constructor Detail

PojoMessageHandlerWholeBinary

public PojoMessageHandlerWholeBinary(java.lang.Object pojo,
                                     java.lang.reflect.Method method,
                                     Session session,
                                     EndpointConfig config,
                                     java.util.List<java.lang.Class<? extends Decoder>> decoderClazzes,
                                     java.lang.Object[] params,
                                     int indexPayload,
                                     boolean convert,
                                     int indexSession,
                                     boolean isForInputStream,
                                     long maxMessageSize)

Create a whole binary message handler.

Parameters:

pojo - POJO instance

method - Method to invoke

session - WebSocket session

config - Endpoint configuration

decoderClazzes - List of decoder classes

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

isForInputStream - True if the payload is an InputStream

maxMessageSize - Maximum message size

Method Detail

decode

protected java.lang.Object decode(java.nio.ByteBuffer message)
                           throws DecodeException

Description copied from class: PojoMessageHandlerWholeBase

Decode the message using the registered decoders.

Specified by:

decode in class PojoMessageHandlerWholeBase<java.nio.ByteBuffer>

Parameters:

message - Message to decode

Returns:

Decoded message or null if no decoder could decode it

Throws:

DecodeException - If the message cannot be decoded

convert

protected java.lang.Object convert(java.nio.ByteBuffer message)

Description copied from class: PojoMessageHandlerWholeBase

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

Overrides:

convert in class PojoMessageHandlerWholeBase<java.nio.ByteBuffer>

Parameters:

message - Message to convert

Returns:

Converted message