CODEWITHSUNDEEP
freemarker
wuntee
wuntee

Reputation: 12470

Setting freemarker template from classpath

I have a web application that I need to manually obtain a Freemarker template - the template is obtained via a class in a library project, but the actual tpl file is contained in the web application classpath. So, there are 2 projects, one 'taac-backend-api' and another 'taac-web'; taac-backend-api has the code to grab the template, and process it, but taac-web is where the template is stores (specifically in: WEB-INF/classes/email/vendor.tpl) - I have tried everything from using springs classpath resource to using Freemarkers setClassForTemplateLoading method. I assume this would work:

    freemarkerConfiguration = new Configuration();
    freemarkerConfiguration.setClassForTemplateLoading(this.getClass(), "");
    Template freemarkerTemplate = freemarkerConfiguration.getTemplate("/email/vendor.tpl");

yet, I always get a FileNotFoundException. Can someone explain the best way to obtain a template from the classpath?

Thanks.

Upvotes: 36

Views: 48090

Answers (5)

Artjom Prozorov
Artjom Prozorov

Reputation: 193

Use the following config and place it in application properties.

spring.freemarker.template-loader-path=

Upvotes: 1

wuntee
wuntee

Reputation: 12470

this is what ended up working for me:

freemarkerConfiguration = new Configuration(Configuration.VERSION_2_3_28);
freemarkerConfiguration.setClassForTemplateLoading(this.getClass(), "/");
Template freemarkerTemplate = freemarkerConfiguration.getTemplate("email/vendor.tpl");

Upvotes: 86

Jan Bodnar
Jan Bodnar

Reputation: 11637

In 2017, the following is deprecated:

Configuration conf = new Configuration();

We should pass freemarker.template.Version to the constructor:

Configuration conf = new Configuration(new Version(2, 3, 23));
conf.setClassForTemplateLoading(Application.class, "/views");

where the version numbers refer to the current version of FreeMarker.

The views directory is located in src/main/resources.

Upvotes: 12

WizardsOfWor
WizardsOfWor

Reputation: 3134

freemarkerConfiguration = new Configuration();
freemarkerConfiguration.setClassForTemplateLoading(this.getClass(), "");
Template freemarkerTemplate = freemarkerConfiguration.getTemplate("template.tpl");

Use this method to load the classes from the package where your class is located, so if your class is

org.foo.SomeClass the templates will be looked for in /org/foo in the classpath. This keeps your templates stored with the class that uses/loads them.

Upvotes: 5

Rodney Gitzel
Rodney Gitzel

Reputation: 2710

If you are using Struts 2 and the Conventions plugin, wuntee's solution doesn't seem to work: setClassForTemplateLoading in turn creates an instance of ClassTemplateLoader which doesn't find files in jars no matter what path prefix is specified.

Instead, create an instance of StrutsClassTemplateLoader. (I do this in a custom sub-class of FreemarkerManager in its getTemplateLoader method.) It takes no parameters, so presumably it just knows how Struts and Conventions do things.

Upvotes: 1

Related Questions