org.alfresco.repo.jscript

Class ApplicationScriptUtils

java.lang.Object

org.alfresco.repo.processor.BaseProcessorExtension

org.alfresco.repo.jscript.BaseScopableProcessorExtension

org.alfresco.repo.jscript.ApplicationScriptUtils

All Implemented Interfaces:

org.alfresco.processor.ProcessorExtension, Scopeable

public final class ApplicationScriptUtils
extends BaseScopableProcessorExtension

Utility functions specifically for external application use.

Author:

Mike Hatfield

Constructor Summary

Constructors

Constructor and Description
ApplicationScriptUtils()

Method Summary

Modifier and Type	Method and Description
String	getDownloadAPIUrl(ScriptNode node)
void	setJsonConversionComponent(JSONConversionComponent jsonConversionComponent)
String	toJSON(ScriptNode node) Returns the JSON representation of a node.
String	toJSON(ScriptNode node, boolean useShortQNames) Returns the JSON representation of this node.

Methods inherited from class org.alfresco.repo.jscript.BaseScopableProcessorExtension

getScope, setScope

Methods inherited from class org.alfresco.repo.processor.BaseProcessorExtension

getExtensionName, register, setExtensionName, setProcessor

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApplicationScriptUtils

public ApplicationScriptUtils()

Method Detail

setJsonConversionComponent

public void setJsonConversionComponent(JSONConversionComponent jsonConversionComponent)

Parameters:

jsonConversionComponent - JSON conversion component

toJSON

public String toJSON(ScriptNode node)
              throws com.fasterxml.jackson.core.JsonProcessingException

Returns the JSON representation of a node. Long-form QNames are used in the result.

Parameters:

node - the node to convert to JSON representation.

Returns:

The JSON representation of this node

Throws:

com.fasterxml.jackson.core.JsonProcessingException

toJSON

public String toJSON(ScriptNode node,
                     boolean useShortQNames)
              throws com.fasterxml.jackson.core.JsonProcessingException

Returns the JSON representation of this node.

Parameters:

node - the node to convert to JSON representation.

useShortQNames - if true short-form qnames will be returned, else long-form.

Returns:

The JSON representation of this node

Throws:

com.fasterxml.jackson.core.JsonProcessingException

getDownloadAPIUrl

public String getDownloadAPIUrl(ScriptNode node)

Parameters:

node - the node to construct the download URL for

Returns:

For a content document, this method returns the URL to the /api/node/content API for the default content property

For a container node, this method returns an empty string