Package org.apache.turbine.services.pull
Interface PipelineDataApplicationTool
-
public interface PipelineDataApplicationTool
Interface for tools to be init'd and refreshed using a PipelineData object Code largely taken from ApplicationTool.- Author:
- Peter Courcoux
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
init(Object data)
Initialize the application tool.void
refresh(PipelineData data)
Refresh the application tool.
-
-
-
Method Detail
-
init
void 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 PipelineData
- 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. The next request on the session will cause the session tool to be refreshed iftools.per.request.refresh
is set totrue
inTurbineResources.properties
. You will then be able to get aUser
object from the instance ofPipelineData
.- Parameters:
data
- initialization data
-
refresh
void refresh(PipelineData data)
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- Parameters:
data
- The current PipelineData Object
-
-