topic Re: Create Java back webscript in share extesion project in Alfresco Archive

Create Java back webscript in share extesion project

djaweid_ — Fri, 08 Jul 2016 20:55:45 GMT

Hi All,I am new with alfresco. I have created a share extension where I want to create a Java backed webscript.I used https://wiki.alfresco.com/wiki/Java-backed_Web_Scripts_Samples to create Java backed webscript.Add the following bean in custom-slingshot-application-context.xml<bean id="webframe

Re: Create Java back webscript in share extesion project

jpotts — Mon, 18 Jul 2016 15:04:28 GMT

You might want to have a look at <a href="http://ecmarchitect.com/alfresco-developer-series-tutorials/webscripts/tutorial/tutorial.html">this tutorial</a>. It describes how to write a Java-backed web script and the config you need.

The tutorial covers repo tier web scripts but it should be the same for Share tier web scripts.

Jeff

Re: Create Java back webscript in share extesion project

darkredd — Wed, 05 Oct 2016 15:01:17 GMT

Hi Jeff Potts,

I followed the principle and structure of your tutorial and that of the official Alfresco document tutorial, but still get the following error.

2016-10-05 16:34:25,500 ERROR [freemarker.runtime] [http-apr-8080-exec-2] Error executing FreeMarker template

FreeMarker template error:

The following has evaluated to null or missing:

==> data [in template "sudo/sudorename.get.html.ftl" at line 6, column 22]

Tip: If the failing expression is known to be legally null/missing, either specify a default value with myOptionalVar!myDefault, or use <#if myOptionalVar??>when-present<#else>when-missing</#if>. (These only cover the last step of the expression; to cover the whole expression, use parenthessis: (myOptionVar.foo)!myDefault, (myOptionVar.foo)??

The failing instruction (FTL stack trace):

----------

==> ${data} [in template "sudo/sudorename.get.html.ftl" at line 6, column 20]

----------

</blockcode>

The webscript is fully registered and only when I invoke it do I get that error message. The Java class is a simple class to return a text (business logic to be done later).

My files:

tomcat\webapps\alfresco\WEB-INF\classes\za\gov\parliament\sudowebscripts\SudoChildNode.class

public Map<String, Object> executeImpl(WebScriptRequest req, Status status, Cache cache)

{

Map<String, Object> model = new HashMap<String, Object>();

model.put("data", "Data retrieved");

logger.debug("Sudo webscript execution complete");

return model;

}

</blockcode>

tomcat\shared\classes\alfresco\extension\templates\webscripts\sudo\sudorename.get.desc.xml

tomcat\shared\classes\alfresco\extension\templates\webscripts\sudo\sudorename.get.html.xml

tomcat\shared\classes\alfresco\extension\sudorename-context.xml

<?xml version='1.0' encoding='UTF-8'?>

<!DOCTYPE beans PUBLIC '-//SPRING//DTD BEAN 2.0//EN' 'http://www.springframework.org/dtd/spring-beans-2.0.dtd'>

<beans>

</beans>

</blockcode>

In all the above is there something that I am missing?

Using Alfresco 5.2 201609 Nightly build

Much thanks.

~Vusani

Re: Create Java back webscript in share extesion project

jpotts — Wed, 05 Oct 2016 21:01:22 GMT

Can you provide the full class signature of your Java class so I can see what it extends/implements?

Re: Create Java back webscript in share extesion project

kaynezhang — Thu, 06 Oct 2016 02:50:01 GMT

And you'd better check if a variable exists in FreeMarker template before using it,like this

<#if data??>

${data}

</#if>

Or display a default text when the variable is null ,like this

${(data)!"default text"}

Re: Create Java back webscript in share extesion project

darkredd — Thu, 06 Oct 2016 07:15:59 GMT

Hi @Jeff

Here is the full class:

package za.gov.parliament.sudowebscripts;
import java.util.HashMap;
import java.util.Map;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.extensions.webscripts.Cache;
import org.springframework.extensions.webscripts.DeclarativeWebScript;
import org.springframework.extensions.webscripts.Status;
import org.springframework.extensions.webscripts.WebScriptRequest;
public class SudoChildNode extends DeclarativeWebScript
{
  private Log logger = LogFactory.getLog(SudoChildNode.class);
  public Map<String, Object> executeImpl(WebScriptRequest req, Status status, Cache cache)
  {
  Map<String, Object> model = new HashMap<String, Object>();
  model.put("data", "Data retrieved");
  logger.debug("Sudo webscript execution complete");
  return model;
  }
}

Much Thanks

~Vusani

Re: Create Java back webscript in share extesion project

jpotts — Thu, 06 Oct 2016 13:46:44 GMT

Your class looks fine, so it must be the Spring context file that is not correct.

I suspect it is your bean ID. As it says in my tutorial, the syntax for the bean ID is:

webscript.package.service-id.method

But yours is "webscript.sudo". Alfresco has no way of knowing which web script you intend to use that class with unless that ID follows the convention. You need to change it to:

webscript.sudo.sudorename.get

Be sure to restart Alfresco after that change.

Re: Create Java back webscript in share extesion project

mitpatoliya — Thu, 06 Oct 2016 13:58:17 GMT

Your issue is due to reasons given by Jeff and and kyne. Error is because you are trying print value of "data" which is null and you do not have any null check in your ftl.

Reason your data is null is because your java class is not getting called.

Re: Create Java back webscript in share extesion project

darkredd — Thu, 06 Oct 2016 14:16:57 GMT

Hi mit patoliya,

Yes that I understand and have since put a freemarker check on the ftl. No the issue is getting the java class called. What could be the cause of the class not to be called?

Re: Create Java back webscript in share extesion project

darkredd — Thu, 06 Oct 2016 14:29:43 GMT

Much thanks,

Indeed it was the bean ID, made the change and worked. It was an oversight while I was working through the tutorial.

~Vusani

Re: Create Java back webscript in share extesion project

jpotts — Thu, 06 Oct 2016 14:42:41 GMT

Awesome, glad you got it working!