Appendix C. JavaScript Root Object Reference

This document displays list of available JavaScript root objects that can be used in JavaScript templates. Root objects are listed in alphabetic order according to their names.

Each JavaScript root object in the following list is backed by a server-side java class respectively. Public methods of the java class are exposed as APIs for corresponding JavaScript root object.

For example

var myObj = {'name':'Test Object','size':100};
var myObjAsString = jsonUtils.toJSONString(myObj);

This project has total 6 JavaScript root objects.

C.1. atom

  • Java Class : org.springframework.extensions.webscripts.atom.AtomService

  • Module Artifact Id : spring-webscripts

  • Module Group Id : Users.mindthegab.Dev.alfresco.workspace.spring-surf-parent.target.checkout.spring-webscripts

  • Module Version : target

  • Java Doc : link

  • Help :

    Collection of Atom related methods.

  • Sample Code :

    //JavaScript Sample Code
     var object = entry.getExtension(atom.names.cmis_object);
    //Freemarker Sample Code
    <#assign cmis_object=entry.getExtension(atom.names.cmis_object)>

  • Methods

    • Method : createEntry

      • Help :

        Constructs an empty entry

      • Return : Empty entry

    • Method : getNames

      • Help :

        Gets pre-configured Atom Extensions (QNames)

      • Return : map of QNames by alias

    • Method : createFeed

      • Help :

        Constructs an empty feed

      • Return : Empty feed

    • Method : createQName

      • Help :

        Creates a QName

      • Return : QName

      • Parameters

        • Parameter : var0

          • Java Class : java.lang.String

          • Help :

            Uri string

        • Parameter : var1

          • Java Class : java.lang.String

          • Help :

            Local name

    • Method : toMimeType

      • Help :

        Establishs mimetype of atom content

      • Return : mimetype (or null, if it could not be established)

      • Parameters

        • Parameter : var0

          • Java Class : org.apache.abdera.model.Entry

          • Help :

            Entry

    • Method : toAtom

      • Help :

        Parses an Atom element

      • Return : Element

      • Parameters

        • Parameter : var0

          • Java Class : org.springframework.extensions.surf.util.Content

          • Help :

            Atom element

    • Method : toAtom

      • Help :

        Parses an Atom element

      • Return : Element

      • Parameters

        • Parameter : var0

          • Java Class : java.lang.String

          • Help :

            Atom element string

    • Method : toService

      • Help :

        Parses an Atom service

      • Return : Atom servce

      • Parameters

        • Parameter : var0

          • Java Class : org.springframework.extensions.surf.util.Content

          • Help :

            Atom entry

    • Method : toService

      • Help :

        Parses an Atom service

      • Return : Atom service

      • Parameters

        • Parameter : var0

          • Java Class : java.lang.String

          • Help :

            Atom entry string

    • Method : toEntry

      • Help :

        Parses an Atom Entry

      • Return : Entry

      • Parameters

        • Parameter : var0

          • Java Class : org.springframework.extensions.surf.util.Content

          • Help :

            Atom entry

    • Method : toEntry

      • Help :

        Parses an Atom entry

      • Return : Entry

      • Parameters

        • Parameter : var0

          • Java Class : java.lang.String

          • Help :

            Atom entry string

    • Method : toFeed

      • Help :

        Parses an Atom feed

      • Return : Feed

      • Parameters

        • Parameter : var0

          • Java Class : org.springframework.extensions.surf.util.Content

          • Help :

            Atom feed

    • Method : toFeed

      • Help :

        Parses an Atom feed

      • Return : Feed

      • Parameters

        • Parameter : var0

          • Java Class : java.lang.String

          • Help :

            Atom feed string

C.2. jsonUtils

  • Java Class : org.springframework.extensions.webscripts.json.JSONUtils

  • Module Artifact Id : spring-webscripts

  • Module Group Id : Users.mindthegab.Dev.alfresco.workspace.spring-surf-parent.target.checkout.spring-webscripts

  • Module Version : target

  • Java Doc : link

  • Help :

    Collection of JSON Utility methods.

  • Sample Code :

    //JavaScript Sample Code
    var myObj = {'name':'Test Object','size':100};
    var myObjAsString = jsonUtils.toJSONString(myObj);
    
    //Freemarker Template Sample Code
    [
        <#list tags as tag>
            ${jsonUtils.encodeJSONString(tag)}<#if tag_has_next>,</#if>
        </#list>
    ]

  • Methods

    • Method : toObject

      • Help :

        Takes a JSON string and converts it to a native java script object

      • Sample Code :

        //JavaScript Sample Code
        model.postCode = jsonUtils.toObject(json).postCode;

      • Return : the created native JS object that represents the JSON object

      • Parameters

        • Parameter : var0

          • Java Class : java.lang.String

          • Help :

            A valid json string

    • Method : toObject

      • Help :

        Takes a JSON object and converts it to a native java script object

      • Sample Code :

        //JavaScript Sample Code
        model.postCode = jsonUtils.toObject(json).postCode;

      • Return : the created native object

      • Parameters

        • Parameter : var0

          • Java Class : org.json.JSONObject

          • Help :

            The json object

    • Method : toJSONString

      • Help :

        Converts a given JavaScript native object and converts it to the relevant JSON string.

      • Sample Code :

        //JavaScript Sample Code
        var myObj = {'name':'Test Object','size':100};
        var myObjAsString = jsonUtils.toJSONString(myObj);

      • Return : JSON string

      • Parameters

        • Parameter : var0

          • Java Class : java.lang.Object

          • Help :

            JavaScript object

    • Method : encodeJSONString

      • Help :

        Encodes a JSON string value

      • Return : Encoded value

      • Parameters

        • Parameter : var0

          • Java Class : java.lang.Object

          • Help :

            Value to encode

C.3. logger

  • Java Class : org.springframework.extensions.webscripts.ScriptLogger

  • Module Artifact Id : spring-webscripts

  • Module Group Id : Users.mindthegab.Dev.alfresco.workspace.spring-surf-parent.target.checkout.spring-webscripts

  • Module Version : target

  • Java Doc : link

  • Help :

    Provides functions to aid debugging of scripts.

  • Sample Code :

    logger.log("Command Processor: isEmailed=" + isEmailed);

  • Methods

    • Method : log

      • Help :

        Logs a message

      • Parameters

        • Parameter : var0

          • Java Class : java.lang.String

          • Help :

            Message to log

    • Method : warn

      • Help :

        Logs a warning message

      • Parameters

        • Parameter : var0

          • Java Class : java.lang.String

          • Help :

            Message to log

    • Method : isLoggingEnabled

      • Help :

        Returns true if logging is enabled.

      • Sample Code :

        var loggerStatus = logger.isLogginEnabled();

      • Return : true if logging is enabled

    • Method : isWarnLoggingEnabled

      • Help :

        Returns true if warn logging is enabled.

      • Sample Code :

        var loggerStatus = logger.isWarnLogginEnabled();

      • Return : true if warn logging is enabled

C.4. remote

  • Java Class : org.springframework.extensions.webscripts.ScriptRemote

  • Module Artifact Id : spring-webscripts

  • Module Group Id : Users.mindthegab.Dev.alfresco.workspace.spring-surf-parent.target.checkout.spring-webscripts

  • Module Version : target

  • Java Doc : link

  • Help :

    Provides useful functions for working with endpoints, connectors and credentials.

  • Sample Code :

    // get a connector to the Alfresco repository endpoint
    var connector = remote.connect("alfresco");
    // retrieve the web script index page 
    var indexHtml = connector.get("/index");

  • Methods

    • Method : connect

      • Help :

        Constructs a remote connector to a default endpoint (if configured).
        If a default endpoint is not configured, null will be returned.

      • Return : The remote client

    • Method : connect

      • Help :

        Constructs a remote connector to a specific endpoint (if configured).
        If a default endpoint is not configured, null will be returned.

      • Return : The remote client

      • Parameters

        • Parameter : var0

          • Java Class : java.lang.String

          • Help :

            Endpoint Url

    • Method : call

      • Help :

        Invoke a specific URI on the default endpoint

      • Return : The reponse

      • Parameters

        • Parameter : var0

          • Java Class : java.lang.String

          • Help :

            Endpoint Url

    • Method : getEndpointIds

      • Help :

        Returns a list of the application endpoint ids

      • Return : List of the application endpoint ids

    • Method : getEndpointName

      • Help :

        Returns the name of an endpoint

      • Return : Endpoint name

      • Parameters

        • Parameter : var0

          • Java Class : java.lang.String

          • Help :

            Endpoint id

    • Method : getEndpointDescription

      • Help :

        Returns the description of an endpoint

      • Return : Endpoint description

      • Parameters

        • Parameter : var0

          • Java Class : java.lang.String

          • Help :

            Endpoint id

    • Method : isEndpointPersistent

      • Help :

        Checks if an endpoint is persistent or not

      • Return : True if the endpoint is persistent

      • Parameters

        • Parameter : var0

          • Java Class : java.lang.String

          • Help :

            Endpoint id

    • Method : getEndpointURL

      • Help :

        Returns the configured URL for the given endpoint

      • Return : The endpoint url

      • Parameters

        • Parameter : var0

          • Java Class : java.lang.String

          • Help :

            Endpoint id

C.5. server

  • Java Class : org.springframework.extensions.webscripts.PresentationContainer$PresentationServerModel

  • Module Artifact Id : spring-webscripts

  • Module Group Id : Users.mindthegab.Dev.alfresco.workspace.spring-surf-parent.target.checkout.spring-webscripts

  • Module Version : target

  • Java Doc : link

C.6. stringUtils

  • Java Class : org.springframework.extensions.webscripts.ScriptableUtils

  • Module Artifact Id : spring-webscripts

  • Module Group Id : Users.mindthegab.Dev.alfresco.workspace.spring-surf-parent.target.checkout.spring-webscripts

  • Module Version : target

  • Java Doc : link

  • Help :

    Collection of script utility methods for working with strings etc.

  • Sample Code :

    //JavaScript Sample Code
    model.biohtml = stringUtils.replaceLineBreaks(bio);
    
    //Freemarker Template Sample Code
    ${stringUtils.stripUnsafeHTML(item.node.content)?substring(0, contentLength)}

  • Methods

    • Method : urlDecode

      • Help :

        Decodes input URL string

      • Return : Processed string

      • Parameters

        • Parameter : var0

          • Java Class : java.lang.String

          • Help :

            Input string

    • Method : stripEncodeUnsafeHTML

      • Help :

        Strips encode unsafe HTML tags from the input string

      • Return : Processed string

      • Parameters

        • Parameter : var0

          • Java Class : java.lang.String

          • Help :

            Input string

    • Method : stripUnsafeHTML

      • Help :

        Strips unsafe HTML tags from the input string

      • Return : Processed string

      • Parameters

        • Parameter : var0

          • Java Class : java.lang.String

          • Help :

            Input string

    • Method : replaceLineBreaks

      • Help :

        Replaces line breaks in the input string

      • Return : Processed string

      • Parameters

        • Parameter : var0

          • Java Class : java.lang.String

          • Help :

            Input string

    • Method : encodeHTML

      • Help :

        Encodes input HTML string

      • Return : Processed string

      • Parameters

        • Parameter : var0

          • Java Class : java.lang.String

          • Help :

            Input string

    • Method : encodeJavaScript

      • Help :

        Encodes input JavaScript string

      • Return : Processed string

      • Parameters

        • Parameter : var0

          • Java Class : java.lang.String

          • Help :

            Input string

    • Method : urlEncode

      • Help :

        Encodes input string using URLEncoder

      • Return : Processed string

      • Parameters

        • Parameter : var0

          • Java Class : java.lang.String

          • Help :

            Input string

    • Method : urlEncodeComponent

      • Help :

        Encode input URL string

      • Return : Processed string

      • Parameters

        • Parameter : var0

          • Java Class : java.lang.String

          • Help :

            Input string

    • Method : parseXMLNodeModel

      • Help :

        Converts an xml string to a freemarker node model

      • Return : Freemarker node model

      • Parameters

        • Parameter : var0

          • Java Class : java.lang.String

          • Help :

            Input XML string