View Javadoc
1   /*
2    * Copyright 2013 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.ssl;
17  
18  
19  /**
20   * Event that is fired once the SSL handshake is complete, which may be because it was successful or there
21   * was an error.
22   */
23  public final class SslHandshakeCompletionEvent {
24  
25      public static final SslHandshakeCompletionEvent SUCCESS = new SslHandshakeCompletionEvent();
26  
27      private final Throwable cause;
28  
29      /**
30       * Creates a new event that indicates a successful handshake.
31       */
32      private SslHandshakeCompletionEvent() {
33          cause = null;
34      }
35  
36      /**
37       * Creates a new event that indicates an unsuccessful handshake.
38       * Use {@link #SUCCESS} to indicate a successful handshake.
39       */
40      public SslHandshakeCompletionEvent(Throwable cause) {
41          if (cause == null) {
42              throw new NullPointerException("cause");
43          }
44          this.cause = cause;
45      }
46  
47      /**
48       * Return {@code true} if the handshake was successful
49       */
50      public boolean isSuccess() {
51          return cause == null;
52      }
53  
54      /**
55       * Return the {@link Throwable} if {@link #isSuccess()} returns {@code false}
56       * and so the handshake failed.
57       */
58      public Throwable cause() {
59          return cause;
60      }
61  }