Dashlet: how to use java-backed code to instead of the .js controller?

As we transition to the new Hyland Community, some post links may be temporarily disrupted as we finalize redirects. We apologize for the inconvenience and are working to resolve this as quickly as possible. Details.

sunquanbin

Hi,

I have created a very simple dashlet for share. I have the following three files in the path: alfresco/web-extension/site-webscripts/org/alfresco/components/dashlets

<li>A controller: hello.js</li>
  It defines a porpterty:

model.msg = "A hello message."‍

<li>A free marker template: hello.get.html.ftl.</li>
  It shows the message:

${msg}‍

<li>A descriptor: hello.get.desc.xml</li>


I tested share and I could add this dashlet successfully.

My question is: can I write a java code as a controller to return the "model.msg" object instead of using the "hello.js". Something is similar in Java Backed WebScript, which registers the java class to an http get request in a *-context.xml file:

 <beans>
  <bean id="webscript.org.alfresco.component.dashlets.hello.get" class="org.alfresco.demo.HelloJava" parent="webscript" />
 </beans>
‍‍‍‍‍

Is there a similar way to do this for dashlet? And how should I name this ???-context.xml file and where should I put it?

PS. my java code is

public class HelloJava extends DeclarativeWebScript
{
   @Override
   protected Map<String, Object> executeImpl(WebScriptRequest req, Status status, Cache cache)
   {
      Map<String, Object> model = new HashMap<String, Object>();
      model.put("msg", "A message from Java Code.");
      
      return model;
   }
}

‍‍‍‍‍‍‍‍‍‍‍‍‍‍

Many thanks

Sun

eric_soto

Sun Quanbin,

Yes, you can write Java code as a controller to return the "model.msg" object instead of using hello.js. Assuming that your bean id is correct and that your webscript package is in fact org.alfresco.component.dashlets and that your Java package is in fact org.alfresco.demo, yes it should work. Your context file can be named "custom-slingshot-context.xml" and can be placed in your web-extension directory. Just to be absolutely sure I verified this in my local environments (Alfresco Enterprise 4.0.2.9 and 4.1.5) and it did work.

My question for you is why would you want to do that? To quote MikeH: "The preferred way would be to expose your Alfresco (repository) version as a RESTful service and call it from Share that way". For more on this please follow the following thread: Click here

<strong>Note</strong>: I believe that "msg" is a reserved function name in the Javascript webscript. To be safe I would change it to "message" or something other than "msg". The same goes for the Java class; change the variable name that goes into the model map. Also, don't forget to change the Freemarker template variable name to ${message}, or whatever you changed the name to in the Java class.

I hope this helps. Cheers.