1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
|
//
// ========================================================================
// Copyright (c) 1995-2013 Mort Bay Consulting Pty. Ltd.
// ------------------------------------------------------------------------
// All rights reserved. This program and the accompanying materials
// are made available under the terms of the Eclipse Public License v1.0
// and Apache License v2.0 which accompanies this distribution.
//
// The Eclipse Public License is available at
// http://www.eclipse.org/legal/epl-v10.html
//
// The Apache License v2.0 is available at
// http://www.opensource.org/licenses/apache2.0.php
//
// You may elect to redistribute this code under either of these licenses.
// ========================================================================
//
package org.eclipse.jetty.websocket.jsr356.annotations;
import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
import java.util.LinkedList;
import java.util.List;
import javax.websocket.EndpointConfig;
import javax.websocket.OnClose;
import javax.websocket.OnError;
import javax.websocket.OnMessage;
import javax.websocket.OnOpen;
import org.eclipse.jetty.util.log.Log;
import org.eclipse.jetty.util.log.Logger;
import org.eclipse.jetty.websocket.common.events.annotated.AbstractMethodAnnotationScanner;
import org.eclipse.jetty.websocket.common.events.annotated.InvalidSignatureException;
import org.eclipse.jetty.websocket.common.util.ReflectUtils;
public class AnnotatedEndpointScanner<T extends Annotation, C extends EndpointConfig> extends AbstractMethodAnnotationScanner<AnnotatedEndpointMetadata<T, C>>
{
private static final Logger LOG = Log.getLogger(AnnotatedEndpointScanner.class);
private final LinkedList<IJsrParamId> paramsOnOpen;
private final LinkedList<IJsrParamId> paramsOnClose;
private final LinkedList<IJsrParamId> paramsOnError;
private final LinkedList<IJsrParamId> paramsOnMessage;
private final AnnotatedEndpointMetadata<T, C> metadata;
public AnnotatedEndpointScanner(AnnotatedEndpointMetadata<T, C> metadata)
{
this.metadata = metadata;
paramsOnOpen = new LinkedList<>();
paramsOnClose = new LinkedList<>();
paramsOnError = new LinkedList<>();
paramsOnMessage = new LinkedList<>();
metadata.customizeParamsOnOpen(paramsOnOpen);
paramsOnOpen.add(JsrParamIdOnOpen.INSTANCE);
metadata.customizeParamsOnClose(paramsOnClose);
paramsOnClose.add(JsrParamIdOnClose.INSTANCE);
metadata.customizeParamsOnError(paramsOnError);
paramsOnError.add(JsrParamIdOnError.INSTANCE);
metadata.customizeParamsOnMessage(paramsOnMessage);
paramsOnMessage.add(JsrParamIdBinary.INSTANCE);
paramsOnMessage.add(JsrParamIdText.INSTANCE);
paramsOnMessage.add(JsrParamIdPong.INSTANCE);
}
private void assertNotDuplicate(JsrCallable callable, Class<? extends Annotation> methodAnnotationClass, Class<?> pojo, Method method)
{
if (callable != null)
{
// Duplicate annotation detected
StringBuilder err = new StringBuilder();
err.append("Encountered duplicate method annotations @");
err.append(methodAnnotationClass.getSimpleName());
err.append(" on ");
err.append(ReflectUtils.toString(pojo,callable.getMethod()));
err.append(" and ");
err.append(ReflectUtils.toString(pojo,method));
throw new InvalidSignatureException(err.toString());
}
}
@Override
public void onMethodAnnotation(AnnotatedEndpointMetadata<T, C> metadata, Class<?> pojo, Method method, Annotation annotation)
{
LOG.debug("onMethodAnnotation({}, {}, {}, {})",metadata,pojo,method,annotation);
if (isAnnotation(annotation,OnOpen.class))
{
assertIsPublicNonStatic(method);
assertIsReturn(method,Void.TYPE);
assertNotDuplicate(metadata.onOpen,OnOpen.class,pojo,method);
OnOpenCallable onopen = new OnOpenCallable(pojo,method);
visitMethod(onopen,pojo,method,paramsOnOpen,OnOpen.class);
metadata.onOpen = onopen;
return;
}
if (isAnnotation(annotation,OnClose.class))
{
assertIsPublicNonStatic(method);
assertIsReturn(method,Void.TYPE);
assertNotDuplicate(metadata.onClose,OnClose.class,pojo,method);
OnCloseCallable onclose = new OnCloseCallable(pojo,method);
visitMethod(onclose,pojo,method,paramsOnClose,OnClose.class);
metadata.onClose = onclose;
return;
}
if (isAnnotation(annotation,OnError.class))
{
assertIsPublicNonStatic(method);
assertIsReturn(method,Void.TYPE);
assertNotDuplicate(metadata.onError,OnError.class,pojo,method);
OnErrorCallable onerror = new OnErrorCallable(pojo,method);
visitMethod(onerror,pojo,method,paramsOnError,OnError.class);
metadata.onError = onerror;
return;
}
if (isAnnotation(annotation,OnMessage.class))
{
assertIsPublicNonStatic(method);
// assertIsReturn(method,Void.TYPE); // no validation, it can be any return type
OnMessageCallable onmessage = new OnMessageCallable(pojo,method);
visitMethod(onmessage,pojo,method,paramsOnMessage,OnMessage.class);
Param param = onmessage.getMessageObjectParam();
switch (param.role)
{
case MESSAGE_BINARY:
metadata.onBinary = new OnMessageBinaryCallable(onmessage);
break;
case MESSAGE_BINARY_STREAM:
metadata.onBinaryStream = new OnMessageBinaryStreamCallable(onmessage);
break;
case MESSAGE_TEXT:
metadata.onText = new OnMessageTextCallable(onmessage);
break;
case MESSAGE_TEXT_STREAM:
metadata.onTextStream = new OnMessageTextStreamCallable(onmessage);
break;
case MESSAGE_PONG:
metadata.onPong = new OnMessagePongCallable(onmessage);
break;
default:
StringBuilder err = new StringBuilder();
err.append("An unrecognized message type <");
err.append(param.type);
err.append(">: does not meet specified type categories of [TEXT, BINARY, DECODER, or PONG]");
throw new InvalidSignatureException(err.toString());
}
}
}
public AnnotatedEndpointMetadata<T, C> scan()
{
scanMethodAnnotations(metadata,metadata.getEndpointClass());
return metadata;
}
private void visitMethod(JsrCallable callable, Class<?> pojo, Method method, LinkedList<IJsrParamId> paramIds,
Class<? extends Annotation> methodAnnotationClass)
{
// Identify all of the parameters
for (Param param : callable.getParams())
{
if (!visitParam(callable,param,paramIds))
{
StringBuilder err = new StringBuilder();
err.append("Encountered unknown parameter type <");
err.append(param.type.getName());
err.append("> on @");
err.append(methodAnnotationClass.getSimpleName());
err.append(" annotated method: ");
err.append(ReflectUtils.toString(pojo,method));
throw new InvalidSignatureException(err.toString());
}
}
}
private boolean visitParam(JsrCallable callable, Param param, List<IJsrParamId> paramIds)
{
for (IJsrParamId paramId : paramIds)
{
LOG.debug("{}.process()",paramId);
if (paramId.process(param,callable))
{
// Successfully identified
LOG.debug("Identified: {}",param);
return true;
}
}
// Failed identification as a known parameter
return false;
}
}
|
