UI-Component Sets
Project Documentation

Web Context Parameters

MyFaces core behavior can be customized, adding some web config params into your WEB-INF/web.xml file for your custom project in this way:

      <context-param>
        <param-name>org.apache.myfaces.SOME_USEFUL_PARAM</param-name>
        <param-value>someValue</param-value>
      </context-param>
  

Below is the list of available web context parameters supported:

Summary

Click on the name of each param to find detailed information about each one of them.

The "since" column means the version since the param was added. Note this param is not "lineal", so please check the release dates on myfaces issue tracker to know if an specified version has or not the selected param. For example, if a param was added on 2.0.7, it means that 2.1.1 has the parameter because it was released on the same time, but 2.1.0 will not have it, because it was released before that date.

Expression Language (EL) Configuration Params

Name Since Default Value Short Description
org.apache.myfaces.STRICT_JSF_2_CC_EL_RESOLVER 2.0.10 false Change default getType() behavior for composite component EL resolver, from return null (see JSF 2_0 spec section 5_6_2_2) to use the metadata information added by composite:attribute, ensuring components working with chained EL expressions to find the right type when a getType() is called over the source EL expression
org.apache.myfaces.SUPPORT_JSP_AND_FACES_EL 2.0.13,2.1.7 true If set false, myfaces won't support JSP and javax.faces.el. JSP are deprecated in " + "JSF 2.X, javax.faces.el in in JSF 1.2. Default value is true.
org.apache.myfaces.EL_RESOLVER_COMPARATOR 1.2.10, 2.0.2 The Class of an Comparator<ELResolver> implementation.
org.apache.myfaces.EL_RESOLVER_PREDICATE 2.1.0 The Class of an org.apache.commons.collections.Predicate<ELResolver> implementation." + "If used and returns true for a ELResolver instance, such resolver will not be installed in " + "ELResolvers chain. Use with caution - can break functionality defined in JSF specification " + "'ELResolver Instances Provided by Faces'
org.apache.myfaces.CACHE_EL_EXPRESSIONS 2.0.8 noCache Indicates if expressions generated by facelets should be cached or not
org.apache.myfaces.EXPRESSION_FACTORY 1.2.7 This parameter specifies the ExpressionFactory implementation to use

Rendering (render) Configuration Params

Name Since Default Value Short Description
org.apache.myfaces.PRETTY_HTML 1.1 true If true, rendered HTML code will be formatted, so that it is "human readable"
org.apache.myfaces.ALLOW_JAVASCRIPT 1.1 true This parameter tells MyFaces if javascript code should be allowed in the rendered HTML output
org.apache.myfaces.STRICT_XHTML_LINKS 1.1.6 true Use "&amp;" entity instead a plain "&" character within HTML
org.apache.myfaces.RENDER_CLEAR_JAVASCRIPT_FOR_BUTTON 1.2.3 false This param renders the clear javascript on button necessary only for compatibility with hidden fields feature of myfaces
org.apache.myfaces.RENDER_HIDDEN_FIELDS_FOR_LINK_PARAMS 1.2.9 false This param renders hidden fields at the end of h:form for link params when h:commandLink + f:param is used, instead use javascript to create them
org.apache.myfaces.SAVE_FORM_SUBMIT_LINK_IE 1.1 false Add a code that save the form before submit using a link (call to window
org.apache.myfaces.WRAP_SCRIPT_CONTENT_WITH_XML_COMMENT_TAG 2.0.1 true Wrap content inside script with xml comment to prevent old browsers to display it
org.apache.myfaces.RENDER_FORM_SUBMIT_SCRIPT_INLINE 2.0.2 false If set true, render the form submit script inline, as in myfaces core 1
org.apache.myfaces.DEFAULT_RESPONSE_WRITER_CONTENT_TYPE_MODE 2.0.11,2.1.5 text/html Define the default content type that the default ResponseWriter generates, when no match can be derived from HTTP Accept Header
org.apache.myfaces.USE_MULTIPLE_JS_FILES_FOR_JSF_UNCOMPRESSED_JS 2.0.1 false If this param is true and the project stage is development mode, the source javascript files will be loaded separately instead have all in just one file, to preserve line numbers and make javascript debugging of the default jsf javascript file more simple
org.apache.myfaces.JSF_JS_MODE 2.0.10,2.1.4 normal Define the mode used for jsf

Resources (resource) Configuration Params

Name Since Default Value Short Description
javax.faces.RESOURCE_EXCLUDES 2.0 .class .jsp .jspx .properties .xhtml .groovy Space separated file extensions that will not be served by the default ResourceHandler implementation
org.apache.myfaces.RESOURCE_MAX_TIME_EXPIRES 2.0 604800000 Set the max time in miliseconds set on the "Expires" header for a resource rendered by the default ResourceHandler
org.apache.myfaces.RESOURCE_HANDLER_CACHE_SIZE 2.0.2 500 Controls the size of the cache used to check if a resource exists or not
org.apache.myfaces.RESOURCE_HANDLER_CACHE_ENABLED 2.0.2 true Enable or disable the cache used to "remember" if a resource handled by the default ResourceHandler exists or not
org.apache.myfaces.STRICT_JSF_2_ALLOW_SLASH_LIBRARY_NAME 2.1.6, 2.0.12 false Allow slash in the library name of a Resource
org.apache.myfaces.RESOURCE_BUFFER_SIZE 2.1.10, 2.0.16 2048 Define the default buffer size that is used between Resource

State Saving (state) Configuration Params

Name Since Default Value Short Description
javax.faces.STATE_SAVING_METHOD 1.1 server Define the state method to be used. There are two different options " + "defined by the specification: 'client' and 'server' state.
javax.faces.FULL_STATE_SAVING_VIEW_IDS 2.0 Indicate the viewId(s) separated by commas that should be saved and restored fully, without use Partial State Saving (PSS)
javax.faces.PARTIAL_STATE_SAVING 2.0 true (false with 1.2 webapps) Enable or disable partial state saving algorithm
org.apache.myfaces.RENDER_VIEWSTATE_ID 1.1 true Define if the input field that should store the state (javax
org.apache.myfaces.REFRESH_TRANSIENT_BUILD_ON_PSS 2.0 auto Indicate if the facelet associated to the view should be reapplied when the view is refreshed
org.apache.myfaces.REFRESH_TRANSIENT_BUILD_ON_PSS_PRESERVE_STATE 2.0 false Enable or disable a special mode that enable full state for parent components containing c:if, c:forEach, c:choose and ui:include with src=ELExpression
org.apache.myfaces.USE_ENCRYPTION 1.1 true Indicate if the view state is encrypted or not
org.apache.myfaces.SECRET 1.1 Defines the secret (Base64 encoded) used to initialize the secret key for encryption algorithm
org.apache.myfaces.ALGORITHM 1.1 DES Indicate the encryption algorithm used for encrypt the view state
org.apache.myfaces.SECRET.CACHE 1.1 If is set to "false", the secret key used for encryption algorithm is not cached
org.apache.myfaces.ALGORITHM.IV 1.1 Defines the initialization vector (Base64 encoded) used for the encryption algorithm
org.apache.myfaces.ALGORITHM.PARAMETERS 1.1 ECB/PKCS5Padding Defines the default mode and padding used for the encryption algorithm
org.apache.myfaces.SERIAL_FACTORY 1.1 Defines the factory class name using for serialize/deserialize the view state returned by state manager into a byte array
org.apache.myfaces.COMPRESS_STATE_IN_CLIENT 1.1 false Indicate if the view state should be compressed before encrypted(optional) and encoded
org.apache.myfaces.MAC_ALGORITHM HmacSHA1 Indicate the algorithm used to calculate the Message Authentication Code that is added to the view state
org.apache.myfaces.MAC_SECRET Define the initialization code that are used to initialize the secret key used on the Message Authentication Code algorithm
org.apache.myfaces.MAC_SECRET.CACHE If is set to "false", the secret key used for MAC algorithm is not cached
org.apache.myfaces.CLIENT_VIEW_STATE_TIMEOUT 2.1.9, 2.0.15 0 Define the time in minutes where the view state is valid when client side state saving is used
org.apache.myfaces.NUMBER_OF_VIEWS_IN_SESSION 1.1 20 Defines the amount (default = 20) of the latest views are stored in session
org.apache.myfaces.NUMBER_OF_SEQUENTIAL_VIEWS_IN_SESSION 2.0.6 Indicates the amount of views (default is not active) that should be stored in session between sequential POST or POST-REDIRECT-GET if org
org.apache.myfaces.SERIALIZE_STATE_IN_SESSION 1.1 true Indicate if the state should be serialized before save it on the session
org.apache.myfaces.COMPRESS_STATE_IN_SESSION 1.1 true Indicates that the serialized state will be compressed before it is written to the session
org.apache.myfaces.CACHE_OLD_VIEWS_IN_SESSION_MODE 1.2.5 off Define the way of handle old view references(views removed from session), making possible to store it in a cache, so the state manager first try to get the view from the session
org.apache.myfaces.USE_FLASH_SCOPE_PURGE_VIEWS_IN_SESSION 2.0.6 false Allow use flash scope to keep track of the views used in session and the previous ones, so server side state saving can delete old views even if POST-REDIRECT-GET pattern is used
org.apache.myfaces.RANDOM_KEY_IN_VIEW_STATE_SESSION_TOKEN 2.1.9, 2.0.15 none Adds a random key to the generated view state session token
org.apache.myfaces.RANDOM_KEY_IN_VIEW_STATE_SESSION_TOKEN_LENGTH 2.1.9, 2.0.15 8 Set the default length of the random key added to the view state session token
org.apache.myfaces.RANDOM_KEY_IN_VIEW_STATE_SESSION_TOKEN_SECURE_RANDOM_CLASS 2.1.9, 2.0.15 Sets the random class to initialize the secure random id generator
org.apache.myfaces.RANDOM_KEY_IN_VIEW_STATE_SESSION_TOKEN_SECURE_RANDOM_PROVIDER 2.1.9, 2.0.15 Sets the random provider to initialize the secure random id generator
org.apache.myfaces.RANDOM_KEY_IN_VIEW_STATE_SESSION_TOKEN_SECURE_RANDOM_ALGORITM 2.1.9, 2.0.15 SHA1PRNG Sets the random algorithm to initialize the secure random id generator
org.apache.myfaces.HANDLE_STATE_CACHING_MECHANICS 2.0.6 true Define if the state caching code should be handled by the ResponseStateManager or by the StateManager used
org.apache.myfaces.SAVE_STATE_WITH_VISIT_TREE_ON_PSS 2.0.8, 2.1.2 true If this param is set to true (by default), when pss algorithm is executed to save state, a visit tree traversal is done, instead a plain traversal like previous versions (2
org.apache.myfaces.CHECK_ID_PRODUCTION_MODE 2.0.12, 2.1.6 auto Define how duplicate ids are checked when ProjectStage is Production, by default (auto) it only check ids of components that does not encapsulate markup (like facelets UILeaf)

Conversion and Validation (validation) Configuration Params

Name Since Default Value Short Description
javax.faces.VALIDATE_EMPTY_FIELDS 2.0 auto Force validation on empty fields (By default is auto, which means it is only enabled when Bean Validation binaries are available on the current classpath)
javax.faces.INTERPRET_EMPTY_STRING_SUBMITTED_VALUES_AS_NULL 2.0 false Submitted values are decoded as null values instead empty strings
org.apache.myfaces.ENUM_CONVERTER_ALLOW_STRING_PASSTROUGH 2.0.1 false If value is a String instance and this param is true, pass it directly without try any change
javax.faces.validator.DISABLE_DEFAULT_BEAN_VALIDATOR 2.0 true If this init parameter is present, no Bean Validators should be added to an UIInput by default
javax.faces.DATETIMECONVERTER_DEFAULT_TIMEZONE_IS_SYSTEM_TIMEZONE 2.0 false Set the default timezone as system timezone when a converter extending from DateTimeConverter is created

View Handling (viewhandler) Configuration Params

Name Since Default Value Short Description
javax.faces.DEFAULT_SUFFIX 1.1 .xhtml .view.xml .jsp Indicate the default suffixes, separated by spaces to derive the default file URI used by JSF to create views and render pages
javax.faces.FACELETS_SUFFIX 2.0 .xhtml The default extension used to handle facelets pages
javax.faces.FACELETS_VIEW_MAPPINGS 2.0 Set of extensions handled by facelets, separated by ';'
org.apache.myfaces.CHECKED_VIEWID_CACHE_SIZE 2.0.2 500 Controls the size of the cache used to 'remember' if a view exists or not.
org.apache.myfaces.CHECKED_VIEWID_CACHE_ENABLED 2.0.2 true Enable or disable a cache used to 'remember' if a view exists or not and reduce the impact " + "of sucesive calls to ExternalContext.getResource().
org.apache.myfaces.VIEW_UNIQUE_IDS_CACHE_ENABLED 2.0.13, 2.1.7 false Enable or disable a cache used to 'remember' the generated facelets unique ids " + "and reduce the impact over memory usage.
org.apache.myfaces.COMPONENT_UNIQUE_IDS_CACHE_SIZE 2.0.13, 2.1.7 100 Set the size of the cache used to store strings generated using SectionUniqueIdCounter for component ids
org.apache.myfaces.STRICT_JSF_2_VIEW_NOT_FOUND 2.1.13 false If this param is set to true, a check will be done in Restore View Phase to check if the viewId exists or not and if it does not exists, a 404 response will be thrown
org.apache.myfaces.CHECKED_VIEWID_CACHE_SIZE 2.0.2 500 Controls the size of the cache used to 'remember' if a view exists or not.
org.apache.myfaces.CHECKED_VIEWID_CACHE_ENABLED 2.0.2 true Enable or disable a cache used to 'remember' if a view exists or not and reduce the impact " + "of sucesive calls to ExternalContext.getResource().
javax.faces.DISABLE_FACELET_JSF_VIEWHANDLER 2.0 false Disable facelets VDL from the current application project

Other Configuration Params

Name Since Default Value Short Description
javax.faces.HONOR_CURRENT_COMPONENT_ATTRIBUTES 2.1.0 false Indicate if the facesContext attribute values under the keys javax
javax.faces.CONFIG_FILES 1.1 Comma separated list of URIs of (additional) faces config files
javax.faces.LIFECYCLE_ID 1.1 Identify the Lifecycle instance to be used
org.apache.myfaces.CONFIG_REFRESH_PERIOD 1.1 2 Set the time in seconds that check for updates of web
org.apache.myfaces.DELEGATE_FACES_SERVLET 1.2.7 Define an alternate class name that will be used to initialize MyFaces, instead the default javax
org.apache.myfaces.VALIDATE_XML 2.0 If set to true, tag library XML files and faces config XML files using schema will be validated during application start up
org.apache.myfaces.DEBUG_PHASE_LISTENER 2.0.8 Enable/disable DebugPhaseListener feature, with provide useful information about ValueHolder variables (submittedValue, localValue, value)
org.apache.myfaces.STRICT_JSF_2_REFRESH_TARGET_AJAX 2.0.10 false Detect if a target (usually head) should be update for the current view in an ajax render operation
org.apache.myfaces.GAE_JSF_JAR_FILES 2.1.8, 2.0.14 When the application runs inside Google Application Engine container (GAE), indicate which jar files should be scanned for files (faces-config, facelets taglib or annotations)
org.apache.myfaces.GAE_JSF_ANNOTATIONS_JAR_FILES 2.1.8, 2.0.14 When the application runs inside Google Application Engine container (GAE), indicate which jar files should be scanned for annotations
org.apache.myfaces.FLASH_SCOPE_DISABLED 2.0.5 false Defines whether flash scope is disabled, preventing add the Flash cookie to the response
javax.faces.PROJECT_STAGE 2.0 Production Indicate the stage of the initialized application
org.apache.myfaces.LAZY_LOAD_CONFIG_OBJECTS 2.0 true Indicate if the classes associated to components, converters, validators or behaviors should be loaded as soon as they are added to the current application instance or instead loaded in a lazy way
org.apache.myfaces.VALIDATE 2.0 false Validate if the managed beans and navigations rules are correct
org.apache.myfaces.annotation.SCAN_PACKAGES 2.0 Servlet context init parameter which defines which packages to scan for beans, separated by commas
org.apache.myfaces.config.annotation.LifecycleProvider 1.1 no description
org.apache.myfaces.ERROR_TEMPLATE_RESOURCE 1.2.4 META-INF/rsc/myfaces-dev-error.xml Indicate the template name used to render the default error page used by MyFaces specific error handler implementation
org.apache.myfaces.DEBUG_TEMPLATE_RESOURCE 1.2.4 META-INF/rsc/myfaces-dev-debug.xml Indicate the template name used to render the default debug page (see ui:debug tag)
org.apache.myfaces.ERROR_HANDLING 1.2.4 false, on Development Project stage: true Indicate if myfaces is responsible to handle errors
org.apache.myfaces.TEMPORAL_RESOURCEHANDLER_CACHE_ENABLED 2.1.11 false If this param is set to true (default false), a temporal directory is created and all files handled by this ResourceLoader are cached there, avoiding the problem described on MYFACES-3586
org.apache.myfaces.SERVICE_PROVIDER_FINDER 2.0.3 Class name of a custom ServiceProviderFinder implementation.
javax.faces.FACELETS_BUFFER_SIZE 2.0 Define the default buffer size value passed to ExternalContext.setResponseBufferResponse() and in " + "a servlet environment to HttpServletResponse.setBufferSize()
javax.faces.FACELETS_DECORATORS 2.0 Set of class names, separated by ';', implementing TagDecorator interface, used to transform a view definition in a facelet abstract syntax tree, that is used later to generate a component tree
javax.faces.FACELETS_LIBRARIES 2.0 Set of .taglib.xml files, separated by ';' that should be loaded by facelet engine.
javax.faces.FACELETS_REFRESH_PERIOD 2.0 -1 Define the period used to refresh the facelet abstract syntax tree from the view definition file
javax.faces.FACELETS_RESOURCE_RESOLVER 2.0 Class implementing ResourceResolver interface used to locate facelet resources
javax.faces.FACELETS_SKIP_COMMENTS 2.0 Skip comments found on a facelet file
org.apache.myfaces.MARK_INITIAL_STATE_WHEN_APPLY_BUILD_VIEW 2.1 false no description
org.apache.myfaces.WRAP_TAG_EXCEPTIONS_AS_CONTEXT_AWARE 2.0.9, 2.1.3 true Wrap exception caused by calls to EL expressions, so information like the location, expression string and tag name can be retrieved by the ExceptionHandler implementation and used to output meaningful information about itself
org.apache.myfaces.INITIALIZE_ALWAYS_STANDALONE 2.0.3 false If this param is set to true, the check for faces servlet mapping is not done
org.apache.myfaces.LOG_WEB_CONTEXT_PARAMS auto Indicate if log all web config params should be done before initialize the webapp
org.apache.myfaces.FACES_INITIALIZER 2.0.1 Class name of a custom FacesInitializer implementation.
org.apache.myfaces.FACES_INIT_PLUGINS 2.0 comma delimited list of plugin classes which can be hooked into myfaces

Deprecated Parameters

Name Since Default Value Short Description
org.apache.myfaces.ERROR_HANDLER 1.2.4 Deprecated: use JSF 2.0 ExceptionHandler
org.apache.myfaces.VIEWSTATE_JAVASCRIPT 1.1 false Set the view state using a javascript function instead a hidden input field
facelets.BUFFER_SIZE 2.0 Define the default buffer size value passed to ExternalContext
facelets.DECORATORS 2.0 Set of class names, separated by ';', implementing TagDecorator interface, used to transform a view definition in a facelet abstract syntax tree, that is used later to generate a component tree
facelets.LIBRARIES 2.0 Set of .taglib.xml files, separated by ';' that should be loaded by facelet engine.
facelets.REFRESH_PERIOD 2.0 -1 Define the period used to refresh the facelet abstract syntax tree from the view definition file
facelets.RESOURCE_RESOLVER 2.0 Class implementing ResourceResolver interface used to locate facelet resources
facelets.SKIP_COMMENTS 2.0 Skip comments found on a facelet file

Detailed Information

Artifact Id: myfaces-api

Param Name: javax.faces.RESOURCE_EXCLUDES
Ignore Upper/Lower case values: false
Default Value: .class .jsp .jspx .properties .xhtml .groovy
Since: 2.0
Group: resources
Tags:
Source Class: javax.faces.application.ResourceHandler
Description:
Space separated file extensions that will not be served by the default ResourceHandler implementation.

Param Name: javax.faces.STATE_SAVING_METHOD
Ignore Upper/Lower case values: false
Default Value: server
Expected Values: server,client
Since: 1.1
Group: state
Tags: performance
Source Class: javax.faces.application.StateManager
Description:
Define the state method to be used. There are two different options defined by the specification: "client" and "server" state.

When "client" state is configured, all state information required to create the tree is embedded within the data rendered to the client. Note that because data received from a remote client must always be treated as "tainted", care must be taken when using such data. Some StateManager implementations may use encryption to ensure that clients cannot modify the data, and that the data received on postback is therefore trustworthy.

When "server" state is configured, the data is saved somewhere "on the back end", and (at most) a token is embedded in the data rendered to the user.

Param Name: javax.faces.FULL_STATE_SAVING_VIEW_IDS
Ignore Upper/Lower case values: false
Since: 2.0
Group: state
Tags:
Source Class: javax.faces.application.StateManager
Description:
Indicate the viewId(s) separated by commas that should be saved and restored fully, without use Partial State Saving (PSS).

Param Name: javax.faces.PARTIAL_STATE_SAVING
Ignore Upper/Lower case values: false
Default Value: true (false with 1.2 webapps)
Expected Values: true,false
Since: 2.0
Group: state
Tags: performance
Source Class: javax.faces.application.StateManager
Description:
Enable or disable partial state saving algorithm.

Partial State Saving algorithm allows to reduce the size of the state required to save a view, keeping track of the "delta" or differences between the view build by first time and the current state of the view.

If the webapp faces-config file version is 2.0 or upper the default value is true, otherwise is false.

Param Name: javax.faces.DEFAULT_SUFFIX
Ignore Upper/Lower case values: false
Default Value: .xhtml .view.xml .jsp
Since: 1.1
Group: viewhandler
Tags:
Source Class: javax.faces.application.ViewHandler
Description:
Indicate the default suffixes, separated by spaces to derive the default file URI used by JSF to create views and render pages.

Param Name: javax.faces.FACELETS_SUFFIX
Ignore Upper/Lower case values: false
Default Value: .xhtml
Since: 2.0
Group: viewhandler
Tags:
Source Class: javax.faces.application.ViewHandler
Description:
The default extension used to handle facelets pages.

Param Name: javax.faces.FACELETS_VIEW_MAPPINGS
Ignore Upper/Lower case values: false
Since: 2.0
Group: viewhandler
Tags:
Source Class: javax.faces.application.ViewHandler
Description:
Set of extensions handled by facelets, separated by ';'.

Param Name: javax.faces.HONOR_CURRENT_COMPONENT_ATTRIBUTES
Ignore Upper/Lower case values: false
Default Value: false
Expected Values: true, false
Since: 2.1.0
Group:
Tags:
Source Class: javax.faces.component.UIComponent
Description:
Indicate if the facesContext attribute values under the keys javax.faces.component.CURRENT_COMPONENT and javax.faces.component.CURRENT_COMPOSITE_COMPONENT should be valid or not. By default, those keys are deprecated since 2.1

Param Name: javax.faces.VALIDATE_EMPTY_FIELDS
Ignore Upper/Lower case values: false
Default Value: auto
Expected Values: auto, true, false
Since: 2.0
Group: validation
Tags:
Source Class: javax.faces.component.UIInput
Description:
Force validation on empty fields (By default is auto, which means it is only enabled when Bean Validation binaries are available on the current classpath).

Param Name: javax.faces.INTERPRET_EMPTY_STRING_SUBMITTED_VALUES_AS_NULL
Ignore Upper/Lower case values: false
Default Value: false
Expected Values: true, false
Since: 2.0
Group: validation
Tags:
Source Class: javax.faces.component.UIInput
Description:
Submitted values are decoded as null values instead empty strings.

Note this param is ignored for components extending from UISelectOne/UISelectMany.

Param Name: org.apache.myfaces.ENUM_CONVERTER_ALLOW_STRING_PASSTROUGH
Ignore Upper/Lower case values: false
Default Value: false
Expected Values: true,false
Since: 2.0.1
Group: validation
Tags:
Source Class: javax.faces.convert.EnumConverter
Description:
If value is a String instance and this param is true, pass it directly without try any change. See MYFACES-2739 for details.

Param Name: javax.faces.validator.DISABLE_DEFAULT_BEAN_VALIDATOR
Ignore Upper/Lower case values: false
Default Value: true
Expected Values: true, false
Since: 2.0
Group: validation
Tags:
Source Class: javax.faces.validator.BeanValidator
Description:
If this init parameter is present, no Bean Validators should be added to an UIInput by default. Explicitly adding a BeanValidator to an UIInput is possible though.

Param Name: javax.faces.CONFIG_FILES
Ignore Upper/Lower case values: false
Since: 1.1
Group:
Tags:
Source Class: javax.faces.webapp.FacesServlet
Description:
Comma separated list of URIs of (additional) faces config files. (e.g. /WEB-INF/my-config.xml)See JSF 1.0 PRD2, 10.3.2 Attention: You do not need to put /WEB-INF/faces-config.xml in here.

Param Name: javax.faces.LIFECYCLE_ID
Ignore Upper/Lower case values: false
Since: 1.1
Group:
Tags:
Source Class: javax.faces.webapp.FacesServlet
Description:
Identify the Lifecycle instance to be used.

Param Name: org.apache.myfaces.ERROR_HANDLER
Ignore Upper/Lower case values: false
Deprecated: true
Since: 1.2.4
Group:
Tags:
Source Class: javax.faces.webapp.PreJsf2ExceptionHandlerFactory$PreJsf2ExceptionHandlerImpl
Description:
Since JSF 2.0 there is a standard way to deal with unexpected Exceptions: the ExceptionHandler. Due to backwards compatibility MyFaces 2.0 also supports the init parameter org.apache.myfaces.ERROR_HANDLER, introduced in MyFaces 1.2.4. However, the given error handler now only needs to include the following method:

  • handleException(FacesContext fc, Exception ex)
Furthermore, the init parameter only works when using the PreJsf2ExceptionHandlerFactory.

Artifact Id: myfaces-impl-shared

Param Name: org.apache.myfaces.CHECKED_VIEWID_CACHE_SIZE
Ignore Upper/Lower case values: false
Default Value: 500
Since: 2.0.2
Group: viewhandler
Tags: performance
Source Class: org.apache.myfaces.shared.application.DefaultViewHandlerSupport
Description:
Controls the size of the cache used to "remember" if a view exists or not.

Param Name: org.apache.myfaces.CHECKED_VIEWID_CACHE_ENABLED
Ignore Upper/Lower case values: false
Default Value: true
Expected Values: true, false
Since: 2.0.2
Group: viewhandler
Tags: performance
Source Class: org.apache.myfaces.shared.application.DefaultViewHandlerSupport
Description:
Enable or disable a cache used to "remember" if a view exists or not and reduce the impact of sucesive calls to ExternalContext.getResource().

Param Name: org.apache.myfaces.PRETTY_HTML
Ignore Upper/Lower case values: true
Default Value: true
Expected Values: true, false, on, off, yes, no
Since: 1.1
Group: render
Tags:
Source Class: org.apache.myfaces.shared.config.MyfacesConfig
Description:
If true, rendered HTML code will be formatted, so that it is "human readable". i.e. additional line separators and whitespace will be written, that do not influence the HTML code. Default: "true"

Param Name: org.apache.myfaces.ALLOW_JAVASCRIPT
Ignore Upper/Lower case values: true
Default Value: true
Expected Values: true, false, on, off, yes, no
Since: 1.1
Group: render
Tags:
Source Class: org.apache.myfaces.shared.config.MyfacesConfig
Description:
This parameter tells MyFaces if javascript code should be allowed in the rendered HTML output. If javascript is allowed, command_link anchors will have javascript code that submits the corresponding form. If javascript is not allowed, the state saving info and nested parameters ill be added as url parameters. Default: "true"

Param Name: org.apache.myfaces.CONFIG_REFRESH_PERIOD
Ignore Upper/Lower case values: false
Default Value: 2
Since: 1.1
Group:
Tags:
Source Class: org.apache.myfaces.shared.config.MyfacesConfig
Description:
Set the time in seconds that check for updates of web.xml and faces-config descriptors and refresh the configuration. This param is valid only if project stage is not production. Set this param to 0 disable this feature.

Param Name: org.apache.myfaces.VIEWSTATE_JAVASCRIPT
Ignore Upper/Lower case values: true
Default Value: false
Deprecated: true
Expected Values: true, false, on, off, yes, no
Since: 1.1
Group: state
Tags:
Source Class: org.apache.myfaces.shared.config.MyfacesConfig
Description:
Set the view state using a javascript function instead a hidden input field.

Param Name: org.apache.myfaces.RENDER_VIEWSTATE_ID
Ignore Upper/Lower case values: true
Default Value: true
Expected Values: true, false, on, off, yes, no
Since: 1.1
Group: state
Tags:
Source Class: org.apache.myfaces.shared.config.MyfacesConfig
Description:
Define if the input field that should store the state (javax.faces.ViewState) should render id="javax.faces.ViewState". JSF API 1.2 defines a "javax.faces.ViewState" client parameter, that must be rendered as both the "name" and the "id" attribute of the hidden input that is rendered for the purpose of state saving (see ResponseStateManager.VIEW_STATE_PARAM). Actually this causes duplicate id attributes and thus invalid XHTML pages when multiple forms are rendered on one page. With the org.apache.myfaces.RENDER_VIEWSTATE_ID context parameter you can tune this behaviour.
Set it to

  • true - to render JSF 1.2 compliant id attributes (that might cause invalid XHTML), or
  • false - to omit rendering of the id attribute (which is only needed for very special AJAX/Javascript components)
Default value is: true (for backwards compatibility and JSF 1.2 compliancy)

Param Name: org.apache.myfaces.STRICT_XHTML_LINKS
Ignore Upper/Lower case values: true
Default Value: true
Expected Values: true, false, on, off, yes, no
Since: 1.1.6
Group: render
Tags:
Source Class: org.apache.myfaces.shared.config.MyfacesConfig
Description:
Use "&amp;" entity instead a plain "&" character within HTML.

W3C recommends to use the "&amp;" entity instead of a plain "&" character within HTML. This also applies to attribute values and thus to the "href" attribute of <a> elements as well. Even more, when XHTML is used as output the usage of plain "&" characters is forbidden and would lead to invalid XML code. Therefore, since version 1.1.6 MyFaces renders the correct "&amp;" entity for links.

The init parameter org.apache.myfaces.STRICT_XHTML_LINKS makes it possible to restore the old behaviour and to make MyFaces "bug compatible" to the Sun RI which renders plain "&" chars in links as well.

See: HTML 4.01 Specification See: Jira: MYFACES-1774

Param Name: org.apache.myfaces.RENDER_CLEAR_JAVASCRIPT_FOR_BUTTON
Ignore Upper/Lower case values: true
Default Value: false
Expected Values: true, false, on, off, yes, no
Since: 1.2.3
Group: render
Tags:
Source Class: org.apache.myfaces.shared.config.MyfacesConfig
Description:
This param renders the clear javascript on button necessary only for compatibility with hidden fields feature of myfaces. This is done because jsf ri does not render javascript on onclick method for button, so myfaces should do this.

Param Name: org.apache.myfaces.RENDER_HIDDEN_FIELDS_FOR_LINK_PARAMS
Ignore Upper/Lower case values: true
Default Value: false
Expected Values: true, false, on, off, yes, no
Since: 1.2.9
Group: render
Tags:
Source Class: org.apache.myfaces.shared.config.MyfacesConfig
Description:
This param renders hidden fields at the end of h:form for link params when h:commandLink + f:param is used, instead use javascript to create them. Set this param to true also enables org.apache.myfaces.RENDER_CLEAR_JAVASCRIPT_FOR_BUTTON automatically to ensure consistency. This feature is required to support Windows Mobile 6, because in this environment, document.createElement() and form.appendChild() javascript methods are not supported.

Param Name: org.apache.myfaces.SAVE_FORM_SUBMIT_LINK_IE
Ignore Upper/Lower case values: true
Default Value: false
Expected Values: true, false, on, off, yes, no
Since: 1.1
Group: render
Tags:
Source Class: org.apache.myfaces.shared.config.MyfacesConfig
Description:
Add a code that save the form before submit using a link (call to window.external.AutoCompleteSaveForm(form) ). It's a bug on IE.

Param Name: org.apache.myfaces.DELEGATE_FACES_SERVLET
Ignore Upper/Lower case values: false
Since: 1.2.7
Group:
Tags:
Source Class: org.apache.myfaces.shared.config.MyfacesConfig
Description:
Define an alternate class name that will be used to initialize MyFaces, instead the default javax.faces.webapp.FacesServlet.

This helps MyFaces to detect the mappings and other additional configuration used to setup the environment, and prevent abort initialization if no FacesServlet config is detected.

Param Name: org.apache.myfaces.REFRESH_TRANSIENT_BUILD_ON_PSS
Ignore Upper/Lower case values: true
Default Value: auto
Expected Values: true,false,auto
Since: 2.0
Group: state
Tags: performance
Source Class: org.apache.myfaces.shared.config.MyfacesConfig
Description:
Indicate if the facelet associated to the view should be reapplied when the view is refreshed. Default mode is "auto".

This param is only valid when partial state saving is on. If this is set as true, the tag-handlers are always reapplied before render view, like in facelets 1.1.x, allowing c:if work correctly to "toggle" components based on a value changed on invoke application phase. If the param is set as "auto", the implementation check if c:if, c:forEach, c:choose and ui:include with src=ELExpression is used on the page and if that so, mark the view to be refreshed.

Param Name: org.apache.myfaces.REFRESH_TRANSIENT_BUILD_ON_PSS_PRESERVE_STATE
Ignore Upper/Lower case values: true
Default Value: false
Expected Values: true, false, on, off, yes, no
Since: 2.0
Group: state
Tags: performance
Source Class: org.apache.myfaces.shared.config.MyfacesConfig
Description:
Enable or disable a special mode that enable full state for parent components containing c:if, c:forEach, c:choose and ui:include with src=ELExpression. By default is disabled(false).

This param is only valid when partial state saving is on. If this is set as true, parent components containing c:if, c:forEach, c:choose and ui:include with src=ELExpression are marked to be restored fully, so state is preserved between request.

Param Name: org.apache.myfaces.VALIDATE_XML
Ignore Upper/Lower case values: true
Expected Values: true, false, on, off, yes, no
Since: 2.0
Group:
Tags:
Source Class: org.apache.myfaces.shared.config.MyfacesConfig
Description:
If set to true, tag library XML files and faces config XML files using schema will be validated during application start up

Param Name: org.apache.myfaces.WRAP_SCRIPT_CONTENT_WITH_XML_COMMENT_TAG
Ignore Upper/Lower case values: true
Default Value: true
Expected Values: true, false, on, off, yes, no
Since: 2.0.1
Group: render
Tags:
Source Class: org.apache.myfaces.shared.config.MyfacesConfig
Description:
Wrap content inside script with xml comment to prevent old browsers to display it. By default it is true.

Param Name: org.apache.myfaces.RENDER_FORM_SUBMIT_SCRIPT_INLINE
Ignore Upper/Lower case values: true
Default Value: false
Expected Values: true, false, on, off, yes, no
Since: 2.0.2
Group: render
Tags:
Source Class: org.apache.myfaces.shared.config.MyfacesConfig
Description:
If set true, render the form submit script inline, as in myfaces core 1.2 and earlier versions

Param Name: org.apache.myfaces.DEBUG_PHASE_LISTENER
Ignore Upper/Lower case values: false
Since: 2.0.8
Group:
Tags:
Source Class: org.apache.myfaces.shared.config.MyfacesConfig
Description:
Enable/disable DebugPhaseListener feature, with provide useful information about ValueHolder variables (submittedValue, localValue, value). Note evaluate those getters for each component could cause some unwanted side effects when using "access" type scopes like on MyFaces CODI. This param only has effect when project stage is Development.

Param Name: org.apache.myfaces.STRICT_JSF_2_REFRESH_TARGET_AJAX
Ignore Upper/Lower case values: false
Default Value: false
Expected Values: true, false
Since: 2.0.10
Group:
Tags:
Source Class: org.apache.myfaces.shared.config.MyfacesConfig
Description:
Detect if a target (usually head) should be update for the current view in an ajax render operation. This is activated if a css or js resource is added dynamically by effect of a refresh (c:if, ui:include src="#{...}" or a manipulation of the tree). This ensures ajax updates of content using ui:include will be consistent. Note this behavior is a myfaces specific extension, so to ensure strict compatibility with the spec, set this param to false (default false).

Param Name: org.apache.myfaces.STRICT_JSF_2_CC_EL_RESOLVER
Ignore Upper/Lower case values: false
Default Value: false
Expected Values: true, false
Since: 2.0.10
Group: EL
Tags:
Source Class: org.apache.myfaces.shared.config.MyfacesConfig
Description:
Change default getType() behavior for composite component EL resolver, from return null (see JSF 2_0 spec section 5_6_2_2) to use the metadata information added by composite:attribute, ensuring components working with chained EL expressions to find the right type when a getType() is called over the source EL expression. To ensure strict compatibility with the spec set this param to true (by default is false, so the change is enabled by default).

Param Name: org.apache.myfaces.DEFAULT_RESPONSE_WRITER_CONTENT_TYPE_MODE
Ignore Upper/Lower case values: false
Default Value: text/html
Expected Values: text/html, application/xhtml+xml
Since: 2.0.11,2.1.5
Group: render
Tags:
Source Class: org.apache.myfaces.shared.config.MyfacesConfig
Description:
Define the default content type that the default ResponseWriter generates, when no match can be derived from HTTP Accept Header.

Param Name: org.apache.myfaces.VIEW_UNIQUE_IDS_CACHE_ENABLED
Ignore Upper/Lower case values: false
Default Value: false
Expected Values: true, false
Since: 2.0.13, 2.1.7
Group: viewhandler
Tags: performance
Source Class: org.apache.myfaces.shared.config.MyfacesConfig
Description:
Enable or disable a cache used to "remember" the generated facelets unique ids and reduce the impact on memory usage, only active if javax.faces.FACELETS_REFRESH_PERIOD is -1 (no refresh).

Param Name: org.apache.myfaces.COMPONENT_UNIQUE_IDS_CACHE_SIZE
Ignore Upper/Lower case values: false
Default Value: 100
Since: 2.0.13, 2.1.7
Group: viewhandler
Tags: performance
Source Class: org.apache.myfaces.shared.config.MyfacesConfig
Description:
Set the size of the cache used to store strings generated using SectionUniqueIdCounter for component ids. If this is set to 0, no cache is used. By default is set to 100.

Param Name: org.apache.myfaces.SUPPORT_JSP_AND_FACES_EL
Ignore Upper/Lower case values: false
Default Value: true
Expected Values: true,false
Since: 2.0.13,2.1.7
Group: EL
Tags: performance
Source Class: org.apache.myfaces.shared.config.MyfacesConfig
Description:
If set false, myfaces won't support JSP and javax.faces.el. JSP are deprecated in JSF 2.X, javax.faces.el in in JSF 1.2. Default value is true. If this property is set is false, JSF 1.1 VariableResolver and PropertyResolver config (replaced in JSF 1.2 by ELResolver) and all related logic for JSP is skipped, making EL evaluation faster.

Param Name: org.apache.myfaces.GAE_JSF_JAR_FILES
Ignore Upper/Lower case values: false
Expected Values: none, myfavoritejsflib-*.jar
Since: 2.1.8, 2.0.14
Group:
Tags: performance, GAE
Source Class: org.apache.myfaces.shared.config.MyfacesConfig
Description:
When the application runs inside Google Application Engine container (GAE), indicate which jar files should be scanned for files (faces-config, facelets taglib or annotations). It accept simple wildcard patterns like myfavoritejsflib-*.jar or myfavoritejsflib-1.1.?.jar. By default, all the classpath is scanned for files annotations (so it adds an small delay on startup).

Param Name: org.apache.myfaces.GAE_JSF_ANNOTATIONS_JAR_FILES
Ignore Upper/Lower case values: false
Expected Values: none, myfavoritejsflib-*.jar
Since: 2.1.8, 2.0.14
Group:
Tags: performance, GAE
Source Class: org.apache.myfaces.shared.config.MyfacesConfig
Description:
When the application runs inside Google Application Engine container (GAE), indicate which jar files should be scanned for annotations. This param overrides org.apache.myfaces.GAE_JSF_JAR_FILES behavior that tries to find faces-config.xml or files ending with .faces-config.xml in /META-INF folder and if that so, try to find JSF annotations in the whole jar file. It accept simple wildcard patterns like myfavoritejsflib-*.jar or myfavoritejsflib-1.1.?.jar. By default, all the classpath is scanned for annotations (so it adds an small delay on startup).

Param Name: org.apache.myfaces.STRICT_JSF_2_VIEW_NOT_FOUND
Ignore Upper/Lower case values: false
Default Value: false
Expected Values: true,false
Since: 2.1.13
Group: viewhandler
Tags:
Source Class: org.apache.myfaces.shared.config.MyfacesConfig
Description:
If this param is set to true, a check will be done in Restore View Phase to check if the viewId exists or not and if it does not exists, a 404 response will be thrown. This is applicable in cases where all the views in the application are generated by a ViewDeclarationLanguage implementation.

Param Name: org.apache.myfaces.FLASH_SCOPE_DISABLED
Ignore Upper/Lower case values: false
Default Value: false
Since: 2.0.5
Group:
Tags:
Source Class: org.apache.myfaces.shared.context.flash.FlashImpl
Description:
Defines whether flash scope is disabled, preventing add the Flash cookie to the response.

This is useful for applications that does not require to use flash scope, and instead uses other scopes.

Param Name: org.apache.myfaces.RESOURCE_MAX_TIME_EXPIRES
Ignore Upper/Lower case values: false
Default Value: 604800000
Since: 2.0
Group: resources
Tags: performance
Source Class: org.apache.myfaces.shared.resource.BaseResourceHandlerSupport
Description:
Set the max time in miliseconds set on the "Expires" header for a resource rendered by the default ResourceHandler. (default to one week in miliseconds or 604800000)

Param Name: org.apache.myfaces.RESOURCE_HANDLER_CACHE_SIZE
Ignore Upper/Lower case values: false
Default Value: 500
Since: 2.0.2
Group: resources
Tags: performance
Source Class: org.apache.myfaces.shared.resource.ResourceHandlerCache
Description:
Controls the size of the cache used to check if a resource exists or not.

See org.apache.myfaces.RESOURCE_HANDLER_CACHE_ENABLED for details.

Param Name: org.apache.myfaces.RESOURCE_HANDLER_CACHE_ENABLED
Ignore Upper/Lower case values: false
Default Value: true
Expected Values: true,false
Since: 2.0.2
Group: resources
Tags: performance
Source Class: org.apache.myfaces.shared.resource.ResourceHandlerCache
Description:
Enable or disable the cache used to "remember" if a resource handled by the default ResourceHandler exists or not.

Param Name: org.apache.myfaces.USE_ENCRYPTION
Ignore Upper/Lower case values: false
Default Value: true
Expected Values: true,false
Since: 1.1
Group: state
Tags:
Source Class: org.apache.myfaces.shared.util.StateUtils
Description:
Indicate if the view state is encrypted or not. By default, encryption is enabled.

Param Name: org.apache.myfaces.SECRET
Ignore Upper/Lower case values: false
Since: 1.1
Group: state
Tags:
Source Class: org.apache.myfaces.shared.util.StateUtils
Description:
Defines the secret (Base64 encoded) used to initialize the secret key for encryption algorithm. See MyFaces wiki/web site documentation for instructions on how to configure an application for different encryption strengths.

Param Name: org.apache.myfaces.ALGORITHM
Ignore Upper/Lower case values: false
Default Value: DES
Since: 1.1
Group: state
Tags: performance
Source Class: org.apache.myfaces.shared.util.StateUtils
Description:
Indicate the encryption algorithm used for encrypt the view state.

Param Name: org.apache.myfaces.SECRET.CACHE
Ignore Upper/Lower case values: false
Since: 1.1
Group: state
Tags:
Source Class: org.apache.myfaces.shared.util.StateUtils
Description:
If is set to "false", the secret key used for encryption algorithm is not cached. This is used when the returned SecretKey for encryption algorithm is not thread safe.

Param Name: org.apache.myfaces.ALGORITHM.IV
Ignore Upper/Lower case values: false
Since: 1.1
Group: state
Tags:
Source Class: org.apache.myfaces.shared.util.StateUtils
Description:
Defines the initialization vector (Base64 encoded) used for the encryption algorithm

Param Name: org.apache.myfaces.ALGORITHM.PARAMETERS
Ignore Upper/Lower case values: false
Default Value: ECB/PKCS5Padding
Since: 1.1
Group: state
Tags:
Source Class: org.apache.myfaces.shared.util.StateUtils
Description:
Defines the default mode and padding used for the encryption algorithm

Param Name: org.apache.myfaces.SERIAL_FACTORY
Ignore Upper/Lower case values: false
Since: 1.1
Group: state
Tags: performance
Source Class: org.apache.myfaces.shared.util.StateUtils
Description:
Defines the factory class name using for serialize/deserialize the view state returned by state manager into a byte array. The expected class must implement org.apache.myfaces.shared.util.serial.SerialFactory interface.

Param Name: org.apache.myfaces.COMPRESS_STATE_IN_CLIENT
Ignore Upper/Lower case values: false
Default Value: false
Expected Values: true,false
Since: 1.1
Group: state
Tags: performance
Source Class: org.apache.myfaces.shared.util.StateUtils
Description:
Indicate if the view state should be compressed before encrypted(optional) and encoded

Param Name: org.apache.myfaces.MAC_ALGORITHM
Ignore Upper/Lower case values: false
Default Value: HmacSHA1
Group: state
Tags: performance
Source Class: org.apache.myfaces.shared.util.StateUtils
Description:
Indicate the algorithm used to calculate the Message Authentication Code that is added to the view state.

Param Name: org.apache.myfaces.MAC_SECRET
Ignore Upper/Lower case values: false
Group: state
Tags:
Source Class: org.apache.myfaces.shared.util.StateUtils
Description:
Define the initialization code that are used to initialize the secret key used on the Message Authentication Code algorithm

Param Name: org.apache.myfaces.MAC_SECRET.CACHE
Ignore Upper/Lower case values: false
Group: state
Tags:
Source Class: org.apache.myfaces.shared.util.StateUtils
Description:
If is set to "false", the secret key used for MAC algorithm is not cached. This is used when the returned SecretKey for mac algorithm is not thread safe.

Artifact Id: myfaces-impl

Param Name: javax.faces.DATETIMECONVERTER_DEFAULT_TIMEZONE_IS_SYSTEM_TIMEZONE
Ignore Upper/Lower case values: false
Default Value: false
Expected Values: true, false
Since: 2.0
Group: validation
Tags:
Source Class: org.apache.myfaces.application.ApplicationImpl
Description:
Set the default timezone as system timezone when a converter extending from DateTimeConverter is created.

Param Name: javax.faces.PROJECT_STAGE
Ignore Upper/Lower case values: false
Default Value: Production
Expected Values: Development, Production, SystemTest, UnitTest
Since: 2.0
Group:
Tags:
Source Class: org.apache.myfaces.application.ApplicationImpl
Description:
Indicate the stage of the initialized application.

Param Name: org.apache.myfaces.LAZY_LOAD_CONFIG_OBJECTS
Ignore Upper/Lower case values: false
Default Value: true
Since: 2.0
Group:
Tags: performance
Source Class: org.apache.myfaces.application.ApplicationImpl
Description:
Indicate if the classes associated to components, converters, validators or behaviors should be loaded as soon as they are added to the current application instance or instead loaded in a lazy way.

Param Name: org.apache.myfaces.STRICT_JSF_2_ALLOW_SLASH_LIBRARY_NAME
Ignore Upper/Lower case values: false
Default Value: false
Expected Values: true, false
Since: 2.1.6, 2.0.12
Group: resources
Tags:
Source Class: org.apache.myfaces.application.ResourceHandlerImpl
Description:
Allow slash in the library name of a Resource.

Param Name: org.apache.myfaces.RESOURCE_BUFFER_SIZE
Ignore Upper/Lower case values: false
Default Value: 2048
Since: 2.1.10, 2.0.16
Group: resources
Tags:
Source Class: org.apache.myfaces.application.ResourceHandlerImpl
Description:
Define the default buffer size that is used between Resource.getInputStream() and httpServletResponse.getOutputStream() when rendering resources using the default ResourceHandler.

Param Name: org.apache.myfaces.CLIENT_VIEW_STATE_TIMEOUT
Ignore Upper/Lower case values: false
Default Value: 0
Since: 2.1.9, 2.0.15
Group: state
Tags:
Source Class: org.apache.myfaces.application.viewstate.ClientSideStateCacheImpl
Description:
Define the time in minutes where the view state is valid when client side state saving is used. By default it is set to 0 (infinite).

Param Name: org.apache.myfaces.NUMBER_OF_VIEWS_IN_SESSION
Ignore Upper/Lower case values: false
Default Value: 20
Since: 1.1
Group: state
Tags: performance
Source Class: org.apache.myfaces.application.viewstate.ServerSideStateCacheImpl
Description:
Defines the amount (default = 20) of the latest views are stored in session.

Only applicable if state saving method is "server" (= default).

Param Name: org.apache.myfaces.NUMBER_OF_SEQUENTIAL_VIEWS_IN_SESSION
Ignore Upper/Lower case values: false
Since: 2.0.6
Group: state
Tags: performance
Source Class: org.apache.myfaces.application.viewstate.ServerSideStateCacheImpl
Description:
Indicates the amount of views (default is not active) that should be stored in session between sequential POST or POST-REDIRECT-GET if org.apache.myfaces.USE_FLASH_SCOPE_PURGE_VIEWS_IN_SESSION is true.

Only applicable if state saving method is "server" (= default). For example, if this param has value = 2 and in your custom webapp there is a form that is clicked 3 times, only 2 views will be stored and the third one (the one stored the first time) will be removed from session, even if the view can store more sessions org.apache.myfaces.NUMBER_OF_VIEWS_IN_SESSION. This feature becomes useful for multi-window applications. where without this feature a window can swallow all view slots so the other ones will throw ViewExpiredException.

Param Name: org.apache.myfaces.SERIALIZE_STATE_IN_SESSION
Ignore Upper/Lower case values: false
Default Value: true
Expected Values: true,false
Since: 1.1
Group: state
Tags: performance
Source Class: org.apache.myfaces.application.viewstate.ServerSideStateCacheImpl
Description:
Indicate if the state should be serialized before save it on the session.

Only applicable if state saving method is "server" (= default). If true (default) the state will be serialized to a byte stream before it is written to the session. If false the state will not be serialized to a byte stream.

Param Name: org.apache.myfaces.COMPRESS_STATE_IN_SESSION
Ignore Upper/Lower case values: false
Default Value: true
Expected Values: true,false
Since: 1.1
Group: state
Tags: performance
Source Class: org.apache.myfaces.application.viewstate.ServerSideStateCacheImpl
Description:
Indicates that the serialized state will be compressed before it is written to the session. By default true. Only applicable if state saving method is "server" (= default) and if org.apache.myfaces.SERIALIZE_STATE_IN_SESSION is true (= default). If true (default) the serialized state will be compressed before it is written to the session. If false the state will not be compressed.

Param Name: org.apache.myfaces.CACHE_OLD_VIEWS_IN_SESSION_MODE
Ignore Upper/Lower case values: false
Default Value: off
Expected Values: off, no, hard-soft, soft, soft-weak, weak
Since: 1.2.5
Group: state
Tags: performance
Source Class: org.apache.myfaces.application.viewstate.ServerSideStateCacheImpl
Description:
Define the way of handle old view references(views removed from session), making possible to store it in a cache, so the state manager first try to get the view from the session. If is it not found and soft or weak ReferenceMap is used, it try to get from it.

Only applicable if state saving method is "server" (= default).

The gc is responsible for remove the views, according to the rules used for soft, weak or phantom references. If a key in soft and weak mode is garbage collected, its values are purged.

By default no cache is used, so views removed from session became phantom references.

  • off, no: default, no cache is used
  • hard-soft: use an ReferenceMap(AbstractReferenceMap.HARD, AbstractReferenceMap.SOFT)
  • soft: use an ReferenceMap(AbstractReferenceMap.SOFT, AbstractReferenceMap.SOFT, true)
  • soft-weak: use an ReferenceMap(AbstractReferenceMap.SOFT, AbstractReferenceMap.WEAK, true)
  • weak: use an ReferenceMap(AbstractReferenceMap.WEAK, AbstractReferenceMap.WEAK, true)

Param Name: org.apache.myfaces.USE_FLASH_SCOPE_PURGE_VIEWS_IN_SESSION
Ignore Upper/Lower case values: false
Default Value: false
Expected Values: true, false
Since: 2.0.6
Group: state
Tags:
Source Class: org.apache.myfaces.application.viewstate.ServerSideStateCacheImpl
Description:
Allow use flash scope to keep track of the views used in session and the previous ones, so server side state saving can delete old views even if POST-REDIRECT-GET pattern is used.

Only applicable if state saving method is "server" (= default). The default value is false.

Param Name: org.apache.myfaces.RANDOM_KEY_IN_VIEW_STATE_SESSION_TOKEN
Ignore Upper/Lower case values: false
Default Value: none
Expected Values: secureRandom, random, none
Since: 2.1.9, 2.0.15
Group: state
Tags:
Source Class: org.apache.myfaces.application.viewstate.ServerSideStateCacheImpl
Description:
Adds a random key to the generated view state session token.

Param Name: org.apache.myfaces.RANDOM_KEY_IN_VIEW_STATE_SESSION_TOKEN_LENGTH
Ignore Upper/Lower case values: false
Default Value: 8
Since: 2.1.9, 2.0.15
Group: state
Tags:
Source Class: org.apache.myfaces.application.viewstate.ServerSideStateCacheImpl
Description:
Set the default length of the random key added to the view state session token. By default is 8.

Param Name: org.apache.myfaces.RANDOM_KEY_IN_VIEW_STATE_SESSION_TOKEN_SECURE_RANDOM_CLASS
Ignore Upper/Lower case values: false
Since: 2.1.9, 2.0.15
Group: state
Tags:
Source Class: org.apache.myfaces.application.viewstate.ServerSideStateCacheImpl
Description:
Sets the random class to initialize the secure random id generator. By default it uses java.security.SecureRandom

Param Name: org.apache.myfaces.RANDOM_KEY_IN_VIEW_STATE_SESSION_TOKEN_SECURE_RANDOM_PROVIDER
Ignore Upper/Lower case values: false
Since: 2.1.9, 2.0.15
Group: state
Tags:
Source Class: org.apache.myfaces.application.viewstate.ServerSideStateCacheImpl
Description:
Sets the random provider to initialize the secure random id generator.

Param Name: org.apache.myfaces.RANDOM_KEY_IN_VIEW_STATE_SESSION_TOKEN_SECURE_RANDOM_ALGORITM
Ignore Upper/Lower case values: false
Default Value: SHA1PRNG
Since: 2.1.9, 2.0.15
Group: state
Tags:
Source Class: org.apache.myfaces.application.viewstate.ServerSideStateCacheImpl
Description:
Sets the random algorithm to initialize the secure random id generator. By default is SHA1PRNG

Param Name: org.apache.myfaces.VALIDATE
Ignore Upper/Lower case values: false
Default Value: false
Expected Values: true, false
Since: 2.0
Group:
Tags:
Source Class: org.apache.myfaces.config.FacesConfigValidator
Description:
Validate if the managed beans and navigations rules are correct.

For example, it checks if the managed bean classes really exists, or if the navigation rules points to existing view files.

Param Name: org.apache.myfaces.annotation.SCAN_PACKAGES
Ignore Upper/Lower case values: false
Since: 2.0
Group:
Tags:
Source Class: org.apache.myfaces.config.annotation.DefaultAnnotationProvider
Description:
Servlet context init parameter which defines which packages to scan for beans, separated by commas.

Param Name: org.apache.myfaces.config.annotation.LifecycleProvider
Ignore Upper/Lower case values: false
Since: 1.1
Group:
Tags:
Source Class: org.apache.myfaces.config.annotation.DefaultLifecycleProviderFactory
Description:
no description

Param Name: org.apache.myfaces.EL_RESOLVER_COMPARATOR
Ignore Upper/Lower case values: false
Since: 1.2.10, 2.0.2
Group: EL
Tags:
Source Class: org.apache.myfaces.el.unified.ResolverBuilderBase
Description:
Define a custom comparator class used to sort the ELResolvers.

This is useful when it is necessary to put an ELResolver on top of other resolvers. Note set this param override the default ordering described by JSF spec section 5.

Param Name: org.apache.myfaces.EL_RESOLVER_PREDICATE
Ignore Upper/Lower case values: false
Since: 2.1.0
Group: EL
Tags:
Source Class: org.apache.myfaces.el.unified.ResolverBuilderBase
Description:
The Class of an org.apache.commons.collections.Predicate<ELResolver> implementation." + "If used and returns true for a ELResolver instance, such resolver will not be installed in " + "ELResolvers chain. Use with caution - can break functionality defined in JSF specification " + "'ELResolver Instances Provided by Faces'

Param Name: org.apache.myfaces.CHECKED_VIEWID_CACHE_SIZE
Ignore Upper/Lower case values: false
Default Value: 500
Since: 2.0.2
Group: viewhandler
Tags: performance
Source Class: org.apache.myfaces.lifecycle.DefaultRestoreViewSupport
Description:
Controls the size of the cache used to "remember" if a view exists or not.

Param Name: org.apache.myfaces.CHECKED_VIEWID_CACHE_ENABLED
Ignore Upper/Lower case values: false
Default Value: true
Expected Values: true, false
Since: 2.0.2
Group: viewhandler
Tags: performance
Source Class: org.apache.myfaces.lifecycle.DefaultRestoreViewSupport
Description:
Enable or disable a cache used to "remember" if a view exists or not and reduce the impact of sucesive calls to ExternalContext.getResource().

Param Name: org.apache.myfaces.ERROR_TEMPLATE_RESOURCE
Ignore Upper/Lower case values: false
Default Value: META-INF/rsc/myfaces-dev-error.xml
Since: 1.2.4
Group:
Tags:
Source Class: org.apache.myfaces.renderkit.ErrorPageWriter
Description:
Indicate the template name used to render the default error page used by MyFaces specific error handler implementation.

See org.apache.myfaces.ERROR_HANDLING for details about how to enable/disable it.

Param Name: org.apache.myfaces.DEBUG_TEMPLATE_RESOURCE
Ignore Upper/Lower case values: false
Default Value: META-INF/rsc/myfaces-dev-debug.xml
Since: 1.2.4
Group:
Tags:
Source Class: org.apache.myfaces.renderkit.ErrorPageWriter
Description:
Indicate the template name used to render the default debug page (see ui:debug tag).

Param Name: org.apache.myfaces.ERROR_HANDLING
Ignore Upper/Lower case values: false
Default Value: false, on Development Project stage: true
Expected Values: true,false
Since: 1.2.4
Group:
Tags:
Source Class: org.apache.myfaces.renderkit.ErrorPageWriter
Description:
Indicate if myfaces is responsible to handle errors. See http://wiki.apache.org/myfaces/Handling_Server_Errors for details.

Param Name: org.apache.myfaces.HANDLE_STATE_CACHING_MECHANICS
Ignore Upper/Lower case values: false
Default Value: true
Expected Values: true, false
Since: 2.0.6
Group: state
Tags:
Source Class: org.apache.myfaces.renderkit.html.HtmlResponseStateManager
Description:
Define if the state caching code should be handled by the ResponseStateManager or by the StateManager used.

This param is used to keep compatibility with previous state managers implementations depending from old myfaces way to deal with this. For example, JspStateManagerImpl requires this param set to false, but by default it is set to true, to keep aligned with the Reference Implementation (RI). Note also the default StateManagerImpl requires this property set to true in order to work correctly, so if you set this param to false, please remember to add an entry into your faces-config.xml setting up JspStateManagerImpl as the state manager to use.

Param Name: org.apache.myfaces.USE_MULTIPLE_JS_FILES_FOR_JSF_UNCOMPRESSED_JS
Ignore Upper/Lower case values: false
Default Value: false
Expected Values: true,false
Since: 2.0.1
Group: render
Tags:
Source Class: org.apache.myfaces.resource.InternalClassLoaderResourceLoader
Description:
If this param is true and the project stage is development mode, the source javascript files will be loaded separately instead have all in just one file, to preserve line numbers and make javascript debugging of the default jsf javascript file more simple.

Param Name: org.apache.myfaces.JSF_JS_MODE
Ignore Upper/Lower case values: false
Default Value: normal
Expected Values: normal, minimal-modern, minimal
Since: 2.0.10,2.1.4
Group: render
Tags:
Source Class: org.apache.myfaces.resource.InternalClassLoaderResourceLoader
Description:
Define the mode used for jsf.js file:

  • normal : contains everything, including jsf-i18n.js, jsf-experimental.js and jsf-legacy.js
  • minimal-modern : is the core jsf with a baseline of ie9+, without jsf-i18n.js, jsf-experimental.js and jsf-legacy.js
  • minimal: which is the same with a baseline of ie6, without jsf-i18n.js, jsf-experimental.js

If org.apache.myfaces.USE_MULTIPLE_JS_FILES_FOR_JSF_UNCOMPRESSED_JS param is set to true and project stage is Development, this param is ignored.

Param Name: org.apache.myfaces.TEMPORAL_RESOURCEHANDLER_CACHE_ENABLED
Ignore Upper/Lower case values: false
Default Value: false
Expected Values: true, false
Since: 2.1.11
Group:
Tags:
Source Class: org.apache.myfaces.resource.TempDirFileCacheResourceLoader
Description:
If this param is set to true (default false), a temporal directory is created and all files handled by this ResourceLoader are cached there, avoiding the problem described on MYFACES-3586. (Performance improvement in Resource loading - HIGH CPU inflating bytes in ResourceHandlerImpl.handleResourceRequest).

Param Name: org.apache.myfaces.SERVICE_PROVIDER_FINDER
Ignore Upper/Lower case values: false
Since: 2.0.3
Group:
Tags:
Source Class: org.apache.myfaces.spi.ServiceProviderFinderFactory
Description:
Define the class name of a custom ServiceProviderFinder implementation.

This class is used to override the default SPI scanning algorithm, that relies on the thread context class loader to locate entries under META-INF/services folder.

Param Name: javax.faces.DISABLE_FACELET_JSF_VIEWHANDLER
Ignore Upper/Lower case values: false
Default Value: false
Expected Values: true,false
Since: 2.0
Group: viewhandler
Tags:
Source Class: org.apache.myfaces.view.ViewDeclarationLanguageFactoryImpl
Description:
Disable facelets VDL from the current application project.

Param Name: org.apache.myfaces.SAVE_STATE_WITH_VISIT_TREE_ON_PSS
Ignore Upper/Lower case values: false
Default Value: true
Expected Values: true, false
Since: 2.0.8, 2.1.2
Group: state
Tags: performance
Source Class: org.apache.myfaces.view.facelets.DefaultFaceletsStateManagementStrategy
Description:
If this param is set to true (by default), when pss algorithm is executed to save state, a visit tree traversal is done, instead a plain traversal like previous versions (2.0.7/2.1.1 and earlier) of MyFaces Core. This param is just provided to preserve backwards behavior.

Param Name: org.apache.myfaces.CHECK_ID_PRODUCTION_MODE
Ignore Upper/Lower case values: false
Default Value: auto
Expected Values: true, auto, false
Since: 2.0.12, 2.1.6
Group: state
Tags: performance
Source Class: org.apache.myfaces.view.facelets.DefaultFaceletsStateManagementStrategy
Description:
Define how duplicate ids are checked when ProjectStage is Production, by default (auto) it only check ids of components that does not encapsulate markup (like facelets UILeaf).

  • true: check all ids, including ids for components that are transient and encapsulate markup.
  • auto: (default) check ids of components that does not encapsulate markup (like facelets UILeaf). Note ids of UILeaf instances are generated by facelets vdl, start with "j_id", are never rendered into the response and UILeaf instances are never used as a target for listeners, so in practice there is no need to check such ids. This reduce the overhead associated with generate client ids.
  • false: do not do any check when ProjectStage is Production

According to specification, identifiers must be unique within the scope of the nearest ancestor to the component that is a naming container.

Param Name: javax.faces.FACELETS_BUFFER_SIZE
Ignore Upper/Lower case values: false
Since: 2.0
Group:
Tags: performance
Source Class: org.apache.myfaces.view.facelets.FaceletViewDeclarationLanguage
Description:
Define the default buffer size value passed to ExternalContext.setResponseBufferResponse() and in a servlet environment to HttpServletResponse.setBufferSize().

Param Name: facelets.BUFFER_SIZE
Ignore Upper/Lower case values: false
Deprecated: true
Since: 2.0
Group:
Tags:
Source Class: org.apache.myfaces.view.facelets.FaceletViewDeclarationLanguage
Description:
Define the default buffer size value passed to ExternalContext.setResponseBufferResponse() and in a servlet environment to HttpServletResponse.setBufferSize().

Param Name: javax.faces.FACELETS_DECORATORS
Ignore Upper/Lower case values: false
Since: 2.0
Group:
Tags:
Source Class: org.apache.myfaces.view.facelets.FaceletViewDeclarationLanguage
Description:
Set of class names, separated by ';', implementing TagDecorator interface, used to transform a view definition in a facelet abstract syntax tree, that is used later to generate a component tree.

Param Name: facelets.DECORATORS
Ignore Upper/Lower case values: false
Deprecated: true
Since: 2.0
Group:
Tags:
Source Class: org.apache.myfaces.view.facelets.FaceletViewDeclarationLanguage
Description:
Set of class names, separated by ';', implementing TagDecorator interface, used to transform a view definition in a facelet abstract syntax tree, that is used later to generate a component tree.

Param Name: javax.faces.FACELETS_LIBRARIES
Ignore Upper/Lower case values: false
Since: 2.0
Group:
Tags:
Source Class: org.apache.myfaces.view.facelets.FaceletViewDeclarationLanguage
Description:
Set of .taglib.xml files, separated by ';' that should be loaded by facelet engine.

Param Name: facelets.LIBRARIES
Ignore Upper/Lower case values: false
Deprecated: true
Since: 2.0
Group:
Tags:
Source Class: org.apache.myfaces.view.facelets.FaceletViewDeclarationLanguage
Description:
Set of .taglib.xml files, separated by ';' that should be loaded by facelet engine.

Param Name: javax.faces.FACELETS_REFRESH_PERIOD
Ignore Upper/Lower case values: false
Default Value: -1
Since: 2.0
Group:
Tags: performance
Source Class: org.apache.myfaces.view.facelets.FaceletViewDeclarationLanguage
Description:
Define the period used to refresh the facelet abstract syntax tree from the view definition file.

By default is infinite (no active).

Param Name: facelets.REFRESH_PERIOD
Ignore Upper/Lower case values: false
Default Value: -1
Deprecated: true
Since: 2.0
Group:
Tags:
Source Class: org.apache.myfaces.view.facelets.FaceletViewDeclarationLanguage
Description:
Define the period used to refresh the facelet abstract syntax tree from the view definition file.

By default is infinite (no active).

Param Name: javax.faces.FACELETS_RESOURCE_RESOLVER
Ignore Upper/Lower case values: false
Since: 2.0
Group:
Tags:
Source Class: org.apache.myfaces.view.facelets.FaceletViewDeclarationLanguage
Description:
Class implementing ResourceResolver interface used to locate facelet resources.

Param Name: facelets.RESOURCE_RESOLVER
Ignore Upper/Lower case values: false
Deprecated: true
Since: 2.0
Group:
Tags:
Source Class: org.apache.myfaces.view.facelets.FaceletViewDeclarationLanguage
Description:
Class implementing ResourceResolver interface used to locate facelet resources.

Param Name: javax.faces.FACELETS_SKIP_COMMENTS
Ignore Upper/Lower case values: false
Since: 2.0
Group:
Tags:
Source Class: org.apache.myfaces.view.facelets.FaceletViewDeclarationLanguage
Description:
Skip comments found on a facelet file.

Param Name: facelets.SKIP_COMMENTS
Ignore Upper/Lower case values: false
Deprecated: true
Since: 2.0
Group:
Tags:
Source Class: org.apache.myfaces.view.facelets.FaceletViewDeclarationLanguage
Description:
Skip comments found on a facelet file.

Param Name: org.apache.myfaces.MARK_INITIAL_STATE_WHEN_APPLY_BUILD_VIEW
Ignore Upper/Lower case values: false
Default Value: false
Expected Values: true, false
Since: 2.1
Group:
Tags: performance
Source Class: org.apache.myfaces.view.facelets.FaceletViewDeclarationLanguage
Description:
no description

Param Name: org.apache.myfaces.WRAP_TAG_EXCEPTIONS_AS_CONTEXT_AWARE
Ignore Upper/Lower case values: false
Default Value: true
Expected Values: true, false
Since: 2.0.9, 2.1.3
Group:
Tags:
Source Class: org.apache.myfaces.view.facelets.impl.FaceletCompositionContextImpl
Description:
Wrap exception caused by calls to EL expressions, so information like the location, expression string and tag name can be retrieved by the ExceptionHandler implementation and used to output meaningful information about itself.

Note in some cases this will wrap the original javax.el.ELException, so the information will not be on the stack trace unless ExceptionHandler retrieve checking if the exception implements ContextAware interface and calling getWrapped() method.

Param Name: org.apache.myfaces.CACHE_EL_EXPRESSIONS
Ignore Upper/Lower case values: false
Default Value: noCache
Expected Values: noCache, strict, allowCset, always, alwaysRecompile
Since: 2.0.8
Group: EL
Tags: performance
Source Class: org.apache.myfaces.view.facelets.impl.FaceletCompositionContextImpl
Description:
Indicates if expressions generated by facelets should be cached or not. Default is noCache. There there are four modes:

  • alwaysRecompile (since 2.1.12): Only does not cache when the expression contains a variable resolved using VariableMapper
  • always: Only does not cache when expressions are inside user tags or the expression contains a variable resolved using VariableMapper
  • allowCset: Like always, but does not allow cache when ui:param was used on the current template context
  • strict: Like allowCset, but does not allow cache when c:set with var and value properties only is used on the current page context
  • noCache: All expression are created each time the view is built

Param Name: org.apache.myfaces.EXPRESSION_FACTORY
Ignore Upper/Lower case values: false
Since: 1.2.7
Group: EL
Tags:
Source Class: org.apache.myfaces.webapp.AbstractFacesInitializer
Description:
This parameter specifies the ExpressionFactory implementation to use.

Param Name: org.apache.myfaces.INITIALIZE_ALWAYS_STANDALONE
Ignore Upper/Lower case values: false
Default Value: false
Since: 2.0.3
Group:
Tags:
Source Class: org.apache.myfaces.webapp.AbstractFacesInitializer
Description:
If this param is set to true, the check for faces servlet mapping is not done

Param Name: org.apache.myfaces.LOG_WEB_CONTEXT_PARAMS
Ignore Upper/Lower case values: false
Default Value: auto
Expected Values: true, auto, false
Group:
Tags:
Source Class: org.apache.myfaces.webapp.AbstractFacesInitializer
Description:
Indicate if log all web config params should be done before initialize the webapp.

If is set in "auto" mode, web config params are only logged on "Development" and "Production" project stages.

Param Name: org.apache.myfaces.FACES_INITIALIZER
Ignore Upper/Lower case values: false
Since: 2.0.1
Group:
Tags:
Source Class: org.apache.myfaces.webapp.FacesInitializerFactory
Description:
Indicate the class implementing FacesInitializer interface that will be used to setup MyFaces Core contexts.

This is used when some custom task must be done specifically when a myfaces web context is initialized or destroyed, or when MyFaces should be initialized in some custom environment.

Param Name: org.apache.myfaces.FACES_INIT_PLUGINS
Ignore Upper/Lower case values: false
Since: 2.0
Group:
Tags:
Source Class: org.apache.myfaces.webapp.StartupServletContextListener
Description:
comma delimited list of plugin classes which can be hooked into myfaces