Module java.naming
Package javax.naming.ldap

Interface Control

所有超级接口:
Serializable
所有已知实现类:
BasicControl, ManageReferralControl, PagedResultsControl, PagedResultsResponseControl, SortControl, SortResponseControl
public interface Control extends Serializable
此接口表示在RFC 2251中定义的LDAPv3控件。

LDAPv3协议使用控件来发送和接收附加数据以影响预定义操作的行为。控件可以与任何LDAP操作一起发送到服务器。这些被称为请求控件。例如，可以在LDAP搜索操作中发送“排序”控件以请求以特定顺序返回结果。服务器还可以在响应中返回请求的和未请求的控件。这些控件被称为响应控件。例如，LDAP服务器可能定义一个特殊控件以返回更改通知。

此接口用于表示请求和响应控件。

自:
1.3
参见:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final boolean
    CRITICAL
    表示一个关键控件。
    static final boolean
    NONCRITICAL
    表示一个非关键控件。

  • Method Summary

    Modifier and Type
    Method
    Description
    byte[]
    getEncodedValue()
    检索LDAP控件的ASN.1 BER编码值。
    String
    getID()
    检索为LDAP控件分配的对象标识符。
    boolean
    isCritical()
    确定LDAP控件的关键性。

  • Field Details

    • CRITICAL

      static final boolean CRITICAL
      表示一个关键控件。此常量的值为true。
      参见:

    • NONCRITICAL

      static final boolean NONCRITICAL
      表示一个非关键控件。此常量的值为false。
      参见:

  • Method Details

    • getID

      String getID()
      检索为LDAP控件分配的对象标识符。
      返回:
      非空对象标识符字符串。

    • isCritical

      boolean isCritical()
      确定LDAP控件的关键性。关键控件不得被服务器忽略。换句话说，如果服务器收到一个不支持的关键控件，无论该控件对操作是否有意义，操作都不会执行，并将抛出OperationNotSupportedException。
      返回:
      如果此控件是关键的，则为true；否则为false。

    • getEncodedValue

      byte[] getEncodedValue()
      检索LDAP控件的ASN.1 BER编码值。结果是原始的BER字节，包括控件值的标记和长度。它不包括控件的OID或关键性。如果值不存在，则返回null。
      返回:
      代表LDAP控件的ASN.1 BER编码值的可能为空的字节数组。