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

Packages that use PipelineData
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 modelled 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.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.velocity Velocity related utility code. 
 

Uses of PipelineData in org.apache.turbine
 

Methods in org.apache.turbine with parameters of type PipelineData
 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 RunData.
 

Uses of PipelineData in org.apache.turbine.modules
 

Methods in org.apache.turbine.modules with parameters of type PipelineData
protected  org.apache.ecs.ConcreteElement Screen.build(PipelineData pipelineData)
          Subclasses can override this method to add additional functionality.
protected  void Page.build(PipelineData pipelineData)
          Subclasses can override this method to add additional functionality.
protected  org.apache.ecs.ConcreteElement Navigation.build(PipelineData pipelineData)
          Subclasses can override this method to add additional functionality.
protected  void Layout.build(PipelineData pipelineData)
          Subclasses can override this method to add additional functionality.
protected  org.apache.ecs.ConcreteElement Screen.doBuild(PipelineData pipelineData)
          A subclass must override this method to build itself.
protected  void Page.doBuild(PipelineData pipelineData)
          A subclass must override this method to build itself.
protected  org.apache.ecs.ConcreteElement Navigation.doBuild(PipelineData pipelineData)
          A subclass must override this method to build itself.
protected  void Layout.doBuild(PipelineData pipelineData)
          A subclass must override this method to perform itself.
 void ActionEvent.doPerform(PipelineData pipelineData)
          You need to implement this in your classes that extend this class.
 void Action.doPerform(PipelineData pipelineData)
          A subclass must override this method to perform itself.
 org.apache.ecs.ConcreteElement ScreenLoader.eval(PipelineData pipelineData, String name)
          Attempts to load and execute the external Screen.
 org.apache.ecs.ConcreteElement NavigationLoader.eval(PipelineData pipelineData, String name)
          Attempts to load and execute the external Navigation.
 void ScreenLoader.exec(PipelineData pipelineData, String name)
          Attempts to load and execute the Screen.
 void PageLoader.exec(PipelineData pipelineData, String name)
          Attempts to load and execute the external page.
 void NavigationLoader.exec(PipelineData pipelineData, String name)
          Attempts to load and execute the external Navigation.
 void LayoutLoader.exec(PipelineData pipelineData, String name)
          Attempts to load and execute the external layout.
 void GenericLoader.exec(PipelineData pipelineData, String name)
          Attempts to load and execute the external action that has been set.
 void ActionLoader.exec(PipelineData pipelineData, String name)
          Attempts to load and execute the external action.
 void ActionEvent.executeEvents(PipelineData pipelineData)
          This method should be called to execute the event based system.
 String Screen.getLayout(PipelineData pipelineData)
          If the Layout has not been defined by the Screen then set the layout to be "DefaultLayout".
 RunData Assembler.getRunData(PipelineData pipelineData)
          This can go once RunData is replaced...
protected  void ActionEvent.perform(PipelineData pipelineData)
          This overrides the default Action.perform() to execute the doEvent() method.
protected  void Action.perform(PipelineData pipelineData)
          Subclasses can override this method to add additional functionality.
 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
 void VelocityAction.doPerform(PipelineData pipelineData)
          You SHOULD NOT override this method and implement it in your action.
 void LogoutUser.doPerform(PipelineData pipelineData)
          Clears the RunData user object back to an anonymous status not logged in, and with a null ACL.
 void LoginUser.doPerform(PipelineData pipelineData)
          Deprecated. Updates the user's LastLogin timestamp, sets their state to "logged in" and calls RunData.setUser() .
 void InitContextsAction.doPerform(PipelineData pipelineData)
          This action will place the contexts defined in the TurbineResources instance (if any) into the data.contexts Hashtable.
 void DefaultAction.doPerform(PipelineData pipelineData)
          Execute the action.
 void AccessController.doPerform(PipelineData pipelineData)
          If there is a user and the user is logged in, doPerform will set the RunData ACL.
 void VelocitySecureAction.doPerform(PipelineData pipelineData, org.apache.velocity.context.Context context)
          Implement this to add information to the context.
 void VelocityAction.doPerform(PipelineData pipelineData, org.apache.velocity.context.Context context)
          You SHOULD override this method and implement it in your action.
protected  org.apache.velocity.context.Context VelocityAction.getContext(PipelineData pipelineData)
          Return the Context needed by Velocity.
protected  boolean VelocitySecureAction.isAuthorized(PipelineData pipelineData)
          Implement this method to perform the security check needed.
protected  void VelocitySecureAction.perform(PipelineData pipelineData)
          This method overrides the method in WebMacroSiteAction to perform a security check first.
protected  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 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
 void TemplateSessionValidator.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 DefaultSessionValidator.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
 void VelocityXslLayout.doBuild(PipelineData pipelineData)
          Build the layout.
 void VelocityOnlyLayout.doBuild(PipelineData pipelineData)
          Build the layout.
 void VelocityDirectLayout.doBuild(PipelineData pipelineData)
          Method called by LayoutLoader.
 void JspLayout.doBuild(PipelineData pipelineData)
          Method called by LayoutLoader.
 void DirectResponseLayout.doBuild(PipelineData pipelineData)
          Ensures that a direct response has been declared.
 

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

Methods in org.apache.turbine.modules.navigations with parameters of type PipelineData
 org.apache.ecs.ConcreteElement VelocityNavigation.buildTemplate(PipelineData pipelineData)
          This Builds the Velocity template.
 org.apache.ecs.ConcreteElement TemplateNavigation.buildTemplate(PipelineData pipelineData)
          This Builds the WebMacro/FreeMarker/etc template.
 org.apache.ecs.ConcreteElement BaseJspNavigation.buildTemplate(PipelineData pipelineData)
          Method that sets up beans and forward the request to the JSP.
protected  org.apache.ecs.ConcreteElement TemplateNavigation.doBuild(PipelineData pipelineData)
          Calls doBuildTemplate() and then buildTemplate().
protected  void VelocityNavigation.doBuildTemplate(PipelineData pipelineData)
          Needs to be implemented to make TemplateNavigation like us.
protected  void TemplateNavigation.doBuildTemplate(PipelineData pipelineData)
          WebMacro Navigations extending this class should overide this method to perform any particular business logic and add information to the context.
protected  void BaseJspNavigation.doBuildTemplate(PipelineData pipelineData)
          Method to be overidden by subclasses to include data in beans, etc.
protected  void VelocityNavigation.doBuildTemplate(PipelineData pipelineData, org.apache.velocity.context.Context context)
          Velocity Navigations extending this class should overide 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
 void DefaultPage.doBuild(PipelineData pipelineData)
          Builds the Page.
protected  void TemplatePage.doBuildAfterAction(PipelineData pipelineData)
          Works with TemplateService to set up default templates and corresponding class modules.
protected  void DefaultPage.doBuildAfterAction(PipelineData pipelineData)
          Can be overridden by template Pages to set up data needed to process a template.
protected  void VelocityPage.doBuildBeforeAction(PipelineData pipelineData)
          Stuffs the Context into the RunData 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 DefaultPage.doBuildBeforeAction(PipelineData pipelineData)
          Can be used by template Pages to stuff the Context into the RunData so that it is available to the Action module and the Screen module via getContext().
protected  void VelocityPage.doPostBuild(PipelineData pipelineData)
          Allows the VelocityService to peform post-request actions.
protected  void DefaultPage.doPostBuild(PipelineData pipelineData)
          Can be overridden to perform actions when the request is fully processed.
 

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

Methods in org.apache.turbine.modules.screens with parameters of type PipelineData
 org.apache.ecs.ConcreteElement VelocityScreen.buildTemplate(PipelineData pipelineData)
          This builds the Velocity template.
 org.apache.ecs.ConcreteElement VelocityDirectScreen.buildTemplate(PipelineData pipelineData)
          This builds the Velocity template.
 org.apache.ecs.ConcreteElement TemplateScreen.buildTemplate(PipelineData pipelineData)
          This method should be implemented by Base template classes.
 org.apache.ecs.ConcreteElement BaseJspScreen.buildTemplate(PipelineData pipelineData)
          Method that sets up beans and forward the request to the JSP.
protected  org.apache.ecs.ConcreteElement TemplateScreen.doBuild(PipelineData pipelineData)
          This method is called by the Screenloader to construct the Screen.
protected  org.apache.ecs.ConcreteElement RawScreen.doBuild(PipelineData pipelineData)
          Build the Screen.
 org.apache.ecs.ConcreteElement Error.doBuild(PipelineData pipelineData)
          Build screen.
protected  void VelocitySecureScreen.doBuildTemplate(PipelineData pipelineData)
          This method overrides the method in VelocityScreen to perform a security check first.
protected  void VelocityScreen.doBuildTemplate(PipelineData pipelineData)
          Needs to be implemented to make TemplateScreen like us.
protected  void TemplateScreen.doBuildTemplate(PipelineData pipelineData)
          This method should be overidden by subclasses that wish to add specific business logic.
protected  void JspErrorScreen.doBuildTemplate(PipelineData pipelineData)
           
protected  void BaseJspScreen.doBuildTemplate(PipelineData pipelineData)
          Method to be overidden by subclasses to include data in beans, etc.
protected  void VelocitySecureScreen.doBuildTemplate(PipelineData pipelineData, org.apache.velocity.context.Context context)
          Implement this to add information to the context.
protected  void VelocityScreen.doBuildTemplate(PipelineData pipelineData, org.apache.velocity.context.Context context)
          Velocity Screens extending this class should overide this method to perform any particular business logic and add information to the context.
protected  void VelocityErrorScreen.doBuildTemplate(PipelineData pipelineData, org.apache.velocity.context.Context context)
          Implement this to add information to the context.
protected  void RawScreen.doOutput(PipelineData pipelineData)
          Actually 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 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 RawScreen.getContentType(PipelineData pipelineData)
          Set the content type.
protected  String JSONScreen.getContentType(PipelineData pipelineData)
           
static org.apache.velocity.context.Context VelocityScreen.getContext(PipelineData pipelineData)
          Deprecated. Use TurbineVelocity.getContext(pipelineData)
 String RawScreen.getLayout(PipelineData pipelineData)
          The layout must be set to null.
protected  boolean VelocitySecureScreen.isAuthorized(PipelineData pipelineData)
          Implement this method to perform the security check needed.
protected abstract  boolean JSONSecureScreen.isAuthorized(PipelineData pipelineData)
          Override this method to perform the necessary security checks.
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
 org.apache.ecs.ConcreteElement InvalidState.doBuild(PipelineData pipelineData)
          Build the Screen.
 

Uses of PipelineData in org.apache.turbine.pipeline
 

Classes in org.apache.turbine.pipeline that implement PipelineData
 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
protected  void CleanUpValve.cleanUp(PipelineData pipelineData)
          Perform clean up after processing the request.
protected  void ExecutePageValve.executePage(PipelineData pipelineData)
          execute the page generation.
 RunData AbstractValve.getRunData(PipelineData pipelineData)
          utility for getting RunData out of the pielineData object.
 void TurbinePipeline.invoke(PipelineData pipelineData)
           
 void Pipeline.invoke(PipelineData data)
          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 Valve.invoke(PipelineData data, ValveContext context)
          Perform request processing as required by this Valve.
 void ExecutePageValve.invoke(PipelineData pipelineData, ValveContext context)
           
 void DetermineTargetValve.invoke(PipelineData pipelineData, ValveContext context)
           
 void DetermineRedirectRequestedValve.invoke(PipelineData pipelineData, ValveContext context)
           
 void DetermineActionValve.invoke(PipelineData pipelineData, ValveContext context)
           
 void DefaultSessionValidationValve.invoke(PipelineData pipelineData, ValveContext context)
           
 void DefaultSessionTimeoutValve.invoke(PipelineData pipelineData, ValveContext context)
           
 void DefaultLoginValve.invoke(PipelineData pipelineData, ValveContext context)
           
 void DefaultACLCreationValve.invoke(PipelineData pipelineData, ValveContext context)
           
 void CleanUpValve.invoke(PipelineData pipelineData, ValveContext context)
           
abstract  void AbstractValve.invoke(PipelineData data, ValveContext context)
           
 void ValveContext.invokeNext(PipelineData data)
          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.
 void TurbinePipeline.invokeNext(PipelineData pipelineData)
           
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
 void TurbineBaseService.init(PipelineData data)
          Performs early initialization.
 

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

Methods in org.apache.turbine.services.jsp with parameters of type PipelineData
static void TurbineJsp.addDefaultObjects(PipelineData pipelineData)
          Adds some convenience objects to the request.
static void TurbineJsp.handleRequest(PipelineData pipelineData, String templateName)
          executes the JSP given by templateName.
static void TurbineJsp.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
 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).
static void TurbinePull.populateContext(org.apache.velocity.context.Context context, PipelineData pipelineData)
          Populate the given context with all request, session and persistent scope tools (it is assumed that the context already wraps the global context, and thus already contains the global tools).
 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 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
 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
 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.velocity
 

Methods in org.apache.turbine.services.velocity with parameters of type PipelineData
 org.apache.velocity.context.Context VelocityService.getContext(PipelineData pipelineData)
          Create a Context from the RunData object.
 org.apache.velocity.context.Context TurbineVelocityService.getContext(PipelineData pipelineData)
          Create a Context from the PipelineData object.
static org.apache.velocity.context.Context TurbineVelocity.getContext(PipelineData pipelineData)
          This returns a Context that you can pass into handleRequest once you have populated it with information that the template will know about.
 

Uses of PipelineData in org.apache.turbine.util
 

Subinterfaces of PipelineData in org.apache.turbine.util
 interface RunData
          RunData is an interface to run-time information that is passed within Turbine.
 

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

Methods in org.apache.turbine.util.velocity with parameters of type PipelineData
 void VelocityActionEvent.doPerform(PipelineData pipelineData)
          You need to implement this in your classes that extend this class.
 void VelocityActionEvent.executeEvents(PipelineData pipelineData, org.apache.velocity.context.Context context)
          This method should be called to execute the event based system.
protected  void VelocityActionEvent.perform(PipelineData pipelineData)
          This overrides the default Action.perform() to execute the doEvent() method.
 

Constructors in org.apache.turbine.util.velocity with parameters of type PipelineData
VelocityHtmlEmail(PipelineData pipelineData)
          Constructor, sets the context object from the passed RunData object
 



Copyright © 2000-2011 The Apache Software Foundation. All Rights Reserved.