Класс SSLContext

java.lang.Object

javax.net.ssl.SSLContext

public class SSLContext extends Object

Экземпляры этого класса представляют реализацию протокола защищённого сокета, который выступает в качестве фабрики для безопасных сокет-фабрик или SSLEngine. Этот класс инициализируется с набором необязательных менеджеров ключей и доверия, а также источником безопасных случайных байтов.

Каждая реализация Java-платформы обязана поддерживать следующие стандартные SSLContext протокола:

TLSv1.2

Данный протокол описан в разделе SSLContext спецификации Java Security Standard Algorithm Names. Обратитесь к документации выпуска вашей реализации, чтобы узнать о поддержке других протоколов.

Since:: 1.4

Краткое описание конструкторов

SSLContext(SSLContextSpi contextSpi,
 Provider provider,
 String protocol)

Модификатор	Конструктор	Описание
`protected`	Создаёт объект SSLContext.

Краткое описание методов

Модификатор и тип	Метод	Описание
`final SSLEngine`	`createSSLEngine()`	Создаёт новый `SSLEngine` с использованием этого контекста.
`final SSLEngine`	`createSSLEngine(String peerHost, int peerPort)`	Создаёт новый `SSLEngine` с использованием этого контекста, используя консультативную информацию о peer.
`final SSLSessionContext`	`getClientSessionContext()`	Возвращает контекст сеанса клиента, который представляет набор SSL сеансов, доступных для использования во время фазы рукопожатия сокетов SSL на стороне клиента.
`static SSLContext`	`getDefault()`	Возвращает стандартный контекст SSL.
`final SSLParameters`	`getDefaultSSLParameters()`	Возвращает копию SSLParameters, указывающую стандартные настройки для этого контекста SSL.
`static SSLContext`	`getInstance(String protocol)`	Возвращает объект `SSLContext`, который реализует указанный протокол защищённого сокета.
`static SSLContext`	`getInstance(String protocol, String provider)`	Возвращает объект `SSLContext`, который реализует указанный протокол защищённого сокета.
`static SSLContext`	`getInstance(String protocol, Provider provider)`	Возвращает объект `SSLContext`, который реализует указанный протокол защищённого сокета.
`final String`	`getProtocol()`	Возвращает имя протокола этого объекта `SSLContext`.
`final Provider`	`getProvider()`	Возвращает провайдера этого объекта `SSLContext`.
`final SSLSessionContext`	`getServerSessionContext()`	Возвращает контекст сеанса сервера, который представляет набор SSL сеансов, доступных для использования во время фазы рукопожатия сокетов SSL на стороне сервера.
`final SSLServerSocketFactory`	`getServerSocketFactory()`	Возвращает объект `ServerSocketFactory` для этого контекста.
`final SSLSocketFactory`	`getSocketFactory()`	Возвращает объект `SocketFactory` для этого контекста.
`final SSLParameters`	`getSupportedSSLParameters()`	Возвращает копию SSLParameters, указывающую поддерживаемые настройки для этого контекста SSL.
`final void`	`init(KeyManager[] km, TrustManager[] tm, SecureRandom random)`	Инициализирует этот контекст.
`static void`	`setDefault(SSLContext context)`	Устанавливает стандартный контекст SSL.

Методы, объявленные в классе java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Подробное описание конструкторов

SSLContext

protected SSLContext(SSLContextSpi contextSpi, Provider provider, String protocol)

Создаёт объект SSLContext.

Параметры:: contextSpi - делегат; provider - поставщик; protocol - протокол

Подробное описание методов

getDefault

public static SSLContext getDefault() throws NoSuchAlgorithmException

Возвращает по умолчанию SSL-контекст.

Если контекст по умолчанию был задан с помощью метода SSLContext.setDefault(), он возвращается. В противном случае, первый вызов этого метода запускает вызов SSLContext.getInstance("Default"). При успешном выполнении этот объект становится контекстом SSL по умолчанию и возвращается.

Контекст по умолчанию немедленно готов к использованию и не требует инициализации SSLContext.getInstance("Default").

Возвращает:: контекст SSL по умолчанию
Исключения:: NoSuchAlgorithmException - если вызов SSLContext.getInstance() завершается неудачей
С:: 1.6

setDefault

public static void setDefault(SSLContext context)

Устанавливает контекст SSL по умолчанию. Он будет возвращаться последующими вызовами getDefault(). Контекст по умолчанию должен быть немедленно готов к использованию и не требует инициализации getDefault().

Параметры:: context - SSLContext
Исключения:: NullPointerException - если контекст null
С:: 1.6

getInstance

public static SSLContext getInstance(String protocol) throws NoSuchAlgorithmException

Возвращает объект SSLContext, реализующий указанный протокол защищённого сокета.

Этот метод обходит список зарегистрированных поставщиков безопасности, начиная с предпочтительного. Возвращается новый объект SSLContext, инкапсулирующий реализацию SSLContextSpi из первого поставщика, который поддерживает указанный протокол.

Обратите внимание, что список зарегистрированных поставщиков можно получить через метод Security.getProviders().

Замечание реализации:

Реализация JDK Reference Implementation дополнительно использует свойство jdk.security.provider.preferred Security для определения предпочтительного порядка поставщиков для указанного алгоритма. Это может отличаться от порядка поставщиков, возвращаемых методом Security.getProviders().

Параметры:

protocol - стандартное имя запрошенного протокола. См. раздел SSLContext в Спецификации Java Security Standard Algorithm Names для получения информации о стандартных именах протоколов.

Возвращает:

новый объект SSLContext

Исключения:

NoSuchAlgorithmException - если ни один поставщик не поддерживает реализацию Provider для указанного протокола

NullPointerException - если protocol является null

См. также:

getInstance

public static SSLContext getInstance(String protocol, String provider) throws NoSuchAlgorithmException, NoSuchProviderException

Возвращает объект SSLContext, реализующий указанный протокол защищённого сокета.

Возвращается новый объект SSLContext, инкапсулирующий реализацию SSLContextSpi от указанного поставщика. Указанный поставщик должен быть зарегистрирован в списке поставщиков безопасности.

Обратите внимание, что список зарегистрированных поставщиков можно получить через метод Security.getProviders().

Параметры:

provider - имя поставщика.

Возвращает:

новый объект SSLContext

Исключения:

IllegalArgumentException - если имя поставщика null или пустое

NoSuchAlgorithmException - если реализация SSLContextSpi для указанного протокола недоступна от указанного поставщика

NoSuchProviderException - если указанный поставщик не зарегистрирован в списке поставщиков безопасности

NullPointerException - если protocol является null

См. также:

getInstance

public static SSLContext getInstance(String protocol, Provider provider) throws NoSuchAlgorithmException

Возвращает объект SSLContext, реализующий указанный протокол защищённого сокета.

Возвращается новый объект SSLContext, инкапсулирующий реализацию SSLContextSpi от указанного объекта поставщика. Обратите внимание, что указанный объект поставщика не обязательно должен быть зарегистрирован в списке поставщиков.

Параметры:

provider - экземпляр поставщика.

Возвращает:

новый объект SSLContext

Исключения:

IllegalArgumentException - если поставщик null

NoSuchAlgorithmException - если реализация SSLContextSpi для указанного протокола недоступна от указанного объекта Provider

NullPointerException - если protocol является null

См. также:

getProtocol

public final String getProtocol()

Возвращает имя протокола этого объекта SSLContext.

Это то же имя, что и в одном из вызовов getInstance, создавших этот объект SSLContext.

Возвращает:: имя протокола этого объекта SSLContext.

getProvider

public final Provider getProvider()

Возвращает поставщика этого объекта SSLContext.

Возвращает:: поставщик этого объекта SSLContext

init

public final void init(KeyManager[] km, TrustManager[] tm, SecureRandom random) throws KeyManagementException

Инициализирует этот контекст. Любой из первых двух параметров может быть null, в этом случае будут просмотрены установленные поставщики безопасности для поиска наиболее приоритетной реализации соответствующего фабричного класса. Аналогично, параметр secure random может быть null, в этом случае будет использоваться реализация по умолчанию.

Используется только первый экземпляр определенного типа менеджера ключей и/или доверия в массиве. (Например, будет использован только первый javax.net.ssl.X509KeyManager в массиве.)

Параметры:: km - источники ключей аутентификации или null; tm - источники решений доверия к проверке подлинности коллег или null; random - источник случайности для этого генератора или null
Исключения:: KeyManagementException - если операция завершается неудачей

getSocketFactory

public final SSLSocketFactory getSocketFactory()

Возвращает объект SocketFactory для этого контекста.

Возвращает:: объект SocketFactory
Исключения:: UnsupportedOperationException - если базовый поставщик не реализует операцию.; IllegalStateException - если SSLContextImpl требует инициализации, и init() не был вызван

getServerSocketFactory

public final SSLServerSocketFactory getServerSocketFactory()

Возвращает объект ServerSocketFactory для этого контекста.

Возвращает:: объект ServerSocketFactory
Исключения:: UnsupportedOperationException - если базовый поставщик не реализует операцию.; IllegalStateException - если SSLContextImpl требует инициализации, и init() не был вызван

createSSLEngine

public final SSLEngine createSSLEngine()

Создаёт новый SSLEngine с использованием данного контекста.

Приложения, использующие этот фабричный метод, не предоставляют подсказок для стратегии повторного использования внутренней сессии. Если подсказки желательны, следует использовать createSSLEngine(String, int) вместо этого.

Некоторые наборы шифров (например, Kerberos) требуют информации о удалённом имени хоста, в этом случае этот фабричный метод не следует использовать.

Примечание для реализации:: Зависит от поставщика, использует ли возвращаемый SSLEngine режим клиента или сервера по умолчанию для соединения (D)TLS. Реализация поставщика JDK SunJSSE по умолчанию использует режим сервера. Однако рекомендуется всегда явно устанавливать требуемый режим, вызвав SSLEngine.setUseClientMode() перед вызовом других методов SSLEngine.
Возвращает:: объект SSLEngine
Исключения:: UnsupportedOperationException - если базовый поставщик не реализует операцию.; IllegalStateException - если SSLContextImpl требует инициализации, и init() не был вызван
С:: 1.5

createSSLEngine

public final SSLEngine createSSLEngine(String peerHost, int peerPort)

Создаёт новый SSLEngine с использованием данного контекста с использованием консультативной информации о узле.

Приложения, использующие этот фабричный метод, предоставляют подсказки для внутренней стратегии повторного использования сессий.

Некоторые наборы шифров (например, Kerberos) требуют информации о удалённом имени хоста, в этом случае peerHost необходимо указать.

Примечание для реализации:: Зависит от поставщика, использует ли возвращаемый SSLEngine режим клиента или сервера по умолчанию для соединения (D)TLS. Реализация поставщика JDK SunJSSE по умолчанию использует режим сервера. Однако рекомендуется всегда явно устанавливать требуемый режим, вызвав SSLEngine.setUseClientMode() перед вызовом других методов SSLEngine.
Параметры:: peerHost - неофициальное имя хоста; peerPort - неофициальное имя порта
Возвращает:: новый объект SSLEngine
Исключения:: UnsupportedOperationException - если базовый поставщик не реализует операцию.; IllegalStateException - если SSLContextImpl требует инициализации, и init() не был вызван
С:: 1.5

getServerSessionContext

public final SSLSessionContext getServerSessionContext()

Возвращает контекст сессии сервера, который представляет набор SSL-сессий, доступных для использования во время фазы рукопожатия сокетов SSL на стороне сервера.

В некоторых средах этот контекст может быть недоступен, в этом случае этот метод возвращает null. Например, когда базовый поставщик SSL не предоставляет реализацию интерфейса SSLSessionContext, этот метод возвращает null. В противном случае возвращается контекст сессии, не равный null.

Возвращает:: контекст сессии сервера, связанный с этим SSL-контекстом

getClientSessionContext

public final SSLSessionContext getClientSessionContext()

Возвращает контекст сессии клиента, который представляет набор SSL-сессий, доступных для использования во время фазы рукопожатия сокетов SSL на стороне клиента.

Возвращает:: контекст сессии клиента, связанный с этим SSL-контекстом

getDefaultSSLParameters

public final SSLParameters getDefaultSSLParameters()

Возвращает копию SSLParameters, указывающую параметры по умолчанию для этого SSL-контекста.

Массивы ciphersuites и protocols всегда будут иметь ненулевые значения.

Возвращает:: копию объекта SSLParameters с параметрами по умолчанию
Исключения:: UnsupportedOperationException - если параметры SSL по умолчанию получить не удалось.
С:: 1.6

getSupportedSSLParameters

public final SSLParameters getSupportedSSLParameters()

Возвращает копию SSLParameters, указывающую поддерживаемые параметры для этого SSL-контекста.

Массивы ciphersuites и protocols всегда будут иметь ненулевые значения.

Возвращает:: копию объекта SSLParameters с поддерживаемыми параметрами
Исключения:: UnsupportedOperationException - если поддерживаемые параметры SSL получить не удалось.
С:: 1.6

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://download.java.net/java/early_access/jdk24/docs/api/java.base/javax/net/ssl/SSLContext.html