Класс StartTlsRequest

java.lang.Object

javax.naming.ldap.StartTlsRequest

Все реализуемые интерфейсы:: Serializable, ExtendedRequest

public class StartTlsRequest extends Object implements ExtendedRequest

Этот класс реализует расширенный запрос LDAPv3 для StartTLS, определённый в документе Протокол доступа к каталогам облегчённой версии (v3): расширение для защиты транспортного уровня. Идентификатор объекта для StartTLS — 1.3.6.1.4.1.1466.20037; значение расширенного запроса не определено.

StartTlsRequest/StartTlsResponse используются для установления TLS-соединения через существующее LDAP-соединение, связанное с контекстом JNDI, для которого вызывается extendedOperation(). Как правило, программа JNDI использует эти классы следующим образом.

 import javax.naming.ldap.*;

 // Open an LDAP association
 LdapContext ctx = new InitialLdapContext();

 // Perform a StartTLS extended operation
 StartTlsResponse tls =
     (StartTlsResponse) ctx.extendedOperation(new StartTlsRequest());

 // Open a TLS connection (over the existing LDAP association) and get details
 // of the negotiated TLS session: cipher suite, peer certificate, etc.
 SSLSession session = tls.negotiate();

 // ... use ctx to perform protected LDAP operations

 // Close the TLS connection (revert back to the underlying LDAP association)
 tls.close();

 // ... use ctx to perform unprotected LDAP operations

 // Close the LDAP association
 ctx.close;

Начиная с версии:

1.4

См. также:

Краткое описание полей

Модификатор и тип	Поле	Описание
`static final String`	`OID`	Назначенный идентификатор объекта расширенного запроса StartTLS: 1.3.6.1.4.1.1466.20037.

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

Конструктор	Описание
`StartTlsRequest()`	Создаёт расширенный запрос StartTLS.

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

Модификатор и тип	Метод	Описание
`ExtendedResponse`	`createExtendedResponse(String id, byte[] berValue, int offset, int length)`	Создаёт объект расширенного ответа, соответствующий расширенному запросу LDAP StartTLS.
`byte[]`	`getEncodedValue()`	Возвращает значение запроса StartTLS, закодированное в формате ASN.1 BER.
`String`	`getID()`	Возвращает строку идентификатора объекта запроса StartTLS.

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

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

Подробное описание полей

OID

public static final String OID

Назначенный идентификатор объекта расширенного запроса StartTLS: 1.3.6.1.4.1.1466.20037.

См. также:

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

StartTlsRequest

public StartTlsRequest()

Создаёт расширенный запрос StartTLS.

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

getID

public String getID()

Возвращает строку идентификатора объекта запроса StartTLS.

Определено в:: getID в интерфейсе ExtendedRequest
Возвращает:: Строка идентификатора объекта «1.3.6.1.4.1.1466.20037».

getEncodedValue

public byte[] getEncodedValue()

Возвращает значение запроса StartTLS, закодированное в формате ASN.1 BER. Поскольку значение запроса не определено, всегда возвращается null.

Определено в:: getEncodedValue в интерфейсе ExtendedRequest
Возвращает:: Значение null.

createExtendedResponse

public ExtendedResponse createExtendedResponse(String id, byte[] berValue, int offset, int length) throws NamingException

Создаёт объект расширенного ответа, соответствующий расширенному запросу LDAP StartTLS.

Результатом должен быть конкретный подкласс StartTlsResponse с открытым конструктором без аргументов.

Этот метод находит класс реализации, выполняя поиск файлов конфигурации с именем:

META-INF/services/javax.naming.ldap.StartTlsResponse

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

Каждый файл конфигурации должен содержать список полных имён классов, по одному в строке. Пробелы и символы табуляции вокруг каждого имени, а также пустые строки игнорируются. Символом комментария является '#' (0x23); в каждой строке все символы после первого символа комментария игнорируются. Файл должен быть закодирован в UTF-8.

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

Если таким способом найти класс не удастся, метод воспользуется способом поиска реализации, зависящим от конкретной реализации. Если реализация не будет найдена, будет выброшено исключение NamingException.

Определено в:

createExtendedResponse в интерфейсе ExtendedRequest

Параметры:

id — идентификатор объекта расширенного ответа. Его значение должно быть «1.3.6.1.4.1.1466.20037» или null. Оба значения равнозначны.

berValue — возможно, равное null значение расширенного ответа, закодированное в формате ASN.1 BER. Это необработанные байты BER, включая тег и длину значения ответа. Идентификатор объекта ответа в них не включён. Значение игнорируется, поскольку ответ StartTLS не должен содержать значения ответа.

offset — начальная позиция в berValue байтов, которые следует использовать. Значение игнорируется, поскольку ответ StartTLS не должен содержать значения ответа.

length — количество байтов в berValue, которые следует использовать. Значение игнорируется, поскольку ответ StartTLS не должен содержать значения ответа.

Возвращает:

Объект расширенного ответа StartTLS.

Выбрасывает:

NamingException — если при создании объекта расширенного ответа StartTLS возникло исключение именования.

См. также:

© 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://docs.oracle.com/en/java/javase/25/docs/api/java.naming/javax/naming/ldap/StartTlsRequest.html