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.

Links

Appendix: Configuration Setup Steps

Appendix: Example Configurations for 1.0.2 or earlier

Appendix: List of Configuration Options for 1.02 or earlier

Requirements

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)

Setup

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

     <dependency>
        <groupId>org.apache.myfaces.extensions.scripting</groupId>
        <artifactId>extscript-myfaces12-bundle</artifactId>
        <version>1.0-SNAPSHOT</version>
     </dependency>

     <dependency>
        <groupId>org.apache.myfaces.extensions.scripting</groupId>
        <artifactId>extscript-myfaces20-bundle</artifactId>
        <version>1.0-SNAPSHOT</version>
     </dependency>

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

     <context-param>
        <description>
            Enables our scripting engine support plugins
        </description>
        <param-name>org.apache.myfaces.FACES_INIT_PLUGINS</param-name>
        <param-value>
            org.apache.myfaces.extensions.scripting.servlet.StartupServletContextPluginChainLoader
        </param-value>
     </context-param>

    <filter>
        <filter-name>scriptingFilter</filter-name>
        <filter-class>org.apache.myfaces.extensions.scripting.servlet.ScriptingServletFilter</filter-class>
    </filter>
    <filter-mapping>
        <filter-name>scriptingFilter</filter-name>
        <url-pattern>/*.jsf</url-pattern>
        <dispatcher>REQUEST</dispatcher>
        <dispatcher>FORWARD</dispatcher>
        <dispatcher>INCLUDE</dispatcher>
        <dispatcher>ERROR</dispatcher>
    </filter-mapping>

     <webapp>/WEB-INF/groovy                    
                

     <webapp>/WEB-INF/java
                

    <context-param>
        <description>Additional comma separated loader paths to allow direct editing on the sources directory instead
            of the deployment dir
        </description>
        <param-name>org.apache.myfaces.extensions.scripting.groovy.LOADER_PATHS</param-name>
        <param-value>
           <some project path>/src/main/webapp/WEB-INF/groovy
        </param-value>
    </context-param>
    <context-param>
        <description>Additional comma separated loader paths to allow direct editing on the sources directory instead
            of the deployment dir
        </description>
        <param-name>org.apache.myfaces.extensions.scripting.java.LOADER_PATHS</param-name>
        <param-value>
            <some project path>/src/main/webapp/WEB-INF/java
        </param-value>
    </context-param>