Package org.apache.turbine.services.pull
Interface ApplicationTool
- 
- All Known Implementing Classes:
- ContentTool,- DateFormatter,- DateTimeFormatterTool,- HtmlPageAttributes,- IntakeTool,- LocalizationTool,- MappedTemplateLink,- OMTool,- SchedulerTool,- SessionData,- SessionTool,- TemplateLink,- UITool
 
 public interface ApplicationTool Tools that go into the Toolbox should implement this interface.- Version:
- $Id$
- Author:
- Jason van Zyl
 
- 
- 
Method SummaryAll Methods Instance Methods Abstract Methods Modifier and Type Method Description voidinit(Object data)Initialize the application tool.voidrefresh()Refresh the application tool.
 
- 
- 
- 
Method Detail- 
initvoid init(Object data) 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 Userobject. This happens when the first request on a session happens to the be login action.If your session tool depends on having a Userobject, you should look at implementing theRunDataApplicationToolinterface instead.- Parameters:
- data- initialization data
 
 - 
refreshvoid refresh() 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
 
- 
 
-