General information

This page covers the general installation and integration process of Apache MyFaces Extension scripting 1.0.2 or earlier,it does not go into the details of the configuration. As of ext-script 1.0.3 a number of legacy dependencies are dropped for easier maintainability such as
  • Support for Java 5 and earlier
  • Support for MyFaces 1.2.x
  • Support for Servlet 2.5 and earlier
If you need to use Ext-Scripting with one of those configurations stick to 1.0.2. The section covers the setup via download or custom build. If you need configuration detail info or info on how to setup your ide correctly please follow the links in the navigation to the correct section.

Setup overview

General Setup Information

Ext-Scripting has a complete appendix list over all configuration and setup options for a quick overview please visit the following links. If you need detailed setup information, then read further on.


For a short checklist of setup steps please follow this link. For a detailed setup guide, please continue reading.


With version 1.0 Ext-Scripting provides all necessary artifacts as download artifacts to get quickly started. A kickstart project is provided which can be used as shell for your own projects.

For Download information please visit the download page.

Once you downloaded the necessary artifacts please check the manual setup section of this document.

Checkout and Build

While Ext-Scripting is already in beta stage, the best way to get started is probably to checkout and build ext-scripting yourself from the latest codebase. All other installation steps will have this step as prerequisite if you want to use the latest codebase instead of one of the beta releases! First you have to check out the latest codebase from via a subversion client.

Make sure you have following requirements fulfilled before checking out:

  • A valid Subversion client
  • Java 5 or higher
  • Maven 2.0.9 or higher

After checkout, a full build can be obtained from the root directory of your checkout via mvn clean install.

Once finished, a valid build is installed, which can be used further on. Additionally you can find two blueprint projects which you can use as starting points for your own projects under <checkoutDir>/examples , which can be started viamvn jetty:run-exploded. The now generated files either can be used to be included in a maven install or be included manually (please go to the next section for detailed setup instructions)

Setup of Ext-Scripting


Before setting up Ext-Scripting for your project make sure following requirements are met.

  • JAVA_HOME points towards a valid Java SDK (JRE is not sufficient)
  • You know how to create and deploy a web application within your preferred setup (command line, ide)


While one of the aims of Ext-Scripting was to enable an easy setup, for now it was not entirely possible for now to get a plug and play configuration. Several configuration steps have to be performed.

  • A valid MyFaces installation has to be present
  • Ext-Scripting and its dependencies has to be added to the MyFaces installation
  • The paths to the scripts have to be present (see also below)

Preparations via Apache Maven 2

The easiest way once Extension scripting is compiled is probably a setup via Apache Maven 2

Depending on your configuration and preferred JDK version you can add following entries to your Maven pom.xml to enable Ext-Scripting

MyFaces 1.2.8+


MyFaces 2.+


Manual Setup

If you do not like Maven or you prefer a manual setup, Ext-Scripting provides convenient meta bundles. A manual setup comes down to the task of adding the appropriate meta bundle (extscript-myfaces12-bundle or extscript-myfaces20-bundle) to your WEB-INF/lib directory and adding a groovy-all.jar as additional dependency.

you can obtain both jars after the build from:

  • <yourbuilderoot>/extscript-bundles/extscript-myfaces12-bundle/target/extscript-myfaces12-bundle-1.0-SNAPSHOT.jar
  • <yourbuilderoot>/extscript-bundles/extscript-myfaces20-bundle/target/extscript-myfaces20-bundle-1.0-SNAPSHOT.jar

After having done that you are ready to setup the rest of the Ext-Scripting configuration manually as described in the section blow

Preparing the Necessary web.xml Entries

First Step

To enable Ext-Scripting you also have to add several entries to your web.xml file.

First a context param has to be set which attaches the Ext-Scripting plugins to MyFaces

            Enables our scripting engine support plugins

Second Step

Add Ext-Scriptings servlet filter to your servlet configuration


The init parameter and the servlet filter MUST be set otherwise Ext-Scripting will not be enabled!

For the filter pattern you can use every pattern which enables your web pages, the standard cases are, either *.jsf or /faces/* Note you must use the same pattern as described in the configuration part of your Faces Servlet.

Additional Optional Steps

Ext-Scripting exposes a number configuration parameters which can be set via context parameters in your web.xml

Adjust the web.xml Root source paths.

Since the goal of Ext-Scripting is to provide scriptability to a running web application, it has to know where to find the sources. For this, a default location has been chosen according to the standards set by the Mojarra Groovy Extension.

The location looks like:


as root location for Groovy files


as root location for java files.

Following image displays the default locations:

However in a normal development scenario, it is often undesirable to have the files located in a deployment location, and a pointer mechanism towards the actual source locations would be more desirable. To provide such a mechanism, Ext-Scripting allows two optional web.xml context parameters, which allow the rerouting of source locations of the supported languages!

        <description>Additional comma separated loader paths to allow direct editing on the sources directory instead
            of the deployment dir
           <some project path>/src/main/webapp/WEB-INF/groovy
        <description>Additional comma separated loader paths to allow direct editing on the sources directory instead
            of the deployment dir
            <some project path>/src/main/webapp/WEB-INF/java
  • org.apache.myfaces.extensions.scripting.groovy.LOADER_PATHS can be a comma separated list of paths which point to the actual Groovy sources.
  • does the same for Java sources..