1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 *
19 */
20 package org.apache.mina.core.service;
21
22 import org.apache.mina.core.session.IdleStatus;
23 import org.apache.mina.core.session.IoSession;
24 import org.apache.mina.filter.FilterEvent;
25 import org.slf4j.Logger;
26 import org.slf4j.LoggerFactory;
27
28 /**
29 * An adapter class for {@link IoHandler}. You can extend this
30 * class and selectively override required event handler methods only. All
31 * methods do nothing by default.
32 *
33 * @author <a href="http://mina.apache.org">Apache MINA Project</a>
34 */
35 public class IoHandlerAdapter implements IoHandler {
36 private static final Logger LOGGER = LoggerFactory.getLogger(IoHandlerAdapter.class);
37
38 /**
39 * {@inheritDoc}
40 */
41 @Override
42 public void sessionCreated(IoSession session) throws Exception {
43 // Empty handler
44 }
45
46 /**
47 * {@inheritDoc}
48 */
49 @Override
50 public void sessionOpened(IoSession session) throws Exception {
51 // Empty handler
52 }
53
54 /**
55 * {@inheritDoc}
56 */
57 @Override
58 public void sessionClosed(IoSession session) throws Exception {
59 // Empty handler
60 }
61
62 /**
63 * {@inheritDoc}
64 */
65 @Override
66 public void sessionIdle(IoSession session, IdleStatus status) throws Exception {
67 // Empty handler
68 }
69
70 /**
71 * {@inheritDoc}
72 */
73 @Override
74 public void exceptionCaught(IoSession session, Throwable cause) throws Exception {
75 if (LOGGER.isWarnEnabled()) {
76 LOGGER.warn("EXCEPTION, please implement " + getClass().getName()
77 + ".exceptionCaught() for proper handling:", cause);
78 }
79 }
80
81 /**
82 * {@inheritDoc}
83 */
84 @Override
85 public void messageReceived(IoSession session, Object message) throws Exception {
86 // Empty handler
87 }
88
89 /**
90 * {@inheritDoc}
91 */
92 @Override
93 public void messageSent(IoSession session, Object message) throws Exception {
94 // Empty handler
95 }
96
97 /**
98 * {@inheritDoc}
99 */
100 @Override
101 public void inputClosed(IoSession session) throws Exception {
102 session.closeNow();
103 }
104
105 /**
106 * {@inheritDoc}
107 */
108 @Override
109 public void event(IoSession session, FilterEvent event) throws Exception {
110 // Empty handler
111 }
112 }