Интерфейс 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()`	Возвращает кодированное значение ASN.1 BER запроса на расширенную операцию LDAP.
`String`	`getID()`	Возвращает идентификатор объекта запроса.

Методы

getID

String getID()

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

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

getEncodedValue

byte[] getEncodedValue()

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