View Javadoc

1   /*
2    * ====================================================================
3    * Licensed to the Apache Software Foundation (ASF) under one
4    * or more contributor license agreements.  See the NOTICE file
5    * distributed with this work for additional information
6    * regarding copyright ownership.  The ASF licenses this file
7    * to you under the Apache License, Version 2.0 (the
8    * "License"); you may not use this file except in compliance
9    * with the License.  You may obtain a copy of the License at
10   *
11   *   http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing,
14   * software distributed under the License is distributed on an
15   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16   * KIND, either express or implied.  See the License for the
17   * specific language governing permissions and limitations
18   * under the License.
19   * ====================================================================
20   *
21   * This software consists of voluntary contributions made by many
22   * individuals on behalf of the Apache Software Foundation.  For more
23   * information on the Apache Software Foundation, please see
24   * <http://www.apache.org/>.
25   *
26   */
27  
28  package org.apache.http.nio.reactor.ssl;
29  
30  import javax.net.ssl.SSLEngine;
31  import javax.net.ssl.SSLException;
32  import javax.net.ssl.SSLSession;
33  
34  import org.apache.http.nio.reactor.IOSession;
35  
36  /**
37   * Callback interface that can be used to customize various aspects of
38   * the TLS/SSl protocol.
39   *
40   * @since 4.2
41   */
42  public interface SSLSetupHandler {
43  
44      /**
45       * Triggered when the SSL connection is being initialized. Custom handlers
46       * can use this callback to customize properties of the {@link SSLEngine}
47       * used to establish the SSL session.
48       *
49       * @param sslengine the SSL engine.
50       * @throws SSLException if case of SSL protocol error.
51       */
52      void initalize(SSLEngine sslengine) throws SSLException;
53  
54      /**
55       * Triggered when the SSL connection has been established and initial SSL
56       * handshake has been successfully completed. Custom handlers can use
57       * this callback to verify properties of the {@link SSLSession}.
58       * For instance this would be the right place to enforce SSL cipher
59       * strength, validate certificate chain and do hostname checks.
60       *
61       * @param iosession the underlying IOSession for the SSL connection.
62       * @param sslsession newly created SSL session.
63       * @throws SSLException if case of SSL protocol error.
64       */
65      void verify(IOSession iosession, SSLSession sslsession) throws SSLException;
66  
67  }