OpenSsl (Netty API Reference (4.1.11.Final))

java.lang.Object
- io.netty.handler.ssl.OpenSsl

```
public final class OpenSsl
extends Object
```
Tells if netty-tcnative and its OpenSSL support are available.

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static Set<String>`	`availableCipherSuites()` Deprecated. use `availableOpenSslCipherSuites()`
`static Set<String>`	`availableJavaCipherSuites()` Returns all the available cipher suites (Java-style).
`static Set<String>`	`availableOpenSslCipherSuites()` Returns all the available OpenSSL cipher suites.
`static void`	`ensureAvailability()` Ensure that `netty-tcnative` and its OpenSSL support are available.
`static boolean`	`isAlpnSupported()` Returns `true` if the used version of openssl supports ALPN.
`static boolean`	`isAvailable()` Returns `true` if and only if `netty-tcnative` and its OpenSSL support are available.
`static boolean`	`isCipherSuiteAvailable(String cipherSuite)` Returns `true` if and only if the specified cipher suite is available in OpenSSL.
`static boolean`	`isOcspSupported()` Returns `true` if the used version of OpenSSL supports OCSP stapling.
`static boolean`	`supportsHostnameValidation()` Returns `true` if Hostname Validation is supported when using OpenSSL.
`static boolean`	`supportsKeyManagerFactory()` Returns `true` if `KeyManagerFactory` is supported when using OpenSSL.
`static Throwable`	`unavailabilityCause()` Returns the cause of unavailability of `netty-tcnative` and its OpenSSL support.
`static int`	`version()` Returns the version of the used available OpenSSL library or `-1` if `isAvailable()` returns `false`.
`static String`	`versionString()` Returns the version string of the used available OpenSSL library or `null` if `isAvailable()` returns `false`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - isAvailable
```
public static boolean isAvailable()
```
    Returns true if and only if netty-tcnative and its OpenSSL support are available.
  - isAlpnSupported
```
public static boolean isAlpnSupported()
```
    Returns true if the used version of openssl supports ALPN.
  - isOcspSupported
```
public static boolean isOcspSupported()
```
    Returns true if the used version of OpenSSL supports OCSP stapling.
  - version
```
public static int version()
```
    Returns the version of the used available OpenSSL library or -1 if isAvailable() returns false.
  - versionString
```
public static String versionString()
```
    Returns the version string of the used available OpenSSL library or null if isAvailable() returns false.
  - ensureAvailability
```
public static void ensureAvailability()
```
    Ensure that netty-tcnative and its OpenSSL support are available.
    
    Throws:
    
    UnsatisfiedLinkError - if unavailable
  - unavailabilityCause
```
public static Throwable unavailabilityCause()
```
    Returns the cause of unavailability of netty-tcnative and its OpenSSL support.
    
    Returns:
    
    the cause if unavailable. null if available.
  - availableCipherSuites
```
@Deprecated
public static Set<String> availableCipherSuites()
```
    Deprecated. use availableOpenSslCipherSuites()
  - availableOpenSslCipherSuites
```
public static Set<String> availableOpenSslCipherSuites()
```
    Returns all the available OpenSSL cipher suites. Please note that the returned array may include the cipher suites that are insecure or non-functional.
  - availableJavaCipherSuites
```
public static Set<String> availableJavaCipherSuites()
```
    Returns all the available cipher suites (Java-style). Please note that the returned array may include the cipher suites that are insecure or non-functional.
  - isCipherSuiteAvailable
```
public static boolean isCipherSuiteAvailable(String cipherSuite)
```
    Returns true if and only if the specified cipher suite is available in OpenSSL. Both Java-style cipher suite and OpenSSL-style cipher suite are accepted.
  - supportsKeyManagerFactory
```
public static boolean supportsKeyManagerFactory()
```
    Returns true if KeyManagerFactory is supported when using OpenSSL.
  - supportsHostnameValidation
```
public static boolean supportsHostnameValidation()
```
    Returns true if Hostname Validation is supported when using OpenSSL.

Class OpenSsl

Method Summary

Methods inherited from class java.lang.Object

Method Detail

isAvailable

isAlpnSupported

isOcspSupported

version

versionString

ensureAvailability

unavailabilityCause

availableCipherSuites

availableOpenSslCipherSuites

availableJavaCipherSuites

isCipherSuiteAvailable

supportsKeyManagerFactory

supportsHostnameValidation