org.apache.struts.tiles.definition
クラス ReloadableDefinitionsFactory

java.lang.Object
  org.apache.struts.tiles.definition.ReloadableDefinitionsFactory

すべての実装インタフェース:

ComponentDefinitionsFactory, java.io.Serializable

public class ReloadableDefinitionsFactory

extends java.lang.Object

implements ComponentDefinitionsFactory

A reloadable factory. This factory is the main entrance to any factory implementation. It takes in charge real implementation instance, and allows reloading by creating a new instance.

導入されたバージョン:

Struts 1.1

バージョン:

$Revision: 1.1 $ $Date: 2004/10/20 03:26:51 $

関連項目:

直列化された形式

入れ子クラスの概要

(パッケージプライベート) class

ReloadableDefinitionsFactory.ServletPropertiesMap Inner class.

フィールドの概要

static java.lang.String	DEFINITIONS_FACTORY_CLASSNAME Name of init property carrying factory class name.
protected ComponentDefinitionsFactory	factory The real factory instance.
protected java.util.Map	properties Initialization parameters.

コンストラクタの概要

ReloadableDefinitionsFactory(javax.servlet.ServletContext servletContext, java.util.Map properties)
Constructor.

ReloadableDefinitionsFactory(javax.servlet.ServletContext servletContext, javax.servlet.ServletConfig servletConfig)
Constructor.

メソッドの概要

ComponentDefinitionsFactory	createDefaultFactory(javax.servlet.ServletContext servletContext, java.util.Map properties) Create default Definition factory.
ComponentDefinitionsFactory	createFactory(javax.servlet.ServletContext servletContext, java.util.Map properties) Create Definition factory.
ComponentDefinitionsFactory	createFactoryFromClassname(javax.servlet.ServletContext servletContext, java.util.Map properties, java.lang.String classname) Create Definition factory from provided classname.
ComponentDefinition	getDefinition(java.lang.String definitionName, javax.servlet.ServletRequest request, javax.servlet.ServletContext servletContext) Get a definition by its name.
ComponentDefinitionsFactory	getFactory() Get underlying factory instance.
void	initFactory(javax.servlet.ServletContext servletContext, java.util.Map properties) Init factory.
void	reload(javax.servlet.ServletContext servletContext) Reload underlying factory.
java.lang.String	toString() Return String representation.

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

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

フィールドの詳細

factory

protected ComponentDefinitionsFactory factory

The real factory instance.

properties

protected java.util.Map properties

Initialization parameters.

DEFINITIONS_FACTORY_CLASSNAME

public static final java.lang.String DEFINITIONS_FACTORY_CLASSNAME

Name of init property carrying factory class name.

関連項目:

定数フィールド値

コンストラクタの詳細

ReloadableDefinitionsFactory

public ReloadableDefinitionsFactory(javax.servlet.ServletContext servletContext,
                                    javax.servlet.ServletConfig servletConfig)
                             throws DefinitionsFactoryException

Constructor. Create a factory according to servlet settings.

パラメータ:

servletContext - Our servlet context.

servletConfig - Our servlet config.

例外:

DefinitionsFactoryException - If factory creation fail.

ReloadableDefinitionsFactory

public ReloadableDefinitionsFactory(javax.servlet.ServletContext servletContext,
                                    java.util.Map properties)
                             throws DefinitionsFactoryException

Constructor. Create a factory according to servlet settings.

パラメータ:

servletContext - Our servlet context.

properties - Map containing all properties.

例外:

DefinitionsFactoryException - If factory creation fail.

メソッドの詳細

createFactoryFromClassname

public ComponentDefinitionsFactory createFactoryFromClassname(javax.servlet.ServletContext servletContext,
                                                              java.util.Map properties,
                                                              java.lang.String classname)
                                                       throws DefinitionsFactoryException

Create Definition factory from provided classname. If a factory class name is provided, a factory of this class is created. Otherwise, a default factory is created. Factory must have a constructor taking ServletContext and Map as parameter.

パラメータ:

classname - Class name of the factory to create.

servletContext - Servlet Context passed to newly created factory.

properties - Map of name/property passed to newly created factory.

戻り値:

newly created factory.

例外:

DefinitionsFactoryException - If an error occur while initializing factory

createDefaultFactory

public ComponentDefinitionsFactory createDefaultFactory(javax.servlet.ServletContext servletContext,
                                                        java.util.Map properties)
                                                 throws DefinitionsFactoryException

Create default Definition factory. Factory must have a constructor taking ServletContext and Map as parameter. In this implementation, default factory is of class I18nFactorySet

パラメータ:

servletContext - Servlet Context passed to newly created factory.

properties - Map of name/property passed to newly created factory.

戻り値:

newly created factory.

例外:

DefinitionsFactoryException - If an error occur while initializing factory

createFactory

public ComponentDefinitionsFactory createFactory(javax.servlet.ServletContext servletContext,
                                                 java.util.Map properties)
                                          throws DefinitionsFactoryException

Create Definition factory. Convenience method. ServletConfig is wrapped into a Map allowing retrieval of init parameters. Factory classname is also retrieved, as well as debug level. Finally, approriate createDefinitionsFactory() is called.

パラメータ:

servletContext - Servlet Context passed to newly created factory.

properties - Map containing all properties.

例外:

DefinitionsFactoryException

getDefinition

public ComponentDefinition getDefinition(java.lang.String definitionName,
                                         javax.servlet.ServletRequest request,
                                         javax.servlet.ServletContext servletContext)
                                  throws FactoryNotFoundException,
                                         DefinitionsFactoryException

Get a definition by its name. Call appropriate method on underlying factory instance. Throw appropriate exception if definition or definition factory is not found.

定義:

インタフェース ComponentDefinitionsFactory 内の getDefinition

パラメータ:

definitionName - Name of requested definition.

request - Current servlet request.

servletContext - Current servlet context.

例外:

FactoryNotFoundException - Can't find definition factory.

DefinitionsFactoryException - General error in factory while getting definition.

reload

public void reload(javax.servlet.ServletContext servletContext)
            throws DefinitionsFactoryException

Reload underlying factory. Reload is done by creating a new factory instance, and replacing the old instance with the new one.

パラメータ:

servletContext - Current servlet context.

例外:

DefinitionsFactoryException - If factory creation fails.

getFactory

public ComponentDefinitionsFactory getFactory()

Get underlying factory instance.

戻り値:

ComponentDefinitionsFactory

initFactory

public void initFactory(javax.servlet.ServletContext servletContext,
                        java.util.Map properties)
                 throws DefinitionsFactoryException

Init factory. This method is required by interface ComponentDefinitionsFactory. It is not used in this implementation, as it manages itself the underlying creation and initialization.

定義:

インタフェース ComponentDefinitionsFactory 内の initFactory

パラメータ:

servletContext - Servlet Context passed to newly created factory.

properties - Map of name/property passed to newly created factory. Map can contain more properties than requested.

例外:

DefinitionsFactoryException - An error occur during initialization.

toString

public java.lang.String toString()

Return String representation.

戻り値:

String representation.