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.filter.codec;
    21
    22  /**
    23   * A special exception that tells the {@link ProtocolDecoder} can keep
    24   * decoding even after this exception is thrown.
    25   * <p>
    26   * Once {@link ProtocolCodecFilter} catches any other type of exception
    27   * than {@link RecoverableProtocolDecoderException}, it stops calling
    28   * the {@link ProtocolDecoder#decode(org.apache.mina.core.session.IoSession,
    29   *        org.apache.mina.core.buffer.IoBuffer, ProtocolDecoderOutput)}
    30   * immediately and fires an <tt>exceptionCaught</tt> event.
    31   * <p>
    32   * On the other hand, if {@link RecoverableProtocolDecoderException} is thrown,
    33   * it doesn't stop immediately but keeps calling the {@link ProtocolDecoder}
    34   * as long as the position of the read buffer changes.
    35   * <p>
    36   * {@link RecoverableProtocolDecoderException} is useful for a robust
    37   * {@link ProtocolDecoder} that can continue decoding even after any
    38   * protocol violation.
    39   *
    40   * @author <a href="http://mina.apache.org">Apache MINA Project</a>
    41   */
    42  public class RecoverableProtocolDecoderException extends ProtocolDecoderException {
    43
    44      private static final long serialVersionUID = -8172624045024880678L;
    45
    46      public RecoverableProtocolDecoderException() {
    47          // Do nothing
    48      }
    49
    50      public RecoverableProtocolDecoderException(String message) {
    51          super(message);
    52      }
    53
    54      public RecoverableProtocolDecoderException(Throwable cause) {
    55          super(cause);
    56      }
    57
    58      public RecoverableProtocolDecoderException(String message, Throwable cause) {
    59          super(message, cause);
    60      }
    61
    62  }