Add context param attributes to @FacesConfig

api/src/main/java/jakarta/faces/annotation/PackageUtils.java

@@ -0,0 +1,67 @@
+/*
+ * Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0, which is available at
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * This Source Code may also be made available under the following Secondary
+ * Licenses when the conditions for such availability set forth in the
+ * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
+ * version 2 with the GNU Classpath Exception, which is available at
+ * https://www.gnu.org/software/classpath/license.html.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
+ */
+package jakarta.faces.annotation;
+
+import static java.util.stream.Collectors.toSet;
+
+import java.lang.annotation.Annotation;
+import java.util.Comparator;
+import java.util.Set;
+
+import jakarta.annotation.Priority;
+import jakarta.enterprise.inject.spi.BeanManager;
+import jakarta.enterprise.inject.spi.CDI;
+import jakarta.faces.context.FacesContext;
+
+class PackageUtils {
+
+    private PackageUtils() {
+    }
+
+    /**
+     * This does unfortunately not exist in cdi spec: https://stackoverflow.com/a/63653513
+     *
+     * This basically sorts descending by priority with fallback to FQN.
+     * Highest priority first.
+     * Priotityless bean last.
+     * Same priorities ordered by FQN (for now?)
+     */
+    public static final Comparator<Object> BEAN_PRIORITY_COMPARATOR = (left, right) -> {
+        Class<?> leftClass = left.getClass();
+        Class<?> rightClass = right.getClass();
+        Priority leftPriority = leftClass.getAnnotation(Priority.class);
+        Priority rightPriority = rightClass.getAnnotation(Priority.class);
+
+        int compare = leftPriority != null && rightPriority != null ? Integer.compare(leftPriority.value(), rightPriority.value())
+                : leftPriority != null ? -1
+                : rightPriority != null ? 1
+                : 0;
+
+        if (compare == 0) {
+            return leftClass.getName().compareTo(rightClass.getName());
+        }
+
+        return compare;
+    };
+
+    public static Set<?> getBeanReferencesByQualifier(FacesContext context, Annotation... qualifiers) {
+        BeanManager beanManager = CDI.current().getBeanManager();
+        return beanManager.getBeans(Object.class, qualifiers).stream()
+            .map(bean -> beanManager.getReference(bean, bean.getBeanClass(), beanManager.createCreationalContext(bean)))
+            .collect(toSet());
+    }
+
+}

api/src/main/java/jakarta/faces/application/ResourceHandler.java

@@ -191,26 +191,44 @@ public abstract class ResourceHandler {
      * {@link #WEBAPP_RESOURCES_DIRECTORY_PARAM_NAME} exists, the runtime must interpret its value as a path, relative to
      * the web app root, where resources are to be located. This param value must not start with a "/", though it may
      * contain "/" characters. If no such <code>&lt;context-param&gt;</code> exists, or its value is invalid, the value
-     * "resources", without the quotes, must be used by the runtime as the value.
+     * {@value #WEBAPP_RESOURCES_DIRECTORY_DEFAULT_VALUE}, without the quotes, must be used by the runtime as the value.
      * </p>
      *
      * @since 2.2
      */
     public static final String WEBAPP_RESOURCES_DIRECTORY_PARAM_NAME = "jakarta.faces.WEBAPP_RESOURCES_DIRECTORY";
 
+    /**
+     * <p class="changed_added_5_0">
+     * The default value of the {@link #WEBAPP_RESOURCES_DIRECTORY_PARAM_NAME} context-param.
+     * </p>
+     *
+     * @since 5.0
+     */
+    public static final String WEBAPP_RESOURCES_DIRECTORY_DEFAULT_VALUE = "resources";
+
     /**
      * <p class="changed_added_2_2">
      * If a <code>&lt;context-param&gt;</code> with the param name equal to the value of
      * {@link #WEBAPP_CONTRACTS_DIRECTORY_PARAM_NAME} exists, the runtime must interpret its value as a path, relative to
      * the web app root, where resource library contracts are to be located. This param value must not start with a "/",
      * though it may contain "/" characters. If no such <code>&lt;context-param&gt;</code> exists, or its value is invalid,
-     * the value "contracts", without the quotes, must be used by the runtime as the value.
+     * the value {@value #WEBAPP_CONTRACTS_DIRECTORY_DEFAULT_VALUE}, without the quotes, must be used by the runtime as the value.
      * </p>
      *
      * @since 2.2
      */
     public static final String WEBAPP_CONTRACTS_DIRECTORY_PARAM_NAME = "jakarta.faces.WEBAPP_CONTRACTS_DIRECTORY";
 
+    /**
+     * <p class="changed_added_5_0">
+     * The default value of the {@link #WEBAPP_CONTRACTS_DIRECTORY_PARAM_NAME} context-param.
+     * </p>
+     *
+     * @since 5.0
+     */
+    public static final String WEBAPP_CONTRACTS_DIRECTORY_DEFAULT_VALUE = "contracts";
+
     /**
      * <p class="changed_added_2_0">
      * The name of a key within the application message bundle named by the return from {@link Application#getMessageBundle}
@@ -235,7 +253,7 @@ public abstract class ResourceHandler {
      * The default value for the {@link #RESOURCE_EXCLUDES_PARAM_NAME} init param.
      * </p>
      */
-    public static final String RESOURCE_EXCLUDES_DEFAULT_VALUE = ".class .jsp .jspx .properties .xhtml .groovy";
+    public static final String RESOURCE_EXCLUDES_DEFAULT_VALUE = ".class .jsp .jspx .properties .xhtml .groovy"; // NOTE: when changing, ensure {@link FacesConfig#resourceExcludes()} is also adjusted.
 
     // ---------------------------------------------------------- Public Methods
 

api/src/main/java/jakarta/faces/application/StateManager.java

@@ -21,6 +21,7 @@
 import java.io.IOException;
 import java.util.Map;
 
+import jakarta.faces.annotation.FacesConfig.ContextParam;
 import jakarta.faces.context.FacesContext;
 import jakarta.faces.context.ResponseWriter;
 import jakarta.faces.render.RenderKit;
@@ -237,16 +238,9 @@ public void writeState(FacesContext context, Object state) throws IOException {
      * @throws NullPointerException if <code>context</code> is <code>null</code>.
      */
     public boolean isSavingStateInClient(FacesContext context) {
-        if (savingStateInClient != null) {
-            return savingStateInClient;
+        if (savingStateInClient == null) {
+            savingStateInClient = ContextParam.STATE_SAVING_METHOD.isDefault(context);
         }
-        savingStateInClient = false;
-
-        String saveStateParam = context.getExternalContext().getInitParameter(STATE_SAVING_METHOD_PARAM_NAME);
-        if (StateSavingMethod.CLIENT.name().equalsIgnoreCase(saveStateParam)) {
-            savingStateInClient = true;
-        }
-
         return savingStateInClient;
     }
 

api/src/main/java/jakarta/faces/application/ViewHandler.java

@@ -127,7 +127,8 @@ public abstract class ViewHandler {
 
     /**
      * <p class="changed_added_2_2 changed_modified_4_1">
-     * The buffer size to set on the response when the ResponseWriter is generated. By default the value is 1024. A value of
+     * The buffer size to set on the response when the ResponseWriter is generated. By default the value is
+     * {@value #FACELETS_BUFFER_SIZE_DEFAULT_VALUE}. A value of
      * -1 will not assign a buffer size on the response. This should be increased if you are using development mode in order
      * to guarantee that the response isn't partially rendered when an error is generated.
      * </p>
@@ -136,6 +137,15 @@ public abstract class ViewHandler {
      */
     public static final String FACELETS_BUFFER_SIZE_PARAM_NAME = "jakarta.faces.FACELETS_BUFFER_SIZE";
 
+    /**
+     * <p class="changed_added_5_0">
+     * The default value of the {@link #FACELETS_BUFFER_SIZE_PARAM_NAME} context-param.
+     * </p>
+     *
+     * @since 5.0
+     */
+    public static final int FACELETS_BUFFER_SIZE_DEFAULT_VALUE = 1024;
+
     /**
      * <p class="changed_added_2_2 changed_modified_4_1">
      * <span class="changed_modified_2_3">When</span> a page is requested, what interval in seconds should the compiler

api/src/main/java/jakarta/faces/component/UIInput.java

@@ -24,10 +24,10 @@
 import jakarta.el.ELException;
 import jakarta.el.ValueExpression;
 import jakarta.faces.FacesException;
+import jakarta.faces.annotation.FacesConfig.ContextParam;
 import jakarta.faces.application.Application;
 import jakarta.faces.application.FacesMessage;
 import jakarta.faces.context.ExceptionHandler;
-import jakarta.faces.context.ExternalContext;
 import jakarta.faces.context.FacesContext;
 import jakarta.faces.convert.Converter;
 import jakarta.faces.convert.ConverterException;
@@ -255,7 +255,6 @@ enum PropertyKeys {
      */
     public UIInput() {
 
-        super();
         setRendererType("jakarta.faces.Text");
 
     }
@@ -884,8 +883,7 @@ private boolean isSetAlwaysValidateRequired(FacesContext context) {
         if (null != bool) {
             isSetAlwaysValidateRequired = bool;
         } else {
-            String val = context.getExternalContext().getInitParameter(ALWAYS_PERFORM_VALIDATION_WHEN_REQUIRED_IS_TRUE);
-            isSetAlwaysValidateRequired = Boolean.valueOf(val);
+            isSetAlwaysValidateRequired = ContextParam.ALWAYS_PERFORM_VALIDATION_WHEN_REQUIRED_IS_TRUE.isSet(context);
         }
 
         return isSetAlwaysValidateRequired;
@@ -1379,8 +1377,7 @@ private void addConversionErrorMessage(FacesContext context, ConverterException
     boolean considerEmptyStringNull(FacesContext ctx) {
 
         if (emptyStringIsNull == null) {
-            String val = ctx.getExternalContext().getInitParameter(EMPTY_STRING_AS_NULL_PARAM_NAME);
-            emptyStringIsNull = Boolean.valueOf(val);
+            emptyStringIsNull = ContextParam.INTERPRET_EMPTY_STRING_SUBMITTED_VALUES_AS_NULL.isSet(ctx);
         }
 
         return emptyStringIsNull;
@@ -1390,16 +1387,24 @@ boolean considerEmptyStringNull(FacesContext ctx) {
     private boolean validateEmptyFields(FacesContext ctx) {
 
         if (validateEmptyFields == null) {
-            ExternalContext extCtx = ctx.getExternalContext();
-            String val = extCtx.getInitParameter(VALIDATE_EMPTY_FIELDS_PARAM_NAME);
+            ValidateEmptyFields val = null;
 
-            if (null == val) {
-                val = (String) extCtx.getApplicationMap().get(VALIDATE_EMPTY_FIELDS_PARAM_NAME);
+            if (!ContextParam.VALIDATE_EMPTY_FIELDS.isSet(ctx)) {
+                String appVal = (String) ctx.getExternalContext().getApplicationMap().get(VALIDATE_EMPTY_FIELDS_PARAM_NAME);
+
+                if (appVal != null) {
+                    val = ValidateEmptyFields.valueOf(appVal.toUpperCase());
+                }
             }
-            if (val == null || ValidateEmptyFields.AUTO.name().equalsIgnoreCase(val)) {
+
+            if (val == null) {
+                val = ContextParam.VALIDATE_EMPTY_FIELDS.getValue(ctx);
+            }
+
+            if (val == ValidateEmptyFields.AUTO) {
                 validateEmptyFields = isBeansValidationAvailable(ctx);
             } else {
-                validateEmptyFields = Boolean.valueOf(val);
+                validateEmptyFields = val == ValidateEmptyFields.TRUE;
             }
         }
 

api/src/main/java/jakarta/faces/component/UINamingContainer.java

@@ -24,6 +24,7 @@
 import java.util.Collection;
 import java.util.logging.Logger;
 
+import jakarta.faces.annotation.FacesConfig.ContextParam;
 import jakarta.faces.component.visit.VisitCallback;
 import jakarta.faces.component.visit.VisitContext;
 import jakarta.faces.context.FacesContext;
@@ -76,7 +77,6 @@ enum PropertyKeys {
      * </p>
      */
     public UINamingContainer() {
-        super();
         setRendererType(null);
     }
 
@@ -113,15 +113,7 @@ public static char getSeparatorChar(FacesContext context) {
 
         Character separatorChar = (Character) context.getAttributes().get(SEPARATOR_CHAR_PARAM_NAME);
         if (separatorChar == null) {
-            String initParam = context.getExternalContext().getInitParameter(SEPARATOR_CHAR_PARAM_NAME);
-            separatorChar = SEPARATOR_CHAR;
-            if (initParam != null) {
-                initParam = initParam.trim();
-                if (initParam.length() != 0) {
-                    separatorChar = initParam.charAt(0);
-                }
-            }
-
+            separatorChar = ContextParam.SEPARATOR_CHAR.getValue(context);
             context.getAttributes().put(SEPARATOR_CHAR_PARAM_NAME, separatorChar);
         }
 

api/src/main/java/jakarta/faces/component/UIWebsocket.java

@@ -25,8 +25,8 @@
 import java.util.regex.Pattern;
 
 import jakarta.el.ValueExpression;
+import jakarta.faces.annotation.FacesConfig.ContextParam;
 import jakarta.faces.component.behavior.ClientBehaviorHolder;
-import jakarta.faces.context.ExternalContext;
 import jakarta.faces.context.FacesContext;
 import jakarta.faces.push.Push;
 import jakarta.faces.push.PushContext;
@@ -97,9 +97,7 @@ enum PropertyKeys {
      * @throws IllegalStateException When Websocket endpoint is not enabled.
      */
     public UIWebsocket() {
-        ExternalContext externalContext = FacesContext.getCurrentInstance().getExternalContext();
-
-        if (!Boolean.parseBoolean(externalContext.getInitParameter(ENABLE_WEBSOCKET_ENDPOINT_PARAM_NAME))) {
+        if (!ContextParam.ENABLE_WEBSOCKET_ENDPOINT.isSet(FacesContext.getCurrentInstance())) {
             throw new IllegalStateException(ERROR_ENDPOINT_NOT_ENABLED);
         }
     }

api/src/main/java/jakarta/faces/lifecycle/ClientWindow.java

@@ -94,23 +94,42 @@ public abstract class ClientWindow {
      * <p class="changed_added_2_2">
      * The context-param that controls the operation of the <code>ClientWindow</code> feature. The runtime must support the
      * values "none" and "url", without the quotes, but other values are possible. If not specified, or the value is not
-     * understood by the implementation, "none" is assumed.
+     * understood by the implementation, {@value #CLIENT_WINDOW_MODE_DEFAULT_VALUE} is assumed.
      * </p>
      *
      * @since 2.2
      */
     public static final String CLIENT_WINDOW_MODE_PARAM_NAME = "jakarta.faces.CLIENT_WINDOW_MODE";
 
+    /**
+     * <p class="changed_added_5_0">
+     * The default value of the {@link #CLIENT_WINDOW_MODE_PARAM_NAME} context-param.
+     * </p>
+     *
+     * @since 5.0
+     */
+    public static final String CLIENT_WINDOW_MODE_DEFAULT_VALUE = "none";
+
     /**
      * <p class="changed_added_4_0">
      * Indicate the max number of ClientWindows, which is used by {@link ClientWindowScoped}.
+     * <span class="changed_added_5_0">By default the value is {@link #NUMBER_OF_CLIENT_WINDOWS_DEFAULT_VALUE}.</span>
      * It is only active when jakarta.faces.CLIENT_WINDOW_MODE is enabled.
      * </p>
      *
      * @since 4.0
      */
     public static final String NUMBER_OF_CLIENT_WINDOWS_PARAM_NAME = "jakarta.faces.NUMBER_OF_CLIENT_WINDOWS";
 
+    /**
+     * <p class="changed_added_5_0">
+     * The default value of the {@link #NUMBER_OF_CLIENT_WINDOWS_PARAM_NAME} context-param.
+     * </p>
+     *
+     * @since 5.0
+     */
+    public static final int NUMBER_OF_CLIENT_WINDOWS_DEFAULT_VALUE = 10;
+
     /**
      * <p class="changed_added_2_2">
      * This method will be called whenever a URL is generated by the runtime where client window related parameters need to