--- schema_version: "1" id: ba343b15a0705f2e2a0632f9952ee5edd9e7d3de0bac61519f4659d834fc2bac title: LDAP Connector 3.3 リファレンス collection: mulesoft version: current locale: ja-jp portal_url: https://docs.salesforce.com/mulesoft/current/ja-jp/ldap-connector/3.3/ldap-connector-reference.md canonical_url: https://docs.mulesoft.com/jp/ldap-connector/3.3/ldap-connector-reference source_site: docs.mulesoft.com content_type: documentation content_hash: d9375930656f428e665fa5b40d544ff87ab689fb6558916e123521b60b3c175c description: MuleSoft Documentation Site release: "3.3" latest: false --- # LDAP Connector 3.3 リファレンス リリースノート: [LDAP Connector リリースノート](https://docs.mulesoft.com/jp/release-notes/connector/ldap-connector-release-notes-mule-4) ## [](#デフォルト設定)デフォルト設定 ### [](#パラメーター)パラメーター
名前 型 説明 デフォルト値 必須

Name (名前)

String (文字列)

この設定の名前。コネクタはこの名前の設定を参照します。

x

Connection (接続)

  • Basic Configuration (基本設定)

  • TLS Configuration (TLS 設定)

この設定に指定する接続型。

x

Expiration Policy (有効期限ポリシー)

ExpirationPolicy

動的設定インスタンスがアイドル状態を続けられる最小時間を設定します。この時間が経過すると、Mule Runtime で期限切れに相当するとみなされます。インスタンスが期限切れとみなされた瞬間にインスタンスが期限切れになるという意味ではありません。必要に応じて、インスタンスがパージされます。

Show attributes as Objects (属性をオブジェクトとして表示)

boolean (ブール)

true に設定されている場合、クエリによりエンティティ属性がオブジェクトとして表示されます。これには、定義種別、属性が複数値かどうかを示すフラグ、および属性の値が含まれます。false に設定されている場合、クエリでは属性値のみが表示されます。

false
## [](#basic-configuration-基本設定-型)Basic Configuration (基本設定) 型 ### [](#パラメーター-2)パラメーター
名前 型 説明 デフォルト値 必須

Principal DN (プリンシパル DN)

String (文字列)

x

Password (パスワード)

String (文字列)

Authentication (認証)

String (文字列)

URL

String (文字列)

x

Reconnection (再接続)

Reconnection (再接続)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。

Type (型)

Enumeration (列挙)。次のいずれかになります。

** JNDI

使用する接続の実装。

JNDI

Schema Enabled (スキーマ有効)

Boolean (ブール)

true に設定されている場合、LDAP Connector は LDAP スキーマ (LDAP v3 でのみ機能) を使用して LDAP エントリの構造またはマップを定義します。このパラメーターは、org.mule.module.ldap.api.LDAPEntry 属性の実装クラスに影響するため、DataSense を使用するには true に設定する必要があります。

false

Referral (参照)

Enumeration (列挙)。次のいずれかになります。

  • IGNORE

  • THROW

  • FOLLOW

サービスプロバイダーで発生した参照の処理方法 (従う、無視する、スローする) を指定するための環境プロパティの名前を保持する定数。

IGNORE

Extended Configuration (拡張設定)

Object (オブジェクト)

これは、コンテキスト環境で使用する拡張設定属性を保持するマップインスタンスです。TLS 接続を使用する場合は、ネイティブ LDAP プーリング機能が無効になっていることを確認してください。たとえば、JNDI を使用している場合、​com.sun.jndi.ldap.connect.pool=true​ などの属性は使用しないでください。使用すると TLS 使用時に問題が発生します。

Initial Pool Size (初期プールサイズ)

Number (数値)

最初に接続 ID の接続を作成するときに作成する ID あたりの接続数を表す整数の文字列表現。プーリングを無効にするには、この値を 0 (ゼロ) に設定します。

1

Max Pool Size (最大プールサイズ)

Number (数値)

同時に保持可能な接続 ID あたりの最大接続数を表す整数の文字列表現。

5

Pool Timeout (プールタイムアウト)

Number (数値)

プール内に保持されるアイドル接続を終了またはプールから削除するまでのミリ秒数を表す整数の文字列表現。

60000
## [](#tls-configuration-tls-設定-型)TLS Configuration (TLS 設定) 型 ### [](#パラメーター-3)パラメーター
名前 型 説明 デフォルト値 必須

Principal DN (プリンシパル DN)

String (文字列)

x

Password (パスワード)

String (文字列)

Authentication (認証)

String (文字列)

URL

String (文字列)

x

Reconnection (再接続)

Reconnection (再接続)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。

Type (型)

Enumeration (列挙)。次のいずれかになります。

** JNDI

使用する接続の実装。

JNDI

Schema Enabled (スキーマ有効)

Boolean (ブール)

true に設定されている場合、LDAP Connector は LDAP スキーマ (LDAP v3 でのみ機能) を使用して LDAP エントリの構造 (マップ) を定義します。このパラメーターは、​org.mule.module.ldap.api.LDAPEntry​ 属性の実装クラスに影響するため、DataSense を使用するには true に設定する必要があります。

false

Referral (参照)

Enumeration (列挙)。次のいずれかになります。

  • IGNORE

  • THROW

  • FOLLOW

サービスプロバイダーで発生した参照の処理方法 (従う、無視する、スローする) を指定するための環境プロパティの名前を保持する定数。

IGNORE

Extended Configuration (拡張設定)

Object (オブジェクト)

これは、コンテキスト環境で使用する拡張設定属性を保持するマップインスタンスです。TLS 接続を使用する場合は、ネイティブ LDAP プーリング機能を無効にする必要があります。たとえば、JNDI を使用している場合、​com.sun.jndi.ldap.connect.pool=true​ などの属性は使用しないでください。使用すると TLS 使用時に問題が発生します。
## [](#サポートされている操作)サポートされている操作 - [Add Entry](#add) - [Add Multi Value Attribute](#addMultiValueAttribute) - [Add Single Value Attribute](#addSingleValueAttribute) - [Bind](#bind) - [Delete Entry](#delete) - [Delete Multi Value Attribute](#deleteMultiValueAttribute) - [Delete Single Value Attribute](#deleteSingleValueAttribute) - [Exists](#exists) - [LDAPEntry To LDIF](#ldapEntryToLdif) - [Lookup](#lookup) - [Modify Entry](#modify) - [Modify Multi Value Attribute](#modifyMultiValueAttribute) - [Modify Single Value Attribute](#modifySingleValueAttribute) - [Paged Result Search](#pagedResultSearch) - [Rename entry](#rename) - [Search](#ldapsearch) - [Search One](#searchOne) - [Unbind](#unbind) ## [](#操作)操作 ## [](#add)Add Entry `` 新しい LDAPEntry を LDAP サーバー内に作成します。エントリには、識別名 (DN)、構造を定義する objectClass 属性、すべての必須属性の 1 つ以上の値を含める必要があります。必須属性は、エントリに割り当てられたオブジェクトクラスによって異なります。標準オブジェクトクラスと属性については、RFC 4519 を参照してください。 ### [](#パラメーター-4)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

エントリ

Object (オブジェクト)

追加する LDAPEntry。

#[payload]

Structural Object Class (構造オブジェクトクラス)

String (文字列)

追加するエントリの型。 エントリの objectClass 属性が設定されていない場合、この属性を使用して objectClass 階層全体が取得されます。オブジェクトクラス階層をトラバースするために LDAP サーバーへのコールが数回実行されるため、パフォーマンス要件がある場合は、この機能を使用しないでください。

Reconnection Strategy (再接続戦略)

  • reconnect (再接続)

  • reconnect-forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。
### [](#次の設定の場合)次の設定の場合 - config ### [](#スロー)スロー - LDAP:COMMUNICATION - LDAP:CONNECTIVITY - LDAP:CONTEXT\_NOT\_EMPTY - LDAP:INVALID\_ATTRIBUTE - LDAP:INVALID\_ENTRY - LDAP:NAME\_ALREADY\_BOUND - LDAP:NAME\_NOT\_FOUND - LDAP:OPERATION\_NOT\_SUPPORTED - LDAP:OPERATION\_NOT\_COMPLETED - LDAP:PERMISSION - LDAP:RETRY\_EXHAUSTED - LDAP:UNKNOWN ## [](#addMultiValueAttribute)Add Multi Value Attribute `` 既存の LDAP エントリの属性にすべての値を追加します。エントリの attributeName にすでに値が含まれている場合には、これらの値が追加されます。属性で複数の値が許容されている必要があります。そうでない場合は、例外が発生します。 ### [](#パラメーター-5)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

DN

String (文字列)

変更する LDAP エントリの DN。

x

Attribute Name (属性名)

String (文字列)

値を追加する属性の名前。

x

Attribute Values (属性値)

Any の配列

属性の値。

#[payload]

Ignore Invalid Attribute (無効な属性を無視)

Boolean (ブール)

追加する属性値がすでに存在する場合に ​INVALID_ATTRIBUTE​ エラーをスローしません。

false

Reconnection Strategy (再接続戦略)

  • reconnect (再接続)

  • reconnect-forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。
### [](#次の設定の場合-2)次の設定の場合 - config ### [](#スロー-2)スロー - LDAP:COMMUNICATION - LDAP:CONNECTIVITY - LDAP:CONTEXT\_NOT\_EMPTY - LDAP:INVALID\_ATTRIBUTE - LDAP:INVALID\_ENTRY - LDAP:NAME\_ALREADY\_BOUND - LDAP:NAME\_NOT\_FOUND - LDAP:OPERATION\_NOT\_SUPPORTED - LDAP:OPERATION\_NOT\_COMPLETED - LDAP:PERMISSION - LDAP:RETRY\_EXHAUSTED - LDAP:UNKNOWN ## [](#addSingleValueAttribute)Add Single Value Attribute `` 既存の LDAP エントリの属性に値を追加します。エントリの指定された attributeName にすでに値が含まれる場合、この値は追加されます (属性が複数値でエントリにその値がまだ含まれていない場合のみ)。String (文字列) 以外の型の値を追加する場合は、add-multi-value-attribute 操作を使用し、その値の単一要素リストを定義できます。 ### [](#パラメーター-6)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

DN

String (文字列)

変更する LDAP エントリの DN。

x

Attribute Name (属性名)

String (文字列)

値を追加する属性の名前。

x

Attribute Value (属性値)

String (文字列)

属性の値。

x

Ignore Invalid Attribute (無効な属性を無視)

Boolean (ブール)

追加する属性値がすでに存在する場合に InvalidAttributeException エラーをスローしません。

false

Reconnection Strategy (再接続戦略)

  • reconnect (再接続)

  • reconnect-forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。
### [](#次の設定の場合-3)次の設定の場合 - config ### [](#スロー-3)スロー - LDAP:COMMUNICATION - LDAP:CONNECTIVITY - LDAP:CONTEXT\_NOT\_EMPTY - LDAP:INVALID\_ATTRIBUTE - LDAP:INVALID\_ENTRY - LDAP:NAME\_ALREADY\_BOUND - LDAP:NAME\_NOT\_FOUND - LDAP:OPERATION\_NOT\_SUPPORTED - LDAP:OPERATION\_NOT\_COMPLETED - LDAP:PERMISSION - LDAP:RETRY\_EXHAUSTED - LDAP:UNKNOWN ## [](#bind)Bind `` LDAP バインド (ログイン) 操作を実行します。ログイン後には、認証済みユーザーを使用する他の操作に使用できる LDAP 接続プールが準備されています。authDn と authPassword を上書きする値が指定されていない場合は、この操作を使用すると config 要素で定義されたユーザー/パスワードが再バインド (再認証) されます。authDn と authPassword の新しい値が指定されている場合は、認証が実行されます。config レベルのログイン情報 (authDn と authPassword) を使用して再認証し、LDAP エントリを返します。 ### [](#パラメーター-7)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Principal DN (プリンシパル DN)

String (文字列)

ユーザーのプリンシパル DN。

Password (パスワード)

String (文字列)

プリンシパル DN のパスワード。

Authentication (認証)

String (文字列)

認証の種別。

Target Variable (対象変数)

String (文字列)

操作の出力が配置される変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価する式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

  • reconnect (再接続)

  • reconnect-forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。
### [](#出力)出力

型

Object (オブジェクト)
### [](#次の設定の場合-4)次の設定の場合 - config ### [](#スロー-4)スロー - LDAP:COMMUNICATION - LDAP:CONNECTIVITY - LDAP:CONTEXT\_NOT\_EMPTY - LDAP:INVALID\_ATTRIBUTE - LDAP:INVALID\_ENTRY - LDAP:NAME\_ALREADY\_BOUND - LDAP:NAME\_NOT\_FOUND - LDAP:OPERATION\_NOT\_SUPPORTED - LDAP:OPERATION\_NOT\_COMPLETED - LDAP:PERMISSION - LDAP:RETRY\_EXHAUSTED - LDAP:UNKNOWN ## [](#delete)Delete Entry `` 指定された識別名 (DN) によって表される LDAP エントリを削除します。エントリには子エントリがないようにする必要があります。子エントリがあると ​CONTEXT\_NOT\_EMPTY​ エラーがスローされます。この操作は羃等です。最終的なアトミック名が対象コンテキストでバインドされていなくても操作が成功しますが、中間コンテキストのいずれかが存在しない場合は ​NAME\_NOT\_FOUND​ エラーがスローされます。 ### [](#パラメーター-8)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

DN

String (文字列)

削除する LDAP エントリの DN。

x

Reconnection Strategy (再接続戦略)

  • reconnect (再接続)

  • reconnect-forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。
### [](#次の設定の場合-5)次の設定の場合 - config ### [](#スロー-5)スロー - LDAP:COMMUNICATION - LDAP:CONNECTIVITY - LDAP:CONTEXT\_NOT\_EMPTY - LDAP:INVALID\_ATTRIBUTE - LDAP:INVALID\_ENTRY - LDAP:NAME\_ALREADY\_BOUND - LDAP:NAME\_NOT\_FOUND - LDAP:OPERATION\_NOT\_SUPPORTED - LDAP:OPERATION\_NOT\_COMPLETED - LDAP:PERMISSION - LDAP:RETRY\_EXHAUSTED - LDAP:UNKNOWN ## [](#deleteMultiValueAttribute)Delete Multi Value Attribute `` attributeName によって定義される属性の attributeValues に一致するすべての値を削除します。エントリに存在しない値は無視されます。値が指定されていない場合、属性全体がエントリから削除されます。 ### [](#パラメーター-9)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

DN

String (文字列)

変更する LDAP エントリの DN。

x

Attribute Name (属性名)

String (文字列)

値を削除する属性の名前。

x

Attribute Values (属性値)

Any の配列

削除する値。

#[payload]

Ignore Invalid Attribute (無効な属性を無視)

Boolean (ブール)

削除する属性または値が存在しない場合に ​INVALID_ATTRIBUTE​ エラーをスローしません。

false

Reconnection Strategy (再接続戦略)

  • reconnect (再接続)

  • reconnect-forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。
### [](#次の設定の場合-6)次の設定の場合 - config ### [](#スロー-6)スロー - LDAP:COMMUNICATION - LDAP:CONNECTIVITY - LDAP:CONTEXT\_NOT\_EMPTY - LDAP:INVALID\_ATTRIBUTE - LDAP:INVALID\_ENTRY - LDAP:NAME\_ALREADY\_BOUND - LDAP:NAME\_NOT\_FOUND - LDAP:OPERATION\_NOT\_SUPPORTED - LDAP:OPERATION\_NOT\_COMPLETED - LDAP:PERMISSION - LDAP:RETRY\_EXHAUSTED - LDAP:UNKNOWN ## [](#deleteSingleValueAttribute)Delete Single Value Attribute `` attributeName によって定義される属性の attributeValue に一致する値を削除します。エントリにその値がない場合は、エントリはそのままになります。値が指定されていない場合、属性全体がエントリから削除されます。String (文字列) 以外の型の値を削除する場合は、delete-multi-value-attribute 操作を使用し、その値の単一要素リストを定義できます。 ### [](#パラメーター-10)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

DN

String (文字列)

変更する LDAP エントリの DN。

x

Attribute Name (属性名)

String (文字列)

値を削除する属性の名前。

x

Attribute Value (属性値)

String (文字列)

削除する値。

Ignore Invalid Attribute (無効な属性を無視)

Boolean (ブール)

削除する属性または値が存在しない場合に ​INVALID_ATTRIBUTE​ エラーをスローしません。

false

Reconnection Strategy (再接続戦略)

  • reconnect (再接続)

  • reconnect-forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。
### [](#次の設定の場合-7)次の設定の場合 - config ### [](#スロー-7)スロー - LDAP:COMMUNICATION - LDAP:CONNECTIVITY - LDAP:CONTEXT\_NOT\_EMPTY - LDAP:INVALID\_ATTRIBUTE - LDAP:INVALID\_ENTRY - LDAP:NAME\_ALREADY\_BOUND - LDAP:NAME\_NOT\_FOUND - LDAP:OPERATION\_NOT\_SUPPORTED - LDAP:OPERATION\_NOT\_COMPLETED - LDAP:PERMISSION - LDAP:RETRY\_EXHAUSTED - LDAP:UNKNOWN ## [](#exists)Exists `` LDAP エントリが LDAP サーバーに存在するかどうかを確認します。 ### [](#パラメーター-11)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

DN

String (文字列)

取得する LDAP エントリの DN。

x

Target Variable (対象変数)

String (文字列)

操作の出力が配置される変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価する式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

  • reconnect (再接続)

  • reconnect-forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。
### [](#出力-2)出力

型

Boolean (ブール)
### [](#次の設定の場合-8)次の設定の場合 - config ### [](#スロー-8)スロー - LDAP:COMMUNICATION - LDAP:CONNECTIVITY - LDAP:CONTEXT\_NOT\_EMPTY - LDAP:INVALID\_ATTRIBUTE - LDAP:INVALID\_ENTRY - LDAP:NAME\_ALREADY\_BOUND - LDAP:NAME\_NOT\_FOUND - LDAP:OPERATION\_NOT\_SUPPORTED - LDAP:OPERATION\_NOT\_COMPLETED - LDAP:PERMISSION - LDAP:RETRY\_EXHAUSTED - LDAP:UNKNOWN ## [](#ldapEntryToLdif)LDAPEntry To LDIF `` LDAPEntry を LDIF 表現の文字列 (RFC 2849) に変換します。 ### [](#パラメーター-12)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

エントリ

Object (オブジェクト)

LDIF に変換する LDAPEntry。

#[payload]

Target Variable (対象変数)

String (文字列)

操作の出力が配置される変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価する式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

  • reconnect (再接続)

  • reconnect-forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。
### [](#出力-3)出力

型

String (文字列)
### [](#次の設定の場合-9)次の設定の場合 - config ### [](#スロー-9)スロー - LDAP:COMMUNICATION - LDAP:CONNECTIVITY - LDAP:CONTEXT\_NOT\_EMPTY - LDAP:INVALID\_ATTRIBUTE - LDAP:INVALID\_ENTRY - LDAP:NAME\_ALREADY\_BOUND - LDAP:NAME\_NOT\_FOUND - LDAP:OPERATION\_NOT\_SUPPORTED - LDAP:OPERATION\_NOT\_COMPLETED - LDAP:PERMISSION - LDAP:RETRY\_EXHAUSTED - LDAP:UNKNOWN ## [](#lookup)Lookup `` エントリの識別名 (DN) に基づいて、LDAP サーバーからエントリを取得します。識別名は LDAP エントリの一意の識別子です。そのため、この方法ではこの ID に基づいて検索が実行され、結果として 1 つのエントリが返されます。DN が無効である場合や存在しない場合は例外がスローされます。 取得するオブジェクトの DN がわかっている場合はこの操作を使用します。 `#searchOne(LDAPConfiguration, LDAPConnectionWrapper, String, String, List, SearchScope, int, long, boolean, String)` ### [](#パラメーター-13)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

DN

String (文字列)

取得する LDAP エントリの DN。

x

Attributes (属性)

Array of String (文字列の配列)

結果で返す属性のリスト。属性リストが空または null の場合、デフォルトではすべての LDAP エントリ属性が返されます。

Structural Object Class (構造オブジェクトクラス)

String (文字列)

返すエントリの型。これは、Anypoint Studio IDE の DataSense で使用され、Mule に影響を及ぼしません。

Target Variable (対象変数)

String (文字列)

操作の出力が配置される変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価する式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

  • reconnect (再接続)

  • reconnect-forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。
### [](#出力-4)出力

型

Object (オブジェクト)
### [](#次の設定の場合-10)次の設定の場合 - config ### [](#スロー-10)スロー - LDAP:COMMUNICATION - LDAP:CONNECTIVITY - LDAP:CONTEXT\_NOT\_EMPTY - LDAP:INVALID\_ATTRIBUTE - LDAP:INVALID\_ENTRY - LDAP:NAME\_ALREADY\_BOUND - LDAP:NAME\_NOT\_FOUND - LDAP:OPERATION\_NOT\_SUPPORTED - LDAP:OPERATION\_NOT\_COMPLETED - LDAP:PERMISSION - LDAP:RETRY\_EXHAUSTED - LDAP:UNKNOWN ## [](#modify)Modify Entry `` LDAP サーバー内の既存の LDAPEntry を更新します。エントリには、既存の識別名 (DN) と、すべての必須属性の 1 つ以上の値を含める必要があります。必須属性は、エントリに割り当てられたオブジェクトクラスによって異なります。標準オブジェクトクラスと属性については、RFC 4519 を参照してください。 LDAP エントリを更新するときには、パラメーターとして渡されたエントリの属性のみが更新または追加されます。属性を削除する必要がある場合は、属性削除操作を使用する必要があります。 例: 1 つの属性を更新し、もう 1 つの属性を追加します。 元の LDAP サーバーエントリ ```text dn: cn=entry,ou=group,dc=company,dc=org cn: entry attr1: Value1 attr2: Value2 multi1: Value3 multi1: Value4 objectclass: top objectclass: myentry ``` パラメーターとして渡されるエントリマップ ```text dn: cn=entry,ou=group,dc=company,dc=org attr1: NewValue attr3: NewAttributeValue ` ``` 結果の LDAP サーバーエントリ ```text dn: cn=entry,ou=group,dc=company,dc=org cn: entry attr1: NewValue attr2: Value2 multi1: Value3 multi1: Value4 attr3: NewAttributeValue objectclass: top objectclass: myentry ``` ### [](#パラメーター-14)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

エントリ

Object (オブジェクト)

更新する LDAPEntry。

#[payload]

Structural Object Class (構造オブジェクトクラス)

String (文字列)

更新するエントリの型。これは、Anypoint Studio IDE の DataSense で使用され、Mule に影響を及ぼしません。

Reconnection Strategy (再接続戦略)

  • reconnect (再接続)

  • reconnect-forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。
### [](#次の設定の場合-11)次の設定の場合 - config ### [](#スロー-11)スロー - LDAP:COMMUNICATION - LDAP:CONNECTIVITY - LDAP:CONTEXT\_NOT\_EMPTY - LDAP:INVALID\_ATTRIBUTE - LDAP:INVALID\_ENTRY - LDAP:NAME\_ALREADY\_BOUND - LDAP:NAME\_NOT\_FOUND - LDAP:OPERATION\_NOT\_SUPPORTED - LDAP:OPERATION\_NOT\_COMPLETED - LDAP:PERMISSION - LDAP:RETRY\_EXHAUSTED - LDAP:UNKNOWN ## [](#modifyMultiValueAttribute)Modify Multi Value Attribute `` attributeName によって定義される属性の値を attributeValues によって定義される新しい値に更新 (置換) します。その属性がエントリに存在しない場合は、値が追加されます。 ### [](#パラメーター-15)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

DN

String (文字列)

変更する LDAP エントリの DN。

x

Attribute Name (属性名)

String (文字列)

値を更新する属性の名前。

x

Attribute Values (属性値)

Any の配列

属性の新しい値。

#[payload]

Ignore Invalid Attribute (無効な属性を無視)

Boolean (ブール)

変更する属性値がすでに存在する場合に ​INVALID_ATTRIBUTE​ エラーをスローしません。

false

Reconnection Strategy (再接続戦略)

  • reconnect (再接続)

  • reconnect-forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。
### [](#次の設定の場合-12)次の設定の場合 - config ### [](#スロー-12)スロー - LDAP:COMMUNICATION - LDAP:CONNECTIVITY - LDAP:CONTEXT\_NOT\_EMPTY - LDAP:INVALID\_ATTRIBUTE - LDAP:INVALID\_ENTRY - LDAP:NAME\_ALREADY\_BOUND - LDAP:NAME\_NOT\_FOUND - LDAP:OPERATION\_NOT\_SUPPORTED - LDAP:OPERATION\_NOT\_COMPLETED - LDAP:PERMISSION - LDAP:RETRY\_EXHAUSTED - LDAP:UNKNOWN ## [](#modifySingleValueAttribute)Modify Single Value Attribute `` attributeName によって定義される属性の値を attributeValue によって定義される新しい値に更新 (置換) します。その属性がエントリに存在しない場合は、値が追加されます。String (文字列) 以外の型の値を更新する場合は、use the update-multi-value-attribute 操作を使用し、その値の単一要素リストを定義します。 ### [](#パラメーター-16)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

DN

String (文字列)

変更する LDAP エントリの DN。

x

Attribute Name (属性名)

String (文字列)

値を更新する属性の名前。

x

Attribute Value (属性値)

String (文字列)

属性の新しい値。

x

Ignore Invalid Attribute (無効な属性を無視)

Boolean (ブール)

変更する属性値がすでに存在する場合に ​INVALID_ATTRIBUTE​ エラーをスローしません。

false

Reconnection Strategy (再接続戦略)

  • reconnect (再接続)

  • reconnect-forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。
### [](#次の設定の場合-13)次の設定の場合 - config ### [](#スロー-13)スロー - LDAP:COMMUNICATION - LDAP:CONNECTIVITY - LDAP:CONTEXT\_NOT\_EMPTY - LDAP:INVALID\_ATTRIBUTE - LDAP:INVALID\_ENTRY - LDAP:NAME\_ALREADY\_BOUND - LDAP:NAME\_NOT\_FOUND - LDAP:OPERATION\_NOT\_SUPPORTED - LDAP:OPERATION\_NOT\_COMPLETED - LDAP:PERMISSION - LDAP:RETRY\_EXHAUSTED - LDAP:UNKNOWN ## [](#pagedResultSearch)Paged Result Search `` LDAP 検索を実行し、結果をフローの残りの部分に流し込みます。 つまり、この操作では、LDAP サーバーでページングがサポートされている場合、すべての結果を含む 1 つのリストを返す代わりに、LDAP 検索結果を複数のページまたはリストに分割します。ページまたはリストのサイズは \[Page Size (ページサイズ)\] パラメーターで指定されています。\[Page Size (ページサイズ)\] の値が ​`1`​ に設定されている場合、結果は個別のエントリとして返されます。 これは横取り操作です。つまり、各検索結果に対して、Mule フローの残りの部分が実行されます。各実行で、1 つの結果リストに集約された結果が返されます。 大きな結果を返すクエリの場合、ページネーションを使用することをお勧めします。ただし、LDAP サーバーによってはサポートされていない場合や、サポートするように設定されていない場合があります。 ページネーションを使用するには、​**\[Max Results (最大結果数)\]**​ (制限数) 以下のページサイズ値を指定します。サイズ制限超過の例外が発生した場合は、認証済みユーザーに十分な権限があることや LDAP サーバーが設定によって制限されていないことを確認します。この場合は、取得サイズの値を小さくする必要があります。 ### [](#パラメーター-17)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Base DN (ベース DN)

String (文字列)

LDAP 検索のベース DN。

x

Filter (検索条件)

String (文字列)

有効な LDAP 検索条件。LDAP Connector では、RFC 2254 で定義されている LDAP 検索条件がサポートされます。

x

Attributes (属性)

Array of String (文字列の配列)

結果で返す属性のリスト。属性リストが空または null の場合、デフォルトではすべての LDAP エントリ属性が返されます。

Scope (スコープ)

Enumeration (列挙)。次のいずれかになります。

  • OBJECT

  • ONE_LEVEL​

  • SUB_TREE

検索のスコープ。有効な属性は次のとおりです。

* OBJECT: ベース DN のエントリのみを検索するため、そのエントリからの結果のみが返されます。これは検索条件を満たす必要があります。 * ONE_LEVEL​: ベース DN の 1 つ下のレベルのすべてのエントリを検索します。ベース DN のエントリや、ベース DN の 1 つ下のレベルのエントリは含まれません。 * SUB_TREE​: 指定したベース DN 以下のすべてのレベルのすべてのエントリを検索します。

ONE_LEVEL

Timeout (タイムアウト)

Number (数値)

検索のタイムアウト (ミリ秒)。値が 0 の場合、無限に待機することを意味します。

0

Max Results (最大結果数)

Number (数値)

検索結果として返すエントリの最大数。0 はすべてのエントリを返すことを示します。

0

Return Object (オブジェクトを返す)

Boolean (ブール)

結果の一部としてオブジェクトを返すことを有効または無効にします。無効にすると、オブジェクトの名前とクラスのみが返されます。有効にすると、オブジェクトが返されます。

false

Page Size (ページサイズ)

Number (数値)

LDAP サーバーが結果のページングをサポートしている場合、この属性をページのサイズに設定します。pageSize が 0 以下の場合、ページングは無効になります。

0

Order by attribute (並び替え基準属性)

String (文字列)

結果を並び替えるために使用される LDAP 属性の名前。

Ascending order? (昇順?)

Boolean (ブール)

orderBy が設定されている場合に、昇順または降順のどちらで並び替えるかを指定します。

true

Structural Object Class (構造オブジェクトクラス)

String (文字列)

返すエントリの型。これは、Anypoint Studio IDE の DataSense で使用され、Mule に影響を及ぼしません。

Fetch Size (フェッチサイズ)

Number (数値)

ページあたりに同時に取得する LDAP エントリの最大数。

200

Streaming Strategy (ストリーミング戦略)

  • repeatable-in-memory-iterable

  • repeatable-file-store-iterable (反復可能なファイルストアイテラブル)

  • non-repeatable-iterable

Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は ​[Target Variable (対象変数)]​ に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

  • reconnect (再接続)

  • reconnect-forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。
### [](#出力-5)出力

型

Array of Object (オブジェクトの配列)
### [](#次の設定の場合-14)次の設定の場合 - config ### [](#スロー-14)スロー - LDAP:COMMUNICATION - LDAP:CONNECTIVITY - LDAP:CONTEXT\_NOT\_EMPTY - LDAP:INVALID\_ATTRIBUTE - LDAP:INVALID\_ENTRY - LDAP:NAME\_ALREADY\_BOUND - LDAP:NAME\_NOT\_FOUND - LDAP:OPERATION\_NOT\_SUPPORTED - LDAP:OPERATION\_NOT\_COMPLETED - LDAP:PERMISSION - LDAP:UNKNOWN ## [](#rename)Rename entry `` 既存の LDAP エントリの名前を変更します (エントリを 1 つの DN から別の DN に移動)。 ### [](#パラメーター-18)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Current DN (現在の DN)

String (文字列)

名前を変更する既存のエントリの DN。

x

New DN (新しい DN)

String (文字列)

変更先の DN。

x

Reconnection Strategy (再接続戦略)

  • reconnect (再接続)

  • reconnect-forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。
### [](#次の設定の場合-15)次の設定の場合 - config ### [](#スロー-15)スロー - LDAP:COMMUNICATION - LDAP:CONNECTIVITY - LDAP:CONTEXT\_NOT\_EMPTY - LDAP:INVALID\_ATTRIBUTE - LDAP:INVALID\_ENTRY - LDAP:NAME\_ALREADY\_BOUND - LDAP:NAME\_NOT\_FOUND - LDAP:OPERATION\_NOT\_SUPPORTED - LDAP:OPERATION\_NOT\_COMPLETED - LDAP:PERMISSION - LDAP:RETRY\_EXHAUSTED - LDAP:UNKNOWN ## [](#ldapsearch)Search `` すべての結果の LDAP エントリのリストを返す LDAP 検索を実行します。大きな結果を返すクエリの場合、ページネーションを使用します。ただし、LDAP サーバーによってはサポートされていない場合や、サポートするように設定されていない場合があります。ページネーションを使用するには、最大結果 (制限数) 以下のページサイズ値を指定します。サイズ制限超過の例外が発生した場合は、認証済みユーザーに十分な権限があることや LDAP サーバーが設定によって制限されていないことを確認します。 ### [](#パラメーター-19)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Base DN (ベース DN)

String (文字列)

LDAP 検索のベース DN。

x

Filter (検索条件)

String (文字列)

有効な LDAP 検索条件。LDAP Connector は、RFC 2254 で定義されている LDAP 検索条件をサポートしています。

x

Attributes (属性)

Array of String (文字列の配列)

結果で返す属性のリスト。属性リストが空または null の場合、デフォルトではすべての LDAP エントリ属性が返されます。

Scope (スコープ)

Enumeration (列挙)。次のいずれかになります。

  • OBJECT

  • ONE_LEVEL​

  • SUB_TREE

検索のスコープ。有効な属性は次のとおりです。

* OBJECT: この値は、ベース DN のエントリのみを検索することを示すために使用されます。結果としてそのエントリのみが返されます (検索条件を満たしている必要もあります)。 * ONE_LEVEL​: この値は、ベース DN の 1 つ下のレベルのすべてのエントリを検索することを示すために使用されます。ベース DN は含まれず、ベース DN の 1 つ下のレベルより下のエントリも含まれません。 * SUB_TREE​: この値は、指定したベース DN 以下のすべてのレベルのすべてのエントリを検索することを示すために使用されます。

ONE_LEVEL

Timeout (タイムアウト)

Number (数値)

検索のタイムアウト (ミリ秒)。値が 0 の場合、無限に待機することを意味します。

0

Max Results (最大結果数)

Number (数値)

検索結果として返すエントリの最大数。0 はすべてのエントリを返すことを示します。

0

Return Object (オブジェクトを返す)

Boolean (ブール)

結果の一部としてオブジェクトを返すことを有効または無効にします。無効にすると、オブジェクトの名前とクラスのみが返されます。有効にすると、オブジェクトも返されます。

false

Page Size (ページサイズ)

Number (数値)

LDAP サーバーが結果のページングをサポートしている場合、この属性をページのサイズに設定します。pageSize が 0 以下の場合、ページングは無効になります。

0

Structural Object Class (構造オブジェクトクラス)

String (文字列)

返すエントリの型。これは、Anypoint Studio IDE の DataSense で使用され、Mule に影響を及ぼしません。

Target Variable (対象変数)

String (文字列)

操作の出力が配置される変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価する式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

  • reconnect (再接続)

  • reconnect-forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。
### [](#出力-6)出力

型

Array of Object (オブジェクトの配列)
### [](#次の設定の場合-16)次の設定の場合 - config ### [](#スロー-16)スロー - LDAP:COMMUNICATION - LDAP:CONNECTIVITY - LDAP:CONTEXT\_NOT\_EMPTY - LDAP:INVALID\_ATTRIBUTE - LDAP:INVALID\_ENTRY - LDAP:NAME\_ALREADY\_BOUND - LDAP:NAME\_NOT\_FOUND - LDAP:OPERATION\_NOT\_SUPPORTED - LDAP:OPERATION\_NOT\_COMPLETED - LDAP:PERMISSION - LDAP:RETRY\_EXHAUSTED - LDAP:UNKNOWN ## [](#searchOne)Search One `` 一意の結果を返すことが想定される LDAP 検索を実行します。検索が複数の結果を返すと、警告ログメッセージが生成され、結果の最初の要素が返されます。取得する必要があるエントリの DN がわかっていないが、1 つのエントリを返すことがわかっている属性セットがある場合 (メールアドレスなど) は、​`#lookup(LDAPConfiguration, LDAPConnectionWrapper, String, List, String)`​ よりもこの操作を使用します。 ### [](#パラメーター-20)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Base DN (ベース DN)

String (文字列)

LDAP 検索のベース DN。

x

Filter (検索条件)

String (文字列)

有効な LDAP 検索条件。LDAP Connector は、RFC 2254 で定義されている LDAP 検索条件をサポートしています。

x

Attributes (属性)

Array of String (文字列の配列)

結果で返す属性のリスト。属性リストが空または null の場合、デフォルトではすべての LDAP エントリ属性が返されます。

Scope (スコープ)

Enumeration (列挙)。次のいずれかになります。

  • OBJECT

  • ONE_LEVEL​

  • SUB_TREE

検索のスコープ。有効な属性は次のとおりです。

* OBJECT: ベース DN のエントリのみを検索することを示します。結果としてそのエントリのみが返されます (検索条件を満たしている必要もあります)。 * ONE_LEVEL​: ベース DN の 1 つ下のレベルのすべてのエントリを検索することを示します。ベース DN は含まれず、ベース DN の 1 つ下のレベルより下のエントリも含まれません。 * SUB_TREE​: 指定したベース DN 以下のすべてのレベルのすべてのエントリを検索することを示します。

ONE_LEVEL

Timeout (タイムアウト)

Number (数値)

検索のタイムアウト (ミリ秒)。値が 0 の場合、無限に待機することを意味します。

0

Max Results (最大結果数)

Number (数値)

検索結果として返すエントリの最大数。0 はすべてのエントリを返すことを示します。

0

Return Object (オブジェクトを返す)

Boolean (ブール)

結果の一部としてオブジェクトを返すことを有効または無効にします。無効にすると、オブジェクトの名前とクラスのみが返されます。有効にすると、オブジェクトも返されます。

false

Structural Object Class (構造オブジェクトクラス)

String (文字列)

返すエントリの型。これは、Anypoint Studio IDE の DataSense で使用され、Mule に影響を及ぼしません。

Target Variable (対象変数)

String (文字列)

操作の出力が配置される変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価する式。この式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

  • reconnect (再接続)

  • reconnect-forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。
### [](#出力-7)出力

型

Object (オブジェクト)
### [](#次の設定の場合-17)次の設定の場合 - config ### [](#スロー-17)スロー - LDAP:COMMUNICATION - LDAP:CONNECTIVITY - LDAP:CONTEXT\_NOT\_EMPTY - LDAP:INVALID\_ATTRIBUTE - LDAP:INVALID\_ENTRY - LDAP:NAME\_ALREADY\_BOUND - LDAP:NAME\_NOT\_FOUND - LDAP:OPERATION\_NOT\_SUPPORTED - LDAP:OPERATION\_NOT\_COMPLETED - LDAP:PERMISSION - LDAP:RETRY\_EXHAUSTED - LDAP:UNKNOWN ## [](#unbind)Unbind `` 現在の接続を閉じます。これにより、次に使用されるときにログイン操作 (バインド) が強制されます。 ### [](#パラメーター-21)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Reconnection Strategy (再接続戦略)

  • reconnect (再接続)

  • reconnect-forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。
### [](#次の設定の場合-18)次の設定の場合 - config ### [](#スロー-18)スロー - LDAP:COMMUNICATION - LDAP:CONNECTIVITY - LDAP:CONTEXT\_NOT\_EMPTY - LDAP:INVALID\_ATTRIBUTE - LDAP:INVALID\_ENTRY - LDAP:NAME\_ALREADY\_BOUND - LDAP:NAME\_NOT\_FOUND - LDAP:OPERATION\_NOT\_SUPPORTED - LDAP:OPERATION\_NOT\_COMPLETED - LDAP:PERMISSION - LDAP:RETRY\_EXHAUSTED - LDAP:UNKNOWN ## [](#reconnection-再接続-型)Reconnection (再接続) 型
項目 型 説明 デフォルト値 必須

Fails Deployment (デプロイメントに失敗)

Boolean (ブール)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。

Reconnection Strategy (再接続戦略)

  • reconnect (再接続)

  • reconnect-forever (繰り返し再接続)

使用する再接続戦略。
### [](#reconnect)Reconnect (再接続)
項目 型 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

再接続する頻度 (ミリ秒)。

Count (数)

Number (数値)

再接続の試行回数。

blocking (ブロック)

Boolean (ブール)

false の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

true
### [](#reconnect-forever)Reconnect Forever (繰り返し再接続)
項目 型 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

再接続する頻度 (ミリ秒)。

blocking (ブロック)

Boolean (ブール)

false の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

true
## [](#ExpirationPolicy)Expiration Policy (有効期限ポリシー) 型
項目 型 説明 デフォルト値 必須

Max Idle Time (最大アイドル時間)

Number (数値)

有効期限の対象とみなされるまで、動的設定インスタンスがアイドル状態を維持できる最大時間のスカラー時間値。

Time Unit (時間単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

maxIdleTime 属性の時間単位。
## [](#repeatable-in-memory-iterable)Repeatable In-Memory Iterable (反復可能なメモリ内イテラブル) 型
項目 型 説明 デフォルト値 必須

Initial Buffer Size (初期バッファサイズ)

Number (数値)

ストリームをコンシュームし、ストリームへのランダムアクセスを提供するために、最初にメモリ内に保持することが許容されるインスタンスの量。このバッファに入りきらない量のデータがストリームに含まれている場合、バッファは bufferSizeIncrement 属性と maxInMemorySize の上限に従って拡張されます。デフォルト値は 100 インスタンスです。

Buffer Size Increment (バッファサイズ増分)

Number (数値)

バッファサイズが初期サイズを超えた場合に、どれだけ拡張するか。値を 0 以下に設定すると、バッファが拡張されず、バッファがフルになると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。デフォルト値は 100 インスタンスです。

Max Buffer Size (最大バッファサイズ)

Number (数値)

使用するメモリの最大量。これを超えると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。0 以下の値は無制限を意味します。
## [](#repeatable-file-store-iterable)Repeatable File Store Iterable (反復可能なファイルストアイテラブル) 型
項目 型 説明 デフォルト値 必須

Max In Memory Size (最大メモリ内サイズ)

Number (数値)

メモリ内に保持されるインスタンスの最大数。これを超えると、ディスクへのコンテンツのバッファが開始されます。

Buffer Unit (バッファ単位)

Enumeration (列挙)。次のいずれかになります。

  • BYTE (バイト)

  • KB

  • MB

  • GB

maxInMemorySize で表される単位。
## [](#関連情報)関連情報 [MuleSoft ヘルプセンター](https://help.mulesoft.com)