1 /*
2 * Copyright 2017 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.netty5.handler.ssl;
17
18
19 /**
20 * Event that is fired once we did a selection of a {@link SslContext} based on the {@code SNI hostname},
21 * which may be because it was successful or there was an error.
22 */
23 public final class SniCompletionEvent extends SslCompletionEvent {
24 private final String hostname;
25
26 /**
27 * Creates a new event that indicates a successful processing of the SNI extension.
28 *
29 * @param hostname the hostname that was used for SNI.
30 */
31 public SniCompletionEvent(String hostname) {
32 super(null);
33 this.hostname = hostname;
34 }
35
36 /**
37 * Creates a new event that indicates a failed processing of the SNI extension.
38 *
39 * @param hostname the hostname that was used for SNI.
40 * @param cause the cause of the failure.
41 */
42 public SniCompletionEvent(String hostname, Throwable cause) {
43 super(null, cause);
44 this.hostname = hostname;
45 }
46
47 /**
48 * Creates a new event that indicates a failed processing of the SNI extension.
49 *
50 * @param cause the cause of the failure.
51 */
52 public SniCompletionEvent(Throwable cause) {
53 this(null, cause);
54 }
55
56 /**
57 * Returns the SNI hostname send by the client if we were able to parse it, {@code null} otherwise.
58 */
59 public String hostname() {
60 return hostname;
61 }
62
63 @Override
64 public String toString() {
65 final Throwable cause = cause();
66 return cause == null ? getClass().getSimpleName() + "(SUCCESS='" + hostname() + "'\")":
67 getClass().getSimpleName() + '(' + cause + ')';
68 }
69 }