Top Description Inners Fields Constructors Methods
com.sun.faces.config

public Class WebConfiguration

extends Object
Class Inheritance
Static Imports
com.sun.faces.config.WebConfiguration.WebContextInitParameter.DefaultSuffix, .WebConfiguration.WebContextInitParameter.FaceletsSuffix, java.util.Arrays.asList, java.util.logging.Level.FINE, java.util.regex.Pattern.CASE_INSENSITIVE, .Pattern.compile

Class Documentation

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
WebConfiguration.BooleanWebContextInitParameter

An enum of all boolean context initalization parameters recognized by the implementation.

private class
private static interface
private class
private static interface
public static enum
WebConfiguration.DisableUnicodeEscaping

An enum of all possible values for the disableUnicodeEscaping configuration parameter.

private static class
public static enum
WebConfiguration.WebContextInitParameter

An enum of all non-boolean context initalization parameters recognized by the implementation.

public static enum
WebConfiguration.WebEnvironmentEntry

An enum of all environment entries (specified in the web.xml) recognized by the implemenetation.

Field Summary

Modifier and TypeField and Description
private static final Pattern
private Map<WebConfiguration.BooleanWebContextInitParameter, Boolean>
private Map<WebConfiguration.WebContextInitParameter, String[]>
private Map<WebConfiguration.WebContextInitParameter, String>
private ArrayList<WebConfiguration.DeferredLoggingAction>
private Map<WebConfiguration.WebEnvironmentEntry, String>
private FaceletsConfiguration
private Map<WebConfiguration.WebContextInitParameter, Map<String, String>>
private boolean
private static final Logger
private Level
public static final String
private static final int
private static final String
private ServletContext
private Set<String>
private static final String

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public boolean
pack-priv static void
clear(ServletContext servletContext)

private void
public void
public String[]

Returns:

merged suffixes including both default suffixes and the facelet suffixes.
getConfiguredExtensions
()

To include the facelets suffix into the supported suffixes.

public String

Returns:

the value of the specified env-entry
getEnvironmentEntry
(WebConfiguration.WebEnvironmentEntry
the env-entry of interest
entry
)

Obtain the value of the specified env-entry

public FaceletsConfiguration
public Map<String, String>
public Map<String, String>
public static WebConfiguration

Returns:

the WebConfiguration for this application or null if no FacesContext is available.
getInstance
()

Return the WebConfiguration instance for this application passing the result of FacesContext.getCurrentInstance().getExternalContext() to getInstance(javax.faces.context.ExternalContext).

public static WebConfiguration

Returns:

the WebConfiguration for this application
getInstance
(ExternalContext
the ExternalContext for this request
extContext
)

Return the WebConfiguration instance for this application.

public static WebConfiguration

Returns:

the WebConfiguration for this application or null if no WebConfiguration could be located
getInstance
(ServletContext
the ServletContext
servletContext
)

Return the WebConfiguration instance for this application.

public static WebConfiguration
public String

Returns:

the value of the specified parameter
getOptionValue
(WebConfiguration.WebContextInitParameter
the parameter of interest
param
)

Obtain the value of the specified parameter

public String[]
public ServletContext

Returns:

The ServletContext originally used to construct this WebConfiguration instance
getServletContext
()

public String

Returns:

the name of this application
getServletContextName
()

private void
initSetList(ServletContext
the ServletContext of interest
servletContext
)

Adds all com.sun.faces init parameter names to a list.

public boolean
public boolean

Returns:

the value of the specified boolean parameter
isOptionEnabled
(WebConfiguration.BooleanWebContextInitParameter
the parameter of interest
param
)

Obtain the value of the specified boolean parameter

public boolean

Returns:

true if the parameter was explicitly set, otherwise, false
isSet
(WebConfiguration.WebContextInitParameter
the init parameter of interest
param
)

public boolean

Returns:

true if the parameter was explicitly set, otherwise, false
isSet
(WebConfiguration.BooleanWebContextInitParameter
the init parameter of interest
param
)

private boolean

Returns:

true if the name was explicitly specified
isSet
(String
the param name
name
)

private boolean

Returns:

true if the value is valid, otherwise false
isValueValid
(WebConfiguration.BooleanWebContextInitParameter
the boolean parameter
param
,
String
the configured value
value
)

Is the configured value valid against the default boolean pattern.

public void
public void
private void
processBooleanParameters(ServletContext
the ServletContext of interest
servletContext
,
String
the context name
contextName
)

Process all boolean context initialization parameters.

private void
processInitParameters(ServletContext
the ServletContext of interest
servletContext
,
String
the context name
contextName
)

Process all non-boolean context initialization parameters.

private void
processJndiEntries(String
the context name
contextName
)

Process all JNDI entries.

private void
public void
setHasFlows(boolean hasFlows)

public void
public void
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait