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.hc.core5.reactor.ssl;
29  
30  import javax.net.ssl.SSLContext;
31  
32  import org.apache.hc.core5.net.NamedEndpoint;
33  
34  /**
35   * Represents a TLS capable session layer.
36   *
37   * @since 5.0
38   */
39  public interface TransportSecurityLayer {
40  
41      /**
42       * Starts TLS session over an existing network connection with the given SSL context.
43       * {@link NamedEndpoint} details are applicable for client side connections and
44       * are used for host name verification, when supported by the SSL engine.
45       *
46       * @param sslContext SSL context to be used for this session.
47       * @param endpoint optional endpoint details for outgoing client side connections.
48       * @param sslBufferMode SSL buffer management mode.
49       * @param initializer SSL session initialization callback.
50       * @param verifier SSL session verification callback.
51       */
52      void startTls(
53              SSLContext sslContext,
54              NamedEndpoint endpoint,
55              SSLBufferMode sslBufferMode,
56              SSLSessionInitializer initializer,
57              SSLSessionVerifier verifier) throws UnsupportedOperationException;
58  
59      /**
60       * Returns details of a fully established TLS session.
61       *
62       * @return TLS session details.
63       */
64      TlsDetails getTlsDetails();
65  
66  }