org.apache.myfaces.spi
Class WebConfigProvider

java.lang.Object
  extended by org.apache.myfaces.spi.WebConfigProvider
Direct Known Subclasses:
DefaultWebConfigProvider

public abstract class WebConfigProvider
extends Object

SPI to provide a custom WebConfigProvider implementation.

Since:
2.0.3
Author:
Leonardo Uribe

Constructor Summary
WebConfigProvider()
           
 
Method Summary
abstract  List<ServletMapping> getFacesServletMappings(ExternalContext externalContext)
          Return the mappings configured on web.xml related to JSF FacesServlet.
abstract  boolean isErrorPagePresent(ExternalContext externalContext)
          Indicate if an error page is configured on web.xml file
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WebConfigProvider

public WebConfigProvider()
Method Detail

getFacesServletMappings

public abstract List<ServletMapping> getFacesServletMappings(ExternalContext externalContext)
Return the mappings configured on web.xml related to JSF FacesServlet.

By default, the algorithm contemplate these three options:

  1. Mappings related to registered servlet class javax.faces.webapp.FacesServlet.
  2. Mappings related to registered servlet class implementing org.apache.myfaces.shared_impl.webapp.webxml.DelegatedFacesServlet interface.
  3. Mappings related to registered servlet class registered using org.apache.myfaces.DELEGATE_FACES_SERVLET web config param.

Parameters:
externalContext -
Returns:

isErrorPagePresent

public abstract boolean isErrorPagePresent(ExternalContext externalContext)
Indicate if an error page is configured on web.xml file

Parameters:
externalContext -
Returns:


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