PojoMethodMapping (Apache Tomcat 8.5.57 API Documentation)

org.apache.tomcat.websocket.pojo

## Class PojoMethodMapping

- java.lang.Object
- - org.apache.tomcat.websocket.pojo.PojoMethodMapping

-     public class PojoMethodMapping
      extends Object

  For a POJO class annotated with `ServerEndpoint`, an instance of this class creates and caches the method handler, method information and parameter information for the onXXX calls.

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `PojoMethodMapping(Class<?> clazzPojo, List<Class<? extends Decoder>> decoderClazzes, String wsPath)`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `Set<MessageHandler>` | `getMessageHandlers(Object pojo, Map<String,String> pathParameters, Session session, EndpointConfig config)`
    `Method` | `getOnClose()`
    `Object[]` | `getOnCloseArgs(Map<String,String> pathParameters, Session session, CloseReason closeReason)`
    `Method` | `getOnError()`
    `Object[]` | `getOnErrorArgs(Map<String,String> pathParameters, Session session, Throwable throwable)`
    `Method` | `getOnOpen()`
    `Object[]` | `getOnOpenArgs(Map<String,String> pathParameters, Session session, EndpointConfig config)`
    `String` | `getWsPath()`
    `boolean` | `hasMessageHandlers()`

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### PojoMethodMapping

          public PojoMethodMapping(Class<?> clazzPojo,
                           List<Class<? extends Decoder>> decoderClazzes,
                           String wsPath)
                            throws DeploymentException

      Throws:
        `DeploymentException`

  - ### Method Detail

    - #### getWsPath

          public String getWsPath()

    - #### getOnOpen

          public Method getOnOpen()

    - #### getOnOpenArgs

          public Object[] getOnOpenArgs(Map<String,String> pathParameters,
                               Session session,
                               EndpointConfig config)
                                 throws DecodeException

      Throws:
        `DecodeException`

    - #### getOnClose

          public Method getOnClose()

    - #### getOnCloseArgs

          public Object[] getOnCloseArgs(Map<String,String> pathParameters,
                                Session session,
                                CloseReason closeReason)
                                  throws DecodeException

      Throws:
        `DecodeException`

    - #### getOnError

          public Method getOnError()

    - #### getOnErrorArgs

          public Object[] getOnErrorArgs(Map<String,String> pathParameters,
                                Session session,
                                Throwable throwable)
                                  throws DecodeException

      Throws:
        `DecodeException`

    - #### hasMessageHandlers

          public boolean hasMessageHandlers()

    - #### getMessageHandlers

          public Set<MessageHandler> getMessageHandlers(Object pojo,
                                               Map<String,String> pathParameters,
                                               Session session,
                                               EndpointConfig config)

Copyright © 2000-2020 Apache Software Foundation. All Rights Reserved.