How to XML escaping with Apache Velocity?

Question

I am generating XML using Apache Velocity. What is the best (most straight-forward) way to XML-escape the output?

(I saw there is an escape tool, but could not figur

Answer 1

Take a look at event handlers.

eventhandler.referenceinsertion.class = org.apache.velocity.app.event.implement.EscapeXmlReference

Escape tool is a production ready as well if you need to escape only selective references (final version of tools was released just recently but it was in beta stage before that for 2 years if not longer)

$esc.xml($var)

How to init velocity tools.

Include velocity-tools.xml into your project and enable required tools:

Then velocity context creation procedure would look like:

ToolManager velocityToolManager = new ToolManager();
velocityToolManager.configure("velocity-tools.xml");
VelocityContext context = new VelocityContext(velocityToolManager.createContext());