View Javadoc
1   /*
2    * Copyright 2019 The Netty Project
3    *
4    * The Netty Project licenses this file to you under the Apache License,
5    * version 2.0 (the "License"); you may not use this file except in compliance
6    * with the License. You may obtain a copy of the License at:
7    *
8    *   http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13   * License for the specific language governing permissions and limitations
14   * under the License.
15   */
16  package io.netty.handler.codec.http.websocketx;
17  
18  import io.netty.handler.codec.CorruptedFrameException;
19  import io.netty.handler.codec.DecoderException;
20  
21  /**
22   * An {@link DecoderException} which is thrown when the received {@link WebSocketFrame} data could not be decoded by
23   * an inbound handler.
24   */
25  public final class CorruptedWebSocketFrameException extends CorruptedFrameException {
26  
27      private static final long serialVersionUID = 3918055132492988338L;
28  
29      private final WebSocketCloseStatus closeStatus;
30  
31      /**
32       * Creates a new instance.
33       */
34      public CorruptedWebSocketFrameException() {
35          this(WebSocketCloseStatus.PROTOCOL_ERROR, null, null);
36      }
37  
38      /**
39       * Creates a new instance.
40       */
41      public CorruptedWebSocketFrameException(WebSocketCloseStatus status, String message, Throwable cause) {
42          super(message == null ? status.reasonText() : message, cause);
43          closeStatus = status;
44      }
45  
46      /**
47       * Creates a new instance.
48       */
49      public CorruptedWebSocketFrameException(WebSocketCloseStatus status, String message) {
50          this(status, message, null);
51      }
52  
53      /**
54       * Creates a new instance.
55       */
56      public CorruptedWebSocketFrameException(WebSocketCloseStatus status, Throwable cause) {
57          this(status, null, cause);
58      }
59  
60      public WebSocketCloseStatus closeStatus() {
61          return closeStatus;
62      }
63  
64  }