Implementation of the JavaServer™ Faces (JSF) 2.1 specification.
- Java 1.5
- Servlet 2.5
- EL 2.1
- CDI 1.0 (optional)
- JSTL 1.2 (optional)
- BV 1.0 (optional)
Steps for checksum & signature verification can be found here
<dependency>
<groupId>org.apache.myfaces.core</groupId>
<artifactId>myfaces-api</artifactId>
<version>2.1.18</version>
</dependency>
<dependency>
<groupId>org.apache.myfaces.core</groupId>
<artifactId>myfaces-impl</artifactId>
<version>2.1.18</version>
</dependency>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 |
|---|---|---|---|---|
| javax.faces.PROJECT_STAGE | 2.0 | Production | Development, Production, SystemTest, UnitTest | Indicate the stage of the initialized application |
| javax.faces.HONOR_CURRENT_COMPONENT_ATTRIBUTES | 2.1.0 | false | true, 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 | ||
| 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 | ||
| o.a.m.CONFIG_REFRESH_PERIOD | 1.1 | 2 | Set the time in seconds that check for updates of web | |
| o.a.m.GAE_JSF_JAR_FILES | 2.1.8, 2.0.14 | none, myfavoritejsflib-*.jar | 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) | |
| o.a.m.GAE_JSF_ANNOTATIONS_JAR_FILES | 2.1.8, 2.0.14 | none, myfavoritejsflib-*.jar | When the application runs inside Google Application Engine container (GAE), indicate which jar files should be scanned for annotations | |
| 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.VALIDATE | 2.0 | false | true, false | Validate if the managed beans and navigations rules are correct |
| 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.config.annotation.LifecycleProvider | 1.1 | no description | ||
| o.a.m.INITIALIZE_SKIP_JAR_FACES_CONFIG_SCAN | 2.2.10, 2.1.19 | 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 property can also be set as a system property. |
| 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.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.SERVICE_PROVIDER_FINDER | 2.0.3 | Class name of a custom ServiceProviderFinder implementation. | ||
| o.a.m.MARK_INITIAL_STATE_WHEN_APPLY_BUILD_VIEW | 2.1 | false | true, false | no description |
| 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.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.LOG_WEB_CONTEXT_PARAMS | auto | true, auto, false | Indicate if log all web config params should be done before initialize the webapp | |
| o.a.m.FACES_INITIALIZER | 2.0.1 | Class name of a custom FacesInitializer implementation. | ||
| o.a.m.FACES_INIT_PLUGINS | 2.0 | comma delimited list of plugin classes which can be hooked into myfaces |
| Name | Since | Default value | Expected values | Description |
|---|---|---|---|---|
| javax.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) |
| javax.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.INTERPRET_EMPTY_STRING_SUBMITTED_VALUES_AS_NULL_CLEAR_INPUT | 2.1.19 | false | true, false | When INTERPRET_EMPTY_STRING_SUBMITTED_VALUES_AS_NULL is enabled, clear required input fields when empty strings are submitted on them Note this param is only applicable when INTERPRET_EMPTY_STRING_SUBMITTED_VALUES_AS_NULL is enabled |
| 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 |
| javax.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 |
| javax.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 |
| Name | Since | Default value | Expected values | Description |
|---|---|---|---|---|
| o.a.m.CDI_MANAGED_CONVERTERS_ENABLED | 2.2.0 | false | true, false | Enable or disable CDI support for converters. |
| o.a.m.CDI_MANAGED_VALIDATORS_ENABLED | 2.2.0 | false | true, false | Enable or disable CDI support for validators. |
| Name | Since | Default value | Expected values | Description |
|---|---|---|---|---|
| o.a.m.SUPPORT_JSP_AND_FACES_EL | 2.0.13,2.1.7 | true | true,false | 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. |
| 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 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'" | ||
| 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.EXPRESSION_FACTORY | 1.2.7 | This parameter specifies the ExpressionFactory implementation to use |
| Name | Since | Default value | Expected values | Description |
|---|---|---|---|---|
| o.a.m.PRETTY_HTML | 1.1 | true | true, false, on, off, yes, no | If true, rendered HTML code will be formatted, so that it is "human readable" |
| o.a.m.ALLOW_JAVASCRIPT | 1.1 | true | true, false, on, off, yes, no | This parameter tells MyFaces if javascript code should be allowed in the rendered HTML output |
| 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.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 |
| Name | Since | Default value | Expected values | 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 ';' | ||
| o.a.m.CHECKED_VIEWID_CACHE_SIZE | 2.0.2 | 500 | Controls the size of the cache used to 'remember' if a view exists or not. | |
| o.a.m.CHECKED_VIEWID_CACHE_ENABLED | 2.0.2 | true | true, false | Enable or disable a cache used to 'remember' if a view exists or not and reduce the impact of successive calls to ExternalContext.getResource(). |
| o.a.m.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 | |
| 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.CHECKED_VIEWID_CACHE_SIZE | 2.0.2 | 500 | Controls the size of the cache used to 'remember' if a view exists or not. | |
| o.a.m.CHECKED_VIEWID_CACHE_ENABLED | 2.0.2 | true | true, false | Enable or disable a cache used to 'remember' if a view exists or not and reduce the impact of successive calls to ExternalContext.getResource(). |
| javax.faces.DISABLE_FACELET_JSF_VIEWHANDLER | 2.0 | false | true,false | Disable facelets VDL from the current application project |
| Name | Since | Default value | Expected values | 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 | |
| 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 | |
| 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.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 |
| Name | Since | Default value | Expected values | Description |
|---|---|---|---|---|
| javax.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. |
| 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) | true,false | Enable or disable partial state saving algorithm |
| 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 (javax.faces.ViewState) should render id="javax.faces.ViewState". |
| 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 | DES | 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 | HmacSHA1 | 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.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.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 | 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.SERIALIZE_STATE_IN_SESSION | 1.1 | true | true,false | Indicate if the state should be serialized before save it on the session |
| 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.CACHE_OLD_VIEWS_IN_SESSION_MODE | 1.2.5 | off | off, no, hard-soft, soft, soft-weak, weak | 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 |
| 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.RANDOM_KEY_IN_VIEW_STATE_SESSION_TOKEN | 2.1.9, 2.0.15 | none | secureRandom, random, none | 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_ALGORITM | 2.1.9, 2.0.15 | SHA1PRNG | Sets the random algorithm to initialize the secure random id generator | |
| o.a.m.HANDLE_STATE_CACHING_MECHANICS | 2.0.6 | true | true, false | Define if the state caching code should be handled by the ResponseStateManager or by the StateManager used |
| o.a.m.AUTOCOMPLETE_OFF_VIEW_STATE | 2.2.8, 2.1.18, 2.0.24 | true | true, false | Add autocomplete="off" to the view state hidden field |
| o.a.m.SAVE_STATE_WITH_VISIT_TREE_ON_PSS | 2.0.8, 2.1.2 | true | true, false | 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 |
| 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) |
| Name | Since | Default value | Expected values | Description |
|---|---|---|---|---|
| o.a.m.VIEWSTATE_JAVASCRIPT | 1.1 | false | true, false, on, off, yes, no | 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.SKIP_COMMENTS | 2.0 | Skip comments found on a facelet file | ||
| facelets.RESOURCE_RESOLVER | 2.0 | Class implementing ResourceResolver interface used to locate facelet resources | ||
| facelets.REFRESH_PERIOD | 2.0 | -1 | Define the period used to refresh the facelet abstract syntax tree from the view definition file | |
| o.a.m.ERROR_HANDLER | 1.2.4 | Deprecated: use JSF 2.0 ExceptionHandler |
⚠️ 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 |
|---|---|---|---|
| @PostConstruct and @PreDestroy injection over jsf managed beans | org.apache.myfaces.config.annotation.LifecycleProvider2 org.apache.myfaces.config.annotation.LifecycleProviderFactory | Provide methods to delegate injection of @PostConstruct and @PreDestroy annotations to the server for custom processing. | 1.2.7 |
| 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 javax.faces.FactoryFinder default algorithm | org.apache.myfaces.spi.FactoryFinderProvider org.apache.myfaces.spi.FactoryFinderProviderFactory |
Provide an interface to override javax.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, 2.1.0 |