最新の安定バージョンについては、Spring LDAP 3.2.12 を使用してください! |
導入
概要
Spring LDAP は、Java での LDAP プログラミングを簡素化するように設計されています。ライブラリによって提供される機能の一部は次のとおりです。
JdbcTemplate
(Javadoc) -LDAP プログラミングに対するスタイルテンプレートの簡素化。JPA または Hibernate スタイルのアノテーションベースのオブジェクトとディレクトリのマッピング。
QueryDSL のサポートを含む、Spring Data リポジトリのサポート。
LDAP クエリと識別名の作成を簡素化するユーティリティ。
適切な LDAP 接続プール。
クライアント側の LDAP 補正トランザクションのサポート。
従来の Java LDAP と LdapClient
の比較
すべての人のストレージを検索し、その名前をリストで返すメソッドを考えてみましょう。JDBC を使用して接続を作成し、ステートメントを使用してクエリを実行します。次に、結果セットをループして目的の列を取得し、リストに追加します。
JNDI を使用して LDAP データベースに対して作業する場合、コンテキストを作成し、検索フィルターを使用して検索を実行します。次に、結果の名前の列挙をループし、必要な属性を取得してリストに追加します。
Java LDAP でこの人名検索メソッドを実装する従来の方法は、次の例のようになります。太字で示されているコードに注意してください。これは、メソッドのビジネス目的に関連するタスクを実際に実行するコードです。残りは接続機能です。
public class TraditionalPersonRepoImpl implements PersonRepo {
public List<String> getAllPersonNames() {
Hashtable env = new Hashtable();
env.put(Context.INITIAL_CONTEXT_FACTORY, "com.sun.jndi.ldap.LdapCtxFactory");
env.put(Context.PROVIDER_URL, "ldap://localhost:389/dc=example,dc=com");
DirContext ctx;
try {
ctx = new InitialDirContext(env);
} catch (NamingException e) {
throw new RuntimeException(e);
}
List<String> list = new LinkedList<String>();
NamingEnumeration results = null;
try {
SearchControls controls = new SearchControls();
controls.setSearchScope(SearchControls.SUBTREE_SCOPE);
results = ctx.search("", "(objectclass=person)", controls);
while (results.hasMore()) {
SearchResult searchResult = (SearchResult) results.next();
Attributes attributes = searchResult.getAttributes();
Attribute attr = attributes.get("cn");
String cn = attr.get().toString();
list.add(cn);
}
} catch (NameNotFoundException e) {
// The base context was not found.
// Just clean up and exit.
} catch (NamingException e) {
throw new RuntimeException(e);
} finally {
if (results != null) {
try {
results.close();
} catch (Exception e) {
// Never mind this.
}
}
if (ctx != null) {
try {
ctx.close();
} catch (Exception e) {
// Never mind this.
}
}
}
return list;
}
}
Spring LDAP AttributesMapper
および LdapClient
クラスを使用すると、次のコードでまったく同じ機能が得られます。
import static org.springframework.ldap.query.LdapQueryBuilder.query;
public class PersonRepoImpl implements PersonRepo {
private LdapClient ldapClient;
public void setLdapClient(LdapClient ldapClient) {
this.ldapClient = ldapClient;
}
public List<String> getAllPersonNames() {
return ldapClient.search().query(
query().where("objectclass").is("person")
).toObject((Attributes attrs) ->
attrs.get("cn").get().toString();
);
}
}
定型コードの量は、従来の例よりも大幅に少なくなります。LdapClient
検索メソッドは、DirContext
インスタンスが作成されていることを確認し、検索を実行し、指定された AttributesMapper
を使用して属性を文字列にマップし、文字列を内部リストに収集し、最後にリストを返します。また、NamingEnumeration
と DirContext
が適切に閉じられていることを確認し、発生する可能性のある例外を処理します。
当然、これは Spring Framework サブプロジェクトであるため、次のように Spring を使用してアプリケーションを構成します。
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:ldap="http://www.springframework.org/schema/ldap"
xsi:schemaLocation="http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/ldap https://www.springframework.org/schema/ldap/spring-ldap.xsd">
<ldap:context-source
url="ldap://localhost:389"
base="dc=example,dc=com"
username="cn=Manager"
password="secret" />
<bean id="ldapClient" class="org.springframework.ldap.core.LdapClient" factory-method="create">
<constructor-arg ref="contextSource" />
</bean>
<bean id="personRepo" class="com.example.repo.PersonRepoImpl">
<property name="ldapClient" ref="ldapClient" />
</bean>
</beans>
カスタム XML 名前空間を使用して Spring LDAP コンポーネントを構成するには、前の例のように、XML 宣言にこの名前空間への参照を含める必要があります。 |
2.2 の新機能
2.2 の詳細については、2.2.0.RC1 [GitHub] (英語) の変更ログを参照してください。Spring LDAP 2.2 のハイライトは次のとおりです。
#415 [GitHub] (英語) : Spring 5 のサポートを追加
#399 [GitHub] (英語) : 組み込み UnboundID LDAP サーバーのサポート
#410 [GitHub] (英語) : Commons Pool 2 サポートのドキュメントを追加
2.1 の新機能
2.1 の詳細については、2.1.0.RC1 [GitHub] (英語) および 2.1.0 [GitHub] (英語) の変更ログを参照してください。Spring LDAP 2.1 のハイライトは次のとおりです。
#390 [GitHub] (英語) : Spring Data ホッパーのサポートを追加
#351 [GitHub] (英語) : commons-pool2 のサポートを追加
#370 [GitHub] (英語) : XML 名前空間に追加されたサポートプロパティプレースホルダー
#392 [GitHub] (英語) : ドキュメントテストのサポートを追加
#401 [GitHub] (英語) : assertj へのスイッチを追加
JIRA から GitHub の課題 (英語) に移行
ジッターチャット (英語) を追加
2.0 の新機能
バージョン 2.0 では、Spring LDAP API に対して大幅な最新化が行われましたが、下位互換性を可能な限り確保するために細心の注意が払われました。Spring LDAP 1.3.x で動作するコードは、変更を加えずに 2.0 ライブラリを使用する場合、いくつかの例外を除いてコンパイルおよび実行する必要があります。
例外は、いくつかの重要なリファクタリングを可能にするために新しいパッケージに移動された少数のクラスです。移動されたクラスは通常、意図したパブリック API の一部ではなく、移行手順はスムーズに行われるはずです。アップグレード後に Spring LDAP クラスが見つからない場合は常に、IDE でインポートを整理する必要があります。
ただし、いくつかの非推奨の警告が表示されることが予想されます。また、他にも多くの API の改善が行われています。2.0 バージョンを可能な限り活用するための推奨事項は、非推奨のクラスとメソッドから離れて、新しく改善された API ユーティリティに移行することです。
次のリストは、Spring LDAP 2.0 の最も重要な変更点を簡単に説明しています。
Java 6 は Spring LDAP で必要になりました。2.0 以降の Spring バージョンは引き続きサポートされます。
セントラル API は、ジェネリクスや可変引数などの Java 5+ 機能で更新されました。その結果、
spring-ldap-tiger
モジュール全体が非推奨になりました。コア Spring LDAP クラスを使用するように移行することをお勧めします。コアインターフェースのパラメーター化により、既存のコードで多くのコンパイル警告が発生します。これらの警告を取り除くために適切な措置を講じることをお勧めします。ODM (Object-Directory Mapping) 機能がコアに移動され、ODM アノテーション付きクラスとの間でこの自動変換を使用する新しいメソッドが
LdapOperations
およびLdapTemplate
に追加されました。詳細については、オブジェクトディレクトリマッピング (ODM) を参照してください。Spring LDAP の構成を簡素化するために、カスタム XML 名前空間が (最終的に) 提供されるようになりました。詳細については、[ 構成 ] を参照してください。
Spring LDAP は、Spring Data リポジトリと QueryDSL をサポートするようになりました。詳細については、Spring LDAP リポジトリを参照してください。
属性値としての
Name
インスタンスが、DirContextAdapter
および ODM での識別名の同等性に関して適切に処理されるようになりました。詳細については、属性値としてのDirContextAdapter
および識別名および属性値としての ODM および識別名を参照してください。DistinguishedName
および関連するクラスは、標準の JavaLdapName
を推奨して廃止されました。LdapName
オブジェクトを操作するときにライブラリがどのように役立つかについては、識別名を動的に構築するを参照してください。Fluent LDAP クエリ構築のサポートが追加されました。これにより、Spring LDAP で LDAP 検索を行う際のプログラミングがより快適になります。LDAP クエリビルダーのサポートの詳細については、LDAP クエリの構築および高度な LDAP クエリを参照してください。
LdapTemplate
の古いauthenticate
メソッドは、LdapQuery
オブジェクトで動作し、認証失敗時に例外をスローするいくつかの新しいauthenticate
メソッドを推奨して非推奨になりました。これにより、認証の試行が失敗した原因をユーザーが見つけやすくなります。サンプル [GitHub] (英語) は、 2.0 の機能を利用するために洗練され、更新されています。LDAP ユーザー管理アプリケーション [GitHub] (英語) の有用な例を提供するためにかなりの労力が費やされました。
パッケージの概要
Spring LDAP を使用するには、少なくとも次のものが必要です。
spring-ldap-core
: Spring LDAP ライブラリspring-core
: フレームワークによって内部的に使用されるその他のユーティリティクラスspring-beans
: Java Bean を操作するためのインターフェースとクラスslf4j
: 内部で使用される単純なロギングファサード
必須の依存関係に加えて、特定の機能には次のオプションの依存関係が必要です。
spring-data-ldap
: リポジトリサポートなどの基本インフラストラクチャspring-context
: アプリケーションが Spring アプリケーションコンテキストを使用して接続されている場合に必要です。spring-context
は、アプリケーションオブジェクトが一貫した API を使用してリソースを取得する機能を追加します。BaseLdapPathBeanPostProcessor
を使用する予定がある場合は、必ず必要です。spring-tx
: クライアント側の補正トランザクションサポートを使用する場合に必要です。spring-jdbc
: クライアント側の補正トランザクションサポートを使用する場合に必要です。commons-pool
: プーリング機能を使用する場合に必要です。spring-batch
: LDIF 解析機能を Spring Batch と一緒に使用する場合に必要です。
spring-data-ldap は、spring-ldap.xsd が使用する spring-repository.xsd を推移的に追加します。このため、Spring Data の機能セットが使用されていない場合でも、Spring LDAP の XML 構成サポートには依存関係が必要です。 |
入門
サンプル [GitHub] (英語) は、一般的な使用例で Spring LDAP を使用する方法のいくつかの有用な例を提供します。
サポート
質問がある場合は、spring-ldap
タグを使用したスタックオーバーフロー (英語) で質問してください。プロジェクトの Web ページは spring.io/spring-ldap/ です。
謝辞
Spring LDAP プロジェクトを開始する最初の取り組みは、ジェイウェイ (英語) によって後援されました。プロジェクトの現在のメンテナンスはピボタル によって資金提供されており、その後 VMware (英語) によって買収されました。
プロジェクト構造をチェックするのに便利なオープンソースライセンスを提供してくれたストラクチャー 101 (英語) に感謝します。