Spec-Zone.ru › OpenJDK 21

Класс StartTlsRequest

java.lang.Object
javax.naming.ldap.StartTlsRequest
Все реализуемые интерфейсы:
Serializable, ExtendedRequest
public class StartTlsRequest extends Object implements ExtendedRequest
Этот класс реализует расширенный запрос LDAPv3 для StartTLS, как определено в Lightweight Directory Access Protocol (v3): Расширение для 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 — Возможно нулевое закодированное значение расширенного ответа в формате ASN.1 BER. Это сырые байты BER, включая тег и длину значения ответа. Он не включает идентификатор объекта ответа. Его значение игнорируется, потому что ожидается, что ответ Start TLS не будет содержать никакого значения ответа.
offset — Начальная позиция в berValue байтов для использования. Его значение игнорируется, потому что ожидается, что ответ Start TLS не будет содержать никакого значения ответа.
length — Количество байтов в berValue для использования. Его значение игнорируется, потому что ожидается, что ответ Start TLS не будет содержать никакого значения ответа.
Возвращает:
Объект расширенного ответа StartTLS.
Исключения:
NamingException — Если во время создания объекта расширенного ответа StartTLS возникло исключение Naming.
См. также:
  • ExtendedResponse

© 1993, 2023, 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/21/docs/api/java.naming/javax/naming/ldap/StartTlsRequest.html

Spec-Zone.ru

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