topic Re: Access Java Class with Freemarker Template in Alfresco Archive

Access Java Class with Freemarker Template

major_king — Mon, 28 Apr 2008 13:30:56 GMT

Hey everybody,is there a possibility to run Java code from an Freemarker template? Does anybody has an example or tutorial for this or is there another workaround to access java classes?Regards,Christian

Re: Access Java Class with Freemarker Template

samuel_penn — Mon, 28 Apr 2008 16:06:17 GMT

Not sure about Freemarker (I haven't used it very much), but it's definitely possible to have Java code run as XSLT extensions if you're using XSLT as the templating language. At least, I've had in working with web forms.

Sam.

Re: Access Java Class with Freemarker Template

nancyg — Mon, 28 Apr 2008 17:45:42 GMT

Freemarker uses the MVC (Model View Controller) pattern, you can use Java to prepare the data and then use Freemarker to display it. You can read more at the Freemarker site, freemarker.org.

Nancy

Re: Access Java Class with Freemarker Template

major_king — Tue, 29 Apr 2008 12:59:45 GMT

Hello,

thanks for fast answering. Now I spend some time on browsing some forums and guids and i found out the Freemarker Beanwrapper. With this it should be possible to call Java-code. Has anybody already done this? I'm struggling with the syntax atm

Thanks for help!
Christian

Re: Access Java Class with Freemarker Template

poptarts — Thu, 01 May 2008 20:23:26 GMT

what helped me the most when trying to wrap my head around the issue was to find somethign that Alfresco already does and try to replicate it. For instance I needed to put a new item on the Sidebar.

So I looked at the existing Sidebar jsps, which are navigator, shelf and opensearch.jsp. Now look at examples under the dashlets jsps, some of which call templates for their rendering.

For me it was more helpful to use the existing stuff and modifying it to see what it would do, than try to read a wiki page to understand it all.

hope that helps a little.

Re: Access Java Class with Freemarker Template

nyronian — Tue, 06 May 2008 14:31:34 GMT

It is really quite powerfull and easy to do once you have it setup.

There are a few items you must be aware of. Here's how I did it.

* Create the javabean according to java standards.
* Add the javabean to the freemarker model. I did this by creating my own servlet the extended GuestTemplateContentServlet and extending the buildModel method. This method is what is used by alfresco add the alfresco java beans to the root model.
* I then added my own javabeans that did whatever I needed them to.

So for example you had a Javabean with a getTotal() method and you added it to the HashMap with an id of "calc". In the template you would simply say: ${calc.total} once the javabean is added to the root Hashmap. Take a look at the org.alfresco.web.app.servlet.GuestTemplateContentServlet. Turn on it's debugging in you wish and you will see how it works.

The total method can return most any java.lang data type as well as List or Map interfaces.

Re: Access Java Class with Freemarker Template

nyronian — Tue, 06 May 2008 14:39:29 GMT

Samual….how do you do this in XSLT. I researched this about a year ago and found NOTHING on it. I posted on the Alfresco forums before and did not get many answers of how to expose java objects to the XSLT engine, so at the time I went all Freemarker because it talks about it natively.

http://forums.alfresco.com/viewtopic.php?f=3&t=6340

Can you point me to the documentation on how to do this in XSLT?

Re: Access Java Class with Freemarker Template

samuel_penn — Tue, 06 May 2008 15:02:33 GMT

The problem I had was trying to get the XSLT to pick up the Java class. In the end, the only way I found to do that was to stick the class in the Tomcat shared classes folder - placing the class in the web project itself (even if in a WEB-INF) didn't work. Once that has been done, then it's just a standard Xalan extension, which is documented on the Apache Xalan site.

I've got a simple example on my laptop which I'll try and dig out and put up later today.

Sam.

Re: Access Java Class with Freemarker Template

samuel_penn — Tue, 06 May 2008 21:58:09 GMT

I think this version of things works. It just uses a Java class to perform a simple arithmetical operation based on the form data (what I actually needed to do was display logs and square roots of some data, which XSLT doesn't do easily, but my implementation of that has been put on hold) to prove that the concept worked.

http://www.glendale.org.uk/~sam/alfresco/plugin.xsd
http://www.glendale.org.uk/~sam/alfresco/plugin.xsl
http://www.glendale.org.uk/~sam/alfresco/PluginTest.java

I haven't had a chance to test these today, but I think they're the versions which worked. At the very least, it should give an idea of what you're supposed to do (the Java class can be run outside Alfresco to test the XSLT side). The class for PluginTest needs to be placed into the Tomcat classpath, and the xsd/xsl used to define a web form.

Sam.

Re: Access Java Class with Freemarker Template

major_king — Wed, 07 May 2008 06:39:14 GMT

Thanks a lot for all these answers. I will try them out

Regards,
christian

Re: Access Java Class with Freemarker Template

major_king — Thu, 29 May 2008 08:56:10 GMT

Hello everybody,

for all developers who will have the same problem, i will post my results

I does not get it work to access the Java class with Freemarker Now i call my Java-Code directly from the jsp-page via JavaServer Faces. For more Information send me a PM.

Regards,
Christian

Re: Access Java Class with Freemarker Template

hansraj — Mon, 17 Nov 2008 11:57:15 GMT

Hi Major,

iam trying to write Java backed Restful API.

i followed the following steps:
1). helloworld.get.desc.xml
2). HelloWorld.java
3). helloworld-scripts-context.xml
4). helloworld.get.html.ftl
5). created HelloWorld.class jar file and placed in

WEB-INF\lib

6). copied helloworld-scripts-context.xml in

shared\classes\alfresco\extension

7). removed alfresco.war
8). restarted Tomcat server
9). created helloworld.get.desc.xml & helloworld.get.html.ftl in DataDictionary/WebScripts-extension space
10). run the Restful API like - http://localhost:8080/alfresco/service/helloworld?name={nameArgument}
11). System.out.print(…) in java file are not getting printed on Tomcat console..
I guess java class is not at all getting invoked. could any body pls answer how to link Java class and FreeMarker Template?

The following are the source files:

1). helloworld.get.dec.xml

<webscript> 
   <shortname> Hello World </shortname>
   <description> Hello World Web Script </description>
   <url> /helloworld?name={nameArgument} </url>
</webscript>‍‍‍‍‍

2). HelloWorld.java

package com.helloworld.scripts;

import java.util.Map;
import java.util.HashMap;
import org.alfresco.web.scripts.DeclarativeWebScript;
import org.alfresco.web.scripts.WebScriptRequest;
import org.alfresco.web.scripts.WebScriptStatus;

public class HelloWorld extends org.alfresco.web.scripts.DeclarativeWebScript
{
   String nm="";
   protected Map<String, Object> executeImpl(WebScriptRequest wr, WebScriptStatus ws){
      System.out.println("from executeImpl()****************");
      System.out.println("hello****************");
      Map<String, Object> model = new HashMap<String, Object>();
      model.put("foo", nm);
      return model;
   }

   public void setSomeName(String name){
      nm=name;
   }

}‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

3). helloworld-scripts-context.xml

<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE beans PUBLIC '-//SPRING//DTD BEAN//EN' 'http://www.springframework.org/dtd/spring-beans-2.0.dtd'>

<beans>
   <bean id="webscript.com.scripts.helloworld.get" class="com.helloworld.scripts.HelloWorld" parent="webscript"> 
      <property name="someName"> 
         <value> This is a Foo Name </value>
      </property>

   </bean> 
</beans>‍‍‍‍‍‍‍‍‍‍‍

4). helloworld.get.html.ftl

<html>
   <body>
      <p>   Hello, ${args.name} </p>
         Foo : ${foo}
   </body>
</html>‍‍‍‍‍‍

Regards,
Hans

Re: Access Java Class with Freemarker Template

pero — Tue, 08 Jun 2010 09:18:31 GMT

It is really quite powerfull and easy to do once you have it setup.

There are a few items you must be aware of. Here's how I did it.

* Create the javabean according to java standards.
* Add the javabean to the freemarker model. I did this by creating my own servlet the extended GuestTemplateContentServlet and extending the buildModel method. This method is what is used by alfresco add the alfresco java beans to the root model.
* I then added my own javabeans that did whatever I needed them to.

So for example you had a Javabean with a getTotal() method and you added it to the HashMap with an id of "calc". In the template you would simply say: ${calc.total} once the javabean is added to the root Hashmap. Take a look at the org.alfresco.web.app.servlet.GuestTemplateContentServlet. Turn on it's debugging in you wish and you will see how it works.

The total method can return most any java.lang data type as well as List or Map interfaces.

Can you please post your custom GuestTemplateContentServlet.buildModel method code.
I' m haveing the same problem. I want to be able to access pojo's from freemarker in Alfresco.