org.jboss.forge.spec.javaee
Interface FacesFacet

All Superinterfaces:

Facet

public interface FacesFacet
extends Facet

If installed, this Project supports features from the JSF specification.

Author:

Lincoln Baxter, III

Method Summary

FileResource<?>	getConfigFile() Get a reference to this Project's configured WEB-INF/faces-config.xml file.
List<String>	getFaceletsDefaultSuffixes() Return all Faces default suffixes for JSP files as configured by the javax.faces.FACELETS_SUFFIX context-parameter.
List<String>	getFaceletsViewMapping() Return all Facelets view mappings as configured by the javax.faces.FACELETS_VIEW_MAPPINGS context-parameter.
List<String>	getFacesDefaultSuffixes() Return all Faces default suffixes for JSP files as configured by the javax.faces.DEFAULT_SUFFIX context-parameter.
List<String>	getFacesServletMappings() Get this application's currently configured FacesServlet mappings.
List<String>	getFacesSuffixes() Return all configured JSP or Facelets default suffixes.
org.jboss.shrinkwrap.descriptor.api.spec.servlet.web.FacesProjectStage	getProjectStage() Get this application's currently configured FacesProjectStage.
Resource<?>	getResourceForWebPath(String path) Given a web path, return the corresponding resource to which that path would resolve when the application is deployed.
List<String>	getWebPaths(Resource<?> r) For a given Resource, if the resource is a web-resource, return all known context-relative URLs with which that resource may be accessed.
List<String>	getWebPaths(String viewId) For a given JSF view-ID, if the view-ID is valid, return all known context-relative URLs with which that resource may be accessed.

Methods inherited from interface org.jboss.forge.project.Facet

getProject, install, isInstalled, setProject, uninstall

Method Detail

getConfigFile

FileResource<?> getConfigFile()

Get a reference to this Project's configured WEB-INF/faces-config.xml file.

Note: This method does not take into account any configuration files that may have been specified by the javax.faces.CONFIG_FILES context-parameter.

getProjectStage

org.jboss.shrinkwrap.descriptor.api.spec.servlet.web.FacesProjectStage getProjectStage()

Get this application's currently configured FacesProjectStage.

getFacesServletMappings

List<String> getFacesServletMappings()

Get this application's currently configured FacesServlet mappings.

getWebPaths

List<String> getWebPaths(Resource<?> r)

For a given Resource, if the resource is a web-resource, return all known context-relative URLs with which that resource may be accessed.

E.g: If the Faces Servlet were mapped to *.jsf, given the resource "$PROJECT_HOME/src/main/webapp/example.xhtml", this method would return "/example.jsf"

getWebPaths

List<String> getWebPaths(String viewId)

For a given JSF view-ID, if the view-ID is valid, return all known context-relative URLs with which that resource may be accessed.

E.g: If the Faces Servlet were mapped to *.jsf, given the view-ID "/example.xhtml", this method would return "/example.jsf"

getResourceForWebPath

Resource<?> getResourceForWebPath(String path)

Given a web path, return the corresponding resource to which that path would resolve when the application is deployed.

E.g: If the Faces Servlet were mapped to *.jsf, given a web path of, "/example.jsf", this method would return a Resource reference to "$PROJECT_HOME/src/main/webapp/example.xhtml"

getFacesSuffixes

List<String> getFacesSuffixes()

Return all configured JSP or Facelets default suffixes.

See Also:

#getFacesDefaultSuffixes()}, {@link #getFaceletsDefaultSuffixes()}

getFacesDefaultSuffixes

List<String> getFacesDefaultSuffixes()

Return all Faces default suffixes for JSP files as configured by the javax.faces.DEFAULT_SUFFIX context-parameter.

getFaceletsDefaultSuffixes

List<String> getFaceletsDefaultSuffixes()

Return all Faces default suffixes for JSP files as configured by the javax.faces.FACELETS_SUFFIX context-parameter.

getFaceletsViewMapping

List<String> getFaceletsViewMapping()

Return all Facelets view mappings as configured by the javax.faces.FACELETS_VIEW_MAPPINGS context-parameter.