Spec-Zone.ru › OpenJDK 21

Интерфейс ExtendedRequest

Все суперинтерфейсы:
Serializable
Все известные реализующие классы:
StartTlsRequest
public interface ExtendedRequest extends Serializable
Этот интерфейс представляет запрос на расширенную операцию LDAPv3, как определено в RFC 2251.
     ExtendedRequest ::= [APPLICATION 23] SEQUENCE {
              requestName      [0] LDAPOID,
              requestValue     [1] OCTET STRING OPTIONAL }
 
Он состоит из строки идентификатора объекта и необязательного значения, закодированного в ASN.1 BER.

Методы этого класса используются поставщиком сервиса для построения битов, которые отправляются на сервер LDAP. Приложения обычно работают только с классами, реализующими этот интерфейс, предоставляя им любую информацию, необходимую для конкретного запроса на расширенную операцию. Затем приложение передает такой класс в качестве аргумента методу LdapContext.extendedOperation() для выполнения расширенной операции LDAPv3.

Например, предположим, что сервер LDAP поддерживает расширенную операцию «получение времени». Он предоставит классы GetTimeRequest и GetTimeResponse:

 public class GetTimeRequest implements ExtendedRequest {
     public GetTimeRequest() {... };
     public ExtendedResponse createExtendedResponse(String id,
         byte[] berValue, int offset, int length)
         throws NamingException {
         return new GetTimeResponse(id, berValue, offset, length);
     }
     ...
 }
 public class GetTimeResponse implements ExtendedResponse {
     long time;
     public GetTimeResponse(String id, byte[] berValue, int offset,
         int length) throws NamingException {
         time =      ... // decode berValue to get time
     }
     public java.util.Date getDate() { return new java.util.Date(time) };
     public long getTime() { return time };
     ...
 }
Программа затем будет использовать эти классы следующим образом:
 GetTimeResponse resp =
     (GetTimeResponse) ectx.extendedOperation(new GetTimeRequest());
 long time = resp.getTime();
С:
1.3
См. также:
  • ExtendedResponse
  • LdapContext.extendedOperation(javax.naming.ldap.ExtendedRequest)

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

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

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

getID

String getID()
Возвращает идентификатор объекта запроса.
Возвращает:
Непустая строка идентификатора объекта, представляющая компонент LDAP ExtendedRequest.requestName.

getEncodedValue

byte[] getEncodedValue()
Возвращает значение запроса на расширенную операцию LDAP, закодированное в ASN.1 BER. Возвращает null, если значение отсутствует. Результат — сырые байты BER, включая тег и длину значения запроса. Он не включает OID запроса. Этот метод вызывается поставщиком сервиса, чтобы получить биты для включения в расширенную операцию, которая будет отправлена на сервер LDAP.
Возвращает:
Возможный массив байтов, представляющий содержимое, закодированное в ASN.1 BER, компонента LDAP ExtendedRequest.requestValue.
Исключения:
IllegalStateException - Если закодированное значение не может быть получено, потому что запрос содержит недостаточные или неверные данные/состояние.

createExtendedResponse

ExtendedResponse createExtendedResponse(String id, byte[] berValue, int offset, int length) throws NamingException
Создает объект ответа, соответствующий этому запросу.

После того, как поставщик сервиса отправил запрос на расширенную операцию на сервер LDAP, он получит ответ от сервера. Если операция завершилась неудачно, поставщик выбросит исключение NamingException. Если операция прошла успешно, поставщик вызовет этот метод, используя полученные данные ответа. Задача этого метода — вернуть класс, реализующий интерфейс ExtendedResponse, подходящий для запроса на расширенную операцию.

Например, класс расширенного запроса Start TLS должен знать, как обработать расширенный ответ Start TLS. Он делает это, создавая класс, реализующий ExtendedResponse.

Параметры:
id - Возможно null идентификатор объекта ответа.
berValue - Возможно null значение ответа, закодированное в ASN.1 BER. Это сырые байты BER, включая тег и длину значения ответа. Он не включает OID ответа.
offset - Начальная позиция в berValue байтов, которые нужно использовать.
length - Количество байтов в berValue, которые нужно использовать.
Возвращает:
Непустой объект.
Исключения:
NamingException - если расширенный ответ не может быть создан из-за ошибки.
См. также:
  • 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/ExtendedRequest.html

Spec-Zone.ru

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