| java.lang.Object
 org.apache.struts.tiles.TilesPlugin
| TilesPlugin | | public class TilesPlugin implements PlugIn(Code) | | Tiles Plugin used to initialize Tiles.
This plugin is to be used with Struts 1.1 in association with
TilesRequestProcessor .
This plugin creates one definition factory for each Struts-module. The definition factory
configuration is read first from 'web.xml' (backward compatibility), then it is
overloaded with values found in the plugin property values.
The plugin changes the Struts configuration by specifying a
TilesRequestProcessor as
request processor. If you want to use your own RequestProcessor,
it should subclass TilesRequestProcessor.
This plugin can also be used to create one single factory for all modules.
This behavior is enabled by specifying moduleAware=false in each
plugin properties. In this case, the definition factory
configuration file is read by the first Tiles plugin to be initialized. The order is
determined by the order of modules declaration in web.xml. The first module
is always the default one if it exists.
The plugin should be declared in each struts-config.xml file in order to
properly initialize the request processor.
since:
Struts 1.1 |
| currentPlugInConfigObject | | protected PlugInConfig currentPlugInConfigObject(Code) | | The plugin config object provided by the ActionServlet initializing
this plugin.
|
| log | | protected static Log log(Code) | | Commons Logging instance.
|
| moduleAware | | protected boolean moduleAware(Code) | | Is the factory module aware?
|
| tilesUtilImplClassname | | protected String tilesUtilImplClassname(Code) | | Tiles util implementation classname. This property can be set
by user in the plugin declaration.
|
| destroy | | public void destroy()(Code) | | End plugin.
|
| findStrutsPlugInConfigProperties | | protected Map findStrutsPlugInConfigProperties(ActionServlet servlet, ModuleConfig config) throws ServletException(Code) | | Find original properties set in the Struts PlugInConfig object.
First, we need to find the index of this plugin. Then we retrieve the array of configs
and then the object for this plugin.
Parameters:
servlet - ActionServlet that is managing all the modulesin this web application.
Parameters:
config - ModuleConfig for the module with whichthis plug in is associated.
exception:
ServletException - if this PlugIn cannotbe successfully initialized. |
| getTilesUtilImplClassname | | public String getTilesUtilImplClassname()(Code) | | Get Tiles util implemention classname.
The classname or null if none is set. |
| init | | public void init(ActionServlet servlet, ModuleConfig moduleConfig) throws ServletException(Code) | | Receive notification that the specified module is being
started up.
Parameters:
servlet - ActionServlet that is managing all the modulesin this web application.
Parameters:
moduleConfig - ModuleConfig for the module with whichthis plugin is associated.
exception:
ServletException - if this PlugIn cannotbe successfully initialized. |
| initRequestProcessorClass | | protected void initRequestProcessorClass(ModuleConfig config) throws ServletException(Code) | | Set RequestProcessor to appropriate Tiles
RequestProcessor .
First, check if a RequestProcessor is specified. If yes, check if it extends
the appropriate
TilesRequestProcessor class. If not, set processor class to
TilesRequestProcessor.
Parameters:
config - ModuleConfig for the module with whichthis plugin is associated.
throws:
ServletException - On errors. |
| isModuleAware | | public boolean isModuleAware()(Code) | | Get the module aware flag.
true: user wants a single factory instance,false: user wants multiple factory instances (one per module with Struts) |
| readFactoryConfig | | protected DefinitionsFactoryConfig readFactoryConfig(ActionServlet servlet, ModuleConfig config) throws ServletException(Code) | | Create FactoryConfig and initialize it from web.xml and struts-config.xml.
Parameters:
servlet - ActionServlet that is managing all the modulesin this web application.
Parameters:
config - ModuleConfig for the module with whichthis plugin is associated.
exception:
ServletException - if this PlugIn cannotbe successfully initialized. |
| setCurrentPlugInConfigObject | | public void setCurrentPlugInConfigObject(PlugInConfig plugInConfigObject)(Code) | | Method used by the ActionServlet initializing this plugin.
Set the plugin config object read from module config.
Parameters:
plugInConfigObject - PlugInConfig. |
| setModuleAware | | public void setModuleAware(boolean moduleAware)(Code) | | Set the module aware flag.
This flag is only meaningful if the property tilesUtilImplClassname is not
set.
Parameters:
moduleAware - true: user wants a single factory instance,false: user wants multiple factory instances (one per module with Struts) |
| setTilesUtilImplClassname | | public void setTilesUtilImplClassname(String tilesUtilImplClassname)(Code) | | Set Tiles util implemention classname.
If this property is set, the flag moduleAware will not be used anymore.
Parameters:
tilesUtilImplClassname - Classname. |
|
|