Top Description Inners Fields Constructors Methods

org.apache.tomcat.websocket.pojo

public Class PojoMethodMapping

Class Inheritance

extends Object

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

Imports

java.io.InputStream, .Reader, java.lang.annotation.Annotation, java.lang.reflect.Method, .Modifier, java.nio.ByteBuffer, java.util.ArrayList, .Arrays, .HashMap, .HashSet, .List, .Map, .Set, jakarta.websocket.CloseReason, .DecodeException, .Decoder, .DeploymentException, .EndpointConfig, .MessageHandler, .OnClose, .OnError, .OnMessage, .OnOpen, .PongMessage, .Session, jakarta.websocket.server.PathParam, org.apache.tomcat.InstanceManager, org.apache.tomcat.util.res.StringManager, org.apache.tomcat.websocket.DecoderEntry, .Util, .Util.DecoderMatch

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

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	PojoMethodMapping.MessageHandlerInfo
private static enum	PojoMethodMapping.MethodType

Field Summary

Modifier and Type	Field and Description
private final Method	onClose
private final PojoPathParam[]	onCloseParams
private final Method	onError
private final PojoPathParam[]	onErrorParams
private final List<PojoMethodMapping.MessageHandlerInfo>	onMessage
private final Method	onOpen
private final PojoPathParam[]	onOpenParams
private static final StringManager	sm
private final String	wsPath

Constructor Summary

Access	Constructor and Description
public	PojoMethodMapping(Class<?> POJO implementation class clazzPojo, List<Class<? extends Decoder>> Set of potential decoder classes decoderClazzes, String Path at which the endpoint will be deployed wsPath, InstanceManager Instance manager to use to create Decoder instances instanceManager) Create a method mapping for the given POJO

Method Summary

Modifier and Type	Method and Description
private static Object[]	buildArgs(PojoPathParam[] pathParams, Map<String, String> pathParameters, Session session, EndpointConfig config, Throwable throwable, CloseReason closeReason)
private void	checkPublic(Method m)
public Set<MessageHandler>	getMessageHandlers(Object pojo, Map<String, String> pathParameters, Session session, EndpointConfig config)
public Method	getOnClose()
public Object[]	getOnCloseArgs(Map<String, String> pathParameters, Session session, CloseReason closeReason)
public Method	getOnError()
public Object[]	getOnErrorArgs(Map<String, String> pathParameters, Session session, Throwable throwable)
public Method	getOnOpen()
public Object[]	getOnOpenArgs(Map<String, String> pathParameters, Session session, EndpointConfig config)
private static PojoPathParam[]	getPathParams(Method m, PojoMethodMapping.MethodType methodType)
public String	getWsPath()
public boolean	hasMessageHandlers()
private boolean	isMethodOverride(Method method1, Method method2)
private boolean	isOverridenWithoutAnnotation(Method[] methods, Method superclazzMethod, Class<? extends Annotation> annotation)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

onClose	back to summary
private final Method onClose

onCloseParams	back to summary
private final PojoPathParam[] onCloseParams

onError	back to summary
private final Method onError

onErrorParams	back to summary
private final PojoPathParam[] onErrorParams

onMessage	back to summary
private final List<PojoMethodMapping.MessageHandlerInfo> onMessage

onOpen	back to summary
private final Method onOpen

onOpenParams	back to summary
private final PojoPathParam[] onOpenParams

sm	back to summary
private static final StringManager sm

wsPath	back to summary
private final String wsPath

Constructor Detail

PojoMethodMapping

back to summary

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

Create a method mapping for the given POJO

Parameters

clazzPojo:Class<?>: POJO implementation class
decoderClazzes:List<Class<? extends Decoder>>: Set of potential decoder classes
wsPath:String: Path at which the endpoint will be deployed
instanceManager:InstanceManager: Instance manager to use to create Decoder instances

Exceptions

DeploymentException:: If the mapping cannot be completed

Method Detail

buildArgs	back to summary
private static Object[] buildArgs(PojoPathParam[] pathParams, Map<String, String> pathParameters, Session session, EndpointConfig config, Throwable throwable, CloseReason closeReason) throws DecodeException

checkPublic	back to summary
private void checkPublic(Method m) throws DeploymentException

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

getOnClose	back to summary
public Method getOnClose()

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

getOnError	back to summary
public Method getOnError()

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

getOnOpen	back to summary
public Method getOnOpen()

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

getPathParams	back to summary
private static PojoPathParam[] getPathParams(Method m, PojoMethodMapping.MethodType methodType) throws DeploymentException

getWsPath	back to summary
public String getWsPath()

hasMessageHandlers	back to summary
public boolean hasMessageHandlers()

isMethodOverride	back to summary
private boolean isMethodOverride(Method method1, Method method2)

isOverridenWithoutAnnotation	back to summary
private boolean isOverridenWithoutAnnotation(Method[] methods, Method superclazzMethod, Class<? extends Annotation> annotation)

org.apache.tomcat.websocket.pojo back to summary

private Class PojoMethodMapping.MessageHandlerInfo

Class Inheritance

extends Object

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

Field Summary

Modifier and Type	Field and Description
private Util.DecoderMatch	decoderMatch
private int	indexBoolean
private int	indexByteArray
private int	indexByteBuffer
private int	indexInputStream
private Map<Integer, PojoPathParam>	indexPathParams
private int	indexPayload
private int	indexPong
private int	indexPrimitive
private int	indexReader
private int	indexSession
private int	indexString
private final Method	m
private long	maxMessageSize

Constructor Summary

Access	Constructor and Description
pack-priv	MessageHandlerInfo(Method m, List<DecoderEntry> decoderEntries)

Method Summary

Modifier and Type	Method and Description
public Set<MessageHandler>	getMessageHandlers(Object pojo, Map<String, String> pathParameters, Session session, EndpointConfig config)
private boolean	isBinary()
private boolean	isPong()
private boolean	isText()
public boolean	targetsSameWebSocketMessageType(PojoMethodMapping.MessageHandlerInfo otherHandler)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

decoderMatch	back to summary
private Util.DecoderMatch decoderMatch

indexBoolean	back to summary
private int indexBoolean

indexByteArray	back to summary
private int indexByteArray

indexByteBuffer	back to summary
private int indexByteBuffer

indexInputStream	back to summary
private int indexInputStream

indexPathParams	back to summary
private Map<Integer, PojoPathParam> indexPathParams

indexPayload	back to summary
private int indexPayload

indexPong	back to summary
private int indexPong

indexPrimitive	back to summary
private int indexPrimitive

indexReader	back to summary
private int indexReader

indexSession	back to summary
private int indexSession

indexString	back to summary
private int indexString

m	back to summary
private final Method m

maxMessageSize	back to summary
private long maxMessageSize

Constructor Detail

MessageHandlerInfo	back to summary
pack-priv MessageHandlerInfo(Method m, List<DecoderEntry> decoderEntries) throws DeploymentException

Method Detail

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

isBinary	back to summary
private boolean isBinary()

isPong	back to summary
private boolean isPong()

isText	back to summary
private boolean isText()

targetsSameWebSocketMessageType	back to summary
public boolean targetsSameWebSocketMessageType(PojoMethodMapping.MessageHandlerInfo otherHandler)

org.apache.tomcat.websocket.pojo back to summary

private final Enum PojoMethodMapping.MethodType

Class Inheritance

extends Enum<PojoMethodMapping.MethodType>

java.lang.Object
java.lang.Enum
org.apache.tomcat.websocket.pojo.PojoMethodMapping.MethodType

Field Summary

Modifier and Type	Field and Description
public static final PojoMethodMapping.MethodType	ON_CLOSE
public static final PojoMethodMapping.MethodType	ON_ERROR
public static final PojoMethodMapping.MethodType	ON_OPEN

Constructor Summary

Access	Constructor and Description
private	MethodType()

Method Summary

Modifier and Type	Method and Description
public static PojoMethodMapping.MethodType	valueOf(String name)
public static PojoMethodMapping.MethodType[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ON_CLOSE	back to summary
public static final PojoMethodMapping.MethodType ON_CLOSE

ON_ERROR	back to summary
public static final PojoMethodMapping.MethodType ON_ERROR

ON_OPEN	back to summary
public static final PojoMethodMapping.MethodType ON_OPEN

Constructor Detail

MethodType	back to summary
private MethodType()

Method Detail

valueOf	back to summary
public static PojoMethodMapping.MethodType valueOf(String name)

values	back to summary
public static PojoMethodMapping.MethodType[] values()