Download
Foundation

Appendix: Configuration Entries

General Information

This page is a general quick overview over the possible configuration parameters, if you need further details please visit thesetup guide.

Param Required Possible values Short Description
org.apache.myfaces.FACES_INIT_PLUGINS YES org.apache.myfaces.extensions.scripting.servlet.StartupServletContextPluginChainLoader MyFaces Extension Point Setup
scriptingFilter YES The scripting filter for further information look below
org.apache.myfaces.extensions.scripting.groovy.LOADER_PATHS NO comma separate list of paths Additional comma separated loader paths to allow direct editing of groovy files on the sources directory instead of editing in the deployment dir /WEB-INF/groovy
org.apache.myfaces.extensions.scripting.java.LOADER_PATHS NO comma separate list of paths Additional comma separated loader paths to allow direct editing of java files on the sources directory instead of editing in the deployment dir /WEB-INF/java
org.apache.myfaces.extensions.scripting.resource.LOADER_PATHS NO comma separate list of paths Additional comma separated loader paths to allow direct editing of resources on the sources directory instead of editing in the deployment directory Important notice, in most cases this path will point to the root of your web application directory (ie: src/main/webapp in a standard Maven2 structure or <project-root>/webapp for a standard Eclipse project structure)
facelets.RESOURCE_RESOLVER NO org.apache.myfaces.extensions.scripting.facelet.ReroutingResourceResolver Enables the loading of xhtml facelet pages from your source directory, if org.apache.myfaces.extensions.scripting.resource.LOADER_PATHS is set properly
org.apache.myfaces.scripting.PGK_WHITELIST NO a comma separate list of whitelisted packages Enables package whitelisting, a mechanism which allows to compile and reload only from whitelisted packages
org.apache.myfaces.extensions.scripting.PGK_ADDITIONAL_CLASSPATH NO a comma separate list of additional classpaths enables additional classpaths for the compile time

Normal configuration entries

all configuration entries except for the scripting filter follow the context parameter convention

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

Scripting Filter

All configuration entries are context parameters, the only exception is the scripting filter which is a servlet filter

The scripting filter differs in its configuration by having to provide a servlet filter tag and a pattern:

            <!-- ======================================================================================
                    Scripting Filter
                    Second step to enable Ext-Scripting
                 ====================================================================================== -->
            <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>/*</url-pattern>
                <dispatcher>REQUEST</dispatcher>
                <dispatcher>FORWARD</dispatcher>
                <dispatcher>INCLUDE</dispatcher>
                <dispatcher>ERROR</dispatcher>
            </filter-mapping>
        
        

Note for further examples of the configuration go to the section On to the appendix: Example Configuration>>