Package org.apache.myfaces.spi
Class FacesConfigurationProvider
- java.lang.Object
- 
- org.apache.myfaces.spi.FacesConfigurationProvider
 
- 
- Direct Known Subclasses:
- DefaultFacesConfigurationProvider,- FacesConfigurationProviderWrapper
 
 public abstract class FacesConfigurationProvider extends Object This interface provide a way to merge and store all JSF config information retrieved from faces-config files, META-INF/service files and annotations that works as base point to initialize MyFaces. The objective is allow server containers to "store" or this information, preventing calculate it over and over each time the web application is started.To wrap the default FacesConfigurationProvider, use a constructor like CustomFacesConfigurationProvider(FacesConfigurationProvider fcp) and extend it from FacesConfigurationProviderWrapper - Since:
- 2.0.3
- Author:
- Leonardo Uribe
 
- 
- 
Constructor SummaryConstructors Constructor Description FacesConfigurationProvider()
 - 
Method SummaryAll Methods Instance Methods Abstract Methods Modifier and Type Method Description abstract FacesConfiggetAnnotationsFacesConfig(ExternalContext ectx, boolean metadataComplete)Return the FacesConfig object model retrieved from scanning annotations on the classpath.abstract List<FacesConfig>getApplicationConfigurationResourceDocumentPopulatorFacesConfig(ExternalContext ectx)Return the FacesConfig object model retrieved from SPI ApplicationConfigurationPopulatorabstract List<FacesConfig>getClassloaderFacesConfig(ExternalContext ectx)Return the FacesConfig object model retrieved from resources under the path META-INF/faces-config.xml and META-INF/[prefix].faces-config.xmlabstract List<FacesConfig>getContextSpecifiedFacesConfig(ExternalContext ectx)Return the FacesConfig object model retrieved from jakarta.faces.CONFIG_FILES web config attributeabstract List<FacesConfig>getFaceletTaglibFacesConfig(ExternalContext ectx)Return the FacesConfig object model retrieved from parsing .taglib.xml files according to spec rules.abstract List<FacesConfig>getFacesFlowFacesConfig(ExternalContext ectx)Return the FacesConfig object model retrieved from a folder with a faces flow definition See JSF 2.2 section 11.4.3.3 and section 7.5.1abstract FacesConfiggetMetaInfServicesFacesConfig(ExternalContext ectx)Return the FacesConfig object model retrieved from locate all JSF factories from META-INF/services/[factory_key].abstract FacesConfiggetStandardFacesConfig(ExternalContext ectx)Return the FacesConfig object model retrieved from MyFaces META-INF/standard-faces-config.xml file.abstract FacesConfiggetWebAppFacesConfig(ExternalContext ectx)Return the FacesConfig object model retrieved from WEB-INF/faces-config.xml
 
- 
- 
- 
Method Detail- 
getStandardFacesConfigpublic abstract FacesConfig getStandardFacesConfig(ExternalContext ectx) Return the FacesConfig object model retrieved from MyFaces META-INF/standard-faces-config.xml file.- Parameters:
- ectx-
- Returns:
 
 - 
getMetaInfServicesFacesConfigpublic abstract FacesConfig getMetaInfServicesFacesConfig(ExternalContext ectx) Return the FacesConfig object model retrieved from locate all JSF factories from META-INF/services/[factory_key]. The default implementation uses ServiceProviderFinder facilities to locate this SPI interfaces.- Parameters:
- ectx-
- Returns:
 
 - 
getAnnotationsFacesConfigpublic abstract FacesConfig getAnnotationsFacesConfig(ExternalContext ectx, boolean metadataComplete) Return the FacesConfig object model retrieved from scanning annotations on the classpath.- Parameters:
- ectx-
- metadataComplete-
- Returns:
 
 - 
getClassloaderFacesConfigpublic abstract List<FacesConfig> getClassloaderFacesConfig(ExternalContext ectx) Return the FacesConfig object model retrieved from resources under the path META-INF/faces-config.xml and META-INF/[prefix].faces-config.xml- Parameters:
- ectx-
- Returns:
 
 - 
getContextSpecifiedFacesConfigpublic abstract List<FacesConfig> getContextSpecifiedFacesConfig(ExternalContext ectx) Return the FacesConfig object model retrieved from jakarta.faces.CONFIG_FILES web config attribute- Parameters:
- ectx-
- Returns:
 
 - 
getWebAppFacesConfigpublic abstract FacesConfig getWebAppFacesConfig(ExternalContext ectx) Return the FacesConfig object model retrieved from WEB-INF/faces-config.xml- Parameters:
- ectx-
- Returns:
 
 - 
getFacesFlowFacesConfigpublic abstract List<FacesConfig> getFacesFlowFacesConfig(ExternalContext ectx) Return the FacesConfig object model retrieved from a folder with a faces flow definition See JSF 2.2 section 11.4.3.3 and section 7.5.1- Parameters:
- ectx-
- Returns:
 
 - 
getApplicationConfigurationResourceDocumentPopulatorFacesConfigpublic abstract List<FacesConfig> getApplicationConfigurationResourceDocumentPopulatorFacesConfig(ExternalContext ectx) Return the FacesConfig object model retrieved from SPI ApplicationConfigurationPopulator
 - 
getFaceletTaglibFacesConfigpublic abstract List<FacesConfig> getFaceletTaglibFacesConfig(ExternalContext ectx) Return the FacesConfig object model retrieved from parsing .taglib.xml files according to spec rules.
 
- 
 
-