1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20 package org.apache.mina.filter.codec;
21
22 import java.net.SocketAddress;
23 import java.util.Queue;
24
25 import org.apache.mina.core.buffer.IoBuffer;
26 import org.apache.mina.core.file.FileRegion;
27 import org.apache.mina.core.filterchain.IoFilter;
28 import org.apache.mina.core.filterchain.IoFilterAdapter;
29 import org.apache.mina.core.filterchain.IoFilterChain;
30 import org.apache.mina.core.future.DefaultWriteFuture;
31 import org.apache.mina.core.future.WriteFuture;
32 import org.apache.mina.core.session.AttributeKey;
33 import org.apache.mina.core.session.IoSession;
34 import org.apache.mina.core.write.DefaultWriteRequest;
35 import org.apache.mina.core.write.NothingWrittenException;
36 import org.apache.mina.core.write.WriteRequest;
37 import org.apache.mina.core.write.WriteRequestWrapper;
38 import org.slf4j.Logger;
39 import org.slf4j.LoggerFactory;
40
41
42
43
44
45
46
47
48
49 public class ProtocolCodecFilter extends IoFilterAdapter {
50
51 private static final Logger LOGGER = LoggerFactory.getLogger(ProtocolCodecFilter.class);
52
53 private static final Class<?>[] EMPTY_PARAMS = new Class[0];
54 private static final IoBuffer EMPTY_BUFFER = IoBuffer.wrap(new byte[0]);
55
56 private final AttributeKey ENCODER = new AttributeKey(ProtocolCodecFilter.class, "encoder");
57 private final AttributeKey DECODER = new AttributeKey(ProtocolCodecFilter.class, "decoder");
58 private final AttributeKey DECODER_OUT = new AttributeKey(ProtocolCodecFilter.class, "decoderOut");
59 private final AttributeKey ENCODER_OUT = new AttributeKey(ProtocolCodecFilter.class, "encoderOut");
60
61
62 private final ProtocolCodecFactory factory;
63
64
65
66
67
68
69
70
71 public ProtocolCodecFilter(ProtocolCodecFactory factory) {
72 if (factory == null) {
73 throw new IllegalArgumentException("factory");
74 }
75
76 this.factory = factory;
77 }
78
79
80
81
82
83
84
85
86
87
88 public ProtocolCodecFilter(final ProtocolEncoder encoder,
89 final ProtocolDecoder decoder) {
90 if (encoder == null) {
91 throw new IllegalArgumentException("encoder");
92 }
93 if (decoder == null) {
94 throw new IllegalArgumentException("decoder");
95 }
96
97
98 this.factory = new ProtocolCodecFactory() {
99 public ProtocolEncoder getEncoder(IoSession session) {
100 return encoder;
101 }
102
103 public ProtocolDecoder getDecoder(IoSession session) {
104 return decoder;
105 }
106 };
107 }
108
109
110
111
112
113
114
115
116
117
118 public ProtocolCodecFilter(
119 final Class<? extends ProtocolEncoder> encoderClass,
120 final Class<? extends ProtocolDecoder> decoderClass) {
121 if (encoderClass == null) {
122 throw new IllegalArgumentException("encoderClass");
123 }
124 if (decoderClass == null) {
125 throw new IllegalArgumentException("decoderClass");
126 }
127 if (!ProtocolEncoder.class.isAssignableFrom(encoderClass)) {
128 throw new IllegalArgumentException("encoderClass: "
129 + encoderClass.getName());
130 }
131 if (!ProtocolDecoder.class.isAssignableFrom(decoderClass)) {
132 throw new IllegalArgumentException("decoderClass: "
133 + decoderClass.getName());
134 }
135 try {
136 encoderClass.getConstructor(EMPTY_PARAMS);
137 } catch (NoSuchMethodException e) {
138 throw new IllegalArgumentException(
139 "encoderClass doesn't have a public default constructor.");
140 }
141 try {
142 decoderClass.getConstructor(EMPTY_PARAMS);
143 } catch (NoSuchMethodException e) {
144 throw new IllegalArgumentException(
145 "decoderClass doesn't have a public default constructor.");
146 }
147
148 final ProtocolEncoder encoder;
149
150 try {
151 encoder = encoderClass.newInstance();
152 } catch (Exception e) {
153 throw new IllegalArgumentException(
154 "encoderClass cannot be initialized");
155 }
156
157 final ProtocolDecoder decoder;
158
159 try {
160 decoder = decoderClass.newInstance();
161 } catch (Exception e) {
162 throw new IllegalArgumentException(
163 "decoderClass cannot be initialized");
164 }
165
166
167 this.factory = new ProtocolCodecFactory() {
168 public ProtocolEncoder getEncoder(IoSession session) throws Exception {
169 return encoder;
170 }
171
172 public ProtocolDecoder getDecoder(IoSession session) throws Exception {
173 return decoder;
174 }
175 };
176 }
177
178
179
180
181
182
183
184
185 public ProtocolEncoder getEncoder(IoSession session) {
186 return (ProtocolEncoder) session.getAttribute(ENCODER);
187 }
188
189 @Override
190 public void onPreAdd(IoFilterChain parent, String name,
191 NextFilter nextFilter) throws Exception {
192 if (parent.contains(this)) {
193 throw new IllegalArgumentException(
194 "You can't add the same filter instance more than once. Create another instance and add it.");
195 }
196 }
197
198 @Override
199 public void onPostRemove(IoFilterChain parent, String name,
200 NextFilter nextFilter) throws Exception {
201
202 disposeCodec(parent.getSession());
203 }
204
205
206
207
208
209
210
211
212
213
214
215
216
217 @Override
218 public void messageReceived(NextFilter nextFilter, IoSession session,
219 Object message) throws Exception {
220 LOGGER.debug( "Processing a MESSAGE_RECEIVED for session {}", session.getId() );
221
222 if (!(message instanceof IoBuffer)) {
223 nextFilter.messageReceived(session, message);
224 return;
225 }
226
227 IoBuffer in = (IoBuffer) message;
228 ProtocolDecoder decoder = factory.getDecoder(session);
229 ProtocolDecoderOutput decoderOut = getDecoderOut(session, nextFilter);
230
231
232
233
234
235 while (in.hasRemaining()) {
236 int oldPos = in.position();
237
238 try {
239 synchronized (decoderOut) {
240
241 decoder.decode(session, in, decoderOut);
242 }
243
244
245 decoderOut.flush(nextFilter, session);
246 } catch (Throwable t) {
247 ProtocolDecoderException pde;
248 if (t instanceof ProtocolDecoderException) {
249 pde = (ProtocolDecoderException) t;
250 } else {
251 pde = new ProtocolDecoderException(t);
252 }
253
254 if (pde.getHexdump() == null) {
255
256 int curPos = in.position();
257 in.position(oldPos);
258 pde.setHexdump(in.getHexDump());
259 in.position(curPos);
260 }
261
262
263 decoderOut.flush(nextFilter, session);
264 nextFilter.exceptionCaught(session, pde);
265
266
267
268
269
270 if (!(t instanceof RecoverableProtocolDecoderException) ||
271 (in.position() == oldPos)) {
272 break;
273 }
274 }
275 }
276 }
277
278 @Override
279 public void messageSent(NextFilter nextFilter, IoSession session,
280 WriteRequest writeRequest) throws Exception {
281 if (writeRequest instanceof EncodedWriteRequest) {
282 return;
283 }
284
285 if (writeRequest instanceof MessageWriteRequest) {
286 MessageWriteRequest wrappedRequest = (MessageWriteRequest) writeRequest;
287 nextFilter.messageSent(session, wrappedRequest.getParentRequest());
288 }
289 else {
290 nextFilter.messageSent(session, writeRequest);
291 }
292 }
293
294 @Override
295 public void filterWrite(NextFilter nextFilter, IoSession session,
296 WriteRequest writeRequest) throws Exception {
297 Object message = writeRequest.getMessage();
298
299
300
301 if ((message instanceof IoBuffer) || (message instanceof FileRegion)) {
302 nextFilter.filterWrite(session, writeRequest);
303 return;
304 }
305
306
307 ProtocolEncoder encoder = factory.getEncoder(session);
308
309 ProtocolEncoderOutput encoderOut = getEncoderOut(session,
310 nextFilter, writeRequest);
311
312 if (encoder == null) {
313 throw new ProtocolEncoderException("The encoder is null for the session " + session);
314 }
315
316 if (encoderOut == null) {
317 throw new ProtocolEncoderException("The encoderOut is null for the session " + session);
318 }
319
320 try {
321
322 encoder.encode(session, message, encoderOut);
323
324
325 Queue<Object> bufferQueue = ((AbstractProtocolEncoderOutput)encoderOut).getMessageQueue();
326
327
328 while (!bufferQueue.isEmpty()) {
329 Object encodedMessage = bufferQueue.poll();
330
331
332 if (!(encodedMessage instanceof IoBuffer) || ((IoBuffer) encodedMessage).hasRemaining()) {
333 SocketAddress destination = writeRequest.getDestination();
334 WriteRequest encodedWriteRequest = new EncodedWriteRequest(encodedMessage, null, destination);
335
336 nextFilter.filterWrite(session, encodedWriteRequest);
337 }
338 }
339
340
341
342 nextFilter.filterWrite(session, new MessageWriteRequest(
343 writeRequest));
344 } catch (Throwable t) {
345 ProtocolEncoderException pee;
346
347
348 if (t instanceof ProtocolEncoderException) {
349 pee = (ProtocolEncoderException) t;
350 } else {
351 pee = new ProtocolEncoderException(t);
352 }
353
354 throw pee;
355 }
356 }
357
358
359 @Override
360 public void sessionClosed(NextFilter nextFilter, IoSession session)
361 throws Exception {
362
363 ProtocolDecoder decoder = factory.getDecoder(session);
364 ProtocolDecoderOutput decoderOut = getDecoderOut(session, nextFilter);
365
366 try {
367 decoder.finishDecode(session, decoderOut);
368 } catch (Throwable t) {
369 ProtocolDecoderException pde;
370 if (t instanceof ProtocolDecoderException) {
371 pde = (ProtocolDecoderException) t;
372 } else {
373 pde = new ProtocolDecoderException(t);
374 }
375 throw pde;
376 } finally {
377
378 disposeCodec(session);
379 decoderOut.flush(nextFilter, session);
380 }
381
382
383 nextFilter.sessionClosed(session);
384 }
385
386 private static class EncodedWriteRequest extends DefaultWriteRequest {
387 public EncodedWriteRequest(Object encodedMessage,
388 WriteFuture future, SocketAddress destination) {
389 super(encodedMessage, future, destination);
390 }
391
392 public boolean isEncoded() {
393 return true;
394 }
395 }
396
397 private static class MessageWriteRequest extends WriteRequestWrapper {
398 public MessageWriteRequest(WriteRequest writeRequest) {
399 super(writeRequest);
400 }
401
402 @Override
403 public Object getMessage() {
404 return EMPTY_BUFFER;
405 }
406
407 @Override
408 public String toString() {
409 return "MessageWriteRequest, parent : " + super.toString();
410 }
411 }
412
413 private static class ProtocolDecoderOutputImpl extends
414 AbstractProtocolDecoderOutput {
415 public ProtocolDecoderOutputImpl() {
416
417 }
418
419 public void flush(NextFilter nextFilter, IoSession session) {
420 Queue<Object> messageQueue = getMessageQueue();
421
422 while (!messageQueue.isEmpty()) {
423 nextFilter.messageReceived(session, messageQueue.poll());
424 }
425 }
426 }
427
428 private static class ProtocolEncoderOutputImpl extends
429 AbstractProtocolEncoderOutput {
430 private final IoSession session;
431
432 private final NextFilter nextFilter;
433
434 private final WriteRequest writeRequest;
435
436 public ProtocolEncoderOutputImpl(IoSession session,
437 NextFilter nextFilter, WriteRequest writeRequest) {
438 this.session = session;
439 this.nextFilter = nextFilter;
440 this.writeRequest = writeRequest;
441 }
442
443 public WriteFuture flush() {
444 Queue<Object> bufferQueue = getMessageQueue();
445 WriteFuture future = null;
446
447 while (!bufferQueue.isEmpty()) {
448 Object encodedMessage = bufferQueue.poll();
449
450
451 if (!(encodedMessage instanceof IoBuffer) || ((IoBuffer) encodedMessage).hasRemaining()) {
452 future = new DefaultWriteFuture(session);
453 nextFilter.filterWrite(session, new EncodedWriteRequest(encodedMessage,
454 future, writeRequest.getDestination()));
455 }
456 }
457
458 if (future == null) {
459 future = DefaultWriteFuture.newNotWrittenFuture(
460 session, new NothingWrittenException(writeRequest));
461 }
462
463 return future;
464 }
465 }
466
467
468
469
470
471
472 private void disposeCodec(IoSession session) {
473
474
475 disposeEncoder(session);
476 disposeDecoder(session);
477
478
479 disposeDecoderOut(session);
480 }
481
482
483
484
485
486
487 private void disposeEncoder(IoSession session) {
488 ProtocolEncoder encoder = (ProtocolEncoder) session
489 .removeAttribute(ENCODER);
490 if (encoder == null) {
491 return;
492 }
493
494 try {
495 encoder.dispose(session);
496 } catch (Throwable t) {
497 LOGGER.warn(
498 "Failed to dispose: " + encoder.getClass().getName() + " (" + encoder + ')');
499 }
500 }
501
502
503
504
505
506
507 private void disposeDecoder(IoSession session) {
508 ProtocolDecoder decoder = (ProtocolDecoder) session
509 .removeAttribute(DECODER);
510 if (decoder == null) {
511 return;
512 }
513
514 try {
515 decoder.dispose(session);
516 } catch (Throwable t) {
517 LOGGER.warn(
518 "Failed to dispose: " + decoder.getClass().getName() + " (" + decoder + ')');
519 }
520 }
521
522
523
524
525
526 private ProtocolDecoderOutput getDecoderOut(IoSession session,
527 NextFilter nextFilter) {
528 ProtocolDecoderOutput out = (ProtocolDecoderOutput) session.getAttribute(DECODER_OUT);
529
530 if (out == null) {
531
532 out = new ProtocolDecoderOutputImpl();
533 session.setAttribute(DECODER_OUT, out);
534 }
535
536 return out;
537 }
538
539 private ProtocolEncoderOutput getEncoderOut(IoSession session,
540 NextFilter nextFilter, WriteRequest writeRequest) {
541 ProtocolEncoderOutput out = (ProtocolEncoderOutput) session.getAttribute(ENCODER_OUT);
542
543 if (out == null) {
544
545 out = new ProtocolEncoderOutputImpl(session, nextFilter, writeRequest);
546 session.setAttribute(ENCODER_OUT, out);
547 }
548
549 return out;
550 }
551
552
553
554
555 private void disposeDecoderOut(IoSession session) {
556 session.removeAttribute(DECODER_OUT);
557 }
558 }