InfoDirectory SDK 使用手引書

2.1.1.3 InfoDirectoryサーバへのアクセス

エントリの検索

　InfoDirectoryサーバに対してエントリの検索を要求すると、検索でヒットしたエントリの情報が通知されます。エントリを検索する場合、以下の関数を使用します。

• ldap_search() ： 非同期型検索
• ldap_search_s() ： 同期型検索
• ldap_search_st() ： 時間制限付きの同期型検索
• ldap_search_ext() ： 非同期型検索（LDAPコントロール指定可能）
• ldap_search_ext_s() ： 同期型検索（LDAPコントロール指定可能）
  

　エントリを検索する場合、以下のパラメタを指定できます。

• エントリのDN

  　サーチベースとなるエントリのDNを指定します。

• 検索する範囲

  　以下のどれかを指定します。

  • サーチベースに指定された階層の検索
  • サーチベースに指定された階層の1つ下の階層を検索
  • サーチベースに指定された階層配下すべてを検索
    　
• 検索フィルタ

  　検索条件を指定します。

• 属性名リスト

  　クライアントに通知する属性の種類を指定します。複数の属性が指定された場合、指定された属性の属性値が通知されます。
  

　上記のパラメタで、検索フィルタと属性名リストは省略できます。検索フィルタと属性名リストを省略した場合、通知される情報は以下のようになります。

• 検索フィルタを省略した場合

  　検索対象のエントリの中で、利用可能なエントリが、すべて通知されます。

• 属性名リストを省略した場合

  　検索でヒットしたエントリの利用可能な属性が、すべて通知されます。
  

　また、以下に示すセションハンドルオプションのパラメタの設定により、検索処理の環境を指定できます。

• LDAP_OPT_DEREF ： 検索での別名の解決方法
• LDAP_OPT_SIZELIMIT ： InfoDirectoryサーバから通知されるエントリ数の限界値
• LDAP_OPT_TIMELIMIT ： InfoDirectoryサーバでの検索処理の制限時間

   

属性値の比較

　属性値の比較は、属性値を読込まずに属性値を判定できます。InfoDirectoryサーバは、指定されたエントリの属性値が、クライアントが指定した値と一致しているかどうかを通知します。
　属性値を比較する場合、以下の関数を使用します。

• ldap_compare() ： 非同期型
• ldap_compare_s() ： 同期型
• ldap_compare_ext() ： 非同期型（LDAPコントロール指定可能）
• ldap_compare_ext_s() ： 同期型（LDAPコントロール指定可能）
  

　属性値を比較する場合、クライアントは、以下のパラメタを指定します。

• エントリのDN

  　比較対象となるエントリのDNを指定します。

• 比較する属性の名前

  　比較対象となる属性の名前を指定します。

• 比較する値

  　比較する値を指定します。文字列データまたはバイナリデータが指定できます。

  • 文字列データの場合

    　ldap_compare() または、ldap_compare_s() を使用します。

  • バイナリデータの場合

    　ldap_compare_ext() または、ldap_compare_ext_s() を使用します。

     

エントリの変更

　エントリの変更では、指定された属性を追加／削除／置換ができます。指定されなかった属性は変更されません。

　エントリを変更する場合には、以下の関数を使用します。

• ldap_modify() ： 非同期型
• ldap_modify_s() ： 同期型
• ldap_modify_ext() ： 非同期型（LDAPコントロール指定可能）
• ldap_modify_ext_s() ： 同期型（LDAPコントロール指定可能）

　エントリを変更する場合、クライアントは、以下のパラメタを指定します。

• エントリのDN

  　変更するエントリのDNを指定します。

• 操作対象の属性

  　操作する属性ごとに、以下のパラメタを指定します。

  • 変更する属性の名前

    　操作する属性の名前を指定します。

  • 変更操作の種類

    　属性値の追加、属性値の削除、属性値の置換のどれかを指定します。

  • 属性値の種類

    　文字列データまたはバイナリデータを指定します。

  • 属性値（複数指定可能）

    　属性の値を指定します。
    

　InfoDirectoryサーバは、指定された変更操作にしたがって以下のように処理します。

• 属性値の追加

  　エントリに、指定された属性と属性値を追加します。既存の属性を指定した場合、指定された属性に属性値を追加します。

  [図: 属性値の追加処理(1)]

  

  [図: 属性値の追加処理(2)]

  

• 属性値の削除

  　指定された属性から、クライアントが指定した属性値を削除します。エントリの属性値の数が1個の場合には、属性を削除します。

  [図: 属性値の削除処理(1)]

  

  　また、属性名だけ指定して、属性値を省略した場合には、指定された属性を削除します。

  [図: 属性値の削除処理(2)]

  

• 属性値の置換

  　指定された属性の値を、クライアントが指定した値と置換えます。

  [図: 属性値の置換処理(1)]

  

  [図: 属性値の置換処理(2)]

  

   

名前の変更

　DNまたはRDNを変更する場合は、以下の関数を使用します。

• ldap_rename() ： 非同期型の変名
• ldap_rename_s() ： 同期型の変名
  

　各関数の仕様については、エントリ名の変更を参照してください。エントリのDNまたはRDNを変更する場合、クライアントは、パラメタに以下を指定します。

• 現在のDN

  　名前を変更するエントリのDNを指定します。

• 新しいRDN

  　指定されたエントリの新しいRDNを指定します。

• 元のRDNに対する処理

  　元のRDNに該当する属性値をエントリから削除するかどうか指定します。

  • 元のRDNに該当する属性値を削除する。
  • 元のRDNに該当する属性値を削除しない。
    　
• 新しい上位エントリ

  　新しい名前のエントリを、どのエントリ配下に配置するか指定します。LDAP V2プロトコルを使用する場合、このパラメタは指定できません。

   

エントリの追加

　エントリを追加する場合は、以下の関数を使用します。

• ldap_add() ： 非同期型
• ldap_add_s() ： 同期型
• ldap_add_ext() ： 非同期型（LDAPコントロール指定可能）
• ldap_add_ext_s() ： 同期型（LDAPコントロール指定可能）
  

　ディレクトリツリー上にエントリを追加する場合、クライアントは、以下のパラメタを指定します。

• エントリのDN

  　作成するDNを指定します。

• エントリの属性の集合

  　作成するエントリの属性名と属性値の集合を指定します。ここで指定する各属性には、以下を指定します。

  • 属性の名前

    　属性の名前を指定します。

  • 属性値の種類

    　文字列データまたはバイナリデータを指定します。

  • 属性値

    　属性に設定する属性値を指定します。属性値は、複数指定できます。

     

エントリの削除

　エントリを削除する場合、以下の関数を使用します。

• ldap_delete() ： 非同期型
• ldap_delete_s() ： 同期型
• ldap_delete_ext() ： 非同期型（LDAPコントロール指定可能）
• ldap_delete_ext_s() ： 同期型（LDAPコントロール指定可能）
  

　エントリの削除は、クライアントはパラメタにエントリのDNを指定します。

 

非同期操作の取消し

　非同期型の関数を使用してInfoDirectoryサーバに要求を送信した場合、以下の関数を使用することで要求を取消すことができます。

• ldap_abandon() ： 非同期型
• ldap_abandon_ext() ： 非同期型（LDAPコントロール指定可能）
  

　非同期要求を取消す場合には、取消したい非同期要求のメッセージIDを指定します。メッセージIDは、非同期要求を発行する際に通知されます。
　ldap_abandon()、またはldap_abandon_ext()を発行した時点で、取消したい非同期要求のresult情報をすでに受信していた場合、result情報は破棄されます。