topic Java backed webscript doesn't show up at all in Alfresco Archive

Java backed webscript doesn't show up at all

mtielemans — Wed, 26 Jun 2013 21:52:49 GMT

I am following the alfresco wiki's guide to java backed webscripts and cannot get it to work. What's worse, I cannot get as far as generating errors in the logs or otherwise, or a webscript listing in <alfresco>/alfresco/service/index/all.Other than the wiki example, I am not using an AMP but

Re: Java backed webscript doesn't show up at all

openpj — Thu, 27 Jun 2013 09:53:00 GMT

Your Java-Backed WebScript is a DeclarativeWebScript and this type of WebScript need to also have a FreeMarker template for the rendition of the output. If you need to manage request and response directly in the Java implementation you need to extend AbstractWebScript.

Please take a look at the sample project of Java-Backed Webscripts that allows you to see how to implement your own Java-Backed Web Scripts taking a look at a complete Maven project that implements the wiki examples:

https://code.google.com/p/alfresco-java-backed-webscripts-demo/

This project is also linked in the Alfresco Wiki page Java-Backed WebScripts Samples:

http://wiki.alfresco.com/wiki/Java-backed_Web_Scripts_Samples

Hope this helps

Re: Java backed webscript doesn't show up at all

mtielemans — Thu, 27 Jun 2013 11:07:16 GMT

Hi Piergiorgio,

thanks for your reply! It's useful, because I could find very little information about DeclarativeWebscripts, no DeclarativeWebscript specific information, in fact. Odd, if you think how important they are.

However, I do have an associated ftl file. The example you linked is the one I too followed. I now edited my project to reflect it more accurately, however.

alfresco/extension/templates/webscripts/nl/mark/cacher/footype.desc.xml now looks like this:


<webscript>
   <shortname>Retrieve a list of foo types associated to a bar type.</shortname>
   <description>Returns an empty JSON array or a JSON array filled with foo types as Strings named 'types'.</description>
   <url>/mark/ztccache/footype.json</url>
   <authentication>user</authentication>
   <format default="json">extension</format>
   <family>mark myservice cacher</family>
</webscript>
‍‍‍‍‍‍‍‍‍‍

footype.get.json.ftl in the same folder looks like this:


${types?string}
‍‍‍

I also moved my bean registration out of the existing context file and placed it in alfresco/module/myservicecache-context.xml to reflect the example project.


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

<beans>
    <!– Java backed webscripts –>
    <bean id="webscript.nl.mark.cacher.footype.get" class="nl.mark.alfresco.myservice.webscript.GetFooTypes"
      parent="webscript">
    </bean>
</beans>
‍‍‍‍‍‍‍‍‍‍‍

All these paths are within the jar file. I'm thinking the problem may be there. After these changes, the result is still the same.

Re: Java backed webscript doesn't show up at all

mtielemans — Thu, 27 Jun 2013 11:28:19 GMT

My webscript descriptor was called footype.desc.get.xml where it should have been footype.get.desc.xml.

Although it will take me a while to look into my eyes in the mirror without shame again, I did learn here. Thanks for thinking along!