How to use velocity templates?

Question

Hi.

I found many questions and answers about velocity templates in Confluence. And what about JIRA?

I have tried example from this page:

// Create the Velocity Context
Map context = MacroUtils.defaultVelocityContext();
context.put("myCustomVar", customVar);
context.put("otherCustomVar", otherCustomVar);
// Render the Template
String result = VelocityUtils.getRenderedTemplate("/com/myplugin/templates/macro.vm", context);

but I cannot find appropriate packages for MacroUtils and VelocityUtils in JIRA.

What packages I need to user for it? Or does exists anything else way to use velocity templates in JIRA?

Thanks.

Yanduganov Andrey · Answer

To use Velocity Template you need:

* add Scanned annotation to your class
* add TemplateRenderer field with ComponentImport annotation
* add TemplateRenderer to constructor
* use it

For example:

@Scanned
public class MyClass {
@ComponentImport
    private final TemplateRenderer templateRenderer;

public MyClass(TemplateRenderer templateRenderer) {
        this.templateRenderer = templateRenderer;
    }
}

After that you can use it, for example

@Override
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
    Map<String, Object> context = Maps.newHashMap();
    resp.setContentType("text/html;charset=utf-8");
    
    context.put("key", "value");

templateRenderer.render("path_to_vm_template", context, resp.getWriter());
}

Yanduganov Andrey · Answer

Hi Branden.

Your answer isn't about templates which I meant.

I write JIRA plugin and I have servlet. And I wanna render it using velocity template. I tryed write HTML just in java but I think that it's a wrong way.

Gaston Valente_dzz4x1 · Answer

great doc, saves a lot of time, thanks!