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 で符号化された値を検出します。この結果は、コントロール値のタグおよび長さを含むそのまま (raw) の BER バイトで表示されます。ただし、コントロールの OID またはクリティカルの程度については表示されません。値が空の場合、null が返されます。

戻り値:
LDAP コントロールの ASN.1 BER で符号化された値を示す null の可能性があるバイト配列

JavaTM 2 Platform
Standard Ed. 5.0

バグの報告と機能のリクエスト
さらに詳しい API リファレンスおよび開発者ドキュメントについては、Java 2 SDK SE 開発者用ドキュメントを参照してください。開発者向けの詳細な解説、概念の概要、用語の定義、バグの回避策、およびコード実例が含まれています。

Copyright 2004 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Documentation Redistribution Policy も参照してください。