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      @Override
41      public void sessionCreated(IoSession session) throws Exception {
42          // Empty handler
43      }
44  
45      /**
46       * {@inheritDoc}
47       */
48      @Override
49      public void sessionOpened(IoSession session) throws Exception {
50          // Empty handler
51      }
52  
53      /**
54       * {@inheritDoc}
55       */
56      @Override
57      public void sessionClosed(IoSession session) throws Exception {
58          // Empty handler
59      }
60  
61      /**
62       * {@inheritDoc}
63       */
64      @Override
65      public void sessionIdle(IoSession session, IdleStatus status) throws Exception {
66          // Empty handler
67      }
68  
69      /**
70       * {@inheritDoc}
71       */
72      @Override
73      public void exceptionCaught(IoSession session, Throwable cause) throws Exception {
74          if (LOGGER.isWarnEnabled()) {
75              LOGGER.warn("EXCEPTION, please implement " + getClass().getName()
76                      + ".exceptionCaught() for proper handling:", cause);
77          }
78      }
79  
80      /**
81       * {@inheritDoc}
82       */
83      @Override
84      public void messageReceived(IoSession session, Object message) throws Exception {
85          // Empty handler
86      }
87  
88      /**
89       * {@inheritDoc}
90       */
91      @Override
92      public void messageSent(IoSession session, Object message) throws Exception {
93          // Empty handler
94      }
95  
96      /**
97       * {@inheritDoc}
98       */
99      @Override
100     public void inputClosed(IoSession session) throws Exception {
101         session.closeNow();
102     }
103 }