org.apache.turbine.services.pull
Interface ApplicationTool

All Known Implementing Classes:

ContentTool, DateFormatter, HtmlPageAttributes, IntakeTool, LocalizationTool, OMTool, SchedulerTool, SessionData, SessionTool, TemplateLink, UIManager, UITool

public interface ApplicationTool

Tools that go into the Toolbox should implement this interface.

Version:

$Id: ApplicationTool.java 534527 2007-05-02 16:10:59Z tv $

Author:

Jason van Zyl

Method Summary

void	init(java.lang.Object data) Initialize the application tool.
void	refresh() Refresh the application tool.

Method Detail

init

public void init(java.lang.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 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

public void 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