From Surf Wiki (app.surf) — the open knowledge base

Apache Velocity

Field	Value
name	Apache Velocity
logo	Apache Velocity logo.svg
developer	Apache Software Foundation
latest release version	2.4.1
latest release date	{{cite web
url	https://velocity.apache.org/news.html
title	Apache Velocity - Project News
website	velocity.apache.org
publisher	Apache Software Foundation
access-date	2025-03-17
operating system	Cross-platform
repo
programming language	Java
genre	Template engine
license	Apache License 2.0
website

| access-date = 2025-03-17 Apache Velocity first released in April 2001, is a Java-based template engine that provides a template language to reference objects defined in Java code. It aims to ensure clean separation between the presentation tier and business tiers in a Web application (the model–view–controller design pattern).

Velocity is an open source software project hosted by the Apache Software Foundation. It is released under the Apache License. Jon Scott Stevens derived the name from the AltiVec Velocity Engine in the PowerPC G4 chip.

Uses

Some common types of applications that use Velocity are:

[[File:Aws-api-gateway--body-mapping-template.png|alt=AWS API Gateway body mapping template|thumb|AWS API Gateway body mapping template.]]Web applications: Web developers render HTML page structures. The content is populated with dynamic information. The page is processed with VelocityViewServlet or any of a number of frameworks that support Velocity.
Source code generation: Velocity can be used to generate Java, SQL, or PostScript source code, based on templates. A number of open source and commercial development software packages use Velocity in this manner.
Automatic emails: Many applications generate automatic emails for account signup, password reminders, or automatically sent reports. Using Velocity, the email template can be stored in a text file, rather than directly embedded in Java code.
XML transformation: Velocity provides an Ant task, called Anakia, which reads an XML file and makes it available to a Velocity template. A common application is to convert software documentation stored in a generic "xdoc" format into a styled HTML document.
AWS API Gateway uses Apache Velocity engine for body mapping templates - JSON is output.

Code examples

The following template:

## Velocity Hello World
<html>
    <body>
        #set( $foo = "Velocity" )
        ## followed by
        Hello $foo World!
    </body>
</html>

processed by Velocity produces the following HTML:

<html>
    <body>
        Hello Velocity World!
    </body>
</html>

Another example using conditions:

if( $foo

Go North**

elseif( $foo == 10 )

Go East**

elseif( $bar == 6 )

Go South**

else

Go West**

end AWS API Gateway body mapping template, for DynamoDB HTTP: { "TableName": "happy-marketer", "KeyConditionExpression": "pk = :pk AND begins_with(sk, :sk)",
if ($input.params('projectStatus') == 'archived') "FilterExpression": "projectStatus = :Archived",
else "FilterExpression": "projectStatus = :InProgress OR projectStatus = :Completed",
end "ExpressionAttributeValues": { ":pk": { "S": "project" }, ":sk": { "S": "$context.authorizer.claims.email" },
if ($input.params('projectStatus') == 'archived') ":Archived": { "S": "Archived" }
else ":InProgress": { "S": "In Progress" }, ":Completed": { "S": "Completed" }
end } } Another example with optional array; without condition will fail because of invalid resulting JSON: { "email": "$context.authorizer.claims.email"
if ($input.params('countries') != "") , "countries": $input.params('countries')
end } The syntax and overall concept of the Apache Velocity templates is similar to the syntax of the older WebMacro template engine, which is now also an open source project.

References

Bibliography

{{citation |access-date = September 4, 2009 |archive-url = https://web.archive.org/web/20090705091506/http://www.apress.com/book/view/9781590594100 |archive-date = July 5, 2009 |url-status = dead
{{citation |access-date = September 4, 2009 |archive-url = https://web.archive.org/web/20121007002812/http://www.wiley.com/WileyCDA/WileyTitle/productCd-0471457949.html |archive-date = October 7, 2012 |url-status = dead

References

(2009-12-30). "PoweredByVelocity". Wiki.apache.org.

Info: Wikipedia Source

This article was imported from Wikipedia and is available under the Creative Commons Attribution-ShareAlike 4.0 License. Content has been adapted to SurfDoc format. Original contributors can be found on the article history page.

apache-software-foundation-projects java-(programming-language)-libraries template-engines

Want to explore this topic further?

Ask Mako anything about Apache Velocity — get instant answers, deeper analysis, and related topics.

Research with Mako

Free with your Surf account

Content sourced from Wikipedia, available under CC BY-SA 4.0.

This content may have been generated or modified by AI. CloudSurf Software LLC is not responsible for the accuracy, completeness, or reliability of AI-generated content. Always verify important information from primary sources.

Report