View Javadoc
1   /*
2    * Copyright 2014 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  import io.netty.buffer.ByteBufAllocator;
19  
20  import javax.net.ssl.SSLEngine;
21  
22  /**
23   * Implements a {@link SSLEngine} using
24   * <a href="https://www.openssl.org/docs/crypto/BIO_s_bio.html#EXAMPLE">OpenSSL BIO abstractions</a>.
25   * <p>
26   * This class will use a finalizer to ensure native resources are automatically cleaned up. To avoid finalizers
27   * and manually release the native memory see {@link ReferenceCountedOpenSslEngine}.
28   */
29  public final class OpenSslEngine extends ReferenceCountedOpenSslEngine {
30      OpenSslEngine(OpenSslContext context, ByteBufAllocator alloc, String peerHost, int peerPort,
31                    boolean jdkCompatibilityMode) {
32          super(context, alloc, peerHost, peerPort, jdkCompatibilityMode, false);
33      }
34  
35      @Override
36      @SuppressWarnings("FinalizeDeclaration")
37      protected void finalize() throws Throwable {
38          super.finalize();
39          OpenSsl.releaseIfNeeded(this);
40      }
41  }