Query-Objects
説明
属性値に基づくオブジェクトを照会します。
構文
<ie:webject name="Query-Objects" type="OBJ">
<ie:param name="ATTRIBUTE" data="attributes"/>
<ie:param name="BASE" data="base_context_name"/>
<ie:param name="CONNECTION_ATTEMPT_INTERVAL" data="interval"/>
<ie:param name="CONNECTION_ATTEMPTS" data="attempts"/>
<ie:param name="DBUSER" data="dbuser_name"/>
<ie:param name="DEREF"
data="[SEARCHING | FINDING | ALWAYS | NEVER]"/>
<ie:param name="FILTER"
data="[character_string | "objectclass=*"]"/>
<ie:param name="GROUP_OUT" data="group_out"/>
<ie:param name="INSTANCE" data="application"/>
<ie:param name="PASSWD" data="dbpassword"/>
<ie:param name="SCOPE" data="[BASE | ONELEVEL | SUBTREE]"/>
<ie:param name="SIZELIMIT" data="number of entries"/>
<ie:param name="TIMELIMIT" data="number_of_seconds"/>
</ie:webject>
パラメータ
|
必須
|
オプション
|
|
INSTANCE
|
ATTRIBUTE
|
|
BASE
|
|
CONNECTION_ATTEMPTS
|
|
CONNECTION_ATTEMPT_INTERVAL
|
|
DBUSER
|
|
DEREF
|
|
FILTER
|
|
GROUP_OUT
|
|
PASSWD
|
|
SCOPE
|
|
SIZELIMIT
|
|
TIMELIMIT
|
ATTRIBUTE
照会されたオブジェクトから返される属性を指定します。LDAP エントリには、ユーザーと操作の 2 種類の属性が含まれます。
◦ 通常、ユーザー属性は、適切な権限を持つアプリケーションによって修正可能なデータです。
◦ 操作属性は、ディレクトリによって作成および維持され、通常は修正できません (creatorsName など)。
操作属性を表示するには、ATTRIBUTE パラメータに特定の属性が指定されている必要があります。"*" を指定すると、すべてのユーザー属性が返されます。返される明示的な操作属性名と値 "*" を使用して複数のパラメータを指定できます。この組み合わせを指定すると、すべてのユーザー属性と指定した操作属性が返されます。
このパラメータを指定しないと、すべてのユーザー属性が返されます。このパラメータはオプションです。
BASE
サーチを開始するエントリのベース識別名を指定します。このパラメータに値が指定されている場合、アダプタの LDAP エントリに指定されているプロパティ値よりも Webject 値が優先されます。このパラメータのデフォルト値は、アダプタの LDAP エントリの searchBase プロパティに指定した値です。これはオプションのパラメータです。
CONNECTION_ATTEMPTS
エラーを返す前にアダプタの接続の確立を試行する最大回数を定義します。デフォルト値は 1 です。このパラメータはオプションです。
複数の INSTANCE パラメータ値を指定する場合、CONNECTION_ATTEMPTS の値は、アダプタインスタンスのリストを繰り返す最大数を定義します。
CONNECTION_ATTEMPT_INTERVAL
接続の試行間の遅延時間を秒単位で定義します。デフォルト値は 60 秒です。このパラメータはオプションです。
複数の INSTANCE パラメータ値が指定されている場合、CONNECTION_ATTEMPT_INTERVAL の値は、アダプタインスタンスのリスト全体を繰り返す試行間の待機秒数を定義します。
DBUSER
データリポジトリへのログイン時に使用するユーザー ID を指定します。このパラメータが Webject で指定されている場合、この Webject の値が、アダプタ LDAP エントリ、または認証マッピング設定で指定されているいずれの値よりも優先されます。このパラメータが指定されていない場合、認証マッピング設定およびアダプタ LDAP エントリで指定する必要があります。資格証明マッピングの詳細については、
資格証明マッピングのセクションを参照してください。
DEREF
サーチのベースオブジェクトについて、サーチ時にエイリアス指定されるオブジェクトの処理方法を指定します。このパラメータの有効な値は、SEARCHING、FINDING、ALWAYS、および NEVER です。
◦ SEARCHING を指定すると、指定されたデータベースをサーチするときにのみベースオブジェクトの下位オブジェクトをエイリアス指定し、サーチのベースオブジェクトを探すときはエイリアス指定しません。
◦ FINDING を指定すると、サーチのベースオブジェクトを探すときのみエイリアス指定し、ベースオブジェクトの下位オブジェクトをサーチするときはエイリアス指定しません。
◦ ALWAYS を指定すると、データベースをサーチするときも、サーチのベースオブジェクトを探すときも、常にエイリアス指定します。
◦ NEVER を指定すると、データベースをサーチするときも、サーチのベースオブジェクトを探すときも、エイリアス指定しません。
このパラメータに値が指定されている場合、アダプタの LDAP エントリに指定されているプロパティ値よりも Webject 値が優先されます。このパラメータのデフォルト値は、アダプタの LDAP エントリの environment.java.naming.ldap.derefAliases プロパティに指定した値です。
アダプタの LDAP でこのプロパティが指定されていない場合、LDAP サーバーのデフォルトが使用されます。このパラメータはオプションです。
FILTER
LDAP ディレクトリサーチに固有のサーチフィルタを示す文字列を指定します。このパラメータに値が指定されている場合、アダプタの LDAP エントリに指定されているプロパティ値よりも Webject 値が優先されます。このパラメータのデフォルト値は、アダプタの LDAP エントリの searchFilter プロパティに指定した値です。このパラメータはオプションです。
GROUP_OUT
操作によって返されるオブジェクトセットの名前を識別します。現在、GROUP_OUT はステータスメッセージのみを返します。このパラメータはオプションです。
INSTANCE
Webject を実行するアダプタの名前を指定します。アダプタ名は、Info*Engine 環境で使用するためにアダプタを設定する際に定義されます。このパラメータは必須です。
特定のアダプタを使用できない場合にほかのアダプタに接続できるように、このパラメータには複数の値を指定できます。Info*Engine は、決められた順番にアダプタへの接続を試みます。最初のアダプタが使用できない場合、次にリストされているアダプタへの接続が試行されます。これは接続が確立されるまで実行されます。リストされているどのアダプタとも接続できない場合は、エラーを返します。
このパラメータとともに、CONNECTION_ATTEMPTS と CONNECTION_ATTEMPT_INTERVAL の 2 つのパラメータを含めることができます。
PASSWD
データリポジトリへのログイン時に使用するパスワードを指定します。このパラメータが Webject で指定されている場合、この Webject の値が、アダプタ LDAP エントリ、または認証マッピング設定で指定されているいずれの値よりも優先されます。このパラメータが指定されていない場合、認証マッピング設定およびアダプタ LDAP エントリで指定する必要があります。資格証明マッピングの詳細については、
資格証明マッピングのセクションを参照してください。
SCOPE
実行するサーチの範囲を指定します。有効な値は、BASE、ONELEVEL、および SUBTREE です。
◦ 範囲を BASE に設定すると、サーチのベースエントリのみが返されます。
◦ 範囲を ONELEVEL に設定すると、サーチのベースエントリとそのすべての子が返されます。
◦ 範囲を SUBTREE に設定すると、サーチのベースエントリとサブツリーが返されます。
このパラメータに値が指定されている場合、アダプタの LDAP エントリに指定されているプロパティ値よりも Webject 値が優先されます。このパラメータのデフォルト値は、アダプタの LDAP エントリの searchScope プロパティに指定した値です。このパラメータはオプションです。
SIZELIMIT
照会の結果として返されるエントリの最大数を指定します。指定された制限に達してもサーチが完了しない場合には、見つかったエントリが返され、IEPartialResultsException が発生します。0 が指定されている場合は、見つかったすべてのエントリが返されます。基本となる LDAP ディレクトリにサイズ制限による制約がある場合もあります。
このパラメータに値が指定されている場合、アダプタの LDAP エントリに指定されているプロパティ値よりも Webject 値が優先されます。このパラメータのデフォルト値は、アダプタの LDAP エントリの sizeLimit プロパティに指定した値です。アダプタの LDAP でこのプロパティが指定されていない場合、LDAP サーバーのデフォルトが使用されます。これはオプションのパラメータです。
指定した値が、ディレクトリに指定された制限値より大きい場合、このパラメータは無効です。
TIMELIMIT
サーチに許可される最大時間を秒単位で指定します。指定した上限に達してもサーチが完了しない場合、見つかったエントリが返されて、IEPartialResultsException が発生します。0 を指定した場合、サーチの時間制限はありません。
このパラメータに値が指定されている場合、アダプタの LDAP エントリに指定されているプロパティ値よりも Webject 値が優先されます。このパラメータのデフォルト値は、アダプタの LDAP エントリの timeLimit プロパティに指定した値です。アダプタの LDAP でこのプロパティが指定されていない場合、LDAP サーバーのデフォルトが使用されます。このパラメータはオプションです。
指定した値が、ディレクトリに指定された制限値より大きい場合、このパラメータは無効です。
例
SCOPE を ONELEVEL に設定した場合
<%@page language="java" session="false"%>
<%@taglib uri="http://www.ptc.com/infoengine/taglib/core"
prefix="ie"%>
<ie:webject name="Query-Objects" type="ACT">
<ie:param name="INSTANCE" data="instance_name"/>
<ie:param name="BASE" data="ou=people, o=organization.com"/>
<ie:param name="ATTRIBUTE" data="cn"/>
<ie:param name="ATTRIBUTE " data="sn"/>
<ie:param name="GROUP_OUT" data="query"/>
<ie:param name="SCOPE" data="onelevel"/>
</ie:webject>
SCOPE を SUBTREE に設定した場合
<%@page language="java" session="false"%>
<%@taglib uri="http://www.ptc.com/infoengine/taglib/core"
prefix="ie"%>
<ie:webject name="Query-Objects" type="ACT">
<ie:param name="INSTANCE" data="instance_name"/>
<ie:param name="BASE" data="ou=people, o=organization.com"/>
<ie:param name="ATTRIBUTE" data="cn"/>
<ie:param name="ATTRIBUTE " data="sn"/>
<ie:param name="GROUP_OUT" data="query"/>
<ie:param name="SCOPE" data="subtree"/>
</ie:webject>
SCOPE を BASE に設定した場合
<%@page language="java" session="false"%>
<%@taglib uri="http://www.ptc.com/infoengine/taglib/core"
prefix="ie"%>
<ie:webject name="Query-Objects" type="ACT">
<ie:param name="INSTANCE" data="instance_name"/>
<ie:param name="BASE" data="ou=people, o=organization.com"/>
<ie:param name="ATTRIBUTE" data="cn"/>
<ie:param name="ATTRIBUTE " data="sn"/>
<ie:param name="GROUP_OUT" data="query"/>
<ie:param name="SCOPE" data="base"/>
</ie:webject>