com.sun.faces.config

Class WebConfiguration

java.lang.Object

com.sun.faces.config.WebConfiguration

public class WebConfiguration
extends Object

Class Documentation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebConfiguration.BooleanWebContextInitParameter An enum of all boolean context initalization parameters recognized by the implementation.
static class	WebConfiguration.DisableUnicodeEscaping An enum of all possible values for the disableUnicodeEscaping configuration parameter.
static class	WebConfiguration.WebContextInitParameter An enum of all non-boolean context initalization parameters recognized by the implementation.
static class	WebConfiguration.WebEnvironmentEntry An enum of all environment entries (specified in the web.xml) recognized by the implemenetation.

Field Summary

Fields

Modifier and Type	Field and Description
static String	META_INF_CONTRACTS_DIR

Method Summary

Modifier and Type	Method and Description
boolean	canProcessJndiEntries()
void	doPostBringupActions()
String[]	getConfiguredExtensions() To include the facelets suffix into the supported suffixes.
String	getEnvironmentEntry(WebConfiguration.WebEnvironmentEntry entry) Obtain the value of the specified env-entry
FaceletsConfiguration	getFaceletsConfiguration()
Map<String,String>	getFacesConfigOptionValue(WebConfiguration.WebContextInitParameter param)
Map<String,String>	getFacesConfigOptionValue(WebConfiguration.WebContextInitParameter param, boolean create)
static WebConfiguration	getInstance() Return the WebConfiguration instance for this application passing the result of FacesContext.getCurrentInstance().getExternalContext() to getInstance(jakarta.faces.context.ExternalContext).
static WebConfiguration	getInstance(jakarta.faces.context.ExternalContext extContext) Return the WebConfiguration instance for this application.
static WebConfiguration	getInstance(jakarta.servlet.ServletContext servletContext) Return the WebConfiguration instance for this application.
static WebConfiguration	getInstanceWithoutCreating(jakarta.servlet.ServletContext servletContext)
String	getOptionValue(WebConfiguration.WebContextInitParameter param) Obtain the value of the specified parameter
String[]	getOptionValue(WebConfiguration.WebContextInitParameter param, String sep)
jakarta.servlet.ServletContext	getServletContext()
String	getServletContextName()
boolean	isHasFlows()
boolean	isOptionEnabled(WebConfiguration.BooleanWebContextInitParameter param) Obtain the value of the specified boolean parameter
boolean	isSet(WebConfiguration.BooleanWebContextInitParameter param)
boolean	isSet(WebConfiguration.WebContextInitParameter param)
void	overrideContextInitParameter(WebConfiguration.BooleanWebContextInitParameter param, boolean value)
void	overrideContextInitParameter(WebConfiguration.WebContextInitParameter param, String value)
void	setHasFlows(boolean hasFlows)
void	setOptionEnabled(WebConfiguration.BooleanWebContextInitParameter param, boolean value)
void	setOptionValue(WebConfiguration.WebContextInitParameter param, String value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

META_INF_CONTRACTS_DIR

public static final String META_INF_CONTRACTS_DIR

Method Detail

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(jakarta.faces.context.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)

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

public boolean isSet(WebConfiguration.BooleanWebContextInitParameter param)

Parameters:

param - the init parameter of interest

Returns:

true if the parameter was explicitly set, otherwise, false

getServletContextName

public String getServletContextName()

Returns:

the name of this application

overrideContextInitParameter

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

getConfiguredExtensions

public String[] getConfiguredExtensions()

To include the facelets suffix into the supported suffixes.

Returns:

merged suffixes including both default suffixes and the facelet suffixes.

overrideContextInitParameter

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

doPostBringupActions

public void doPostBringupActions()

canProcessJndiEntries

public boolean canProcessJndiEntries()