| <!DOCTYPE html> |
| <!-- |
| | Generated by Apache Maven Doxia Site Renderer 1.11.1 from xdocs/services\velocity-service.xml at 12 February 2024 |
| | Rendered using Apache Maven Fluido Skin 1.9 |
| --> |
| <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 1.11.1" /> |
| <title>Apache Turbine – Turbine Services - Velocity Service</title> |
| <link rel="stylesheet" href="../css/apache-maven-fluido-1.9.min.css" /> |
| <link rel="stylesheet" href="../css/site.css" /> |
| <link rel="stylesheet" href="../css/print.css" media="print" /> |
| <script src="../js/apache-maven-fluido-1.9.min.js"></script> |
| <link rel="icon" type="image/png" sizes="48x48" href="./images/favicon.ico"> |
| <link rel="icon" type="image/png" sizes="48x48" href="../images/favicon.ico"> |
| <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> |
| </head> |
| <body class="topBarDisabled"> |
| <a href="https://github.com/apache/turbine-core"> |
| <img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000;" |
| src="https://s3.amazonaws.com/github/ribbons/forkme_right_orange_ff7600.png" |
| alt="Fork me on GitHub"> |
| </a> |
| <div class="container-fluid"> |
| <header> |
| <div id="banner"> |
| <div class="pull-left"><a href="../../" id="bannerLeft" title="Apache Turbine"><img src="../images/turbine-project-apache-separate.png" alt="Apache Turbine"/></a></div> |
| <div class="pull-right"><div id="bannerRight"><img src="../images/logo.gif" alt=""/></div> |
| </div> |
| <div class="clear"><hr/></div> |
| </div> |
| |
| <div id="breadcrumbs"> |
| <ul class="breadcrumb"> |
| <li id="publishDate">Last Published: 12 February 2024<span class="divider">|</span> |
| </li> |
| <li id="projectVersion">Version: 6.1-SNAPSHOT</li> |
| <li class="pull-right"><span class="divider">|</span> |
| <a href="https://turbine.apache.org/fulcrum/" class="externalLink" title="Fulcrum">Fulcrum</a></li> |
| <li class="pull-right"><span class="divider">|</span> |
| <a href="https://turbine.apache.org/" class="externalLink" title="Turbine">Turbine</a></li> |
| <li class="pull-right"><a href="https://www.apache.org" class="externalLink" title="Apache">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" title="Overview"><span class="none"></span>Overview</a></li> |
| <li><a href="../features.html" title="Features"><span class="none"></span>Features</a></li> |
| <li><a href="../fsd.html" title="Specification"><span class="none"></span>Specification</a></li> |
| <li><a href="../getting-started.html" title="Getting Started"><span class="none"></span>Getting Started</a></li> |
| <li><a href="../how-to-build.html" title="Howto Build Turbine"><span class="none"></span>Howto Build Turbine</a></li> |
| <li><a href="../changes-report.html" title="Changes"><span class="none"></span>Changes</a></li> |
| <li class="nav-header">Documentation</li> |
| <li><a href="../services/index.html" title="Services"><span class="icon-chevron-down"></span>Services</a> |
| <ul class="nav nav-list"> |
| <li><a href="../services/assemblerbroker-service.html" title="Assembler Broker Service"><span class="none"></span>Assembler Broker Service</a></li> |
| <li><a href="../services/avalon-component-service.html" title="Avalon Component Service"><span class="none"></span>Avalon Component Service</a></li> |
| <li><a href="../../fulcrum/fulcrum-crypto/" title="Crypto Service"><span class="none"></span>Crypto Service</a></li> |
| <li><a href="../../fulcrum/fulcrum-cache/" title="Cache Service"><span class="none"></span>Cache Service</a></li> |
| <li><a href="../../fulcrum/fulcrum-factory/" title="Factory Service"><span class="none"></span>Factory Service</a></li> |
| <li><a href="../../fulcrum/fulcrum-intake/" title="Intake Service"><span class="none"></span>Intake Service</a></li> |
| <li><a href="../services/jsonrpc-service.html" title="JSON-RPC Service"><span class="none"></span>JSON-RPC Service</a></li> |
| <li><a href="../../fulcrum/fulcrum-json/" title="JSON Service"><span class="none"></span>JSON Service</a></li> |
| <li><a href="../services/jsp-service.html" title="JSP Service"><span class="none"></span>JSP Service</a></li> |
| <li><a href="../../fulcrum/fulcrum-localization/" title="Localization Service"><span class="none"></span>Localization Service</a></li> |
| <li><a href="../../fulcrum/fulcrum-mimetype/" title="MimeType Service"><span class="none"></span>MimeType Service</a></li> |
| <li><a href="../services/naming-service.html" title="Naming Service"><span class="none"></span>Naming Service</a></li> |
| <li><a href="../../fulcrum/fulcrum-parser/" title="Parser Service"><span class="none"></span>Parser Service</a></li> |
| <li><a href="../../fulcrum/fulcrum-pool/" title="Pool Service"><span class="none"></span>Pool Service</a></li> |
| <li><a href="../services/pull-service.html" title="Pull Service"><span class="none"></span>Pull Service</a></li> |
| <li><a href="../services/rundata-service.html" title="RunData Service"><span class="none"></span>RunData Service</a></li> |
| <li><a href="../services/scheduler-service.html" title="Scheduler Service"><span class="none"></span>Scheduler Service</a></li> |
| <li><a href="../services/security-service.html" title="Security Service"><span class="none"></span>Security Service</a></li> |
| <li><a href="../services/servlet-service.html" title="Servlet Service"><span class="none"></span>Servlet Service</a></li> |
| <li><a href="../services/session-service.html" title="Session Service"><span class="none"></span>Session Service</a></li> |
| <li><a href="../services/template-service.html" title="Template Service"><span class="none"></span>Template Service</a></li> |
| <li><a href="../services/ui-service.html" title="UI Service"><span class="none"></span>UI Service</a></li> |
| <li><a href="../services/uniqueid-service.html" title="Unique ID Service"><span class="none"></span>Unique ID Service</a></li> |
| <li><a href="../services/urlmapper-service.html" title="URL Mapper Service"><span class="none"></span>URL Mapper Service</a></li> |
| <li><a href="../../fulcrum/fulcrum-upload/" title="Upload Service"><span class="none"></span>Upload Service</a></li> |
| <li class="active"><a href="#"><span class="none"></span>Velocity Service</a></li> |
| <li><a href="../../fulcrum/fulcrum-xmlrpc/" title="XML-RPC Service"><span class="none"></span>XML-RPC Service</a></li> |
| <li><a href="../../fulcrum/fulcrum-xslt/" title="XSLT Service"><span class="none"></span>XSLT Service</a></li> |
| </ul></li> |
| <li><a href="../howto/index.html" title="Howtos"><span class="icon-chevron-right"></span>Howtos</a></li> |
| <li><a href="https://cwiki.apache.org/confluence/display/TURBINE" class="externalLink" title="Wiki"><span class="none"></span>Wiki</a></li> |
| <li><a href="../apidocs/index.html" title="JavaDocs"><span class="none"></span>JavaDocs</a></li> |
| <li class="nav-header">Development</li> |
| <li><a href="../proposals.html" title="Proposals"><span class="none"></span>Proposals</a></li> |
| <li><a href="../how-to-help.html" title="How To Help"><span class="none"></span>How To Help</a></li> |
| <li><a href="../todo.html" title="Todo"><span class="none"></span>Todo</a></li> |
| <li class="nav-header">Project Documentation</li> |
| <li><a href="../project-info.html" title="Project Information"><span class="icon-chevron-right"></span>Project Information</a></li> |
| <li><a href="../project-reports.html" title="Project Reports"><span class="icon-chevron-right"></span>Project Reports</a></li> |
| <li class="nav-header">Apache</li> |
| <li><a href="https://www.apache.org/" class="externalLink" title="Apache Website"><span class="none"></span>Apache Website</a></li> |
| <li><a href="https://www.apache.org/licenses/" class="externalLink" title="License"><span class="none"></span>License</a></li> |
| <li><a href="https://www.apache.org/foundation/how-it-works.html" class="externalLink" title="How the ASF works"><span class="none"></span>How the ASF works</a></li> |
| <li><a href="https://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsorship"><span class="none"></span>Sponsorship</a></li> |
| <li><a href="https://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks"><span class="none"></span>Thanks</a></li> |
| <li><a href="https://www.apache.org/security/" class="externalLink" title="Security"><span class="none"></span>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-core" name="sitesearch" type="hidden"/> |
| <input class="search-query" name="q" id="query" type="text" /> |
| </form> |
| <script>asyncJs( 'https://cse.google.com/brand?form=search-form' )</script> |
| <hr /> |
| <div id="poweredBy"> |
| <div class="clear"></div> |
| <div class="clear"></div> |
| <div class="clear"></div> |
| <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" /></a> |
| </div> |
| </div> |
| </header> |
| <main id="bodyColumn" class="span10" > |
| |
| |
| |
| |
| <section> |
| <h2><a name="Velocity_Service"></a>Velocity Service</h2> |
| |
| |
| <p> |
| </p> |
| |
| </section> |
| |
| <section> |
| <h2><a name="Configuration"></a>Configuration</h2> |
| |
| |
| <div class="source"><pre class="prettyprint"> |
| # ------------------------------------------------------------------- |
| # |
| # S E R V I C E S |
| # |
| # ------------------------------------------------------------------- |
| # Classes for Turbine Services should be defined here. |
| # Format: services.[name].classname=[implementing class] |
| # |
| # To specify properties of a service use the following syntax: |
| # service.[name].[property]=[value] |
| |
| services.VelocityService.classname = org.apache.turbine.services.velocity.TurbineVelocityService |
| . |
| . |
| . |
| # ------------------------------------------------------------------- |
| # |
| # V E L O C I T Y S E R V I C E |
| # |
| # ------------------------------------------------------------------- |
| |
| # The location of Velocity configuration file, relative to webapp root |
| # These properties will override the default properties set by Velocity. |
| # You should specify the path to the templates directories as well as |
| # the path to the log file and they should also be relative to webapp root |
| |
| services.VelocityService.template.extension = vm |
| services.VelocityService.default.page = VelocityPage |
| services.VelocityService.default.screen = VelocityScreen |
| services.VelocityService.default.layout = VelocityECSLayout |
| services.VelocityService.default.navigation = VelocityNavigation |
| services.VelocityService.default.error.screen = VelocityErrorScreen |
| services.VelocityService.default.layout.template = Default.vm |
| |
| # |
| # Set this to true to catch Velocity Errors and display them in the log file |
| services.VelocityService.catch.errors = true |
| |
| services.VelocityService.runtime.log = /logs/velocity.log |
| #services.VelocityService.input.encoding = UTF-8 |
| services.VelocityService.velocimacro.library = GlobalMacros.vm |
| |
| services.VelocityService.resource.loader = file |
| services.VelocityService.file.resource.loader.description = Velocity File Resource Loader |
| services.VelocityService.file.resource.loader.class = org.apache.velocity.runtime.resource.loader.FileResourceLoader |
| services.VelocityService.file.resource.loader.path = /templates/app |
| services.VelocityService.file.resource.loader.cache = false |
| services.VelocityService.file.resource.loader.modificationCheckInterval = 2 |
| |
| services.VelocityService.resource.loader = classpath |
| services.VelocityService.classpath.resource.loader.description = Velocity Classpath Resource Loader |
| services.VelocityService.classpath.resource.loader.class = org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader |
| |
| </pre></div> |
| |
| </section> |
| |
| <section> |
| <h2><a name="Usage"></a>Usage</h2> |
| |
| </section> |
| |
| <section> |
| <h2><a name="Properties"></a>Properties</h2> |
| |
| <ul> |
| |
| <li>"services.VelocityService.catch.errors" controls the reporting of Velocity errors to the application (and to to the user). |
| If this is set to "true" (which is the default), errors are caught by Turbine and reported in the turbine.log file at |
| error level. Velocity will get the String "[Turbine caught an Error here. Look into the turbine.log for further information]" |
| as return value (this might cause further errors down the road if you e.g. expect a numerical value or an object as the result |
| of a method), so if you see this message in your screen, follow the instructions. |
| </li> |
| </ul> |
| </section> |
| |
| |
| |
| </main> |
| </div> |
| </div> |
| <hr/> |
| <footer> |
| <div class="container-fluid"> |
| <div class="row-fluid"> |
| <p>© 2000–2024 |
| <a href="https://www.apache.org/">The Apache Software Foundation</a> |
| </p> |
| </div> |
| </div> |
| </footer> |
| </body> |
| </html> |
