org.apache.myfaces.spi
Class FacesConfigurationProvider

java.lang.Object
  extended by 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 Summary
FacesConfigurationProvider()
           
 
Method Summary
abstract  FacesConfig getAnnotationsFacesConfig(ExternalContext ectx, boolean metadataComplete)
          Return the FacesConfig object model retrieved from scanning annotations on the classpath.
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
abstract  List<FacesConfig> getContextSpecifiedFacesConfig(ExternalContext ectx)
          Return the FacesConfig object model retrieved from javax.faces.CONFIG_FILES web config attribute
abstract  FacesConfig getMetaInfServicesFacesConfig(ExternalContext ectx)
          Return the FacesConfig object model retrieved from locate all JSF factories from META-INF/services/[factory_key].
abstract  FacesConfig getStandardFacesConfig(ExternalContext ectx)
          Return the FacesConfig object model retrieved from MyFaces META-INF/standard-faces-config.xml file.
abstract  FacesConfig getWebAppFacesConfig(ExternalContext ectx)
          Return the FacesConfig object model retrieved from WEB-INF/faces-config.xml
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FacesConfigurationProvider

public FacesConfigurationProvider()
Method Detail

getStandardFacesConfig

public abstract FacesConfig getStandardFacesConfig(ExternalContext ectx)
Return the FacesConfig object model retrieved from MyFaces META-INF/standard-faces-config.xml file.

Parameters:
ectx -
Returns:

getMetaInfServicesFacesConfig

public 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:

getAnnotationsFacesConfig

public abstract FacesConfig getAnnotationsFacesConfig(ExternalContext ectx,
                                                      boolean metadataComplete)
Return the FacesConfig object model retrieved from scanning annotations on the classpath.

Parameters:
ectx -
metadataComplete -
Returns:

getClassloaderFacesConfig

public 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:

getContextSpecifiedFacesConfig

public abstract List<FacesConfig> getContextSpecifiedFacesConfig(ExternalContext ectx)
Return the FacesConfig object model retrieved from javax.faces.CONFIG_FILES web config attribute

Parameters:
ectx -
Returns:

getWebAppFacesConfig

public abstract FacesConfig getWebAppFacesConfig(ExternalContext ectx)
Return the FacesConfig object model retrieved from WEB-INF/faces-config.xml

Parameters:
ectx -
Returns:


Copyright © 2014 The Apache Software Foundation. All Rights Reserved.