| <!DOCTYPE html> |
| |
| |
| <!-- |
| | Generated by Apache Maven Doxia Site Renderer 2.0.0 from src/site/xdoc/howto/pullmodel-howto.xml at 10 Sep 2025 |
| | Rendered using Apache Maven Fluido Skin 2.1.0 |
| --> |
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1" /> |
| <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0" /> |
| <title>Pull Model Howto – Apache Turbine</title> |
| <link rel="stylesheet" href="../css/apache-maven-fluido-2.1.0.min.css" /> |
| <link rel="stylesheet" href="../css/site.css" /> |
| <link rel="stylesheet" href="../css/print.css" media="print" /> |
| <script src="../js/apache-maven-fluido-2.1.0.min.js"></script> |
| <link rel="icon" type="image/png" sizes="48x48" href="https://apache.org/favicons/favicon.ico"> |
| <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> |
| <style>.github-fork-ribbon:before { background-color: orange; }</style> |
| </head> |
| <body> |
| <a class="github-fork-ribbon right-top" href="https://github.com/apache/turbine-build" data-ribbon="Fork me on GitHub">Fork me on GitHub</a> |
| <div class="container-fluid container-fluid-top"> |
| <header> |
| <div id="banner"> |
| <div class="pull-left"><div id="bannerLeft"><h1><a href="https://turbine.apache.org/"><img src="https://www.apache.org/img/feather_glyph_notm.png" style="width: 50px;" /> The Apache Turbine project</a></h1></div></div> |
| <div class="pull-right"><div id="bannerRight"><h1><a href="https://turbine.apache.org/"><img src="https://turbine.apache.org/images/logo.gif" alt="Apache Turbine" /></a></h1></div></div> |
| <div class="clear"><hr/></div> |
| </div> |
| |
| <div id="breadcrumbs"> |
| <ul class="breadcrumb"> |
| <li id="publishDate">Last Published: 01 Apr 2025<span class="divider">|</span> |
| </li> |
| <li id="projectVersion">Version: 7.1-SNAPSHOT</li> |
| <li class="pull-right"><span class="divider">|</span> |
| <a href="https://turbine.apache.org/fulcrum/">Fulcrum</a></li> |
| <li class="pull-right"><span class="divider">|</span> |
| <a href="https://turbine.apache.org/">Turbine</a></li> |
| <li class="pull-right"><a href="https://www.apache.org">Apache</a></li> |
| </ul> |
| </div> |
| </header> |
| <div class="row-fluid"> |
| <header id="leftColumn" class="span2"> |
| <nav class="well sidebar-nav"> |
| <ul class="nav nav-list"> |
| <li class="nav-header">General Information</li> |
| <li><a href="../index.html">Overview</a></li> |
| <li><a href="../features.html">Features</a></li> |
| <li><a href="../fsd.html">Specification</a></li> |
| <li><a href="../getting-started.html">Getting Started</a></li> |
| <li><a href="../how-to-build.html">Howto Build Turbine</a></li> |
| <li><a href="../changes-report.html">Changes</a></li> |
| <li class="nav-header">Documentation</li> |
| <li><a href="../services/index.html"><span class="icon-chevron-right"></span>Services</a></li> |
| <li><a href="../howto/index.html"><span class="icon-chevron-down"></span>Howtos</a> |
| <ul class="nav nav-list"> |
| <li><a href="../howto/action-event-howto.html">Action Events Howto</a></li> |
| <li><a href="../howto/annotations.html">Annotations Howto</a></li> |
| <li><a href="../howto/configuration-howto.html">Configuration Howto</a></li> |
| <li><a href="../howto/extend-user-howto.html">Extend User Howto</a></li> |
| <li><a href="../howto/hibernate-howto.html">Hibernate OM Howto</a></li> |
| <li><a href="../howto/intake-howto.html">Intake Howto</a></li> |
| <li><a href="../howto/jsp-howto.html">JSP Howto</a></li> |
| <li><a href="../howto/migrate-from-2_1-howto.html">Migrating from 2.1 to 2.2</a></li> |
| <li><a href="../howto/migrate-from-2_2-howto.html">Migrating from 2.2 to 2.3</a></li> |
| <li><a href="../howto/migrate-from-2_3-howto.html">Migrating from 2.3 to 4.0</a></li> |
| <li><a href="../howto/migrate-from-4_0-howto.html">Migrating from 4.0 to 5.0</a></li> |
| <li class="active"><a>Pull Model Howto</a></li> |
| <li><a href="../howto/python-howto.html">Python Howto</a></li> |
| <li><a href="../howto/security-howto.html">Security Howto</a></li> |
| <li><a href="../howto/services-howto.html">Services Howto</a></li> |
| <li><a href="../howto/url-mapper-howto.html">URL Mapper Howto</a></li> |
| <li><a href="../howto/url-rewriting-howto.html">URL Rewriting Howto</a></li> |
| <li><a href="../howto/context-howto.html">Velocity Context Howto</a></li> |
| <li><a href="../howto/velocity-site-howto.html">Velocity Site Howto</a></li> |
| <li><a href="../howto/velocityonlylayout-howto.html">VelocityOnlyLayout Howto</a></li> |
| </ul></li> |
| <li><a href="https://cwiki.apache.org/confluence/display/TURBINE">Wiki</a></li> |
| <li><a href="../apidocs/index.html">JavaDocs</a></li> |
| <li class="nav-header">Development</li> |
| <li><a href="../proposals.html">Proposals</a></li> |
| <li><a href="../how-to-help.html">How To Help</a></li> |
| <li><a href="../todo.html">Todo</a></li> |
| <li class="nav-header">Project Documentation</li> |
| <li><a href="../project-info.html"><span class="icon-chevron-right"></span>Project Information</a></li> |
| <li><a href="../project-reports.html"><span class="icon-chevron-right"></span>Project Reports</a></li> |
| <li class="nav-header">Apache</li> |
| <li><a href="https://www.apache.org/">Apache Website</a></li> |
| <li><a href="https://www.apache.org/licenses/">License</a></li> |
| <li><a href="https://www.apache.org/foundation/how-it-works.html">How the ASF works</a></li> |
| <li><a href="https://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li> |
| <li><a href="https://www.apache.org/foundation/thanks.html">Thanks</a></li> |
| <li><a href="https://www.apache.org/security/">Security</a></li> |
| </ul> |
| </nav> |
| <div class="well sidebar-nav"> |
| <form id="search-form" action="https://www.google.com/search" method="get" > |
| <input value="http://turbine.apache.org/turbine/turbine-7-0" name="sitesearch" type="hidden" /> |
| <input class="search-query" name="q" id="query" type="text" placeholder="Search with Google..." /> |
| </form> |
| <div id="poweredBy"> |
| <div class="clear"></div> |
| <div class="clear"></div> |
| <a href="https://maven.apache.org/" class="builtBy" target="_blank"><img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" /></a> |
| </div> |
| </div> |
| </header> |
| <main id="bodyColumn" class="span10"> |
| |
| |
| |
| |
| <section><a id="Using_the_pull_model_with_Turbine_2"></a> |
| <h1>Using the pull model with Turbine 2</h1> |
| |
| |
| <p> |
| Turbine 2 can be used with two different programming models - the push model |
| and the pull model. The difference is in how the Context is built up. The |
| Context is used by the Velocity or WebMacro template files to "fill in the |
| blanks" and introduce dynamic data into a static HTML-based template. This |
| programming concept is incredibly powerful - because it allows the web |
| designer, who may be experienced with HTML, CSS, and Javascript but not |
| Java, to put data fields wherever they want on a page without having to ask |
| the Java programmers to change a Java class and recompile. For more |
| information on which to choose for your Turbine application, read Jon |
| Stevens' informative commentary <a href="../pullmodel.html">Push vs |
| Pull</a>. |
| </p> |
| |
| |
| <p> |
| Also see the <a href="../services/pull-service.html">Pull Service</a> |
| Documentation |
| for another explanation of how the Pull Service works with Tools. |
| </p> |
| |
| |
| <p> |
| The push model is based on a one-to-one mapping of Java Screen |
| classes and Velocity template files. The Screen class puts key/value pairs |
| into the Context. The <a href="context-howto.html">Context Howto</a> |
| explains this approach. |
| </p> |
| |
| |
| <p> |
| The pull model allows the web designer even more freedom than the push |
| model. Java programmers can create globally accessible Java classes known as |
| Tools. These Tools are going to be useful for getting data out of a |
| service and bringing it to the presentation layer, authenticating users, or |
| creating links (see the TemplateLink tool that is built into Turbine). |
| </p> |
| </section> |
| |
| <section><a id="Pull_Tool_Implementation"></a> |
| <h1>Pull Tool Implementation</h1> |
| |
| <p> |
| Your SimpleSecurityTool should implement ApplicationTool, which is a simple |
| interface with two methods, init(Object data) and refresh. It could be a |
| facade class that calls other classes, or it could have its own business |
| logic. |
| </p> |
| </section> |
| |
| <section><a id="Entries_in_TurbineResources.properties"></a> |
| <h1>Entries in TurbineResources.properties</h1> |
| |
| <p> |
| To make the Tool available to Turbine, you need to define your Tools in the |
| TurbineResources.properties file. The "Pull Service" section of the |
| properties file is where the tools are listed. You can use the following |
| syntax (all explained in the TurbineResources.properties): |
| </p> |
| |
| |
| |
| <pre class="prettyprint"><code> |
| tool.<Scope>.<Id> = <Classname> |
| |
| tool.request.formsTool = com.yourcompany.turbine.tools.SimpleFormsTool |
| </code></pre> |
| |
| |
| <p> |
| Classname is your java classname - |
| com.yourcompany.turbine.tools.SimpleFormsTool |
| </p> |
| |
| |
| <p> |
| Id is a unique identifier that you will use in your Velocity templates - |
| formsTool, for instance. |
| </p> |
| |
| |
| <p> |
| Scope defines the life cycle of the Tool. There are four, global, request, |
| session, and persistent. |
| </p> |
| |
| |
| <p> |
| Global: The tool is instantiated once and is available to all templates for |
| all requests. Must be threadsafe. |
| </p> |
| |
| |
| <p> |
| Request: The tool is instantiated once for every request to Turbine. |
| Doesn't need to be threadsafe. The link, page, and flux tools are all |
| defined as request scope. |
| </p> |
| |
| |
| <p> |
| Session: The tool is instantiated once for each user session. Should be |
| threadsafe. Useful for tools that might hold user profiles, or items in a |
| shopping cart. |
| </p> |
| |
| |
| <p> |
| Persistent: Tool is instantiated once for each user session, and is stored |
| along with the user information. Must be threadsafe and implement |
| Serializable. An example of how this scope would be used would be great! |
| </p> |
| |
| |
| <p> |
| Additional tool-defined properties can be configured in the |
| TurbineResources.properties. The syntax is defined under the "Pull Service" |
| section. |
| </p> |
| |
| </section> |
| |
| |
| </main> |
| </div> |
| </div> |
| <hr/> |
| <footer> |
| <div class="container-fluid"> |
| <div class="row-fluid"> |
| <p>© 2000–2025 |
| <a href="https://www.apache.org/">The Apache Software Foundation</a> |
| </p> |
| </div> |
| </div> |
| </footer> |
| </body> |
| </html> |
