| org.apache.turbine.services.pull.ApplicationTool
All known Subclasses: org.apache.turbine.services.pull.util.DateFormatter, org.apache.turbine.services.pull.util.SessionData, org.apache.turbine.services.pull.util.UIManager, org.apache.turbine.services.pull.tools.UITool, org.apache.turbine.services.pull.tools.TemplateLink, org.apache.turbine.services.pull.tools.ContentTool, org.apache.turbine.services.localization.LocalizationTool, org.apache.turbine.util.template.HtmlPageAttributes, org.apache.turbine.services.schedule.SchedulerTool, org.apache.turbine.services.session.SessionTool, org.apache.turbine.services.intake.IntakeTool, org.apache.turbine.om.OMTool,
| ApplicationTool | | public interface ApplicationTool (Code) | | Tools that go into the Toolbox should implement this interface.
author:
Jason van Zyl
version:
$Id: ApplicationTool.java 534527 2007-05-02 16:10:59Z tv $ |
| Method Summary | |
| void | init(Object data)
Initialize the application tool. | | void | refresh()
Refresh the application tool. |
| init | | void init(Object data)(Code) | | Initialize the application tool. The data parameter holds a different
type depending on how the tool is being instantiated:
- For global tools data will be null
- For request tools data will be of type RunData
- For session and authorized tools data will be of type User
It is possible that session scope tools will be initialized with a null
User object. This happens when the first request on a
session happens to the be login action.
If your session tool depends on having a User object, you
should look at implementing the
RunDataApplicationTool interface
instead.
Parameters:
data - initialization data |
| refresh | | void refresh()(Code) | | Refresh the application tool. This is
necessary for development work where you
probably want the tool to refresh itself
if it is using configuration information
that is typically cached after initialization
|
|
|