Spec-Zone .ru
спецификации, руководства, описания, API
 Платформа Java™
Стандарт Эд. 7

Пакет javax.naming.ldap

Оказывает поддержку для LDAPv3 расширенные операции и средства управления.

См.: Описание

Пакет javax.naming.ldap Описание

Оказывает поддержку для LDAPv3 расширенные операции и средства управления.

Этот пакет расширяет операции каталога Именования Java и Каталога InterfaceTM (JNDI). JNDI обеспечивает именование и функциональность каталога к приложениям, записанным в языке программирования Java. Это разрабатывается, чтобы быть независимым от любого определенного именования или реализации службы каталогов. Таким образом ко множеству служб - новый, появление, и уже развернутые - можно получить доступ в распространенном способе.

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

Расширенные Операции

Этот пакет определяет интерфейсный ExtendedRequest, чтобы представить параметр расширенной работе, и интерфейсный ExtendedResponse, чтобы представить результат расширенной работы. Расширенный ответ всегда соединяется с расширенным запросом, но не обязательно наоборот. Таким образом, у Вас может быть расширенный запрос, у которого нет никакого соответствующего расширенного ответа.

Приложение обычно не имеет дело непосредственно с этими интерфейсами. Вместо этого это имеет дело с классами, которые реализуют эти интерфейсы. Приложение получает эти классы или как часть репертуара расширенных операций, стандартизированных через IETF, или от поставщиков каталога для специфичных для поставщика расширенных операций. У классов запроса должны быть конструкторы, которые принимают параметры безопасным с точки зрения типов и удобным для пользователя способом, в то время как у классов ответа должны быть методы доступа для того, чтобы получить данные ответа безопасным с точки зрения типов и удобным для пользователя способом. Внутренне, классы запроса/ответа имеют дело с кодированием и декодированием значений BER.

Например, предположите, что сервер LDAP поддерживает, "получают время" расширенная работа. Это предоставило бы классы, такие как GetTimeRequest и GetTimeResponse, так, чтобы приложения могли использовать эту функцию. Приложение использовало бы эти классы следующим образом: 

GetTimeResponse resp =
    (GetTimeResponse) ectx.extendedOperation(new GetTimeRequest());
long time = resp.getTime();

GetTimeRequest и классы GetTimeResponse могли бы быть определены следующим образом: 

public class GetTimeRequest implements ExtendedRequest {
    // User-friendly constructor 
    public GetTimeRequest() {
    };

    // Methods used by service providers
    public String getID() {
        return GETTIME_REQ_OID;
    }
    public byte[] getEncodedValue() {
        return null;  // no value needed for get time request
    }
    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;
    // called by GetTimeRequest.createExtendedResponse()
    public GetTimeResponse(String id, byte[] berValue, int offset, int length) 
        throws NamingException {
        // check validity of id
        long time =  ... // decode berValue to get time
    }

    // Type-safe and User-friendly methods
    public java.util.Date getDate() { return new java.util.Date(time); }
    public long getTime() { return time; }

    // Low level methods
    public byte[] getEncodedValue() {
        return // berValue saved;
    }
    public String getID() {
        return GETTIME_RESP_OID;
    }
}

Средства управления

Этот пакет определяет интерфейсный Control, чтобы представить управление LDAPv3. Это может быть управление, которое отправляется серверу LDAP (управление запросом) или управление, возвращенное сервером LDAP (управление ответом). В отличие от расширенных запросов и ответов, есть не обязательно любое соединение между средствами управления запросом и средствами управления ответом. Можно отправить средства управления запросом и не ожидать средства управления ответом назад, или получить средства управления ответом, не отправляя средств управления запросом.

Приложение обычно не имеет дело непосредственно с этим интерфейсом. Вместо этого это имеет дело с классами, которые реализуют этот интерфейс. Приложение получает классы управления или как часть репертуара средств управления, стандартизированных через IETF, или от поставщиков каталога для специфичных для поставщика средств управления. У классов управления запросом должны быть конструкторы, которые принимают параметры безопасным с точки зрения типов и удобным для пользователя способом, в то время как у классов управления ответом должны быть методы доступа для того, чтобы получить данные ответа безопасным с точки зрения типов и удобным для пользователя способом. Внутренне, классы управления запросом/ответом имеют дело с кодированием и декодированием значений BER.

Например, предположите, что сервер LDAP поддерживает "результаты со знаком" управление запросом, которое когда отправлено с запросом, просит сервер в цифровой форме подписывать результаты работы. Это предоставило бы класс SignedResultsControl так, чтобы приложения могли использовать эту функцию. Приложение использовало бы этот класс следующим образом: 

Control[] reqCtls = new Control[] {new SignedResultsControl(Control.CRITICAL)};
ectx.setRequestControls(reqCtls);
NamingEnumeration enum = ectx.search(...);
Класс SignedResultsControl мог бы быть определен следующим образом: 
public class SignedResultsControl implements Control {
    // User-friendly constructor 
    public SignedResultsControl(boolean criticality) {
        // assemble the components of the request control
    };

    // Methods used by service providers
    public String getID() {
        return // control's object identifier
    }
    public byte[] getEncodedValue() {
        return // ASN.1 BER encoded control value
    }
    ...
}

Когда поставщик услуг получает средства управления ответом, это использует класс ControlFactory, чтобы произвести определенные классы, которые реализуют интерфейс Control.

Сервер LDAP может отослать средства управления ответом назад с работой LDAP и также с результатами перечисления, такими как возвращенные списком или искать работу. LdapContext обеспечивает метод (getResponseControls()) для того, чтобы он получил средства управления ответом, отправленные с работой LDAP, в то время как интерфейс HasControls используется, чтобы получить средства управления ответом, связанные с результатами перечисления.

Например, предположите, что сервер LDAP отсылает "управление" ID изменения назад в ответ на успешную модификацию. Это предоставило бы класс ChangeIDControl так, чтобы приложение могло использовать эту функцию. Приложение выполнило бы обновление, и затем попыталось бы получить ID изменения. 

// Perform update
Context ctx = ectx.createSubsubcontext("cn=newobj");

// Get response controls
Control[] respCtls = ectx.getResponseControls();
if (respCtls != null) {
    // Find the one we want
    for (int i = 0; i < respCtls; i++) {
        if(respCtls[i] instanceof ChangeIDControl) {
            ChangeIDControl cctl = (ChangeIDControl)respCtls[i];
            System.out.println(cctl.getChangeID());
        }
    }
}
The vendor might supply the following ChangeIDControl and VendorXControlFactory classes. The VendorXControlFactory will be used by the service provider when the provider receives response controls from the LDAP server. 
public class ChangeIDControl implements Control {
    long id;

    // Constructor used by ControlFactory
    public ChangeIDControl(String OID, byte[] berVal) throws NamingException {
        // check validity of OID
        id = // extract change ID from berVal
    };

    // Type-safe and User-friendly method
    public long getChangeID() {
        return id;
    }

    // Low-level methods
    public String getID() {
        return CHANGEID_OID;
    }
    public byte[] getEncodedValue() {
        return // original berVal
    }
    ...
}
public class VendorXControlFactory extends ControlFactory {
    public VendorXControlFactory () {
    }

    public Control getControlInstance(Control orig) throws NamingException {
        if (isOneOfMyControls(orig.getID())) {
            ... 

            // determine which of ours it is and call its constructor
            return (new ChangeIDControl(orig.getID(), orig.getEncodedValue()));
        }
        return null;  // not one of ours
    }
}

Package Specification

The JNDI API Specification and related documents can be found in the JNDI documentation.
Since:
1.3
Java™ Platform
Standard Ed. 7

Представьте ошибку или функцию
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2011, Oracle and/or its affiliates. All rights reserved.