Spec-Zone.ru › OpenJDK 24

Класс StartTlsRequest

java.lang.Object
javax.naming.ldap.StartTlsRequest
Все реализуемые интерфейсы:
Serializable, ExtendedRequest
public class StartTlsRequest extends Object implements ExtendedRequest
Этот класс реализует расширенный запрос LDAPv3 StartTLS, определённый в Lightweight Directory Access Protocol (v3): Extension for Transport Layer Security. Идентификатор объекта для 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
См. также:
  • StartTlsResponse
  • Сериализованная форма

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

Модификатор и тип Поле Описание
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.

Методы, объявленные в классе java.lang.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, включая тег и длину значения ответа. Оно не включает идентификатор объекта ответа. Его значение игнорируется, так как ожидается, что ответ Start TLS не будет содержать никакого значения ответа.
offset — Начальная позиция в berValue байтов для использования. Его значение игнорируется, так как ожидается, что ответ Start TLS не будет содержать никакого значения ответа.
length — Количество байтов в berValue для использования. Его значение игнорируется, так как ожидается, что ответ Start TLS не будет содержать никакого значения ответа.
Возвращает:
Объект расширенного ответа StartTLS.
Выбрасывает:
NamingException — Если при создании объекта расширенного ответа StartTLS произошло исключение имени.
См. также:
  • ExtendedResponse

© 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.naming/javax/naming/ldap/StartTlsRequest.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API