org.seasar.framework.container.factory
クラス SingletonS2ContainerFactory

java.lang.Object
  org.seasar.framework.container.factory.SingletonS2ContainerFactory

public final class SingletonS2ContainerFactory

extends Object

唯一のS2コンテナを提供するためのファクトリクラスです。

シングルトンS2コンテナファクトリは、設定ファイルに基づいてS2コンテナを生成・初期化し、それを保持します。 保持されるS2コンテナは、このクラスをロードしたクラスローダで一意になります。

デフォルトの設定ファイル名はapp.diconとなります。

シングルトンS2コンテナファクトリの標準的な利用方法としては、 アプリケーション開始時にinit()を呼び出して、 getContainer()でS2コンテナを取得し、 アプリケーション終了時にdestroy()を呼び出します。 WebアプリケーションであればServlet.init(javax.servlet.ServletConfig)でinit()を、 Servlet.destroy()でdestroy()を呼び出します。

作成者:

koichik, goto

メソッドの概要

static void	destroy() S2コンテナやその他の終了処理を行ないます。
static String	getConfigPath() 設定ファイルのファイルパスを返します。
static S2Container	getContainer() 唯一のS2コンテナを返します。
static ExternalContext	getExternalContext() 外部コンテキストを返します。
static ExternalContextComponentDefRegister	getExternalContextComponentDefRegister() 外部コンテキストコンポーネント定義レジスタを返します。
static boolean	hasContainer() S2コンテナを保持しているかどうかを返します。
static void	init() 設定ファイルに基づいてS2コンテナを生成・初期化し、それを保持します。
static void	setConfigPath(String path) 設定ファイルのファイルパスを設定します。
static void	setContainer(S2Container c) 保持するS2コンテナを設定します。
static void	setExternalContext(ExternalContext extCtx) 外部コンテキストを設定します。
static void	setExternalContextComponentDefRegister(ExternalContextComponentDefRegister extCtxComponentDefRegister) 外部コンテキストコンポーネント定義レジスタを設定します。

クラス java.lang.Object から継承したメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

メソッドの詳細

getConfigPath

public static String getConfigPath()

設定ファイルのファイルパスを返します。

戻り値:

設定ファイルのファイルパス

setConfigPath

public static void setConfigPath(String path)

設定ファイルのファイルパスを設定します。

パラメータ:

path - 設定ファイルのファイルパス

getExternalContext

public static ExternalContext getExternalContext()

外部コンテキストを返します。

戻り値:

外部コンテキスト

setExternalContext

public static void setExternalContext(ExternalContext extCtx)

外部コンテキストを設定します。

パラメータ:

extCtx - 外部コンテキスト

getExternalContextComponentDefRegister

public static ExternalContextComponentDefRegister getExternalContextComponentDefRegister()

外部コンテキストコンポーネント定義レジスタを返します。

戻り値:

外部コンテキストコンポーネント定義レジスタ

setExternalContextComponentDefRegister

public static void setExternalContextComponentDefRegister(ExternalContextComponentDefRegister extCtxComponentDefRegister)

外部コンテキストコンポーネント定義レジスタを設定します。

パラメータ:

extCtxComponentDefRegister - 外部コンテキストコンポーネント定義レジスタ

init

public static void init()

設定ファイルに基づいてS2コンテナを生成・初期化し、それを保持します。 既にS2コンテナが保持されている場合は何もしません。

S2コンテナを生成した後、 初期化を行なう前に必要に応じて、 外部コンテキストおよび外部コンテキストコンポーネント定義レジスタをS2コンテナに設定します。

関連項目:

S2ContainerFactory.create(String), ExternalContext, ExternalContextComponentDefRegister

destroy

public static void destroy()

S2コンテナやその他の終了処理を行ないます。

getContainer

public static S2Container getContainer()

唯一のS2コンテナを返します。 S2コンテナが保持されていない場合、 EmptyRuntimeExceptionをスローします。

戻り値:

S2コンテナ

setContainer

public static void setContainer(S2Container c)

保持するS2コンテナを設定します。

パラメータ:

c - S2コンテナ

hasContainer

public static boolean hasContainer()

S2コンテナを保持しているかどうかを返します。

戻り値:

S2コンテナを保持している場合はtrue、そうでない場合はfalse