Comments? Questions? Get Involved? Community Guide
A Resource Facade location string is structured like a URL with a protocol, host, optional port, and filename. It supports the standard Java URL protocols (http, https, ftp, jar, and file). It also supports some additional useful protocols:
Additional protocols can be added by implementing the org.moqui.context.ResourceReference interface and adding a resource-facade.resource-reference element to the Moqui Conf XML file. The supported protocols listed above are configured this way in the MoquiDefaultConf.xml file.
The simplest way to use a resource, and supported by all location protocols, is to read the text or binary content. To get the text from a resource location use the ec.resource.getLocationText(String location, boolean cache) method. To get an InputStream for binary or large text resources use the ec.resource.getLocationStream(String location) method.
For a wider variety of operations beyond just reading resource data use the ec.resource.getLocationReference(String location) method to get an instance of the org.moqui.context.ResourceReference interface. This interface has methods to get text or binary stream data from the resource like the Resource Facade methods. It also has methods for directory resources to get child resources, find child files and/or directories recursively by name, write text or binary stream data, and move the resource to another location.
There is a single method for rendering a template in a resource at a location: ec.resource.renderTemplateInCurrentContext(String location, Writer writer). This method returns nothing and simply writes the template output to the writer. By default FTL (Freemarker Template Language) and GString (Groovy String) are supported.
Additional template renderers can be supported by implementing the org.moqui.context.TemplateRenderer interface and adding a resource-facade.template-renderer element to the Moqui Conf XML file.
To run a script through the Resource Facade use the Object ec.resource.runScriptInCurrentContext(String location, String method) method. Specify the location and optionally the method within the script at the location and this method will run the script and return the Object that the script returns or evaluates to. There is a variation on this method in the Resource Facade that also accepts a Map additionalContext parameter for convenience (it just pushes the Map onto the context stack, runs the script, then pops from the context stack). By default Moqui supports Groovy, XML Actions, JavaScript, and any scripting engine available through the javax.script.ScriptEngineManager.
To add a script runner you have two options. You can use the javax.script approach for any scripting language that implements the javax.script.ScriptEngine interface and is discoverable through the javax.script.ScriptEngineManager. Moqui uses this to discover the script engine using the extension on the script’s filename and execute the script. If the script engine implements the javax.script.Compilable interface then Moqui will compile the script and cache it in compiled form for the faster repeat execution of a script at a given location.
The other option is to implement the org.moqui.context.ScriptRunner interface and add a resource-facade.script-runner element to the Moqui Conf XML file. Moqui uses Groovy the XML Actions through this interface as it provides additional flexibility not available through the javax.script interfaces.
Because Groovy is the default expression language in Moqui there are a few Resource Facade methods to easily evaluate expressions for different purposes:
These methods accept a debugLocation parameter that is used in error messages. For faster evaluation these expressions are all cached, using the expression itself as the key for maximal reuse.