Package org.apache.myfaces.spi
Class FacesConfigurationProvider
java.lang.Object
org.apache.myfaces.spi.FacesConfigurationProvider
- Direct Known Subclasses:
- DefaultFacesConfigurationProvider,- FacesConfigurationProviderWrapper
This interface provide a way to merge and store all Faces 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
- 
Method SummaryModifier and TypeMethodDescriptionabstract FacesConfiggetAnnotationsFacesConfig(ExternalContext ectx, boolean metadataComplete) Return the FacesConfig object model retrieved from scanning annotations on the classpath.abstract List<FacesConfig>Return the FacesConfig object model retrieved from SPI ApplicationConfigurationPopulatorabstract List<FacesConfig>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>Return the FacesConfig object model retrieved from jakarta.faces.CONFIG_FILES web config attributeabstract List<FacesConfig>Return the FacesConfig object model retrieved from parsing .taglib.xml files according to spec rules.abstract List<FacesConfig>Return the FacesConfig object model retrieved from a folder with a faces flow definition See Faces 2.2 section 11.4.3.3 and section 7.5.1abstract FacesConfigReturn the FacesConfig object model retrieved from locate all Faces factories from META-INF/services/[factory_key].abstract FacesConfigReturn the FacesConfig object model retrieved from MyFaces META-INF/standard-faces-config.xml file.abstract FacesConfigReturn the FacesConfig object model retrieved from WEB-INF/faces-config.xml
- 
Constructor Details- 
FacesConfigurationProviderpublic FacesConfigurationProvider()
 
- 
- 
Method Details- 
getStandardFacesConfigReturn the FacesConfig object model retrieved from MyFaces META-INF/standard-faces-config.xml file.- Parameters:
- ectx-
- Returns:
 
- 
getMetaInfServicesFacesConfigReturn the FacesConfig object model retrieved from locate all Faces 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:
 
- 
getClassloaderFacesConfigReturn 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:
 
- 
getContextSpecifiedFacesConfigReturn the FacesConfig object model retrieved from jakarta.faces.CONFIG_FILES web config attribute- Parameters:
- ectx-
- Returns:
 
- 
getWebAppFacesConfigReturn the FacesConfig object model retrieved from WEB-INF/faces-config.xml- Parameters:
- ectx-
- Returns:
 
- 
getFacesFlowFacesConfigReturn the FacesConfig object model retrieved from a folder with a faces flow definition See Faces 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
- 
getFaceletTaglibFacesConfigReturn the FacesConfig object model retrieved from parsing .taglib.xml files according to spec rules.
 
-