javax.naming.ldap

インタフェース ExtendedResponse

すべてのスーパーインタフェース:

Serializable

既知のすべてのサブインタフェース:

UnsolicitedNotification

既知のすべての実装クラス:

StartTlsResponse

public interface ExtendedResponse
extends Serializable

このインタフェースは、RFC 2251 で定義された LDAP 拡張操作の応答を表します。

     ExtendedResponse ::= [APPLICATION 24] SEQUENCE {
          COMPONENTS OF LDAPResult,
          responseName     [10] LDAPOID OPTIONAL,
          response         [11] OCTET STRING OPTIONAL }
 

この応答は、任意のオブジェクト拡張子と任意の ASN.1 BER でエンコードされた値で構成されます。

このクラスのメソッドは、拡張操作の応答に関する低レベル情報を取得するアプリケーションによって使用可能です。ただし、一般にこのアプリケーションは、このインタフェースを実装しているクラス固有のメソッドを使用します。このようなクラスは応答の際に、BER バッファーをデコードしていなければならず、型保証でユーザーが使いやすい方法でユーザーが応答データにアクセスできるメソッドを提供する必要があります。

「時間取得」の拡張操作をサポートした LDAP サーバーを例にとります。LDAP サーバーは、GetTimeRequest および GetTimeResponse のクラスを指定します。GetTimeResponse は次のようになります。

 public class GetTimeResponse implements ExtendedResponse {
     public java.util.Date getDate() {...};
     public long getTime() {...};
     ....
 }

プログラムはこれらのクラスを次のように使用します。

 GetTimeResponse resp =
     (GetTimeResponse) ectx.extendedOperation(new GetTimeRequest());
 java.util.Date now = resp.getDate();

導入されたバージョン:

1.3

関連項目:

ExtendedRequest

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
byte[]	getEncodedValue() LDAP 拡張操作の応答の ASN.1 BER でエンコードされた値を取得します。
String	getID() 応答のオブジェクト拡張子を取得します。

メソッドの詳細

getID

String getID()

応答のオブジェクト拡張子を取得します。LDAP プロトコルでは、応答オブジェクト識別子を任意に指定します。サーバーがこの識別子を送らないと、応答には ID が含まれません。つまり、null になります。

戻り値:

LDAP の ExtendedResponse.responseName コンポーネントを表す、オブジェクトの識別子の文字列。null の場合もある。

getEncodedValue

byte[] getEncodedValue()

LDAP 拡張操作の応答の ASN.1 BER でエンコードされた値を取得します。LDAP サーバーから返された応答にこの値が存在しない場合、null を返します。この結果は、応答値のタグおよび長さを含むそのまま (raw) の BER バイトで表示されます。ただし、応答 OID は含まない。

戻り値:

LDAP の ExtendedResponse.response コンポーネントの ASN.1 BER でエンコードされた内容を示す null の可能性があるバイト配列。