JavaScript Root Objects

It is possible to create and add custom script APIs implemented in Java and accessible as root objects in JavaScript. This provides an integration point for SkyVault extensions to provide custom JavaScript APIs where appropriate.

In order to implement a custom JavaScript API it is recommended that you develop a POJO (Plain Old Java Object) that extends the base class org.alfresco.repo.processor.BaseProcessorExtension. The public methods of your class will be those that will be accessible from JavaScript.

Let's implement a custom root object that can print text to the log (i.e. tomcat/logs/catalina.out):

package org.alfresco.training.jscript;
import org.alfresco.repo.processor.BaseProcessorExtension;

public class CustomProcessorExtension extends BaseProcessorExtension {
 public void log2StdOut(String text) {
  System.out.println(text);
 }
}   

This class needs to be defined as a Spring Bean with parent set to baseJavaScriptExtension:

<bean id="org.alfresco.training.customRootObject" 
         class="org.alfresco.training.jscript.CustomProcessorExtension" 
         parent="baseJavaScriptExtension">
    <property name="extensionName" value="custom" />
</bean>

The extensionName property is used to configure what root object name you want to use in the JavaScript controllers.

The new custom root object can now be used in the JavaScript controller as follows:

custom.log2StdOut("Hello World!");

• repo-amp/src/main/java - put the implementation class for the root object somewhere under this directory

• repo-amp/src/main/amp/config/alfresco/module/repo-amp/context/service-context.xml - put the root object Spring bean here.

• Repository side JavaScript root objects reference (Have a look at what root objects are available for Repo Web Scripts etc)
• Surf root object reference (Have a look at what root objects are available for Surf Web Scripts)