Uses of Interface
org.apache.turbine.pipeline.PipelineData

Packages that use PipelineData

Package	Description
org.apache.turbine	Turbine Servlet and Constants.
org.apache.turbine.modules	Modules (Action, Screen, Layout, Navigation, Page) classes for the Turbine view.
org.apache.turbine.modules.actions	Action class implementations.
org.apache.turbine.modules.actions.sessionvalidator	Session validator classes to be used with Turbine apps that use security.
org.apache.turbine.modules.layouts	Layout class implementations.
org.apache.turbine.modules.navigations	Navigation class implementations.
org.apache.turbine.modules.pages	Page class implementations.
org.apache.turbine.modules.screens	Screen class implementations.
org.apache.turbine.modules.screens.error	Error Screen classes.
org.apache.turbine.pipeline	The Turbine processing pipeline is modeled after the pipeline found in Tomcat 4.0.1 (Catalina), and after the module architecture found in Apache httpd.
org.apache.turbine.services	Contains the Service framework for Turbine.
org.apache.turbine.services.jsp	JSP Service is used to provide Turbine with a Java Server page (JSP) based view.
org.apache.turbine.services.pull	Provides application tools that are put into the context of a template view.
org.apache.turbine.services.rundata	Rundata Service provides a factory for the request cycle data objects.
org.apache.turbine.services.template	Template Service maps template references to a view service and a template name.
org.apache.turbine.services.urlmapper	Provide back-and-forth-mapping facilities for simplified URLs $Id$
org.apache.turbine.services.velocity	Velocity Service is used to provide Turbine with a Velocity based view.
org.apache.turbine.util	Various utilities used in Turbine and for Turbine based applications.
org.apache.turbine.util.template	Template related utilities.
org.apache.turbine.util.velocity	Velocity related utility code.

Uses of PipelineData in org.apache.turbine

Methods in org.apache.turbine with parameters of type PipelineData

Modifier and Type	Method	Description
protected void	Turbine.handleException(PipelineData pipelineData, HttpServletResponse res, Throwable t)	This method is about making sure that we catch and display errors to the screen in one fashion or another.
void	Turbine.init(PipelineData data)	Initializes the services which need PipelineData to initialize themselves (post startup).
static void	Turbine.saveServletInfo(PipelineData data)	Save some information about this servlet so that it can be utilized by object instances that do not have direct access to PipelineData.

Uses of PipelineData in org.apache.turbine.modules

Methods in org.apache.turbine.modules with parameters of type PipelineData

Modifier and Type	Method	Description
default void	Layout.build(PipelineData pipelineData)	Subclasses can override this method to add additional functionality.
default String	Navigation.build(PipelineData pipelineData)	Subclasses can override this method to add additional functionality.
default void	Page.build(PipelineData pipelineData)	Subclasses can override this method to add additional functionality.
default String	Screen.build(PipelineData pipelineData)	Subclasses can override this method to add additional functionality.
void	Layout.doBuild(PipelineData pipelineData)	A subclass must implement this method to perform itself.
String	Navigation.doBuild(PipelineData pipelineData)	A subclass must implement this method to build itself.
void	Page.doBuild(PipelineData pipelineData)	A subclass must override this method to build itself.
String	Screen.doBuild(PipelineData pipelineData)	A subclass must implement this method to build itself.
void	Action.doPerform(PipelineData pipelineData)	A subclass must implement this method to perform itself.
void	ActionEvent.doPerform(PipelineData pipelineData)	This overrides the default Action.doPerform() to execute the doEvent() method.
String	NavigationLoader.eval(PipelineData pipelineData, String name)	Attempts to load and execute the external Navigation.
String	ScreenLoader.eval(PipelineData pipelineData, String name)	Attempts to load and execute the external Screen.
void	ActionLoader.exec(PipelineData pipelineData, String name)	Attempts to load and execute the external action.
abstract void	GenericLoader.exec(PipelineData pipelineData, String name)	Attempts to load and execute the external action that has been set.
void	LayoutLoader.exec(PipelineData pipelineData, String name)	Attempts to load and execute the external layout.
void	NavigationLoader.exec(PipelineData pipelineData, String name)	Attempts to load and execute the external Navigation.
void	PageLoader.exec(PipelineData pipelineData, String name)	Attempts to load and execute the external page.
void	ScheduledJobLoader.exec(PipelineData pipelineData, String name)	Deprecated.
void	ScreenLoader.exec(PipelineData pipelineData, String name)	Attempts to load and execute the Screen.
default String	Screen.getLayout(PipelineData pipelineData)	If the Layout has not been defined by the Screen then set the layout to be "DefaultLayout".
default void	Action.perform(PipelineData pipelineData)	Subclasses can override this method to add additional functionality.
default void	Screen.setLayout(PipelineData pipelineData, String layout)	Set the layout for a Screen.

Uses of PipelineData in org.apache.turbine.modules.actions

Methods in org.apache.turbine.modules.actions with parameters of type PipelineData

Modifier and Type	Method	Description
void	AccessController.doPerform(PipelineData pipelineData)	If there is a user and the user is logged in, doPerform will set the RunData ACL.
void	DefaultAction.doPerform(PipelineData pipelineData)	Execute the action.
void	InitContextsAction.doPerform(PipelineData pipelineData)	This action will place the contexts defined in the TurbineResources instance (if any) into the data.contexts Hashtable.
void	LegacyVelocityAction.doPerform(PipelineData pipelineData)	Deprecated. This overrides the default Action.doPerform() to execute the doEvent() method.
void	LegacyVelocityAction.doPerform(PipelineData pipelineData, org.apache.velocity.context.Context context)	Deprecated. Adapter method for legacy signature
void	LoginUser.doPerform(PipelineData pipelineData)	Updates the user's LastLogin timestamp, sets their state to "logged in" and calls RunData.setUser() .
void	LogoutUser.doPerform(PipelineData pipelineData)	Clears the PipelineData user object back to an anonymous status not logged in, and with a null ACL.
abstract void	VelocityAction.doPerform(PipelineData pipelineData, org.apache.velocity.context.Context context)	You SHOULD override this method and implement it in your action.
protected abstract boolean	VelocitySecureAction.isAuthorized(PipelineData pipelineData)	Implement this method to perform the security check needed.
void	LegacyVelocitySecureAction.perform(PipelineData pipelineData)	Deprecated. This method overrides the method in VelocityAction to perform a security check first.
void	VelocityAction.perform(PipelineData pipelineData)	Sets up the context and then calls super.perform(); thus, subclasses don't have to worry about getting a context themselves!
void	VelocitySecureAction.perform(PipelineData pipelineData)	This method overrides the method in VelocityAction to perform a security check first.
void	VelocityAction.setTemplate(PipelineData pipelineData, String template)	This method is used when you want to short circuit an Action and change the template that will be executed next.

Uses of PipelineData in org.apache.turbine.modules.actions.sessionvalidator

Methods in org.apache.turbine.modules.actions.sessionvalidator with parameters of type PipelineData

Modifier and Type	Method	Description
void	DefaultSessionValidator.doPerform(PipelineData pipelineData)	Execute the action.
void	TemplateSecureSessionValidator.doPerform(PipelineData pipelineData)	doPerform is virtually identical to DefaultSessionValidator except that it calls template methods instead of bare screen methods.
void	TemplateSessionValidator.doPerform(PipelineData pipelineData)	Execute the action.

Uses of PipelineData in org.apache.turbine.modules.layouts

Methods in org.apache.turbine.modules.layouts with parameters of type PipelineData

Modifier and Type	Method	Description
void	DirectResponseLayout.doBuild(PipelineData pipelineData)	Ensures that a direct response has been declared.
void	JspLayout.doBuild(PipelineData pipelineData)	Method called by LayoutLoader.
void	VelocityLayout.doBuild(PipelineData pipelineData)	Method called by LayoutLoader.
void	VelocityXslLayout.doBuild(PipelineData pipelineData)	Build the layout.
protected void	VelocityDirectLayout.populateContext(PipelineData pipelineData, org.apache.velocity.context.Context context)
protected abstract void	VelocityLayout.populateContext(PipelineData pipelineData, org.apache.velocity.context.Context context)	Populate Velocity context
protected void	VelocityOnlyLayout.populateContext(PipelineData pipelineData, org.apache.velocity.context.Context context)
protected void	VelocityCachedLayout.render(PipelineData pipelineData, org.apache.velocity.context.Context context, String templateName)	Render layout
protected void	VelocityLayout.render(PipelineData pipelineData, org.apache.velocity.context.Context context, String templateName)	Render layout

Uses of PipelineData in org.apache.turbine.modules.navigations

Methods in org.apache.turbine.modules.navigations with parameters of type PipelineData

Modifier and Type	Method	Description
String	BaseJspNavigation.buildTemplate(PipelineData pipelineData)	Method that sets up beans and forward the request to the JSP.
abstract String	TemplateNavigation.buildTemplate(PipelineData pipelineData)	This Builds the WebMacro/FreeMarker/etc template.
String	VelocityNavigation.buildTemplate(PipelineData pipelineData)	This builds the Velocity template.
String	TemplateNavigation.doBuild(PipelineData pipelineData)	Calls doBuildTemplate() and then buildTemplate().
protected void	BaseJspNavigation.doBuildTemplate(PipelineData pipelineData)	Method to be overridden by subclasses to include data in beans, etc.
protected void	LegacyVelocityNavigation.doBuildTemplate(PipelineData pipelineData, org.apache.velocity.context.Context context)	Deprecated. Adapter method
protected abstract void	TemplateNavigation.doBuildTemplate(PipelineData pipelineData)	WebMacro Navigations extending this class should override this method to perform any particular business logic and add information to the context.
protected void	VelocityNavigation.doBuildTemplate(PipelineData pipelineData)	Needs to be implemented to make TemplateNavigation like us.
protected void	VelocityNavigation.doBuildTemplate(PipelineData pipelineData, org.apache.velocity.context.Context context)	Velocity Navigations extending this class should override this method to perform any particular business logic and add information to the context.

Uses of PipelineData in org.apache.turbine.modules.pages

Methods in org.apache.turbine.modules.pages with parameters of type PipelineData

Modifier and Type	Method	Description
void	DefaultPage.doBuild(PipelineData pipelineData)	Builds the Page.
protected void	DefaultPage.doBuildAfterAction(PipelineData pipelineData)	Can be overridden by template Pages to set up data needed to process a template.
protected void	TemplatePage.doBuildAfterAction(PipelineData pipelineData)	Works with TemplateService to set up default templates and corresponding class modules.
protected void	DefaultPage.doBuildBeforeAction(PipelineData pipelineData)	Can be used by template Pages to stuff the Context into the PipelineData so that it is available to the Action module and the Screen module via getContext().
protected void	JspPage.doBuildBeforeAction(PipelineData pipelineData)	Stuffs some useful objects into the request so that it is available to the Action module and the Screen module
protected void	VelocityPage.doBuildBeforeAction(PipelineData pipelineData)	Stuffs the Context into the PipelineData so that it is available to the Action module and the Screen module via getContext().
protected void	DefaultPage.doPostBuild(PipelineData pipelineData)	Can be overridden to perform actions when the request is fully processed.
protected void	VelocityPage.doPostBuild(PipelineData pipelineData)	Allows the VelocityService to perform post-request actions.

Uses of PipelineData in org.apache.turbine.modules.screens

Methods in org.apache.turbine.modules.screens with parameters of type PipelineData

Modifier and Type	Method	Description
String	BaseJspScreen.buildTemplate(PipelineData pipelineData)	Method that sets up beans and forward the request to the JSP.
abstract String	TemplateScreen.buildTemplate(PipelineData pipelineData)	This method should be implemented by Base template classes.
String	VelocityCachedScreen.buildTemplate(PipelineData pipelineData)	This builds the Velocity template.
String	VelocityDirectScreen.buildTemplate(PipelineData pipelineData)	This builds the Velocity template.
String	VelocityScreen.buildTemplate(PipelineData pipelineData)	This builds the Velocity template.
String	RawScreen.doBuild(PipelineData pipelineData)	Build the Screen.
String	TemplateScreen.doBuild(PipelineData pipelineData)	This method is called by the Screenloader to construct the Screen.
protected void	BaseJspScreen.doBuildTemplate(PipelineData pipelineData)	Method to be overridden by subclasses to include data in beans, etc.
protected void	JspErrorScreen.doBuildTemplate(PipelineData pipelineData)
protected void	LegacyVelocityScreen.doBuildTemplate(PipelineData pipelineData, org.apache.velocity.context.Context context)	Deprecated. Adapter method
protected void	LegacyVelocitySecureScreen.doBuildTemplate(PipelineData pipelineData)	Deprecated. This method overrides the method in VelocityScreen to perform a security check first.
protected abstract void	TemplateScreen.doBuildTemplate(PipelineData pipelineData)	This method should be overridden by subclasses that wish to add specific business logic.
protected void	VelocityErrorScreen.doBuildTemplate(PipelineData pipelineData, org.apache.velocity.context.Context context)	Implement this to add information to the context.
protected void	VelocityScreen.doBuildTemplate(PipelineData pipelineData)	Needs to be implemented to make TemplateScreen like us.
protected void	VelocityScreen.doBuildTemplate(PipelineData pipelineData, org.apache.velocity.context.Context context)	Velocity Screens extending this class should override this method to perform any particular business logic and add information to the context.
protected void	VelocitySecureScreen.doBuildTemplate(PipelineData pipelineData)	This method overrides the method in VelocityScreen to perform a security check first.
protected abstract void	VelocitySecureScreen.doBuildTemplate(PipelineData pipelineData, org.apache.velocity.context.Context context)	Implement this to add information to the context.
protected void	JSONScreen.doOutput(PipelineData pipelineData)	Output the dynamic content.
protected void	JSONSecureScreen.doOutput(PipelineData pipelineData)	This method overrides the method in JSONScreen to perform a security check prior to producing the output.
protected void	PlainJSONScreen.doOutput(PipelineData pipelineData)	Output JSON content set into RunData.getMessage().
void	PlainJSONSecureAnnotatedScreen.doOutput(PipelineData pipelineData)	This method overrides the method in JSONScreen to perform a security check prior to producing the output.
protected abstract void	RawScreen.doOutput(PipelineData pipelineData)	Actually output the dynamic content.
protected void	TemplateScreen.doPostBuildTemplate(PipelineData pipelineData)	This method can be overridden to write code that executes when the template has been built (called from a finally clause, so executes regardless of whether an exception is thrown or not)
void	TemplateScreen.doRedirect(PipelineData pipelineData, String template)	You can call this within a Screen to cause an internal redirect to happen.
void	TemplateScreen.doRedirect(PipelineData pipelineData, String screen, String template)	You can call this within a Screen to cause an internal redirect to happen.
protected String	JSONScreen.getContentType(PipelineData pipelineData)
protected String	PlainJSONScreen.getContentType(PipelineData pipelineData)
protected abstract String	RawScreen.getContentType(PipelineData pipelineData)	Set the content type.
String	RawScreen.getLayout(PipelineData pipelineData)	The layout must be set to null.
protected abstract boolean	JSONSecureScreen.isAuthorized(PipelineData pipelineData)	Override this method to perform the necessary security checks.
protected boolean	PlainJSONSecureAnnotatedScreen.isAuthorized(PipelineData pipelineData)	Use this method to perform the necessary security check with Turbine annotations TurbineRequiredRole in a newly overridden PlainJSONSecureAnnotatedScreen.doOutput(PipelineData) method.
protected abstract boolean	VelocitySecureScreen.isAuthorized(PipelineData pipelineData)	Implement this method to perform the security check needed.
static void	TemplateScreen.setTemplate(PipelineData pipelineData, String template)	This method is used when you want to short circuit a Screen and change the template that will be executed next.

Uses of PipelineData in org.apache.turbine.modules.screens.error

Methods in org.apache.turbine.modules.screens.error with parameters of type PipelineData

Modifier and Type	Method	Description
String	InvalidState.doBuild(PipelineData pipelineData)	Build the Screen.

Uses of PipelineData in org.apache.turbine.pipeline

Classes in org.apache.turbine.pipeline that implement PipelineData

Modifier and Type	Class	Description
class	DefaultPipelineData	A PipelineData is a holder for data being passed from one Valve to the next.

Methods in org.apache.turbine.pipeline with parameters of type PipelineData

Modifier and Type	Method	Description
protected void	CleanUpValve.cleanUp(PipelineData pipelineData)	Perform clean up after processing the request.
protected void	ExecutePageValve.executePage(PipelineData pipelineData)	execute the page generation.
void	CleanUpValve.invoke(PipelineData pipelineData, ValveContext context)
void	DefaultACLCreationValve.invoke(PipelineData pipelineData, ValveContext context)
void	DefaultLoginValve.invoke(PipelineData pipelineData, ValveContext context)
void	DefaultSessionTimeoutValve.invoke(PipelineData pipelineData, ValveContext context)	Deprecated.
void	DefaultSessionValidationValve.invoke(PipelineData pipelineData, ValveContext context)
void	DefaultSetEncodingValve.invoke(PipelineData pipelineData, ValveContext context)
void	DetermineActionValve.invoke(PipelineData pipelineData, ValveContext context)
void	DetermineRedirectRequestedValve.invoke(PipelineData pipelineData, ValveContext context)
void	DetermineTargetValve.invoke(PipelineData pipelineData, ValveContext context)
void	ExecutePageValve.invoke(PipelineData pipelineData, ValveContext context)
void	Pipeline.invoke(PipelineData pipelineData)	Cause the specified request and response to be processed by the sequence of Valves associated with this pipeline, until one of these Valves decides to end the processing.
void	TurbinePipeline.invoke(PipelineData pipelineData)
void	Valve.invoke(PipelineData pipelineData, ValveContext context)	Perform request processing as required by this Valve.
void	TurbinePipeline.invokeNext(PipelineData pipelineData)
void	ValveContext.invokeNext(PipelineData pipelineData)	Cause the invoke() method of the next Valve that is part of the Pipeline currently being processed (if any) to be executed, passing on the specified request and response objects plus this ValveContext instance.
protected void	DefaultLoginValve.process(PipelineData pipelineData)	Handles user sessions, parsing of the action from the query string, and access control.
protected void	DetermineRedirectRequestedValve.redirectRequested(PipelineData pipelineData)	Perform clean up after processing the request.

Uses of PipelineData in org.apache.turbine.services

Methods in org.apache.turbine.services with parameters of type PipelineData

Modifier and Type	Method	Description
void	TurbineBaseService.init(PipelineData pipelineData)	Performs early initialization.

Uses of PipelineData in org.apache.turbine.services.jsp

Methods in org.apache.turbine.services.jsp with parameters of type PipelineData

Modifier and Type	Method	Description
void	JspService.addDefaultObjects(PipelineData pipelineData)	Adds some convenience objects to the request.
void	TurbineJspService.addDefaultObjects(PipelineData pipelineData)	Adds some convenience objects to the request.
void	JspService.handleRequest(PipelineData pipelineData, String templateName)	executes the JSP given by templateName.
void	JspService.handleRequest(PipelineData pipelineData, String templateName, boolean isForward)	executes the JSP given by templateName.
void	TurbineJspService.handleRequest(PipelineData pipelineData, String templateName)	executes the JSP given by templateName.
void	TurbineJspService.handleRequest(PipelineData pipelineData, String templateName, boolean isForward)	executes the JSP given by templateName.

Uses of PipelineData in org.apache.turbine.services.pull

Methods in org.apache.turbine.services.pull with parameters of type PipelineData

Modifier and Type	Method	Description
void	PullService.populateContext(org.apache.velocity.context.Context context, PipelineData pipelineData)	Populate the given context with all request, session, authorized and persistent scope tools (it is assumed that the context already wraps the global context, and thus already contains the global tools).
void	TurbinePullService.populateContext(org.apache.velocity.context.Context context, PipelineData pipelineData)	Populate the given context with all request, session, authorized and persistent scope tools (it is assumed that the context already wraps the global context, and thus already contains the global tools).
void	PipelineDataApplicationTool.refresh(PipelineData data)	Refresh the application tool.

Uses of PipelineData in org.apache.turbine.services.rundata

Subinterfaces of PipelineData in org.apache.turbine.services.rundata

Modifier and Type	Interface	Description
interface	TurbineRunData	TurbineRunData is an extension to the RunData interface to be implemented by RunData implementations to be distributed by the Turbine RunData Service.

Classes in org.apache.turbine.services.rundata that implement PipelineData

Modifier and Type	Class	Description
class	DefaultTurbineRunData	DefaultTurbineRunData is the default implementation of the TurbineRunData interface, which is distributed by the Turbine RunData service, if another implementation is not defined in the default or specified RunData configuration.

Uses of PipelineData in org.apache.turbine.services.template

Methods in org.apache.turbine.services.template with parameters of type PipelineData

Modifier and Type	Method	Description
String	TemplateService.getDefaultLayoutName(PipelineData pipelineData)	Find the default layout module name for the given request.
String	TurbineTemplateService.getDefaultLayoutName(PipelineData pipelineData)	Find the default layout module name for the given request.
String	TemplateService.getDefaultPageName(PipelineData pipelineData)	Find the default page module name for the given request.
String	TurbineTemplateService.getDefaultPageName(PipelineData pipelineData)	Find the default page module name for the given request.

Uses of PipelineData in org.apache.turbine.services.urlmapper

Methods in org.apache.turbine.services.urlmapper with parameters of type PipelineData

Modifier and Type	Method	Description
void	URLMapperValve.invoke(PipelineData pipelineData, ValveContext context)

Uses of PipelineData in org.apache.turbine.services.velocity

Methods in org.apache.turbine.services.velocity with parameters of type PipelineData

Modifier and Type	Method	Description
org.apache.velocity.context.Context	TurbineVelocityService.getContext(PipelineData pipelineData)	Create a Context from the PipelineData object.
org.apache.velocity.context.Context	VelocityService.getContext(PipelineData pipelineData)	Create a Context from the PipelineData object.

Uses of PipelineData in org.apache.turbine.util

Subinterfaces of PipelineData in org.apache.turbine.util

Modifier and Type	Interface	Description
interface	RunData	RunData is an interface to run-time information that is passed within Turbine.

Methods in org.apache.turbine.util with parameters of type PipelineData

Modifier and Type	Method	Description
static void	HttpUtils.setCacheHeaders(PipelineData pipelineData, int expiry)	This method sets the required expiration headers in the response for a given PipelineData object.

Uses of PipelineData in org.apache.turbine.util.template

Constructors in org.apache.turbine.util.template with parameters of type PipelineData

Constructor	Description
TemplateNavigation(PipelineData pipelineData)	Constructor
TemplateScreen(PipelineData pipelineData)	Constructor
TemplateSecurityCheck(PipelineData pipelineData)	Generic Constructor.
TemplateSecurityCheck(PipelineData pipelineData, String message)	Constructor.

Uses of PipelineData in org.apache.turbine.util.velocity

Methods in org.apache.turbine.util.velocity with parameters of type PipelineData

Modifier and Type	Method	Description
void	VelocityActionEvent.doPerform(PipelineData pipelineData)	This overrides the default Action.doPerform() to execute the doEvent() method.