Configuration

S2Directory を動かすに必要な dicon ファイルの詳細について説明します。事前に Setup に従い、必要なライブラリをあなたのプロジェクトに配置しておいてください。

• 目次
  • S2Directory の動作に必要な dicon ファイル
  • directory.dicon: ディレクトリサーバに接続するための各種設定
  • [オプション] SSL/TLS 接続利用時の sslSocketFactory 設定
  • [オプション] コネクション作成時の環境プロパティ設定
  • [オプション] SearchControls 設定
  • [オプション] 抽象オブジェクトクラス設定
  • [オプション] コネクションプール設定
  • [オプション] directorydao.dicon: S2Directory の基本機能を提供するためのシステム設定

S2Directory の動作に必要な dicon ファイル

S2Directory の動作に必要な dicon ファイルには次のものがあります。

* diconファイル(ダイコンファイル)とは S2Container で使用する設定ファイルです。
* diconファイルの詳細については、S2Container のドキュメントを見てください。

directory.dicon: ディレクトリサーバに接続するための各種設定

directory.diconは、ディレクトリサーバに接続するための各種設定情報を定義する dicon ファイルです。

S2Directory 0.6.1 以前から 0.7.0 以降へ更新する場合の注意

設定例

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE components PUBLIC "-//SEASAR//DTD S2Container 2.4//EN"
	"http://www.seasar.org/dtd/components24.dtd">
<components namespace="directory">
<!--
	# Directory Configuration
-->
	<component name="directoryControlProperty"
		class="org.seasar.directory.impl.DirectoryControlPropertyImpl"
			instance="prototype">

		<property name="initialContextFactory">
			"com.sun.jndi.ldap.LdapCtxFactory"
		</property>

	<!--
		# PermissiveSSLSocketFactory is not strictly secure.
		# But, it can connect to the server having the SSL certificate signed by own CA.
		# default value:
		<property name="sslSocketFactory">
			"javax.net.ssl.SSLSocketFactory"
		</property>
	-->
		<property name="sslSocketFactory">
			"org.seasar.directory.impl.PermissiveSSLSocketFactory"
		</property>
		<property name="enableTLS">false</property>

		<property name="url">
			"ldap://localhost:389"
		</property>
		<property name="baseDn">"dc=seasar,dc=org"</property>
		<property name="bindDn">"cn=Manager,dc=seasar,dc=org"</property>
		<property name="password">"secret"</property>

	<!--
		# Other options and each default value.
		<property name="authentication">"simple"</property>
		<property name="user"></property>
		<property name="passwordAlgorithm">"SSHA"</property>
		<property name="passwordSaltLength">"4"</property>
		<property name="userSuffix">"ou=Users"</property>
		<property name="userAttributeName">"uid"</property>
		<property name="groupSuffix">"ou=Groups"</property>
		<property name="groupAttributeName">"memberUid"</property>
		<property name="multipleValueDelimiter">"DEFAULT_MULTIPLE_VALUE_DELIMITER"</property>
	-->
	</component>
</components>

directoryControlProperty コンポーネントに関する設定の説明

[オプション] SSL/TLS 接続利用時の sslSocketFactory 設定

S2Directory 0.6 以降、ディレクトリサーバへの接続に SSL 接続、もしくは、STARTTLS 接続を利用した暗号化通信を行うことができます。
関連する設定項目である sslSocketFactory には、javax.net.ssl.SSLSocketFactory もしくは org.seasar.directory.impl.PermissiveSSLSocketFactory を利用することができます。
どちらであっても暗号化通信を行うことは出来ますが、下記のような違いがあります。

sslSocketFactoryの設定値の説明

org.seasar.directory.impl.PermissiveSSLSocketFactory 使用時の注意事項

[オプション] コネクション作成時の環境プロパティ設定

S2Directory 0.7.1 以降、コネクション作成時に任意のプロパティを設定できます。 指定可能な項目や値は LDAP Naming Service Provider のドキュメントを参照してください。

• LDAP Naming Service Provider for the Java Naming and Directory InterfaceTM (JNDI)

使用時の注意事項

directory.diconへの追加設定例

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE components PUBLIC "-//SEASAR//DTD S2Container 2.4//EN"
	"http://www.seasar.org/dtd/components24.dtd">
<components namespace="directory">

<!--
	# Default Environment Properties
	http://docs.oracle.com/javase/6/docs/technotes/guides/jndi/jndi-ldap.html
-->
	<component name="directoryDefaultEnvironment" class="java.util.Hashtable"
		instance="prototype">
		<initMethod>#self.put("com.sun.jndi.ldap.connect.timeout", "500")</initMethod>
		<initMethod>#self.put("com.sun.jndi.ldap.read.timeout", "5000")</initMethod>
	</component>

<!--
	# Directory Configuration
-->
	<component name="directoryControlProperty"
		class="org.seasar.directory.impl.DirectoryControlPropertyImpl"
			instance="prototype">
		<property name="defaultEnvironment">directoryDefaultEnvironment</property>
		... 環境プロパティ設定を指定しない場合と同じため省略 ...
	</component>
</components>

[オプション] SearchControls 設定

S2Directory 0.7.1 以降、検索時に使用される SearchControls のオプション値を設定できます。 指定可能な項目や値は SearchControls の JavaDoc ドキュメントを参照してください。

• SearchControls (Java Platform SE 6)

directory.diconへの追加設定例

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE components PUBLIC "-//SEASAR//DTD S2Container 2.4//EN"
	"http://www.seasar.org/dtd/components24.dtd">
<components namespace="directory">

<!--
	# Default SearchControls
	http://docs.oracle.com/javase/1.5.0/docs/api/javax/naming/directory/SearchControls.html
-->
	<component name="directoryDefaultSearchControls" class="javax.naming.directory.SearchControls"
		instance="prototype">
		<property name="countLimit">1000</property>
		<property name="searchScope">@javax.naming.directory.SearchControls@SUBTREE_SCOPE</property>
		<property name="timeLimit">5000</property>
	</component>

<!--
	# Directory Configuration
-->
	<component name="directoryControlProperty"
		class="org.seasar.directory.impl.DirectoryControlPropertyImpl"
			instance="prototype">
		<property name="defaultSearchControls">directoryDefaultSearchControls</property>
		... SearchControl 設定を指定しない場合と同じため省略 ...
	</component>
</components>

[オプション] 抽象オブジェクトクラス設定

S2Directory 0.7.1 以降、エントリ作成時に自動的に追加される抽象オブジェクトクラスを設定できます。
このオプション設定を指定しなかった場合は、S2Directory 0.7.0 以前同様、top が設定されています。

使用時の注意事項

directory.diconへの追加設定例

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE components PUBLIC "-//SEASAR//DTD S2Container 2.4//EN"
	"http://www.seasar.org/dtd/components24.dtd">
<components namespace="directory">

<!--
	# Directory Configuration
-->
	<component name="directoryControlProperty"
		class="org.seasar.directory.impl.DirectoryControlPropertyImpl"
			instance="prototype">
		<property name="abstractObjectClasses">new String[] {"top", "alias"}</property>
		... 抽象オブジェクトクラス設定を指定しない場合と同じため省略 ...
	</component>
</components>

[オプション] コネクションプール設定

S2Directory 0.6 以降、JDK が提供するコネクションプールの利用が実験的にサポートされました。
コネクションプーリングを利用する場合、directory.dicon に次の設定を足すことで利用することができます。

コネクションプーリング使用時の注意事項

directory.dicon への追加設定例

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE components PUBLIC "-//SEASAR//DTD S2Container 2.4//EN"
	"http://www.seasar.org/dtd/components24.dtd">
<components namespace="directory">
<!--
	# Connection Pooling Configuration
		Connection pooling is supported only on the Java 2 SDK, v 1.4.1, and later releases.
		http://java.sun.com/products/jndi/tutorial/ldap/connect/config.html
		http://java.sun.com/j2se/1.5.0/ja/docs/ja/guide/jndi/jndi-ldap.html#POOL
-->
	<component name="connectionPool"
		class="org.seasar.directory.impl.DirectoryConnectionPoolImpl">
		<property name="authentication">"none simple DIGEST-MD5"</property>
		<property name="debug">"fine"</property>
		<property name="initSize">1</property>
		<property name="maxSize">10</property>
		<property name="prefSize">5</property>
		<property name="protocol">"plain ssl"</property>
		<property name="timeout">3000</property>
	</component>

<!--
	# Directory Configuration
-->
	<component name="directoryControlProperty"
		class="org.seasar.directory.impl.DirectoryControlPropertyImpl"
			instance="prototype">
		... コネクションプーリングを利用しない場合と同じため省略 ...
	</component>
</components>

[オプション] directorydao.dicon: S2Directory の基本機能を提供するためのシステム設定

directorydao.dicon は、S2Directory の基本機能を提供するためのシステム設定を定義する dicon ファイルです。 独自定義することで S2Direcotry を拡張することが出来ます。 S2Directory の機能を拡張したい方以外はこの設定ファイルの詳細を知る必要はありません。

directorydao.dicon に関する注意事項

標準設定

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE components PUBLIC "-//SEASAR2.1//DTD S2Container 2.4//EN"
	"http://www.seasar.org/dtd/components24.dtd">
<components namespace="directorydao">
	<include path="directory.dicon"/>

	<!-- attribute handlers -->
	<component name="defaultHandler" class="org.seasar.directory.attribute.DefaultAttributeHandler"/>
	<component class="org.seasar.directory.attribute.DistinguishedNameAttributeHandler">
		<property name="attributeNameList">{"dn"}</property>
	</component>
	<component class="org.seasar.directory.attribute.UserPasswordAttributeHandler">
		<property name="attributeNameList">{"userPassword", "alternativeUserPassword"}</property>
	</component>

	<!-- factory -->
	<component class="org.seasar.directory.impl.DirectoryDataSourceFactoryImpl"/>
	<component class="org.seasar.directory.impl.DirectoryAttributeHandlerFactoryImpl">
		<property name="ignoreCase">true</property>
		<property name="defaultAttributeHandler">defaultHandler</property>
		<property name="attributeHandlers">container.findComponents( @org.seasar.directory.attribute.AttributeHandler@class)</property>
	</component>
	<component class="org.seasar.directory.impl.DirectoryValueTypeFactoryImpl"/>
	<component class="org.seasar.directory.dao.impl.DirectoryAnnotationReaderFactoryImpl"/>
	<component class="org.seasar.directory.dao.impl.DirectoryDaoMetaDataFactoryImpl"/>
	<component class="org.seasar.directory.dao.impl.DirectoryDaoNamingConventionImpl"/>

	<!-- interceptor -->
	<component name="interceptor"
		class="org.seasar.directory.dao.interceptors.S2DirectoryDaoInterceptor"/>
</components>

標準設定の説明