Class WebConfiguration

java.lang.Object
com.sun.faces.config.WebConfiguration

public class WebConfiguration extends Object
Class Documentation
  • Field Details

    • META_INF_CONTRACTS_DIR

      public static final String META_INF_CONTRACTS_DIR
  • Method Details

    • getInstance

      public static WebConfiguration getInstance()
      Return the WebConfiguration instance for this application passing the result of FacesContext.getCurrentInstance().getExternalContext() to getInstance(jakarta.faces.context.ExternalContext).
      Returns:
      the WebConfiguration for this application or null if no FacesContext is available.
    • getInstance

      public static WebConfiguration getInstance(ExternalContext extContext)
      Return the WebConfiguration instance for this application.
      Parameters:
      extContext - the ExternalContext for this request
      Returns:
      the WebConfiguration for this application
    • getInstance

      public static WebConfiguration getInstance(jakarta.servlet.ServletContext servletContext)
      Return the WebConfiguration instance for this application.
      Parameters:
      servletContext - the ServletContext
      Returns:
      the WebConfiguration for this application or null if no WebConfiguration could be located
    • getInstanceWithoutCreating

      public static WebConfiguration getInstanceWithoutCreating(jakarta.servlet.ServletContext servletContext)
    • getServletContext

      public jakarta.servlet.ServletContext getServletContext()
      Returns:
      The ServletContext originally used to construct this WebConfiguration instance
    • isHasFlows

      public boolean isHasFlows()
    • setHasFlows

      public void setHasFlows(boolean hasFlows)
    • getSpecificationVersion

      public String getSpecificationVersion()
    • isOptionEnabled

      public boolean isOptionEnabled(WebConfiguration.BooleanWebContextInitParameter param)
      Obtain the value of the specified boolean parameter
      Parameters:
      param - the parameter of interest
      Returns:
      the value of the specified boolean parameter
    • getOptionValue

      public String getOptionValue(WebConfiguration.WebContextInitParameter param)
      Obtain the value of the specified parameter
      Parameters:
      param - the parameter of interest
      Returns:
      the value of the specified parameter
    • setOptionValue

      public void setOptionValue(WebConfiguration.WebContextInitParameter param, String value)
    • setOptionEnabled

      public void setOptionEnabled(WebConfiguration.BooleanWebContextInitParameter param, boolean value)
    • getFaceletsConfiguration

      public FaceletsConfiguration getFaceletsConfiguration()
    • getFacesConfigOptionValue

      public Map<String,String> getFacesConfigOptionValue(WebConfiguration.WebContextInitParameter param, boolean create)
    • getFacesConfigOptionValue

      public Map<String,String> getFacesConfigOptionValue(WebConfiguration.WebContextInitParameter param)
    • getOptionValue

      public String[] getOptionValue(WebConfiguration.WebContextInitParameter param, String sep)
    • getEnvironmentEntry

      public String getEnvironmentEntry(WebConfiguration.WebEnvironmentEntry entry)
      Obtain the value of the specified env-entry
      Parameters:
      entry - the env-entry of interest
      Returns:
      the value of the specified env-entry
    • isSet

      public boolean isSet(WebConfiguration.WebContextInitParameter param)
      Parameters:
      param - the init parameter of interest
      Returns:
      true if the parameter was explicitly set, otherwise, false
    • isSet

      Parameters:
      param - the init parameter of interest
      Returns:
      true if the parameter was explicitly set, otherwise, false
    • overrideContextInitParameter

      public void overrideContextInitParameter(WebConfiguration.BooleanWebContextInitParameter param, boolean value)
    • getConfiguredExtensions

      public List<String> getConfiguredExtensions()
      Returns:
      the facelet suffixes.
    • overrideContextInitParameter

      public void overrideContextInitParameter(WebConfiguration.WebContextInitParameter param, String value)
    • doPostBringupActions

      public void doPostBringupActions()
    • canProcessJndiEntries

      public boolean canProcessJndiEntries()
    • toIterable

      public <T> Iterable<T> toIterable(Iterator<T> iterator)