JavaTM 2 Platform
Standard Ed. 5.0

javax.naming.ldap
接口 Control

所有超级接口:
Serializable
所有已知实现类:
BasicControl, ManageReferralControl, PagedResultsControl, PagedResultsResponseControl, SortControl, SortResponseControl

public interface Control
extends Serializable

此接口表示在 RFC 2251 中定义的 LDAPv3 控件。

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

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

从以下版本开始:
1.3
另请参见:
ControlFactory

字段摘要
static boolean CRITICAL
          指示关键控件。
static boolean NONCRITICAL
          指示非关键控件。
 
方法摘要
 byte[] getEncodedValue()
          检索 LDAP 控件的 ASN.1 BER 编码值。
 String getID()
          检索为 LDAP 控件分配的对象标识符。
 boolean isCritical()
          确定 LDAP 控件的关键性。
 

字段详细信息

CRITICAL

static final boolean CRITICAL
指示关键控件。此常量的值为 true

另请参见:
常量字段值

NONCRITICAL

static final boolean NONCRITICAL
指示非关键控件。此常量的值为 false

另请参见:
常量字段值
方法详细信息

getID

String getID()
检索为 LDAP 控件分配的对象标识符。

返回:
非 null 对象标识符字符串。

isCritical

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

返回:
如果此控件是关键的,则返回 true;否则返回 false。

getEncodedValue

byte[] getEncodedValue()
检索 LDAP 控件的 ASN.1 BER 编码值。结果为原始 BER 字节,包括控件值的标记和长度。它不包括控件 OID 和关键性。 如果值不存在,则返回 null。

返回:
表示 LDAP 控件的 ASN.1 BER 编码值的字节数组(可能为 null)。

JavaTM 2 Platform
Standard Ed. 5.0

提交错误或意见
有关更多的 API 参考资料和开发人员文档,请参阅 Java 2 SDK SE 开发人员文档。该文档包含更详细的、面向开发人员的描述,以及总体概述、术语定义、使用技巧和工作代码示例。

版权所有 2004 Sun Microsystems, Inc. 保留所有权利。 请遵守许可证条款。另请参阅文档重新分发政策