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.impl.nio.reactor;
29  
30  import java.net.SocketAddress;
31  
32  import javax.net.ssl.SSLEngine;
33  import javax.net.ssl.SSLException;
34  import javax.net.ssl.SSLSession;
35  
36  import org.apache.http.params.HttpParams;
37  
38  /**
39   * Callback interface that can be used to customize various aspects of
40   * the TLS/SSl protocol.
41   *
42   * @since 4.0
43   *
44   * @deprecated (4.2) Use {@link SSLSetupHandler}
45   */
46  @Deprecated
47  public interface SSLIOSessionHandler {
48  
49      /**
50       * Triggered when the SSL connection is being initialized. Custom handlers
51       * can use this callback to customize properties of the {@link SSLEngine}
52       * used to establish the SSL session.
53       *
54       * @param sslengine the SSL engine.
55       * @param params HTTP parameters.
56       * @throws SSLException if case of SSL protocol error.
57       */
58      void initalize(SSLEngine sslengine, HttpParams params)
59          throws SSLException;
60  
61      /**
62       * Triggered when the SSL connection has been established and initial SSL
63       * handshake has been successfully completed. Custom handlers can use
64       * this callback to verify properties of the {@link SSLSession}.
65       * For instance this would be the right place to enforce SSL cipher
66       * strength, validate certificate chain and do hostname checks.
67       *
68       * @param remoteAddress the remote address of the connection.
69       * @param session newly created SSL session.
70       * @throws SSLException if case of SSL protocol error.
71       */
72      void verify(SocketAddress remoteAddress, SSLSession session)
73          throws SSLException;
74  
75  }