Define where to search for Facelets in JSF 2

Question

When I configure the FacesServlet in my web.xml, where does it search for *.xhtml facelets? Only in App-Root?

Answer 1

I don't understand your question. But a try to an answer: All files in your web directory (and subdirs) that have the xhtml extension will be handeled as facelets.

Answer 2

They're by default scanned in the web root folder of the WAR and in the /META-INF/resources folder of all JARs included in the /WEB-INF/lib of the WAR. You can control this scanning algorithm with a custom ResourceResolver. Here's a (relatively foolish) example which scans for an additional location on local disk file system as well when nothing is found in WAR (nor in JARs in its /WEB-INF/lib):

public class MyResourceResolver extends ResourceResolver {

    private ResourceResolver parent;

    public MyResourceResolver(ResourceResolver parent) {
        this.parent = parent;
    }

    @Override
    public URL resolveUrl(String path) {
        URL url = parent.resolveUrl(path); // Resolves from WAR.

        if (url == null) {
            url = new File("/some/folder", path).toURI().toURL();
        }

        return url;
    }

}

As to placing Facelets files in /WEB-INF folder, you should only put Facelets files in there which are not supposed to be publicly accessible, such as template files, tag files, include files, etc. Files which are supposed to be publicly accessible should not be placed in there, such as template clients (the top level views).

See also:

• Obtaining Facelets templates/files from an external filesystem or database
• Which XHTML files do I need to put in /WEB-INF and which not?
• Structure for multiple JSF projects with shared code

Answer 3

It will depends of theses parameters in web.xml :

<context-param>
    <param-name>javax.faces.DEFAULT_SUFFIX</param-name>
    <param-value>.xhtml</param-value>
</context-param>

<servlet-mapping>
    <servlet-name>Faces Servlet</servlet-name>
    <url-pattern>*.jspx</url-pattern>
</servlet-mapping>