com.sun.faces.config
Class WebConfiguration

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

public class WebConfiguration
extends java.lang.Object

Class Documentation

Nested Class Summary

static class	WebConfiguration.BooleanWebContextInitParameter An enum of all boolean context initalization parameters recognized by the implementation.
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 implmenetation.

Method Summary

boolean	getBooleanContextInitParameter(WebConfiguration.BooleanWebContextInitParameter param) Obtain the value of the specified boolean parameter
java.lang.String	getContextInitParameter(WebConfiguration.WebContextInitParameter param) Obtain the value of the specified parameter
java.lang.String	getEnvironmentEntry(WebConfiguration.WebEnvironmentEntry entry) Obtain the value of the specified env-entry
static WebConfiguration	getInstance() Return the WebConfiguration instance for this application passing the result of FacesContext.getCurrentInstance().getExternalContext() to getInstance(javax.faces.context.ExternalContext).
static WebConfiguration	getInstance(javax.faces.context.ExternalContext extContext) Return the WebConfiguration instance for this application.
static WebConfiguration	getInstance(javax.servlet.ServletContext servletContext) Return the WebConfiguration instance for this application.
javax.servlet.ServletContext	getServletContext()
java.lang.String	getServletContextName()
void	overrideContextInitParameter(WebConfiguration.BooleanWebContextInitParameter param)
void	overrideContextInitParameter(WebConfiguration.WebContextInitParameter param)
void	overrideEnvEntry(WebConfiguration.WebEnvironmentEntry entry)

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static WebConfiguration getInstance()

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

Returns:

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

getInstance

public static WebConfiguration getInstance(javax.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(javax.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

getServletContext

public javax.servlet.ServletContext getServletContext()

Returns:

The ServletContext originally used to construct this WebConfiguration instance

getBooleanContextInitParameter

public boolean getBooleanContextInitParameter(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

getContextInitParameter

public java.lang.String getContextInitParameter(WebConfiguration.WebContextInitParameter param)

Obtain the value of the specified parameter

Parameters:

param - the parameter of interest

Returns:

the value of the specified parameter

getEnvironmentEntry

public java.lang.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

getServletContextName

public java.lang.String getServletContextName()

Returns:

the name of this application

overrideContextInitParameter

public void overrideContextInitParameter(WebConfiguration.BooleanWebContextInitParameter param)

overrideContextInitParameter

public void overrideContextInitParameter(WebConfiguration.WebContextInitParameter param)

overrideEnvEntry

public void overrideEnvEntry(WebConfiguration.WebEnvironmentEntry entry)