Package org.apache.myfaces.spi

Class FacesConfigurationProviderWrapper

java.lang.Object

org.apache.myfaces.spi.FacesConfigurationProvider

org.apache.myfaces.spi.FacesConfigurationProviderWrapper

All Implemented Interfaces:

FacesWrapper<FacesConfigurationProvider>

public abstract class FacesConfigurationProviderWrapper
extends FacesConfigurationProvider
implements FacesWrapper<FacesConfigurationProvider>

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

Constructors

Constructor	Description
FacesConfigurationProviderWrapper()

Method Summary

Modifier and Type	Method	Description
FacesConfig	getAnnotationsFacesConfig(ExternalContext ectx, boolean metadataComplete)	Return the FacesConfig object model retrieved from scanning annotations on the classpath.
List<FacesConfig>	getApplicationConfigurationResourceDocumentPopulatorFacesConfig(ExternalContext ectx)	Return the FacesConfig object model retrieved from SPI ApplicationConfigurationPopulator
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
List<FacesConfig>	getContextSpecifiedFacesConfig(ExternalContext ectx)	Return the FacesConfig object model retrieved from jakarta.faces.CONFIG_FILES web config attribute
List<FacesConfig>	getFaceletTaglibFacesConfig(ExternalContext ectx)	Return the FacesConfig object model retrieved from parsing .taglib.xml files according to spec rules.
List<FacesConfig>	getFacesFlowFacesConfig(ExternalContext ectx)	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.1
FacesConfig	getMetaInfServicesFacesConfig(ExternalContext ectx)	Return the FacesConfig object model retrieved from locate all Faces factories from META-INF/services/[factory_key].
FacesConfig	getStandardFacesConfig(ExternalContext ectx)	Return the FacesConfig object model retrieved from MyFaces META-INF/standard-faces-config.xml file.
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

Methods inherited from interface jakarta.faces.FacesWrapper

getWrapped

Constructor Detail

FacesConfigurationProviderWrapper

public FacesConfigurationProviderWrapper()

Method Detail

getStandardFacesConfig

public FacesConfig getStandardFacesConfig(ExternalContext ectx)

Description copied from class: FacesConfigurationProvider

Return the FacesConfig object model retrieved from MyFaces META-INF/standard-faces-config.xml file.

Specified by:

getStandardFacesConfig in class FacesConfigurationProvider

Returns:

getMetaInfServicesFacesConfig

public FacesConfig getMetaInfServicesFacesConfig(ExternalContext ectx)

Description copied from class: FacesConfigurationProvider

Return 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.

Specified by:

getMetaInfServicesFacesConfig in class FacesConfigurationProvider

Returns:

getAnnotationsFacesConfig

public FacesConfig getAnnotationsFacesConfig(ExternalContext ectx,
                                             boolean metadataComplete)

Description copied from class: FacesConfigurationProvider

Return the FacesConfig object model retrieved from scanning annotations on the classpath.

Specified by:

getAnnotationsFacesConfig in class FacesConfigurationProvider

Returns:

getClassloaderFacesConfig

public List<FacesConfig> getClassloaderFacesConfig(ExternalContext ectx)

Description copied from class: FacesConfigurationProvider

Return the FacesConfig object model retrieved from resources under the path META-INF/faces-config.xml and META-INF/[prefix].faces-config.xml

Specified by:

getClassloaderFacesConfig in class FacesConfigurationProvider

Returns:

getContextSpecifiedFacesConfig

public List<FacesConfig> getContextSpecifiedFacesConfig(ExternalContext ectx)

Description copied from class: FacesConfigurationProvider

Return the FacesConfig object model retrieved from jakarta.faces.CONFIG_FILES web config attribute

Specified by:

getContextSpecifiedFacesConfig in class FacesConfigurationProvider

Returns:

getWebAppFacesConfig

public FacesConfig getWebAppFacesConfig(ExternalContext ectx)

Description copied from class: FacesConfigurationProvider

Return the FacesConfig object model retrieved from WEB-INF/faces-config.xml

Specified by:

getWebAppFacesConfig in class FacesConfigurationProvider

Returns:

getFacesFlowFacesConfig

public List<FacesConfig> getFacesFlowFacesConfig(ExternalContext ectx)

Description copied from class: FacesConfigurationProvider

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.1

Specified by:

getFacesFlowFacesConfig in class FacesConfigurationProvider

Returns:

getApplicationConfigurationResourceDocumentPopulatorFacesConfig

public List<FacesConfig> getApplicationConfigurationResourceDocumentPopulatorFacesConfig(ExternalContext ectx)

Description copied from class: FacesConfigurationProvider

Return the FacesConfig object model retrieved from SPI ApplicationConfigurationPopulator

Specified by:

getApplicationConfigurationResourceDocumentPopulatorFacesConfig in class FacesConfigurationProvider

getFaceletTaglibFacesConfig

public List<FacesConfig> getFaceletTaglibFacesConfig(ExternalContext ectx)

Description copied from class: FacesConfigurationProvider

Return the FacesConfig object model retrieved from parsing .taglib.xml files according to spec rules.

Specified by:

getFaceletTaglibFacesConfig in class FacesConfigurationProvider