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  /**
29   * An abstract 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 The Apache MINA Project (dev@mina.apache.org)
34   */
35  public class IoHandlerAdapter implements IoHandler {
36      private static final Logger LOGGER = LoggerFactory.getLogger(IoHandlerAdapter.class);
37  
38      public void sessionCreated(IoSession session) throws Exception {
39          // Empty handler
40      }
41  
42      public void sessionOpened(IoSession session) throws Exception {
43          // Empty handler
44      }
45  
46      public void sessionClosed(IoSession session) throws Exception {
47          // Empty handler
48      }
49  
50      public void sessionIdle(IoSession session, IdleStatus status)
51              throws Exception {
52          // Empty handler
53      }
54  
55      public void exceptionCaught(IoSession session, Throwable cause)
56              throws Exception {
57          if (LOGGER.isWarnEnabled()) {
58              LOGGER.warn("EXCEPTION, please implement "
59                      + getClass().getName()
60                      + ".exceptionCaught() for proper handling:", cause);
61          }
62      }
63  
64      public void messageReceived(IoSession session, Object message)
65              throws Exception {
66          // Empty handler
67      }
68  
69      public void messageSent(IoSession session, Object message) throws Exception {
70          // Empty handler
71      }
72  }