View Javadoc
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.slf4j.Logger;
25  import org.slf4j.LoggerFactory;
26  
27  /**
28   * An adapter class for {@link IoHandler}.  You can extend this
29   * class and selectively override required event handler methods only.  All
30   * methods do nothing by default.
31   *
32   * @author <a href="http://mina.apache.org">Apache MINA Project</a>
33   */
34  public class IoHandlerAdapter implements IoHandler {
35      private static final Logger LOGGER = LoggerFactory.getLogger(IoHandlerAdapter.class);
36  
37      /**
38       * {@inheritDoc}
39       */
40      public void sessionCreated(IoSession session) throws Exception {
41          // Empty handler
42      }
43  
44      /**
45       * {@inheritDoc}
46       */
47      public void sessionOpened(IoSession session) throws Exception {
48          // Empty handler
49      }
50  
51      /**
52       * {@inheritDoc}
53       */
54      public void sessionClosed(IoSession session) throws Exception {
55          // Empty handler
56      }
57  
58      /**
59       * {@inheritDoc}
60       */
61      public void sessionIdle(IoSession session, IdleStatus status) throws Exception {
62          // Empty handler
63      }
64  
65      /**
66       * {@inheritDoc}
67       */
68      public void exceptionCaught(IoSession session, Throwable cause) throws Exception {
69          if (LOGGER.isWarnEnabled()) {
70              LOGGER.warn("EXCEPTION, please implement " + getClass().getName()
71                      + ".exceptionCaught() for proper handling:", cause);
72          }
73      }
74  
75      /**
76       * {@inheritDoc}
77       */
78      public void messageReceived(IoSession session, Object message) throws Exception {
79          // Empty handler
80      }
81  
82      /**
83       * {@inheritDoc}
84       */
85      public void messageSent(IoSession session, Object message) throws Exception {
86          // Empty handler
87      }
88  
89      /**
90       * {@inheritDoc}
91       */
92      public void inputClosed(IoSession session) throws Exception {
93          session.closeNow();
94      }
95  }