Implementation of the Jakarta Faces 4.1 specification for Jakarta Enterprise Edition 11.
- Java 17
- Servlet 6.1+
- EL 6.0
- CDI 4.1
- JSTL 3.0 (optional)
- BV 3.1 (optional)
<dependency>
<groupId>org.apache.myfaces.core</groupId>
<artifactId>myfaces-api</artifactId>
<version>4.1.0-RC3</version>
</dependency>
<dependency>
<groupId>org.apache.myfaces.core</groupId>
<artifactId>myfaces-impl</artifactId>
<version>4.1.0-RC3</version>
</dependency>Steps for checksum & signature verification can be found here
MyFaces core behavior can be customized, adding some web config params into your WEB-INF/web.xml or META-INF/web-fragment.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>
⚠️ The table below useso.a.mas shortcut fororg.apache.myfaces
| Name | Since | Default value | Expected values | Description |
|---|---|---|---|---|
| jakarta.faces.PROJECT_STAGE | 2.0 | Production | Development, Production, SystemTest, UnitTest | no description |
| jakarta.faces.FACELETS_BUFFER_SIZE | 2.0 | 1024 | Define the default buffer size value passed to ExternalContext.setResponseBufferResponse() and in " + "a servlet environment to HttpServletResponse.setBufferSize() | |
| jakarta.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 | ||
| jakarta.faces.FACELETS_LIBRARIES | 2.0 | Set of .taglib.xml files, separated by ';' that should be loaded by facelet engine. | ||
| jakarta.faces.FACELETS_REFRESH_PERIOD | 2.0 | 0, -1 in Production | Define the period used to refresh the facelet abstract syntax tree from the view definition file | |
| jakarta.faces.FACELETS_SKIP_COMMENTS | 2.0 | Skip comments found on a facelet file | ||
| jakarta.faces.HONOR_CURRENT_COMPONENT_ATTRIBUTES | 2.1.0 | false | true, false | Indicate if the facesContext attribute values under the keys javax |
| jakarta.faces.VIEWROOT_PHASE_LISTENER_QUEUES_EXCEPTIONS | 2.3 | false | true, false | no description |
| jakarta.faces.CLIENT_WINDOW_MODE | 2.2.0 | none | none, url, url-redirect, client | Defines the ClientWindow mode to use |
| jakarta.faces.CONFIG_FILES | 1.1 | Comma separated list of URIs of (additional) faces config files | ||
| jakarta.faces.LIFECYCLE_ID | 1.1 | Identify the Lifecycle instance to be used | ||
| jakarta.faces.DISABLE_FACESSERVLET_TO_XHTML | 2.3 | Disable automatic FacesServlet xhtml mapping | ||
| jakarta.faces.FACELETS_RESOURCE_RESOLVER | 2.0 | Class implementing ResourceResolver interface used to locate facelet resources | ||
| jakarta.faces.WEBSOCKET_ENDPOINT_PORT | 2.3 | Indicates the port used for websocket connections | ||
| jakarta.faces.AUTOMATIC_EXTENSIONLESS_MAPPING | 4.0 | false | true, false | This parameter enables automatic extensionless mapping for all JSF views |
| o.a.m.VIEW_POOL_MAX_POOL_SIZE | 5 | Defines the number of views to be hold per each view metadata definition | ||
| o.a.m.VIEW_POOL_MAX_DYNAMIC_PARTIAL_LIMIT | 2 | Defines the limit of the views that cannot be reused partially | ||
| o.a.m.VIEW_POOL_ENTRY_MODE | soft | weak,soft | Defines the type of memory reference that is used to hold the view into memory | |
| o.a.m.VIEW_POOL_DEFERRED_NAVIGATION | false | true, false | Defines if the view pool uses deferred navigation to recycle views when navigation is performed | |
| o.a.m.USE_LAMBDA_METAFACTORY | 2.3-next | false | true,false | Defines if Lambda expressions (via LambdaMetafactory) are used for getter/setter instead of Reflection |
| o.a.m.CONFIG_REFRESH_PERIOD | 1.1 | 2 | Set the time in seconds that check for updates of web | |
| o.a.m.VALIDATE_XML | 2.0 | true, false, on, off, yes, no | If set to true, tag library XML files and faces config XML files using schema |
|
| o.a.m.FACES_INIT_PLUGINS | 2.0 | comma delimited list of plugin classes which can be hooked into myfaces | ||
| o.a.m.INITIALIZE_SKIP_JAR_FACES_CONFIG_SCAN | 2.2.10 | false | true, false | If the flag is true, the algoritm skip jar scanning for faces-config files to check if the current application requires FacesServlet to be added dynamically (servlet spec 3). This parameter can also be set as a system property. |
| o.a.m.INITIALIZE_ALWAYS_STANDALONE | 2.0.3 | false | If this param is set to true, the check for faces servlet mapping is not done | |
| o.a.m.WRAP_TAG_EXCEPTIONS_AS_CONTEXT_AWARE | 2.0.9, 2.1.3 | true | true, false | 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 |
| o.a.m.RESOURCE_CACHE_LAST_MODIFIED | 2.3-next | true | true, false | Defines if the last-modified should be cached of the resources when the ProjectStage is Production |
| o.a.m.LOG_WEB_CONTEXT_PARAMS | dev-only | true, dev-only, false | Indicate if info logging all web config params should be done before initializing the webapp. With 4.0.0, the default changed from auto to dev-only. where logging no longer occurs in the production project stage (new default behavior). True enables logging in the production and development project stages. False disables logging. | |
| o.a.m.FACES_INITIALIZER | 2.0.1 | Class name of a custom FacesInitializer implementation. | ||
| o.a.m.spi.InjectionProvider | 2.2 | Define the class implementing InjectionProvider interface to handle dependendy injection, PostConstruct and PreDestroy callbacks | ||
| o.a.m.WEBSOCKET_MAX_CONNECTIONS | 2.3 | no description | ||
| o.a.m.RENDER_CLIENTBEHAVIOR_SCRIPTS_AS_STRING | 2.3-next | false | Defines if the clientbehavior scripts are passed as string or function to the jsf | |
| o.a.m.ALWAYS_FORCE_SESSION_CREATION | 2.3-next | false | true,false | Defines if a session should be created (if one does not exist) before response rendering |
| o.a.m.RESOURCE_BUNDLE_CONTROL | 2.3-next | Defines the {@link java | ||
| o.a.m.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 | |
| o.a.m.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) | |
| o.a.m.ERROR_HANDLING | 1.2.4 | false, on Development Project stage: true | true,false | Indicate if myfaces is responsible to handle errors |
| o.a.m.SERVICE_PROVIDER_FINDER | 2.0.3 | Class name of a custom ServiceProviderFinder implementation. | ||
| o.a.m.DEBUG_PHASE_LISTENER | 2.0.8 | Enable/disable DebugPhaseListener feature, with provide useful information about ValueHolder variables (submittedValue, localValue, value) | ||
| o.a.m.VALIDATE | 2.0 | false | true, false | Validate if the managed beans and navigations rules are correct |
| o.a.m.annotation.USE_CDI_FOR_ANNOTATION_SCANNING | 2.2.9 | false | Defines if CDI should be used for annotation scanning to improve the startup performance | |
| o.a.m.STRICT_JSF_2_ORIGIN_HEADER_APP_PATH | 2.3 | false | true,false | This parameter specifies whether or not the Origin header app path should be checked |
| o.a.m.MARK_INITIAL_STATE_WHEN_APPLY_BUILD_VIEW | 2.1 | false | true, false | no description |
| o.a.m.annotation.SCAN_PACKAGES | 2.0 | Servlet context init parameter which defines which packages to scan for beans, separated by commas | ||
| o.a.m.WEBSOCKET_MAX_IDLE_TIMEOUT | 300000 | no description | ||
| o.a.m.TEMPORAL_RESOURCEHANDLER_CACHE_ENABLED | 2.1.11 | false | true, 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 |
| o.a.m.FLASH_SCOPE_DISABLED | 2.0.5 | false | Defines whether flash scope is disabled, preventing add the Flash cookie to the response | |
| o.a.m.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 | |
| o.a.m..EL_RESOLVER_TRACING | 4.0 | false | Defines if ELResolvers should be traced on each request and logged. Only active on Development ProjectStage. |
| Name | Since | Default value | Expected values | Description |
|---|---|---|---|---|
| jakarta.faces.VALIDATE_EMPTY_FIELDS | 2.0 | auto | auto, true, false | 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) |
| jakarta.faces.INTERPRET_EMPTY_STRING_SUBMITTED_VALUES_AS_NULL | 2.0 | false | true, false | Submitted values are decoded as null values instead empty strings |
| o.a.m.CLEAR_INPUT_WHEN_SUBMITTED_VALUE_IS_NULL_OR_EMPTY | 2.3.0 | true | true, false | When CLEAR_INPUT_WHEN_SUBMITTED_VALUE_IS_NULL_OR_EMPTY is enabled, input fields will be cleared when null or empty values are submitted |
| jakarta.faces.ALWAYS_PERFORM_VALIDATION_WHEN_REQUIRED_IS_TRUE | 2.3 | false | true, false | If set to true, validation is always performed when required is true |
| jakarta.faces.DATETIMECONVERTER_DEFAULT_TIMEZONE_IS_SYSTEM_TIMEZONE | 2.0 | false | true, false | Set the default timezone as system timezone when a converter extending from DateTimeConverter is created |
| o.a.m.ENUM_CONVERTER_ALLOW_STRING_PASSTROUGH | 2.0.1 | false | true,false | If value is a String instance and this param is true, pass it directly without try any change |
| jakarta.faces.validator.DISABLE_DEFAULT_BEAN_VALIDATOR | 2.0 | true | true, false | If this init parameter is present, no Bean Validators should be added to an UIInput by default |
| jakarta.faces.validator.ENABLE_VALIDATE_WHOLE_BEAN | 2.3 | false | true, false | Enable f:validateWholeBean use |
| o.a.m.validator.BEAN_BEFORE_JSF_VALIDATION | 2.2.10 | false | true, false | Enforce f:validateBean to be called first before any JSF validator |
| Name | Since | Default value | Expected values | Description |
|---|---|---|---|---|
| o.a.m.SUPPORT_EL_3_IMPORT_HANDLER | 2.2.9 | false | true,false | This parameter specifies whether or not the ImportHandler will be supported |
| o.a.m.EL_RESOLVER_COMPARATOR | 1.2.10, 2.0.2 | The Class of an Comparator<ELResolver> implementation. | ||
| o.a.m.EL_RESOLVER_PREDICATE | 2.1.0 | The Class of an java.util.function.Predicate<ELResolver> implementation." + "If used and returns false 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' | ||
| o.a.m.EXPRESSION_FACTORY | 1.2.7 | This parameter specifies the ExpressionFactory implementation to use | ||
| o.a.m.CACHE_EL_EXPRESSIONS | 2.0.8 | noCache | noCache, strict, allowCset, always, alwaysRecompile | Indicates if expressions generated by facelets should be cached or not |
| o.a.m.STRICT_JSF_2_CC_EL_RESOLVER | 2.0.10 | false | true, 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 |
| Name | Since | Default value | Expected values | Description |
|---|---|---|---|---|
| o.a.m.STRICT_XHTML_LINKS | 1.1.6 | true | true, false, on, off, yes, no | Use "&" entity instead a plain "&" character within HTML |
| o.a.m.RENDER_CLEAR_JAVASCRIPT_FOR_BUTTON | 1.2.3 | false | true, false, on, off, yes, no | This param renders the clear javascript on button necessary only for compatibility with hidden fields feature of myfaces |
| o.a.m.WRAP_SCRIPT_CONTENT_WITH_XML_COMMENT_TAG | 2.0.1 | false | true, false, on, off, yes, no | Wrap content inside script with xml comment to prevent old browsers to display it |
| o.a.m.EARLY_FLUSH_ENABLED | 2.2.0 | false | true, false | Enable or disable an early flush which allows to send e.g. the HTML-Head to the client " + "while the rest gets rendered. It's a well known technique to reduce the time for loading a page. |
| o.a.m.RENDER_FORM_VIEW_STATE_AT_BEGIN | 2.2.4 | false | true,false | This param makes h:form component to render the view state and other hidden fields at the beginning of the form |
| o.a.m.USE_MULTIPLE_JS_FILES_FOR_JSF_UNCOMPRESSED_JS | 2.0.1 | false | true,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 |
| o.a.m.JSF_JS_MODE | 2.0.10,2.1.4 | normal | normal, minimal-modern, minimal | Define the mode used for jsf |
| o.a.m.DEFAULT_RESPONSE_WRITER_CONTENT_TYPE_MODE | 2.0.11,2.1.5 | text/html | text/html, application/xhtml+xml | Define the default content type that the default ResponseWriter generates, when no match can be derived from HTTP Accept Header |
| Name | Since | Default value | Expected values | Description |
|---|---|---|---|---|
| jakarta.faces.DEFAULT_SUFFIX | 1.1 | .xhtml .view.xml | Indicate the default suffixes, separated by spaces to derive the default file URI used by JSF to create views and render pages | |
| jakarta.faces.FACELETS_SUFFIX | 2.0 | .xhtml | The default extension used to handle facelets pages | |
| jakarta.faces.FACELETS_VIEW_MAPPINGS | 2.0 | Set of extensions handled by facelets, separated by ';' | ||
| o.a.m.VIEWID_CACHE_SIZE | 2.0.2 | 500 | Controls the size of the viewId related caches: " + "VIEWID_EXISTS_CACHE_ENABLED, VIEWID_PROTECTED_CACHE_ENABLED, VIEWID_DERIVE_CACHE_ENABLED | |
| o.a.m.VIEWID_EXISTS_CACHE_ENABLED | 2.0.2 | true | true, false | Enable or disable the cache used to 'remember' if a view exists or not and reduce the impact " + "of sucesive calls to ExternalContext.getResource(). |
| o.a.m.VIEWID_PROTECTED_CACHE_ENABLED | 2.3-next | true | true, false | Enable or disable the cache used to 'remember' if a view is protected or not. |
| o.a.m.VIEWID_DERIVE_CACHE_ENABLED | 2.3-next | true | true, false | Enable or disable the cache used to 'remember' the derived viewId from the rawViewId. |
| o.a.m.VIEW_UNIQUE_IDS_CACHE_ENABLED | 2.0.13, 2.1.7 | true | true, false | Enable or disable a cache used to 'remember' the generated facelets unique ids " + "and reduce the impact over memory usage. |
| o.a.m.COMPONENT_UNIQUE_IDS_CACHE_SIZE | 2.0.13, 2.1.7 | 200 | Set the size of the cache used to store strings generated using SectionUniqueIdCounter for component ids | |
| o.a.m.STRICT_JSF_2_VIEW_NOT_FOUND | 2.1.13 | false | true,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 |
| o.a.m.STRICT_JSF_2_FACELETS_COMPATIBILITY | 2.2.0 | false | true,false | This param makes components like c:set, ui:param and templating components like ui:decorate, ui:composition and ui:include to behave like the ones provided originally in facelets 1_1_x |
| Name | Since | Default value | Expected values | Description |
|---|---|---|---|---|
| jakarta.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 | |
| o.a.m.STRICT_JSF_2_ALLOW_SLASH_LIBRARY_NAME | 2.1.6, 2.0.12 | false | true, false | Allow slash in the library name of a Resource |
| o.a.m.RESOURCE_BUFFER_SIZE | 2.1.10, 2.0.16 | 2048 | Define the default buffer size that is used between Resource | |
| o.a.m.RESOURCE_HANDLER_CACHE_SIZE | 2.0.2 | 500 | Controls the size of the cache used to check if a resource exists or not | |
| o.a.m.RESOURCE_HANDLER_CACHE_ENABLED | 2.0.2 | true | true,false | Enable or disable the cache used to "remember" if a resource handled by the default ResourceHandler exists or not |
| o.a.m.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 |
| Name | Since | Default value | Expected values | Description |
|---|---|---|---|---|
| jakarta.faces.STATE_SAVING_METHOD | 1.1 | server | server,client | Define the state method to be used. There are two different options " + "defined by the specification: 'client' and 'server' state. |
| jakarta.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) Note: This parameter is deprecated in 4.1 | ||
| jakarta.faces.PARTIAL_STATE_SAVING | 2.0 | true (false with 1.2 webapps) | true,false | Enable or disable partial state saving algorithm. Note: Full State Saving is deprecated in 4.1 |
| jakarta.faces.SERIALIZE_SERVER_STATE | 2.2 | false | true,false | Indicate if the state should be serialized before save it on the session |
| o.a.m.USE_ENCRYPTION | 1.1 | true | true,false | Indicate if the view state is encrypted or not |
| o.a.m.SECRET | 1.1 | Defines the secret (Base64 encoded) used to initialize the secret key for encryption algorithm | ||
| o.a.m.ALGORITHM | 1.1 | AES | Indicate the encryption algorithm used for encrypt the view state | |
| o.a.m.SECRET.CACHE | 1.1 | If is set to "false", the secret key used for encryption algorithm is not cached | ||
| o.a.m.ALGORITHM.IV | 1.1 | Defines the initialization vector (Base64 encoded) used for the encryption algorithm | ||
| o.a.m.ALGORITHM.PARAMETERS | 1.1 | ECB/PKCS5Padding | Defines the default mode and padding used for the encryption algorithm | |
| o.a.m.SERIAL_FACTORY | 1.1 | Defines the factory class name using for serialize/deserialize the view state returned by state manager into a byte array | ||
| o.a.m.COMPRESS_STATE_IN_CLIENT | 1.1 | false | true,false | Indicate if the view state should be compressed before encrypted(optional) and encoded |
| o.a.m.MAC_ALGORITHM | HmacSHA256 | Indicate the algorithm used to calculate the Message Authentication Code that is added to the view state | ||
| o.a.m.MAC_SECRET | Define the initialization code that are used to initialize the secret key used on the Message Authentication Code algorithm | |||
| o.a.m.MAC_SECRET.CACHE | If is set to "false", the secret key used for MAC algorithm is not cached | |||
| o.a.m.RENDER_VIEWSTATE_ID | 1.1 | true | true, false, on, off, yes, no | Define if the input field that should store the state (jakarta.faces.ViewState) should render id="jakarta.faces.ViewState". |
| o.a.m.REFRESH_TRANSIENT_BUILD_ON_PSS | 2.0 | auto | true,false,auto | Indicate if the facelet associated to the view should be reapplied when the view is refreshed |
| o.a.m.REFRESH_TRANSIENT_BUILD_ON_PSS_PRESERVE_STATE | 2.0 | false | true, false, on, off, yes, no | 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 |
| o.a.m.RANDOM_KEY_IN_CSRF_SESSION_TOKEN_LENGTH | 2.2.0 | 16 | Set the default length of the random key used for the csrf session token | |
| o.a.m.RANDOM_KEY_IN_CSRF_SESSION_TOKEN_SECURE_RANDOM_CLASS | 2.2.0 | Sets the random class to initialize the secure random id generator | ||
| o.a.m.RANDOM_KEY_IN_CSRF_SESSION_TOKEN_SECURE_RANDOM_PROVIDER | 2.2.0 | Sets the random provider to initialize the secure random id generator | ||
| o.a.m.RANDOM_KEY_IN_CSRF_SESSION_TOKEN_SECURE_RANDOM_ALGORITM | 2.2.0 | SHA1PRNG | Sets the random algorithm to initialize the secure random id generator | |
| o.a.m.RANDOM_KEY_IN_WEBSOCKET_SESSION_TOKEN | 2.2.0 | none | secureRandom, random | Defines how to generate the csrf session token |
| o.a.m.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 | |
| o.a.m.RANDOM_KEY_IN_VIEW_STATE_SESSION_TOKEN | 2.1.9, 2.0.15 | random | secureRandom, random | Adds a random key to the generated view state session token |
| o.a.m.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 | |
| o.a.m.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 | ||
| o.a.m.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 | ||
| o.a.m.RANDOM_KEY_IN_VIEW_STATE_SESSION_TOKEN_SECURE_RANDOM_ALGORITHM | 2.1.9, 2.0.15 | SHA1PRNG | Sets the random algorithm to initialize the secure random id generator | |
| o.a.m.RANDOM_KEY_IN_CSRF_SESSION_TOKEN | 2.2.0 | none | secureRandom, random | Defines how to generate the csrf session token |
| o.a.m.COMPRESS_STATE_IN_SESSION | 1.1 | true | true,false | Indicates that the serialized state will be compressed before it is written to the session |
| o.a.m.USE_FLASH_SCOPE_PURGE_VIEWS_IN_SESSION | 2.0.6 | false | true, 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 |
| o.a.m.AUTOCOMPLETE_OFF_VIEW_STATE | 2.2.8, 2.1.18, 2.0.24 | false | true, false | Add autocomplete="off" to the view state hidden field |
| o.a.m.NUMBER_OF_VIEWS_IN_SESSION | 1.1 | 20 | Defines the amount (default = 20) of the latest views are stored in session | |
| o.a.m.NUMBER_OF_SEQUENTIAL_VIEWS_IN_SESSION | 2.0.6 | 4 | Indicates the amount of views (default is not active) that should be stored in session between sequential POST or POST-REDIRECT-GET if org | |
| o.a.m.CHECK_ID_PRODUCTION_MODE | 2.0.12, 2.1.6 | auto | true, auto, false | 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) |
| o.a.m.NUMBER_OF_FLASH_TOKENS_IN_SESSION | 2.2.6 | Indicate the max number of flash tokens stored into session | ||
| jakarta.faces.NUMBER_OF_CLIENT_WINDOWS | 4.0.0 | 10 | Indicate the max number of ClientWindows, which is used by ClientWindowScoped. |
⚠️ usually common users of MyFaces Core does not need to deal with these specific stuff, because the application/web server could already provide the necessary hooks or integration modules "out of the box"
MyFaces core provides some "points of integration" that can be used by application and web servers to override or add some specific code. For example, JBoss AS provides a custom virtual file system (VFS), and MyFaces core needs to scan for faces-config.xml files, so it is necessary to provide some code that uses JBoss VFS to locate faces-config.xml files to be parsed later.
Some features uses Service Provider Interface (SPI) pattern, so take a look at java.util.ServiceLoader description in java 6 api to get the idea how it works.
Below there is a table of the "points of integration" used by application and web servers:
| Integration Point | Classes Involved | Description | Since |
|---|---|---|---|
| Override SPI handling | org.apache.myfaces.spi.ServiceProviderFinder org.apache.myfaces.spi.ServiceProviderFinderFactory |
Override SPI handling done by MyFaces Core, usually taking advantage of container specific features to scan files inside jars. | 2.0.3, 2.1.0 |
| Annotation Scanning | org.apache.myfaces.spi.AnnotationProvider org.apache.myfaces.spi.AnnotationProviderWrapper org.apache.myfaces.spi.AnnotationProviderFactory |
Override/wrap myfaces annotation scanning algorithm that needs to be processed at startup. | 2.0.3, 2.1.0 |
| Locate facelet .taglib.xml files through classpath. | org.apache.myfaces.spi.FaceletConfigResourceProvider org.apache.myfaces.spi.FaceletConfigResourceProviderFactory |
Locate facelet .taglib.xml files through classpath. These files has definitions that are used by facelets algorithm to parse view files. | 2.0.3, 2.1.0 |
| Locate faces-config.xml files through classpath. | org.apache.myfaces.spi.FacesConfigResourceProvider org.apache.myfaces.spi.FacesConfigResourceProviderFactory |
Locate faces-config xml files through classpath. These files has definitions that are used by initialize jsf environment. By default it locate all files inside META-INF folder, named faces-config.xml or ending with .faces-config.xml | 2.0.3, 2.1.0 |
| Get an unified configuration after sort and order all config files. | org.apache.myfaces.spi.FacesConfigurationMerger org.apache.myfaces.spi.FacesConfigurationMergerFactory org.apache.myfaces.config.element.* |
Get all org.apache.myfaces.config.element.FacesConfig data and then it combines it into one org.apache.myfaces.config.element.FacesConfigData instance. | 2.0.3, 2.1.0 |
| Get configuration information from different sources and allow cache them. | org.apache.myfaces.spi.FacesConfigurationProvider org.apache.myfaces.spi.FacesConfigurationProviderFactory org.apache.myfaces.config.element.* |
This interface provide a way to merge and store all JSF config information retrieved from faces-config.xml files, META-INF/service files and annotations that works as base point to initialize MyFaces. The objective is allow server containers to "store" or this information, preventing calculate it over and over each time the web application is started. | 2.0.3, 2.1.0 |
| Override jakarta.faces.FactoryFinder default algorithm | org.apache.myfaces.spi.FactoryFinderProvider org.apache.myfaces.spi.FactoryFinderProviderFactory |
Provide an interface to override jakarta.faces.FactoryFinder class methods. This is useful if containers does not want to use Thread Context Class Loader to load classes, like in OSGi. | 2.0.5, 2.1.0 |
| Provide additional info from web.xml files | org.apache.myfaces.spi.WebConfigProvider org.apache.myfaces.spi.WebConfigProviderFactory org.apache.myfaces.spi.ServletMapping |
Provide additional info from web.xml files, like mapping or if an error page is present. | 2.0.3, 2.1.0 |
| Override initialization and destroy web applications | org.apache.myfaces.webapp.FacesInitializer org.apache.myfaces.webapp.FacesInitializerFactory |
Allow customize initialization / destroy operations or provide an alternate MyFaces initializer to a specific container. | 2.0.1, |
| Scan for annotated Flows and manage Flow scope | org.apache.myfaces.spi.FacesFlowProvider org.apache.myfaces.spi.FacesFlowProviderFactory |
In this interface @FlowDefinition annotation is scanned for flows defined programatically and it is also managed the flow scope logic. By default MyFaces provides two implementations, one using CDI and one without CDI (that only manages flow scope) | 2.2.0 |
| Scan for available contracts | org.apache.myfaces.spi.ResourceLibraryContractsProvider org.apache.myfaces.spi.ResourceLibraryContractsProviderFactory |
Provides an interface to scan for the available resource library contracts in the current environment. By default it scans using external context getResource(...) methods and in the classpath according to JSF spec. | 2.2.0 |