View Javadoc
1   /*
2    * Copyright 2020 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    *   https://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.http.DefaultHttpResponse;
19  import io.netty.handler.codec.http.FullHttpResponse;
20  import io.netty.handler.codec.http.HttpResponse;
21  import io.netty.util.ReferenceCounted;
22  
23  /**
24   * Client exception during handshaking process.
25   *
26   *  <p><b>IMPORTANT</b>: This exception does not contain any {@link ReferenceCounted} fields
27   *  e.g. {@link FullHttpResponse}, so no special treatment is needed.
28   */
29  public final class WebSocketClientHandshakeException extends WebSocketHandshakeException {
30  
31      private static final long serialVersionUID = 1L;
32  
33      private final HttpResponse response;
34  
35      public WebSocketClientHandshakeException(String message) {
36          this(message, null);
37      }
38  
39      public WebSocketClientHandshakeException(String message, HttpResponse httpResponse) {
40          super(message);
41          if (httpResponse != null) {
42              response = new DefaultHttpResponse(httpResponse.protocolVersion(),
43                                                 httpResponse.status(), httpResponse.headers());
44          } else {
45              response = null;
46          }
47      }
48  
49      /**
50       * Returns a {@link HttpResponse response} if exception occurs during response validation otherwise {@code null}.
51       */
52      public HttpResponse response() {
53          return response;
54      }
55  }