Author: nbelaevski Date: 2010-11-10 12:10:46 -0500 (Wed, 10 Nov 2010) New Revision: 20017 Modified: trunk/examples/richfaces-showcase/src/main/java-gae-jsf-ri/com/sun/faces/config/WebConfiguration.java Log: Update of WebConfiguration for Mojarra 2.0.3 Modified: trunk/examples/richfaces-showcase/src/main/java-gae-jsf-ri/com/sun/faces/config/WebConfiguration.java =================================================================== --- trunk/examples/richfaces-showcase/src/main/java-gae-jsf-ri/com/sun/faces/config/WebConfiguration.java 2010-11-10 17:06:55 UTC (rev 20016) +++ trunk/examples/richfaces-showcase/src/main/java-gae-jsf-ri/com/sun/faces/config/WebConfiguration.java 2010-11-10 17:10:46 UTC (rev 20017) @@ -40,8 +40,9 @@ import java.util.EnumMap; import java.util.Enumeration; import java.util.HashMap; -import java.util.List; +import java.util.HashSet; import java.util.Map; +import java.util.Set; import java.util.logging.Level; import java.util.logging.Logger; import java.util.regex.Pattern; @@ -59,1051 +60,1329 @@ import com.sun.faces.util.FacesLogger; import com.sun.faces.util.Util; + /** Class Documentation */ -public class WebConfiguration -{ +public class WebConfiguration { - // Log instance for this class - private static final Logger LOGGER = FacesLogger.CONFIG.getLogger(); - // A Simple regular expression of allowable boolean values - private static final Pattern ALLOWABLE_BOOLEANS = Pattern - .compile("true|false"); + // Log instance for this class + private static final Logger LOGGER = FacesLogger.CONFIG.getLogger(); - // Key under which we store our WebConfiguration instance. - private static final String WEB_CONFIG_KEY = "com.sun.faces.config.WebConfiguration"; + // A Simple regular expression of allowable boolean values + private static final Pattern ALLOWABLE_BOOLEANS = + Pattern.compile("true|false"); - // Logging level. Defaults to FINE - private Level loggingLevel = Level.FINE; + // Key under which we store our WebConfiguration instance. + private static final String WEB_CONFIG_KEY = + "com.sun.faces.config.WebConfiguration"; - private Map<BooleanWebContextInitParameter, Boolean> booleanContextParameters = new EnumMap<BooleanWebContextInitParameter, Boolean>( - BooleanWebContextInitParameter.class); + // Logging level. Defaults to FINE + private Level loggingLevel = Level.FINE; - private Map<WebContextInitParameter, String> contextParameters = new EnumMap<WebContextInitParameter, String>( - WebContextInitParameter.class); + private Map<BooleanWebContextInitParameter, Boolean> booleanContextParameters = + new EnumMap<BooleanWebContextInitParameter, Boolean>(BooleanWebContextInitParameter.class); - private Map<WebEnvironmentEntry, String> envEntries = new EnumMap<WebEnvironmentEntry, String>( - WebEnvironmentEntry.class); + private Map<WebContextInitParameter, String> contextParameters = + new EnumMap<WebContextInitParameter, String>(WebContextInitParameter.class); - private Map<WebContextInitParameter, String[]> cachedListParams; + private Map<WebEnvironmentEntry, String> envEntries = + new EnumMap<WebEnvironmentEntry, String>(WebEnvironmentEntry.class); - private List<String> setParams = new ArrayList<String>(); + private Map<WebContextInitParameter, String []> cachedListParams; - private ServletContext servletContext; + private Set<String> setParams = new HashSet<String>(); - // ------------------------------------------------------------ Constructors + private ServletContext servletContext; - private WebConfiguration(ServletContext servletContext) - { + private ArrayList<DeferredLoggingAction> deferredLoggingActions; - this.servletContext = servletContext; - String contextName = getServletContextName(); + // ------------------------------------------------------------ Constructors - initSetList(servletContext); - processBooleanParameters(servletContext, contextName); - processInitParameters(servletContext, contextName); - if (canProcessJndiEntries()) - { - processJndiEntries(contextName); - } - // build the cache of list type params - cachedListParams = new HashMap<WebContextInitParameter, String[]>(3); - getOptionValue(WebContextInitParameter.ResourceExcludes, " "); - getOptionValue(WebContextInitParameter.DefaultSuffix, " "); - getOptionValue(WebContextInitParameter.FaceletsViewMappings, ";"); + private WebConfiguration(ServletContext servletContext) { - } + this.servletContext = servletContext; - // ---------------------------------------------------------- Public Methods + String contextName = getServletContextName(); - /** - * Return the WebConfiguration instance for this application passing the - * result of FacesContext.getCurrentInstance().getExternalContext() to - * {@link #getInstance(javax.faces.context.ExternalContext)}. - * - * @return the WebConfiguration for this application or <code>null</code> if - * no FacesContext is available. - */ - public static WebConfiguration getInstance() - { + initSetList(servletContext); + processBooleanParameters(servletContext, contextName); + processInitParameters(servletContext, contextName); + if (canProcessJndiEntries()) { + processJndiEntries(contextName); + } + + // build the cache of list type params + cachedListParams = new HashMap<WebContextInitParameter, String []>(3); + getOptionValue(WebContextInitParameter.ResourceExcludes, " "); + getOptionValue(WebContextInitParameter.DefaultSuffix, " "); + getOptionValue(WebContextInitParameter.FaceletsViewMappings, ";"); - FacesContext facesContext = FacesContext.getCurrentInstance(); - return getInstance(facesContext.getExternalContext()); + } - } - /** - * Return the WebConfiguration instance for this application. - * - * @param extContext - * the ExternalContext for this request - * @return the WebConfiguration for this application - */ - public static WebConfiguration getInstance(ExternalContext extContext) - { + // ---------------------------------------------------------- Public Methods - WebConfiguration config = (WebConfiguration) extContext - .getApplicationMap().get(WEB_CONFIG_KEY); - if (config == null) - { - return getInstance((ServletContext) extContext.getContext()); - } - else - { - return config; - } - } + /** + * Return the WebConfiguration instance for this application passing + * the result of FacesContext.getCurrentInstance().getExternalContext() + * to {@link #getInstance(javax.faces.context.ExternalContext)}. + * @return the WebConfiguration for this application or <code>null</code> + * if no FacesContext is available. + */ + public static WebConfiguration getInstance() { - /** - * Return the WebConfiguration instance for this application. - * - * @param servletContext - * the ServletContext - * @return the WebConfiguration for this application or <code>null</code> if - * no WebConfiguration could be located - */ - public static WebConfiguration getInstance(ServletContext servletContext) - { + FacesContext facesContext = FacesContext.getCurrentInstance(); + return getInstance(facesContext.getExternalContext()); - WebConfiguration webConfig = (WebConfiguration) servletContext - .getAttribute(WEB_CONFIG_KEY); + } - if (webConfig == null) - { - webConfig = new WebConfiguration(servletContext); - servletContext.setAttribute(WEB_CONFIG_KEY, webConfig); - } - return webConfig; - } + /** + * Return the WebConfiguration instance for this application. + * @param extContext the ExternalContext for this request + * @return the WebConfiguration for this application + */ + public static WebConfiguration getInstance(ExternalContext extContext) { - /** - * @return The <code>ServletContext</code> originally used to construct this - * WebConfiguration instance - */ - public ServletContext getServletContext() - { + WebConfiguration config = (WebConfiguration) extContext.getApplicationMap() + .get(WEB_CONFIG_KEY); + if (config == null) { + return getInstance((ServletContext) extContext.getContext()); + } else { + return config; + } - return servletContext; + } - } - /** - * Obtain the value of the specified boolean parameter - * - * @param param - * the parameter of interest - * @return the value of the specified boolean parameter - */ - public boolean isOptionEnabled(BooleanWebContextInitParameter param) - { + /** + * Return the WebConfiguration instance for this application. + * @param servletContext the ServletContext + * @return the WebConfiguration for this application or <code>null</code> + * if no WebConfiguration could be located + */ + public static WebConfiguration getInstance(ServletContext servletContext) { - if (booleanContextParameters.get(param) != null) - { - return booleanContextParameters.get(param); - } - else - { - return param.getDefaultValue(); - } + WebConfiguration webConfig = (WebConfiguration) + servletContext.getAttribute(WEB_CONFIG_KEY); - } + if (webConfig == null) { + webConfig = new WebConfiguration(servletContext); + servletContext.setAttribute(WEB_CONFIG_KEY, webConfig); + } + return webConfig; - /** - * Obtain the value of the specified parameter - * - * @param param - * the parameter of interest - * @return the value of the specified parameter - */ - public String getOptionValue(WebContextInitParameter param) - { - String result = contextParameters.get(param); + } - if (null == result) - { - WebContextInitParameter alternate = param.getAlternate(); - if (null != alternate) - { - result = contextParameters.get(alternate); - } - } - return result; + /** + * @return The <code>ServletContext</code> originally used to construct + * this WebConfiguration instance + */ + public ServletContext getServletContext() { - } + return servletContext; - public String[] getOptionValue(WebContextInitParameter param, String sep) - { - String[] result; + } - assert (null != cachedListParams); - if (null == (result = cachedListParams.get(param))) - { - String value = getOptionValue(param); - if (null == value) - { - result = new String[0]; - } - else - { - result = Util.split(value, sep); - } - cachedListParams.put(param, result); - } - return result; - } + /** + * Obtain the value of the specified boolean parameter + * @param param the parameter of interest + * @return the value of the specified boolean parameter + */ + public boolean isOptionEnabled(BooleanWebContextInitParameter param) { - /** - * Obtain the value of the specified env-entry - * - * @param entry - * the env-entry of interest - * @return the value of the specified env-entry - */ - public String getEnvironmentEntry(WebEnvironmentEntry entry) - { + if (booleanContextParameters.get(param) != null) { + return booleanContextParameters.get(param); + } else { + return param.getDefaultValue(); + } - return envEntries.get(entry); + } - } - /** - * @param param - * the init parameter of interest - * @return <code>true</code> if the parameter was explicitly set, otherwise, - * <code>false</code> - */ - public boolean isSet(WebContextInitParameter param) - { + /** + * Obtain the value of the specified parameter + * @param param the parameter of interest + * @return the value of the specified parameter + */ + public String getOptionValue(WebContextInitParameter param) { + String result = contextParameters.get(param); + + if (null == result) { + WebContextInitParameter alternate = param.getAlternate(); + if (null != alternate) { + result = contextParameters.get(alternate); + } + } - return isSet(param.getQualifiedName()); + return result; - } + } + + public String[] getOptionValue(WebContextInitParameter param, String sep) { + String [] result; + + assert(null != cachedListParams); + if (null == (result = cachedListParams.get(param))) { + String value = getOptionValue(param); + if (null == value) { + result = new String[0]; + } else { + result = Util.split(value, sep); + } + cachedListParams.put(param, result); + } + + return result; + } - /** - * @param param - * the init parameter of interest - * @return <code>true</code> if the parameter was explicitly set, otherwise, - * <code>false</code> - */ - public boolean isSet(BooleanWebContextInitParameter param) - { - return isSet(param.getQualifiedName()); + /** + * Obtain the value of the specified env-entry + * @param entry the env-entry of interest + * @return the value of the specified env-entry + */ + public String getEnvironmentEntry(WebEnvironmentEntry entry) { - } + return envEntries.get(entry); - /** - * @return the name of this application - */ - public String getServletContextName() - { + } - if (servletContext.getMajorVersion() == 2 - && servletContext.getMinorVersion() <= 4) - { - return servletContext.getServletContextName(); - } - else - { - return servletContext.getContextPath(); - } - } + /** + * @param param the init parameter of interest + * @return <code>true</code> if the parameter was explicitly set, + * otherwise, <code>false</code> + */ + public boolean isSet(WebContextInitParameter param) { - public void overrideContextInitParameter( - BooleanWebContextInitParameter param, boolean value) - { + return isSet(param.getQualifiedName()); - if (param == null) { return; } - boolean oldVal = booleanContextParameters.put(param, value); - if (LOGGER.isLoggable(Level.FINE) && oldVal != value) - { - LOGGER - .log( - Level.FINE, - "Overriding init parameter {0}. Changing from {1} to {2}.", - new Object[] - { - param.getQualifiedName(), oldVal, value - }); - } + } - } - public void overrideContextInitParameter(WebContextInitParameter param, - String value) - { + /** + * @param param the init parameter of interest + * @return <code>true</code> if the parameter was explicitly set, + * otherwise, <code>false</code> + */ + public boolean isSet(BooleanWebContextInitParameter param) { - if (param == null || value == null || value.length() == 0) { return; } - value = value.trim(); - String oldVal = contextParameters.put(param, value); - cachedListParams.remove(param); - if (oldVal != null) - { - if (LOGGER.isLoggable(Level.FINE) && !(oldVal.equals(value))) - { - LOGGER - .log( - Level.FINE, - "Overriding init parameter {0}. Changing from {1} to {2}.", - new Object[] - { - param.getQualifiedName(), oldVal, value - }); - } - } + return isSet(param.getQualifiedName()); - } + } - // ------------------------------------------------- Package Private Methods - static void clear(ServletContext servletContext) - { + /** + * @return the name of this application + */ + public String getServletContextName() { - servletContext.removeAttribute(WEB_CONFIG_KEY); + if (servletContext.getMajorVersion() == 2 + && servletContext.getMinorVersion() <= 4) { + return servletContext.getServletContextName(); + } else { + return servletContext.getContextPath(); + } - } + } - // --------------------------------------------------------- Private Methods - /** - * <p> - * Is the configured value valid against the default boolean pattern. - * </p> - * - * @param param - * the boolean parameter - * @param value - * the configured value - * @return <code>true</code> if the value is valid, otherwise - * <code>false</code> - */ - private boolean isValueValid(BooleanWebContextInitParameter param, - String value) - { + public void overrideContextInitParameter(BooleanWebContextInitParameter param, boolean value) { - if (!ALLOWABLE_BOOLEANS.matcher(value).matches()) - { - if (LOGGER.isLoggable(Level.WARNING)) - { - LOGGER.log(Level.WARNING, - "jsf.config.webconfig.boolconfig.invalidvalue", - new Object[] - { - value, param.getQualifiedName(), "true|false" - }); - } - return false; - } + if (param == null) { + return; + } + boolean oldVal = booleanContextParameters.put(param, value); + if (LOGGER.isLoggable(Level.FINE) && oldVal != value) { + LOGGER.log(Level.FINE, + "Overriding init parameter {0}. Changing from {1} to {2}.", + new Object[] { param.getQualifiedName(), oldVal, value}); + } - return true; + } - } - /** - * <p> - * Process all boolean context initialization parameters. - * </p> - * - * @param servletContext - * the ServletContext of interest - * @param contextName - * the context name - */ - private void processBooleanParameters(ServletContext servletContext, - String contextName) - { + public void overrideContextInitParameter(WebContextInitParameter param, String value) { - // process boolean contxt parameters - for (BooleanWebContextInitParameter param : BooleanWebContextInitParameter - .values()) - { - String strValue = servletContext.getInitParameter(param - .getQualifiedName()); - boolean value; + if (param == null || value == null || value.length() == 0) { + return; + } + value = value.trim(); + String oldVal = contextParameters.put(param, value); + cachedListParams.remove(param); + if (oldVal != null) { + if (LOGGER.isLoggable(Level.FINE) && !(oldVal.equals(value))) { + LOGGER.log(Level.FINE, + "Overriding init parameter {0}. Changing from {1} to {2}.", + new Object[]{param.getQualifiedName(), + oldVal, + value}); + } + } - if (strValue != null && strValue.length() > 0 - && param.isDeprecated()) - { - BooleanWebContextInitParameter alternate = param.getAlternate(); - if (LOGGER.isLoggable(Level.WARNING)) - { - if (alternate != null) - { - LOGGER.log(Level.WARNING, - "jsf.config.webconfig.param.deprecated", - new Object[] - { - contextName, param.getQualifiedName(), - alternate.getQualifiedName() - }); - } - else - { - LOGGER - .log( - Level.WARNING, - "jsf.config.webconfig.param.deprecated.no_replacement", - new Object[] - { - contextName, - param.getQualifiedName() - }); - } - } - if (alternate != null) - { - if (isValueValid(param, strValue)) - { - value = Boolean.valueOf(strValue); - } - else - { - value = param.getDefaultValue(); - } + } - if (LOGGER.isLoggable(Level.INFO) && alternate != null) - { - LOGGER - .log( - Level.INFO, - ((value) ? "jsf.config.webconfig.configinfo.reset.enabled" - : "jsf.config.webconfig.configinfo.reset.disabled"), - new Object[] - { - contextName, - alternate.getQualifiedName() - }); - } - booleanContextParameters.put(alternate, value); - } - continue; - } + public void doLoggingActions() { - if (!param.isDeprecated()) - { - if (strValue == null) - { - value = param.getDefaultValue(); - } - else - { - if (isValueValid(param, strValue)) - { - value = Boolean.valueOf(strValue); - } - else - { - value = param.getDefaultValue(); - } - } + if (deferredLoggingActions != null) { + for (DeferredLoggingAction loggingAction : deferredLoggingActions) { + loggingAction.log(); + } + } - // first param processed should be - // com.sun.faces.displayConfiguration - if (BooleanWebContextInitParameter.DisplayConfiguration - .equals(param) - && value) - { - loggingLevel = Level.INFO; - } + } - if (LOGGER.isLoggable(loggingLevel)) - { - LOGGER - .log( - loggingLevel, - ((value) ? "jsf.config.webconfig.boolconfiginfo.enabled" - : "jsf.config.webconfig.boolconfiginfo.disabled"), - new Object[] - { - contextName, - param.getQualifiedName() - }); - } - booleanContextParameters.put(param, value); - } + // ------------------------------------------------- Package Private Methods - } - } + static void clear(ServletContext servletContext) { - /** - * Adds all com.sun.faces init parameter names to a list. This allows - * callers to determine if a parameter was explicitly set. - * - * @param servletContext - * the ServletContext of interest - */ - private void initSetList(ServletContext servletContext) - { + servletContext.removeAttribute(WEB_CONFIG_KEY); - for (Enumeration e = servletContext.getInitParameterNames(); e - .hasMoreElements();) - { - String name = e.nextElement().toString(); - if (name.startsWith("com.sun.faces")) - { - setParams.add(name); - } - } + } - } - /** - * @param name - * the param name - * @return <code>true</code> if the name was explicitly specified - */ - private boolean isSet(String name) - { + // --------------------------------------------------------- Private Methods - return setParams.contains(name); - } + /** + * <p>Is the configured value valid against the default boolean pattern.</p> + * @param param the boolean parameter + * @param value the configured value + * @return <code>true</code> if the value is valid, + * otherwise <code>false</code> + */ + private boolean isValueValid(BooleanWebContextInitParameter param, + String value) { - /** - * <p> - * Process all non-boolean context initialization parameters. - * </p> - * - * @param servletContext - * the ServletContext of interest - * @param contextName - * the context name - */ - private void processInitParameters(ServletContext servletContext, - String contextName) - { + if (!ALLOWABLE_BOOLEANS.matcher(value).matches()) { + if (LOGGER.isLoggable(Level.WARNING)) { + LOGGER.log(Level.WARNING, + "jsf.config.webconfig.boolconfig.invalidvalue", + new Object[]{ + value, + param.getQualifiedName(), + "true|false" + }); + } + return false; + } - for (WebContextInitParameter param : WebContextInitParameter.values()) - { - String value = servletContext.getInitParameter(param - .getQualifiedName()); + return true; - if (value != null && value.length() > 0 && param.isDeprecated()) - { - WebContextInitParameter alternate = param.getAlternate(); - if (LOGGER.isLoggable(Level.WARNING)) - { - if (alternate != null) - { - LOGGER.log(Level.WARNING, - "jsf.config.webconfig.param.deprecated", - new Object[] - { - contextName, param.getQualifiedName(), - alternate.getQualifiedName() - }); - } - else - { - LOGGER - .log( - Level.WARNING, - "jsf.config.webconfig.param.deprecated.no_replacement", - new Object[] - { - contextName, - param.getQualifiedName() - }); - } - } + } - if (alternate != null) - { - if (LOGGER.isLoggable(Level.INFO)) - { - LOGGER.log(Level.INFO, - "jsf.config.webconfig.configinfo.reset", - new Object[] - { - contextName, - alternate.getQualifiedName(), value - }); - } - contextParameters.put(alternate, value); - } - continue; - } + /** + * <p>Process all boolean context initialization parameters.</p> + * @param servletContext the ServletContext of interest + * @param contextName the context name + */ + private void processBooleanParameters(ServletContext servletContext, + String contextName) { - if ((value == null || value.length() == 0) && !param.isDeprecated()) - { - value = param.getDefaultValue(); - } - if (value == null || value.length() == 0) - { - continue; - } + // process boolean contxt parameters + for (BooleanWebContextInitParameter param : BooleanWebContextInitParameter + .values()) { + String strValue = + servletContext.getInitParameter(param.getQualifiedName()); + boolean value; - if (value.length() > 0) - { - if (LOGGER.isLoggable(loggingLevel)) - { - LOGGER.log(loggingLevel, "jsf.config.webconfig.configinfo", - new Object[] - { - contextName, param.getQualifiedName(), - value - }); + if (strValue != null && strValue.length() > 0 && param.isDeprecated()) { + BooleanWebContextInitParameter alternate = param.getAlternate(); + if (LOGGER.isLoggable(Level.WARNING)) { + if (alternate != null) { + queueLoggingAction(new DeferredBooleanParameterLoggingAction( + param, + Level.WARNING, + "jsf.config.webconfig.param.deprecated", + new Object[]{ + contextName, + param.getQualifiedName(), + alternate.getQualifiedName()})); - } - contextParameters.put(param, value); - } - else - { - if (LOGGER.isLoggable(loggingLevel)) - { - LOGGER.log(loggingLevel, - "jsf.config.webconfig.option.notconfigured", - new Object[] - { - contextName, param.getQualifiedName() - }); - } - } + } else { + queueLoggingAction(new DeferredBooleanParameterLoggingAction( + param, + Level.WARNING, + "jsf.config.webconfig.param.deprecated.no_replacement", + new Object[]{ + contextName, + param.getQualifiedName()})); - } + } + } - } + if (alternate != null) { + if (isValueValid(param, strValue)) { + value = Boolean.valueOf(strValue); + } else { + value = param.getDefaultValue(); + } - /** - * <p> - * Process all JNDI entries. - * </p> - * - * @param contextName - * the context name - */ - private void processJndiEntries(String contextName) - { -/* - * This section has been disabled due to incompatibilities with Google App Engine 1.2.6. - Context initialContext = null; - try - { - initialContext = new InitialContext(); - } - catch (NamingException ne) - { - if (LOGGER.isLoggable(Level.WARNING)) - { - LOGGER.log(Level.WARNING, ne.toString(), ne); - } - } + if (LOGGER.isLoggable(Level.INFO) && alternate != null) { + queueLoggingAction(new DeferredBooleanParameterLoggingAction( + param, + Level.INFO, + ((value) + ? "jsf.config.webconfig.configinfo.reset.enabled" + : "jsf.config.webconfig.configinfo.reset.disabled"), + new Object[]{ + contextName, + alternate.getQualifiedName()})); + } - if (initialContext != null) - { - // process environment entries - for (WebEnvironmentEntry entry : WebEnvironmentEntry.values()) - { - String entryName = entry.getQualifiedName(); - String value = null; + booleanContextParameters.put(alternate, value); + } + continue; + } - try - { - value = (String) initialContext.lookup(entryName); - } - catch (NamingException root) - { - if (LOGGER.isLoggable(Level.FINE)) - { - LOGGER.fine(root.toString()); - } - } + if (!param.isDeprecated()) { + if (strValue == null) { + value = param.getDefaultValue(); + } else { + if (isValueValid(param, strValue)) { + value = Boolean.valueOf(strValue); + } else { + value = param.getDefaultValue(); + } + } - if (value != null) - { - if (LOGGER.isLoggable(Level.INFO)) - { - // special logic for ClientStateSavingPassword - if (!entry - .equals(WebEnvironmentEntry.ClientStateSavingPassword)) - { - if (LOGGER.isLoggable(loggingLevel)) - { - LOGGER.log(loggingLevel, - "jsf.config.webconfig.enventryinfo", - new Object[] - { - contextName, entryName, value - }); - } - } - else - { - if (LOGGER.isLoggable(loggingLevel)) - { - LOGGER - .log( - loggingLevel, - "jsf.config.webconfig.enventry.clientencrypt", - contextName); - } - } - } - envEntries.put(entry, value); - } - } - } -*/ - } + // first param processed should be + // com.sun.faces.displayConfiguration + if (BooleanWebContextInitParameter.DisplayConfiguration.equals(param) && value) { + loggingLevel = Level.INFO; + } - private boolean canProcessJndiEntries() - { + if (LOGGER.isLoggable(loggingLevel)) { + LOGGER.log(loggingLevel, + ((value) + ? "jsf.config.webconfig.boolconfiginfo.enabled" + : "jsf.config.webconfig.boolconfiginfo.disabled"), + new Object[]{contextName, + param.getQualifiedName()}); + } - /* - * This section has been disabled due to incompatibilities with Google App Engine 1.2.6 - try - { - Util.getCurrentLoader(this) - .loadClass("javax.naming.InitialContext"); - } - catch (Exception e) - { - */ - if (LOGGER.isLoggable(Level.FINE)) - { - LOGGER - .fine("javax.naming is forced unavailable. JNDI entries related to Mojarra configuration will not be processed."); - } - return false; - /* - } - return true; - */ + booleanContextParameters.put(param, value); + } - } + } - // ------------------------------------------------------------------- Enums + } - /** - * <p> - * An <code>enum</code> of all non-boolean context initalization parameters - * recognized by the implementation. - * </p> - */ - public enum WebContextInitParameter - { - // implementation note: - // if a parameter is to be deprecated, - // then the <name>Deprecated enum element - // *must* appear after the one that is taking - // its place. The reporting logic depends on this + /** + * Adds all com.sun.faces init parameter names to a list. This allows + * callers to determine if a parameter was explicitly set. + * @param servletContext the ServletContext of interest + */ + private void initSetList(ServletContext servletContext) { - ManagedBeanFactoryDecorator( - "com.sun.faces.managedBeanFactoryDecoratorClass", ""), StateSavingMethod( - "javax.faces.STATE_SAVING_METHOD", "server"), FaceletsSuffix( - ViewHandler.FACELETS_SUFFIX_PARAM_NAME, - ViewHandler.DEFAULT_FACELETS_SUFFIX), DefaultSuffix( - ViewHandler.DEFAULT_SUFFIX_PARAM_NAME, - ViewHandler.DEFAULT_SUFFIX), JavaxFacesConfigFiles( - "javax.faces.CONFIG_FILES", ""), JavaxFacesProjectStage( - "javax.faces.PROJECT_STAGE", "Production"), AlternateLifecycleId( - "javax.faces.LIFECYCLE_ID", ""), ResourceExcludes( - ResourceHandler.RESOURCE_EXCLUDES_PARAM_NAME, - ResourceHandler.RESOURCE_EXCLUDES_DEFAULT_VALUE + " .groovy"), NumberOfViews( - "com.sun.faces.numberOfViewsInSession", "15"), NumberOfViewsDeprecated( - "com.sun.faces.NUMBER_OF_VIEWS_IN_SESSION", "15", true, - NumberOfViews), NumberOfLogicalViews( - "com.sun.faces.numberOfLogicalViews", "15"), NumberOfLogicalViewsDeprecated( - "com.sun.faces.NUMBER_OF_VIEWS_IN_LOGICAL_VIEW_IN_SESSION", - "15", true, NumberOfLogicalViews), NumberOfConcurrentFlashUsers( - "com.sun.faces.numberOfConcerrentFlashUsers", "5000"), NumberOfFlashesBetweenFlashReapings( - "com.sun.faces.numberOfFlashesBetweenFlashReapings", "5000"), InjectionProviderClass( - "com.sun.faces.injectionProvider", ""), SerializationProviderClass( - "com.sun.faces.serializationProvider", ""), ResponseBufferSize( - "com.sun.faces.responseBufferSize", "1024"), FaceletsBufferSize( - "javax.faces.FACELETS_BUFFER_SIZE", "1024", true, - ResponseBufferSize), FaceletsBufferSizeDeprecated( - "facelets.BUFFER_SIZE", "1024", true, FaceletsBufferSize), ClientStateWriteBufferSize( - "com.sun.faces.clientStateWriteBufferSize", "8192"), ResourceBufferSize( - "com.sun.faces.resourceBufferSize", "2048"), ExpressionFactory( - "com.sun.faces.expressionFactory", - "com.sun.el.ExpressionFactoryImpl"), ClientStateTimeout( - "com.sun.faces.clientStateTimeout", ""), DefaultResourceMaxAge( - "com.sun.faces.defaultResourceMaxAge", "604800"), ResourceUpdateCheckPeriod( - "com.sun.faces.resourceUpdateCheckPeriod", "5" // in minutes - ), CompressableMimeTypes("com.sun.faces.compressableMimeTypes", ""), DisableUnicodeEscaping( - "com.sun.faces.disableUnicodeEscaping", "auto"), FaceletsDefaultRefreshPeriod( - "javax.faces.FACELETS_REFRESH_PERIOD", "2"), FaceletsDefaultRefreshPeriodDeprecated( - "facelets.REFRESH_PERIOD", "2", true, - FaceletsDefaultRefreshPeriod), FaceletsResourceResolver( - ResourceResolver.FACELETS_RESOURCE_RESOLVER_PARAM_NAME, ""), FaceletsResourceResolverDeprecated( - "facelets.RESOURCE_RESOLVER", "", true, - FaceletsResourceResolver), FaceletsViewMappings( - ViewHandler.FACELETS_VIEW_MAPPINGS_PARAM_NAME, ""), FaceletsViewMappingsDeprecated( - "facelets.VIEW_MAPPINGS", "", true, FaceletsViewMappings), FaceletsLibraries( - "javax.faces.FACELETS_LIBRARIES", ""), FaceletsLibrariesDeprecated( - "facelets.LIBRARIES", "", true, FaceletsLibraries), FaceletsDecorators( - "javax.faces.FACELETS_DECORATORS", ""), FaceletsDecoratorsDeprecated( - "facelets.DECORATORS", "", true, FaceletsDecorators), DuplicateJARPattern( - "com.sun.faces.duplicateJARPattern", ""), ValidateEmptyFields( - UIInput.VALIDATE_EMPTY_FIELDS_PARAM_NAME, "auto"), FullStateSavingViewIds( - StateManager.FULL_STATE_SAVING_VIEW_IDS_PARAM_NAME, ""), AnnotationScanPackages( - "com.sun.faces.annotationScanPackages", ""), FaceletFactory( - "com.sun.faces.faceletFactory", ""); + for (Enumeration e = servletContext.getInitParameterNames(); + e.hasMoreElements(); ) { + String name = e.nextElement().toString(); + if (name.startsWith("com.sun.faces") || + name.startsWith("javax.faces")) { + setParams.add(name); + } + } - private String defaultValue; - private String qualifiedName; - private WebContextInitParameter alternate; - private boolean deprecated; + } - // ---------------------------------------------------------- Public - // Methods - public String getDefaultValue() - { + /** + * @param name the param name + * @return <code>true</code> if the name was explicitly specified + */ + private boolean isSet(String name) { - return defaultValue; + return setParams.contains(name); - } + } - public String getQualifiedName() - { - return qualifiedName; + /** + * <p>Process all non-boolean context initialization parameters.</p> + * @param servletContext the ServletContext of interest + * @param contextName the context name + */ + private void processInitParameters(ServletContext servletContext, + String contextName) { - } + for (WebContextInitParameter param : WebContextInitParameter.values()) { + String value = + servletContext.getInitParameter(param.getQualifiedName()); - // ------------------------------------------------- Package Private - // Methods + if (value != null && value.length() > 0 && param.isDeprecated()) { + WebContextInitParameter alternate = param.getAlternate(); + DeprecationLoggingStrategy strategy = param.getDeprecationLoggingStrategy(); + if (strategy == null || strategy.shouldBeLogged(this)) { + if (LOGGER.isLoggable(Level.WARNING)) { + if (alternate != null) { + queueLoggingAction(new DeferredParameterLoggingAction(param, Level.WARNING, + "jsf.config.webconfig.param.deprecated", + new Object[]{ + contextName, + param.getQualifiedName(), + alternate.getQualifiedName()})); - WebContextInitParameter(String qualifiedName, String defaultValue) - { + } else { + queueLoggingAction(new DeferredParameterLoggingAction( + param, + Level.WARNING, + "jsf.config.webconfig.param.deprecated.no_replacement", + new Object[]{ + contextName, + param.getQualifiedName()})); + } + } + } - this(qualifiedName, defaultValue, false, null); + if (alternate != null) { + queueLoggingAction( + new DeferredParameterLoggingAction(param, + Level.INFO, + "jsf.config.webconfig.configinfo.reset", + new Object[]{ + contextName, + alternate.getQualifiedName(), + value})); - } + contextParameters.put(alternate, value); + } + continue; + } - WebContextInitParameter(String qualifiedName, String defaultValue, - boolean deprecated, WebContextInitParameter alternate) - { + if ((value == null || value.length() == 0) && !param.isDeprecated()) { + value = param.getDefaultValue(); + } + if (value == null || value.length() == 0) { + continue; + } - this.qualifiedName = qualifiedName; - this.defaultValue = defaultValue; - this.deprecated = deprecated; - this.alternate = alternate; + if (value.length() > 0) { + if (LOGGER.isLoggable(loggingLevel)) { + LOGGER.log(loggingLevel, + "jsf.config.webconfig.configinfo", + new Object[]{contextName, + param.getQualifiedName(), + value}); - } + } + contextParameters.put(param, value); + } else { + if (LOGGER.isLoggable(loggingLevel)) { + LOGGER.log(loggingLevel, + "jsf.config.webconfig.option.notconfigured", + new Object[]{contextName, + param.getQualifiedName()}); + } + } - // --------------------------------------------------------- Private - // Methods + } - private WebContextInitParameter getAlternate() - { + } - return alternate; - } + /** + * <p>Process all JNDI entries.</p> + * @param contextName the context name + */ + //This section has been disabled due to incompatibilities with Google App Engine 1.2.6. + private void processJndiEntries(String contextName) { +// +// Context initialContext = null; +// try { +// initialContext = new InitialContext(); +// } catch (NamingException ne) { +// if (LOGGER.isLoggable(Level.WARNING)) { +// LOGGER.log(Level.WARNING, ne.toString(), ne); +// } +// } +// +// if (initialContext != null) { +// // process environment entries +// for (WebEnvironmentEntry entry : WebEnvironmentEntry.values()) { +// String entryName = entry.getQualifiedName(); +// String value = null; +// +// try { +// value = (String) initialContext.lookup(entryName); +// } catch (NamingException root) { +// if (LOGGER.isLoggable(Level.FINE)) { +// LOGGER.fine(root.toString()); +// } +// } +// +// if (value != null) { +// if (LOGGER.isLoggable(Level.INFO)) { +// // special logic for ClientStateSavingPassword +// if (!entry +// .equals(WebEnvironmentEntry.ClientStateSavingPassword)) { +// if (LOGGER +// .isLoggable(loggingLevel)) { +// LOGGER.log(loggingLevel, +// "jsf.config.webconfig.enventryinfo", +// new Object[]{contextName, +// entryName, +// value}); +// } +// } else { +// if (LOGGER +// .isLoggable(loggingLevel)) { +// LOGGER.log(loggingLevel, +// "jsf.config.webconfig.enventry.clientencrypt", +// contextName); +// } +// } +// } +// envEntries.put(entry, value); +// } +// } +// } - private boolean isDeprecated() - { + } - return deprecated; - } + //This section has been disabled due to incompatibilities with Google App Engine 1.2.6. + private boolean canProcessJndiEntries() { +// +// try { +// Util.getCurrentLoader(this).loadClass("javax.naming.InitialContext"); +// } catch (Exception e) { +// if (LOGGER.isLoggable(Level.FINE)) { +// LOGGER.fine( +// "javax.naming is unavailable. JNDI entries related to Mojarra configuration will not be processed."); +// } +// return false; +// } +// return true; + return false; + } - } - /** - * <p> - * An <code>enum</code> of all boolean context initalization parameters - * recognized by the implementation. - * </p> - */ - public enum BooleanWebContextInitParameter - { + private void queueLoggingAction(DeferredLoggingAction loggingAction) { - // implementation note: - // if a parameter is to be deprecated, - // then the <name>Deprecated enum element - // *must* appear after the one that is taking - // its place. The reporting logic depends on this + if (deferredLoggingActions == null) { + deferredLoggingActions = new ArrayList<DeferredLoggingAction>(); + } + deferredLoggingActions.add(loggingAction); - DisplayConfiguration("com.sun.faces.displayConfiguration", false), ValidateFacesConfigFiles( - "com.sun.faces.validateXml", false), VerifyFacesConfigObjects( - "com.sun.faces.verifyObjects", false), ForceLoadFacesConfigFiles( - "com.sun.faces.forceLoadConfiguration", false), DisableArtifactVersioning( - "com.sun.faces.disableVersionTracking", false, true, null), EnableHtmlTagLibraryValidator( - "com.sun.faces.enableHtmlTagLibValidator", false), EnableCoreTagLibraryValidator( - "com.sun.faces.enableCoreTagLibValidator", false), PreferXHTMLContentType( - "com.sun.faces.preferXHTML", false), PreferXHTMLContextTypeDeprecated( - "com.sun.faces.PreferXHTML", false, true, - PreferXHTMLContentType), CompressViewState( - "com.sun.faces.compressViewState", true), CompressViewStateDeprecated( - "com.sun.faces.COMPRESS_STATE", true, true, CompressViewState), CompressJavaScript( - "com.sun.faces.compressJavaScript", true), ExternalizeJavaScriptDeprecated( - "com.sun.faces.externalizeJavaScript", true, true, null), SendPoweredByHeader( - "com.sun.faces.sendPoweredByHeader", true), EnableJSStyleHiding( - "com.sun.faces.enableJSStyleHiding", false), EnableScriptInAttributeValue( - "com.sun.faces.enableScriptsInAttributeValues", true), WriteStateAtFormEnd( - "com.sun.faces.writeStateAtFormEnd", true), EnableLazyBeanValidation( - "com.sun.faces.enableLazyBeanValidation", true), EnableLoadBundle11Compatibility( - "com.sun.faces.enabledLoadBundle11Compatibility", false), EnableRestoreView11Compatibility( - "com.sun.faces.enableRestoreView11Compatibility", false), SerializeServerState( - "com.sun.faces.serializeServerState", false), EnableViewStateIdRendering( - "com.sun.faces.enableViewStateIdRendering", true), RegisterConverterPropertyEditors( - "com.sun.faces.registerConverterPropertyEditors", false), EnableGroovyScripting( - "com.sun.faces.enableGroovyScripting", false), DisableFaceletJSFViewHandler( - "javax.faces.DISABLE_FACELET_JSF_VIEWHANDLER", false), DisableDefaultBeanValidator( - BeanValidator.DISABLE_DEFAULT_BEAN_VALIDATOR_PARAM_NAME, false), DateTimeConverterUsesSystemTimezone( - "javax.faces.DATETIMECONVERTER_DEFAULT_TIMEZONE_IS_SYSTEM_TIMEZONE", - false), FaceletsSkipComments( - "javax.faces.FACELETS_SKIP_COMMENTS", false), FaceletsSkipCommentsDeprecated( - "facelets.SKIP_COMMENTS", false, true, FaceletsSkipComments), PartialStateSaving( - StateManager.PARTIAL_STATE_SAVING_PARAM_NAME, true), GenerateUniqueServerStateIds( - "com.sun.faces.generateUniqueServerStateIds", true), AutoCompleteOffOnViewState( - "com.sun.faces.autoCompleteOffOnViewState", true), EnableThreading( - "com.sun.faces.enableThreading", false), AllowTextChildren( - "com.sun.faces.allowTextChildren", false); + } - private BooleanWebContextInitParameter alternate; - private String qualifiedName; - private boolean defaultValue; - private boolean deprecated; + // ------------------------------------------------------------------- Enums - // ---------------------------------------------------------- Public - // Methods - public boolean getDefaultValue() - { + /** + * <p>An <code>enum</code> of all non-boolean context initalization parameters + * recognized by the implementation.</p> + */ + public enum WebContextInitParameter { - return defaultValue; - } + // implementation note: + // if a parameter is to be deprecated, + // then the <name>Deprecated enum element + // *must* appear after the one that is taking + // its place. The reporting logic depends on this - public String getQualifiedName() - { + ManagedBeanFactoryDecorator( + "com.sun.faces.managedBeanFactoryDecoratorClass", + "" + ), + StateSavingMethod( + "javax.faces.STATE_SAVING_METHOD", + "server" + ), + FaceletsSuffix( + ViewHandler.FACELETS_SUFFIX_PARAM_NAME, + ViewHandler.DEFAULT_FACELETS_SUFFIX + ), + DefaultSuffix( + ViewHandler.DEFAULT_SUFFIX_PARAM_NAME, + ViewHandler.DEFAULT_SUFFIX + ), + JavaxFacesConfigFiles( + "javax.faces.CONFIG_FILES", + "" + ), + JavaxFacesProjectStage( + "javax.faces.PROJECT_STAGE", + "Production" + ), + AlternateLifecycleId( + "javax.faces.LIFECYCLE_ID", + "" + ), + ResourceExcludes( + ResourceHandler.RESOURCE_EXCLUDES_PARAM_NAME, + ResourceHandler.RESOURCE_EXCLUDES_DEFAULT_VALUE + " .groovy" + ), + NumberOfViews( + "com.sun.faces.numberOfViewsInSession", + "15" + ), + NumberOfViewsDeprecated( + "com.sun.faces.NUMBER_OF_VIEWS_IN_SESSION", + "15", + true, + NumberOfViews + ), + NumberOfLogicalViews( + "com.sun.faces.numberOfLogicalViews", + "15" + ), + NumberOfLogicalViewsDeprecated( + "com.sun.faces.NUMBER_OF_VIEWS_IN_LOGICAL_VIEW_IN_SESSION", + "15", + true, + NumberOfLogicalViews + ), + NumberOfConcurrentFlashUsers( + "com.sun.faces.numberOfConcerrentFlashUsers", + "5000" + ), + NumberOfFlashesBetweenFlashReapings( + "com.sun.faces.numberOfFlashesBetweenFlashReapings", + "5000" + ), + InjectionProviderClass( + "com.sun.faces.injectionProvider", + "" + ), + SerializationProviderClass( + "com.sun.faces.serializationProvider", + "" + ), + ResponseBufferSize( + "com.sun.faces.responseBufferSize", + "1024" + ), + FaceletsBufferSize( + "javax.faces.FACELETS_BUFFER_SIZE", + "1024" + ), + FaceletsBufferSizeDeprecated( + "facelets.BUFFER_SIZE", + "1024", + true, + FaceletsBufferSize, + new FaceletsConfigParamLoggingStrategy() + ), + ClientStateWriteBufferSize( + "com.sun.faces.clientStateWriteBufferSize", + "8192" + ), + ResourceBufferSize( + "com.sun.faces.resourceBufferSize", + "2048" + ), + ExpressionFactory( + "com.sun.faces.expressionFactory", + "com.sun.el.ExpressionFactoryImpl" + ), + ClientStateTimeout( + "com.sun.faces.clientStateTimeout", + "" + ), + DefaultResourceMaxAge( + "com.sun.faces.defaultResourceMaxAge", + "604800000" // 7 days + ), + ResourceUpdateCheckPeriod( + "com.sun.faces.resourceUpdateCheckPeriod", + "5" // in minutes + ), + CompressableMimeTypes( + "com.sun.faces.compressableMimeTypes", + "" + ), + DisableUnicodeEscaping( + "com.sun.faces.disableUnicodeEscaping", + "auto" + ), + FaceletsDefaultRefreshPeriod( + "javax.faces.FACELETS_REFRESH_PERIOD", + "2" + ), + FaceletsDefaultRefreshPeriodDeprecated( + "facelets.REFRESH_PERIOD", + "2", + true, + FaceletsDefaultRefreshPeriod, + new FaceletsConfigParamLoggingStrategy() + ), + FaceletsResourceResolver( + ResourceResolver.FACELETS_RESOURCE_RESOLVER_PARAM_NAME, + "" + ), + FaceletsResourceResolverDeprecated( + "facelets.RESOURCE_RESOLVER", + "", + true, + FaceletsResourceResolver, + new FaceletsConfigParamLoggingStrategy() + ), + FaceletsViewMappings( + ViewHandler.FACELETS_VIEW_MAPPINGS_PARAM_NAME, + "" + ), + FaceletsViewMappingsDeprecated( + "facelets.VIEW_MAPPINGS", + "", + true, + FaceletsViewMappings, + new FaceletsConfigParamLoggingStrategy() + ), + FaceletsLibraries( + "javax.faces.FACELETS_LIBRARIES", + "" + ), + FaceletsLibrariesDeprecated( + "facelets.LIBRARIES", + "", + true, + FaceletsLibraries, + new FaceletsConfigParamLoggingStrategy() + ), + FaceletsDecorators( + "javax.faces.FACELETS_DECORATORS", + "" + ), + FaceletsDecoratorsDeprecated( + "facelets.DECORATORS", + "", + true, + FaceletsDecorators, + new FaceletsConfigParamLoggingStrategy() + ), + DuplicateJARPattern( + "com.sun.faces.duplicateJARPattern", + "" + ), + ValidateEmptyFields( + UIInput.VALIDATE_EMPTY_FIELDS_PARAM_NAME, + "auto" + ), + FullStateSavingViewIds( + StateManager.FULL_STATE_SAVING_VIEW_IDS_PARAM_NAME, + "" + ), + AnnotationScanPackages( + "com.sun.faces.annotationScanPackages", + "" + ), + FaceletFactory( + "com.sun.faces.faceletFactory", + "" + ), + FaceletCache( + "com.sun.faces.faceletCache", + "" + ); - return qualifiedName; - } - // ------------------------------------------------- Package Private - // Methods + private String defaultValue; + private String qualifiedName; + private WebContextInitParameter alternate; + private boolean deprecated; + private DeprecationLoggingStrategy loggingStrategy; - BooleanWebContextInitParameter(String qualifiedName, - boolean defaultValue) - { - this(qualifiedName, defaultValue, false, null); + // ---------------------------------------------------------- Public Methods - } - BooleanWebContextInitParameter(String qualifiedName, - boolean defaultValue, boolean deprecated, - BooleanWebContextInitParameter alternate) - { + public String getDefaultValue() { - this.qualifiedName = qualifiedName; - this.defaultValue = defaultValue; - this.deprecated = deprecated; - this.alternate = alternate; + return defaultValue; - } + } - // --------------------------------------------------------- Private - // Methods - private BooleanWebContextInitParameter getAlternate() - { + public String getQualifiedName() { - return alternate; + return qualifiedName; - } + } - private boolean isDeprecated() - { - return deprecated; + DeprecationLoggingStrategy getDeprecationLoggingStrategy() { - } + return loggingStrategy; - } + } - /** - * <p> - * An <code>enum</code> of all environment entries (specified in the - * web.xml) recognized by the implemenetation. - * </p> - */ - public enum WebEnvironmentEntry - { + + // ------------------------------------------------- Package Private Methods - ClientStateSavingPassword("ClientStateSavingPassword"), ProjectStage( - javax.faces.application.ProjectStage.PROJECT_STAGE_JNDI_NAME); - private static final String JNDI_PREFIX = "java:comp/env/"; - private String qualifiedName; + WebContextInitParameter(String qualifiedName, + String defaultValue) { - // ---------------------------------------------------------- Public - // Methods + this(qualifiedName, defaultValue, false, null); - public String getQualifiedName() - { + } - return qualifiedName; - } + WebContextInitParameter(String qualifiedName, + String defaultValue, + boolean deprecated, + WebContextInitParameter alternate) { - // ------------------------------------------------- Package Private - // Methods + this.qualifiedName = qualifiedName; + this.defaultValue = defaultValue; + this.deprecated = deprecated; + this.alternate = alternate; - WebEnvironmentEntry(String qualifiedName) - { + } - if (qualifiedName.startsWith(JNDI_PREFIX)) - { - this.qualifiedName = qualifiedName; - } - else - { - this.qualifiedName = JNDI_PREFIX + qualifiedName; - } - } + WebContextInitParameter(String qualifiedName, + String defaultValue, + boolean deprecated, + WebContextInitParameter alternate, + DeprecationLoggingStrategy loggingStrategy) { - } + this(qualifiedName, defaultValue, deprecated, alternate); + this.loggingStrategy = loggingStrategy; - /** - * <p> - * An <code>enum</code> of all possible values for the - * <code>disableUnicodeEscaping</code> configuration parameter. - * </p> - */ - public enum DisableUnicodeEscaping - { - True("true"), False("false"), Auto("auto"); + } - private final String value; - DisableUnicodeEscaping(String value) - { - this.value = value; - } + // --------------------------------------------------------- Private Methods - public static DisableUnicodeEscaping getByValue(String value) - { - for (DisableUnicodeEscaping disableUnicodeEscaping : DisableUnicodeEscaping - .values()) - { - if (disableUnicodeEscaping.value.equals(value)) { return disableUnicodeEscaping; } - } - return null; - } - } + private WebContextInitParameter getAlternate() { -} // END WebConfiguration \ No newline at end of file + return alternate; + + } + + + private boolean isDeprecated() { + + return deprecated; + + } + + } + + /** + * <p>An <code>enum</code> of all boolean context initalization parameters + * recognized by the implementation.</p> + */ + public enum BooleanWebContextInitParameter { + + + // implementation note: + // if a parameter is to be deprecated, + // then the <name>Deprecated enum element + // *must* appear after the one that is taking + // its place. The reporting logic depends on this + + DisplayConfiguration( + "com.sun.faces.displayConfiguration", + false + ), + ValidateFacesConfigFiles( + "com.sun.faces.validateXml", + false + ), + VerifyFacesConfigObjects( + "com.sun.faces.verifyObjects", + false + ), + ForceLoadFacesConfigFiles( + "com.sun.faces.forceLoadConfiguration", + false + ), + DisableArtifactVersioning( + "com.sun.faces.disableVersionTracking", + false, + true, + null + ), + EnableHtmlTagLibraryValidator( + "com.sun.faces.enableHtmlTagLibValidator", + false + ), + EnableCoreTagLibraryValidator( + "com.sun.faces.enableCoreTagLibValidator", + false + ), + PreferXHTMLContentType( + "com.sun.faces.preferXHTML", + false + ), + PreferXHTMLContextTypeDeprecated( + "com.sun.faces.PreferXHTML", + false, + true, + PreferXHTMLContentType + ), + CompressViewState( + "com.sun.faces.compressViewState", + true + ), + CompressViewStateDeprecated( + "com.sun.faces.COMPRESS_STATE", + true, + true, + CompressViewState + ), + CompressJavaScript( + "com.sun.faces.compressJavaScript", + true + ), + ExternalizeJavaScriptDeprecated( + "com.sun.faces.externalizeJavaScript", + true, + true, + null + ), + SendPoweredByHeader( + "com.sun.faces.sendPoweredByHeader", + true + ), + EnableJSStyleHiding( + "com.sun.faces.enableJSStyleHiding", + false + ), + EnableScriptInAttributeValue( + "com.sun.faces.enableScriptsInAttributeValues", + true + ), + WriteStateAtFormEnd( + "com.sun.faces.writeStateAtFormEnd", + true + ), + EnableLazyBeanValidation( + "com.sun.faces.enableLazyBeanValidation", + true + ), + EnableLoadBundle11Compatibility( + "com.sun.faces.enabledLoadBundle11Compatibility", + false + ), + EnableRestoreView11Compatibility( + "com.sun.faces.enableRestoreView11Compatibility", + false + ), + SerializeServerState( + "com.sun.faces.serializeServerState", + false + ), + EnableViewStateIdRendering( + "com.sun.faces.enableViewStateIdRendering", + true + ), + RegisterConverterPropertyEditors( + "com.sun.faces.registerConverterPropertyEditors", + false + ), + EnableGroovyScripting( + "com.sun.faces.enableGroovyScripting", + false + ), + DisableFaceletJSFViewHandler( + "javax.faces.DISABLE_FACELET_JSF_VIEWHANDLER", + false + ), + DisableDefaultBeanValidator( + BeanValidator.DISABLE_DEFAULT_BEAN_VALIDATOR_PARAM_NAME, + false), + DateTimeConverterUsesSystemTimezone( + "javax.faces.DATETIMECONVERTER_DEFAULT_TIMEZONE_IS_SYSTEM_TIMEZONE", + false + ), + FaceletsSkipComments( + "javax.faces.FACELETS_SKIP_COMMENTS", + false + ), + FaceletsSkipCommentsDeprecated( + "facelets.SKIP_COMMENTS", + false, + true, + FaceletsSkipComments, + new FaceletsConfigParamLoggingStrategy() + ), + PartialStateSaving( + StateManager.PARTIAL_STATE_SAVING_PARAM_NAME, + true + ), + GenerateUniqueServerStateIds( + "com.sun.faces.generateUniqueServerStateIds", + true + ), + AutoCompleteOffOnViewState( + "com.sun.faces.autoCompleteOffOnViewState", + true + ), + EnableThreading( + "com.sun.faces.enableThreading", + false + ), + AllowTextChildren( + "com.sun.faces.allowTextChildren", + false + ), + CacheResourceModificationTimestamp( + "com.sun.faces.cacheResourceModificationTimestamp", + false + ); + + private BooleanWebContextInitParameter alternate; + + private String qualifiedName; + private boolean defaultValue; + private boolean deprecated; + private DeprecationLoggingStrategy loggingStrategy; + + + // ---------------------------------------------------------- Public Methods + + + public boolean getDefaultValue() { + + return defaultValue; + + } + + + public String getQualifiedName() { + + return qualifiedName; + + } + + + DeprecationLoggingStrategy getDeprecationLoggingStrategy() { + + return loggingStrategy; + + } + + + // ------------------------------------------------- Package Private Methods + + + BooleanWebContextInitParameter(String qualifiedName, + boolean defaultValue) { + + this(qualifiedName, defaultValue, false, null); + + } + + + BooleanWebContextInitParameter(String qualifiedName, + boolean defaultValue, + boolean deprecated, + BooleanWebContextInitParameter alternate) { + + this.qualifiedName = qualifiedName; + this.defaultValue = defaultValue; + this.deprecated = deprecated; + this.alternate = alternate; + + } + + + BooleanWebContextInitParameter(String qualifiedName, + boolean defaultValue, + boolean deprecated, + BooleanWebContextInitParameter alternate, + DeprecationLoggingStrategy loggingStrategy) { + + this(qualifiedName, defaultValue, deprecated, alternate); + this.loggingStrategy = loggingStrategy; + + } + + + // --------------------------------------------------------- Private Methods + + + private BooleanWebContextInitParameter getAlternate() { + + return alternate; + + } + + + private boolean isDeprecated() { + + return deprecated; + + } + + } + + /** + * <p>An <code>enum</code> of all environment entries (specified in the + * web.xml) recognized by the implemenetation.</p> + */ + public enum WebEnvironmentEntry { + + + ClientStateSavingPassword("ClientStateSavingPassword"), + ProjectStage(javax.faces.application.ProjectStage.PROJECT_STAGE_JNDI_NAME); + + private static final String JNDI_PREFIX = "java:comp/env/"; + private String qualifiedName; + + + // ---------------------------------------------------------- Public Methods + + + public String getQualifiedName() { + + return qualifiedName; + + } + + + // ------------------------------------------------- Package Private Methods + + + WebEnvironmentEntry(String qualifiedName) { + + if (qualifiedName.startsWith(JNDI_PREFIX)) { + this.qualifiedName = qualifiedName; + } else { + this.qualifiedName = JNDI_PREFIX + qualifiedName; + } + + } + + } + + /** + * <p>An <code>enum</code> of all possible values for the <code>disableUnicodeEscaping</code> + * configuration parameter.</p> + */ + public enum DisableUnicodeEscaping { + True("true"), + False("false"), + Auto("auto"); + + private final String value; + + DisableUnicodeEscaping(String value) { + this.value = value; + } + + public static DisableUnicodeEscaping getByValue(String value) + { + for (DisableUnicodeEscaping disableUnicodeEscaping : DisableUnicodeEscaping.values()) { + if (disableUnicodeEscaping.value.equals(value)) { + return disableUnicodeEscaping; + } + } + + return null; + } + } + + + // ----------------------------------------------------------- Inner Classes + + + private interface DeprecationLoggingStrategy { + + boolean shouldBeLogged(WebConfiguration configuration); + + } + + + private static class FaceletsConfigParamLoggingStrategy implements DeprecationLoggingStrategy { + + public boolean shouldBeLogged(WebConfiguration configuration) { + return !configuration.isOptionEnabled(BooleanWebContextInitParameter.DisableFaceletJSFViewHandler); + } + + } // END FaceletsConfigParamLoggingStrategy + + + private interface DeferredLoggingAction { + + void log(); + + } // END DeferredLogginAction + + + private class DeferredParameterLoggingAction implements DeferredLoggingAction { + + private WebContextInitParameter parameter; + private Level loggingLevel; + private String logKey; + private Object[] params; + + + DeferredParameterLoggingAction(WebContextInitParameter parameter, + Level loggingLevel, + String logKey, + Object[] params) { + + this.parameter = parameter; + this.loggingLevel = loggingLevel; + this.logKey = logKey; + this.params = params; + + } + + public void log() { + + if (WebConfiguration.LOGGER.isLoggable(loggingLevel)) { + DeprecationLoggingStrategy strategy = parameter.getDeprecationLoggingStrategy(); + if (strategy != null && strategy.shouldBeLogged(WebConfiguration.this)) { + WebConfiguration.LOGGER.log(loggingLevel, logKey, params); + } + } + + } + + } // END DeferredParameterLogginAction + + + private class DeferredBooleanParameterLoggingAction implements DeferredLoggingAction { + + private BooleanWebContextInitParameter parameter; + private Level loggingLevel; + private String logKey; + private Object[] params; + + DeferredBooleanParameterLoggingAction(BooleanWebContextInitParameter parameter, + Level loggingLevel, + String logKey, + Object[] params) { + this.parameter = parameter; + this.loggingLevel = loggingLevel; + this.logKey = logKey; + this.params = params; + } + + public void log() { + + if (WebConfiguration.LOGGER.isLoggable(loggingLevel)) { + DeprecationLoggingStrategy strategy = parameter.getDeprecationLoggingStrategy(); + if (strategy != null && strategy.shouldBeLogged(WebConfiguration.this)) { + WebConfiguration.LOGGER.log(loggingLevel, logKey, params); + } + } + + } + + } // END DeferredBooleanParameterLoggingAction + +} // END WebConfiguration