PojoMessageHandlerWholeBase (Apache Tomcat 7.0.109 API Documentation)

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 javax.websocket.MessageHandler
  MessageHandler.Partial<T>, MessageHandler.Whole<T>

Field Summary
- Fields inherited from class org.apache.tomcat.websocket.pojo.PojoMessageHandlerBase
  convert, indexPayload, indexSession, maxMessageSize, method, params, pojo, session

Constructor Summary

Constructors
Constructor and Description
`PojoMessageHandlerWholeBase(Object pojo, Method method, Session session, Object[] params, int indexPayload, boolean convert, int indexSession, long maxMessageSize)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected Object`	`convert(T message)`
`protected abstract Object`	`decode(T message)`
`protected abstract void`	`onClose()`
`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

Constructor Detail

PojoMessageHandlerWholeBase

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

Method Detail
- onMessage
```
public final void onMessage(T message)
```
  Description copied from interface: MessageHandler.Whole
  
  Called when a whole message is available to be processed.
  
  Specified by:
  
  onMessage in interface MessageHandler.Whole<T>
  
  Parameters:
  message - The message
- convert
```
protected Object convert(T message)
```
- decode
```
protected abstract Object decode(T message)
                          throws DecodeException
```
  Throws:
  
  DecodeException
- onClose
```
protected abstract void onClose()
```

Class PojoMessageHandlerWholeBase<T>

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

PojoMessageHandlerWholeBase

Method Detail

onMessage

convert

decode

onClose