Class MojarraProperties
java.lang.Object
org.joinfaces.autoconfigure.mojarra.MojarraProperties
- All Implemented Interfaces:
ServletContextInitParameterProperties
@ConfigurationProperties(prefix="joinfaces.mojarra")
public class MojarraProperties
extends Object
implements ServletContextInitParameterProperties
Configuration properties of Mojarra.
Taken from
https://balusc.omnifaces.org/2015/09/what-mojarra-context-parameters-are.html
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
boolean
A white space separated list of case sensitive HTTP method names that are allowed to be processed by this servlet.If true, allow children of h:inputText and h:outputText to be rendered.The value of this context init parameter is a whitespace separated list of values that control which class packages are scanned for jakarta.faces annotations.If false, don't use autocomplete="off" on view state hidden input field.If true, cache the modification time of the resource and use the cached time to tell if the resource needs to be refreshed.Maximum time, in seconds, that client state will be considered valid by the default StateManager/ResponseStateManager implementations.The size, in bytes, of the buffer that is used to write client state.Specify mime types that should be gzip compressed.If true, then the JavaScript rendered by h:commandLink will be compressed to reduce the amount of whitespace transmitted in the response.When true, the view is compressed after it is serialized and before base64 encoded.This affects the value of the Expires response header that will be sent for a resource.Since Mojarra 2.2, the client state is by default always encrypted.If true, then component ID uniqueness won't be checked if ProjectStage is Production to enhance performance.By default any characters above a certain range will be escaped as either an HTML entity or a decimal reference.Javadoc not found.When this context param is set to true, this would set a feature on the SAX parser to disallow DOCTYPE declarations.If true then all web configuration information (context initialization parameters and environment entries) will be written to the log.Javadoc not found.If true, makes it so every session attribute is touched in for every request through the lifecycle.When true, the client state will as test be unserialized before writing and any serialization exceptions will be logged aInteger with a debug path to the cause of the serialization error.When true, enable validation of standard Core TagLibs, at the expense of a slightly slower start time.If true, signal JSF that the application is deployed to a clustered environment, so that session dirtying will be explicitly performed, hereby forcing session replication.If true, inlined JavaScript rendered by the HTML ResponseWriter implementation will be rendered so that the script is hidden from older browser implementations which does not recognize<script/>
elements.Javadoc not found.See issue 3684 for details.Javadoc not found.When true, enable validation of standard Html TagLibs, at the expense of a slightly slower start time.add the HttpMethodRestrictionPhaseListener if the parameter is enabled.Javadoc not found.When true, managed beans will be validated when first created.If enabled, the runtime will check for the existence of a resource library before checking for the resource itself.Javadoc not found.If false, attribute values with javascript: or script: will not be rendered within attribute values to prevent potential XSS attacks.When enabled, the runtime initialization and default ResourceHandler implementation will use threads to perform their functions.If true, the act of calling getExternalContext().getFlash() on the FacesContext at startup or shutdown time will cause a no-op implementation of the Flash to be returned.If true, the view state hidden field will be rendered with both the id and name attributes having the value of "jakarta.faces.ViewState".Class<? extends ExpressionFactory>
This parameter specifies a class that implements the ExpressionFactory.Javadoc not found.Class<?>
The value of this option is a fully qualfified class that extends the com.sun.faces.facelets.FaceletFactory abstract class.Javadoc not found.If true, then the flash cookie will always be written, regardless of whether or not the flash has data.There is a chance for an NPE in com.sun.faces.application.WebappLifecycleListener with some configurations.If true, generate random server view state ids.Class<? extends InjectionProvider>
This parameter specifies a class that implements the InjectionProvider.Javadoc not found.If true, then view state hidden field is namespaced according to NamingContainer rules.Number of concurrent flash users.Number flashes between flash repaings.Defines the maximum number of serialized views stored in the session.Definies the maximum number of serialized logical views per view.For the case where a browser supports XHTML and HTML without a quality.If true, allow EL Coercion to use JSF Custom converters.When jakarta.faces.PROJECT_STATE is Production, UnitTest, or SystemTest resource paths will be cached to reduce the overhead of resource path compuation.This parameter specifies the size, in bytes, of the buffer that is used to write all generated JSP content excluding state.The servlet specification defines an optional header that can be sent by a container to communicate the version of the JSP/Servlet the response was generated by.Class<? extends SerializationProvider>
This parameter specifies a class that implements the SerializationProvider SPI.If enabled the component state (not the tree) will be serialized before being stored in the session.When true, enable validation of faces-config.xml files, at the expense of a slightly slower start time.When true, JSF makes during startup sure all that registered managed beans components, validators, etc can be instantiated by the runtime, at the expense of a slightly slower start time.Per the renderkit doc specification, the state information for the view will be written out prior to closing the form tag.int
hashCode()
void
setAllowedHttpMethods
(String allowedHttpMethods) A white space separated list of case sensitive HTTP method names that are allowed to be processed by this servlet.void
setAllowTextChildren
(Boolean allowTextChildren) If true, allow children of h:inputText and h:outputText to be rendered.void
setAnnotationScanPackages
(String annotationScanPackages) The value of this context init parameter is a whitespace separated list of values that control which class packages are scanned for jakarta.faces annotations.void
setAutoCompleteOffOnViewState
(Boolean autoCompleteOffOnViewState) If false, don't use autocomplete="off" on view state hidden input field.void
setCacheResourceModificationTimestamp
(Boolean cacheResourceModificationTimestamp) If true, cache the modification time of the resource and use the cached time to tell if the resource needs to be refreshed.void
setClientStateTimeout
(Duration clientStateTimeout) Maximum time, in seconds, that client state will be considered valid by the default StateManager/ResponseStateManager implementations.void
setClientStateWriteBufferSize
(DataSize clientStateWriteBufferSize) The size, in bytes, of the buffer that is used to write client state.void
setCompressableMimeTypes
(String compressableMimeTypes) Specify mime types that should be gzip compressed.void
setCompressJavaScript
(Boolean compressJavaScript) If true, then the JavaScript rendered by h:commandLink will be compressed to reduce the amount of whitespace transmitted in the response.void
setCompressViewState
(Boolean compressViewState) When true, the view is compressed after it is serialized and before base64 encoded.void
setDefaultResourceMaxAge
(Duration defaultResourceMaxAge) This affects the value of the Expires response header that will be sent for a resource.void
setDisableClientStateEncryption
(Boolean disableClientStateEncryption) Since Mojarra 2.2, the client state is by default always encrypted.void
setDisableIdUniquenessCheck
(Boolean disableIdUniquenessCheck) If true, then component ID uniqueness won't be checked if ProjectStage is Production to enhance performance.void
setDisableUnicodeEscaping
(String disableUnicodeEscaping) By default any characters above a certain range will be escaped as either an HTML entity or a decimal reference.void
setDisableVersionTracking
(Boolean disableVersionTracking) Javadoc not found.void
setDisallowDoctypeDecl
(Boolean disallowDoctypeDecl) When this context param is set to true, this would set a feature on the SAX parser to disallow DOCTYPE declarations.void
setDisplayConfiguration
(Boolean displayConfiguration) If true then all web configuration information (context initialization parameters and environment entries) will be written to the log.void
setDuplicateJARPattern
(String duplicateJARPattern) Javadoc not found.void
setEnableAgressiveSessionDirtying
(Boolean enableAgressiveSessionDirtying) If true, makes it so every session attribute is touched in for every request through the lifecycle.void
setEnableClientStateDebugging
(Boolean enableClientStateDebugging) When true, the client state will as test be unserialized before writing and any serialization exceptions will be logged aInteger with a debug path to the cause of the serialization error.void
setEnableCoreTagLibValidator
(Boolean enableCoreTagLibValidator) When true, enable validation of standard Core TagLibs, at the expense of a slightly slower start time.void
setEnableDistributable
(Boolean enableDistributable) If true, signal JSF that the application is deployed to a clustered environment, so that session dirtying will be explicitly performed, hereby forcing session replication.void
setEnabledJsStyleHiding
(Boolean enabledJsStyleHiding) If true, inlined JavaScript rendered by the HTML ResponseWriter implementation will be rendered so that the script is hidden from older browser implementations which does not recognize<script/>
elements.void
setEnabledLoadBundle11Compatibility
(Boolean enabledLoadBundle11Compatibility) Javadoc not found.void
setEnableFaceletsResourceResolverCompositeComponents
(Boolean enableFaceletsResourceResolverCompositeComponents) See issue 3684 for details.void
setEnableGroovyScripting
(Boolean enableGroovyScripting) Javadoc not found.void
setEnableHtmlTagLibValidator
(Boolean enableHtmlTagLibValidator) When true, enable validation of standard Html TagLibs, at the expense of a slightly slower start time.void
setEnableHttpMethodRestrictionPhaseListener
(Boolean enableHttpMethodRestrictionPhaseListener) add the HttpMethodRestrictionPhaseListener if the parameter is enabled.void
setEnableJSStyleHiding
(Boolean enableJSStyleHiding) Javadoc not found.void
setEnableLazyBeanValidation
(Boolean enableLazyBeanValidation) When true, managed beans will be validated when first created.void
setEnableMissingResourceLibraryDetection
(Boolean enableMissingResourceLibraryDetection) If enabled, the runtime will check for the existence of a resource library before checking for the resource itself.void
setEnableRestoreView11Compatibility
(Boolean enableRestoreView11Compatibility) Javadoc not found.void
setEnableScriptsInAttributeValues
(Boolean enableScriptsInAttributeValues) If false, attribute values with javascript: or script: will not be rendered within attribute values to prevent potential XSS attacks.void
setEnableThreading
(Boolean enableThreading) When enabled, the runtime initialization and default ResourceHandler implementation will use threads to perform their functions.void
setEnableTransitionTimeNoOpFlash
(Boolean enableTransitionTimeNoOpFlash) If true, the act of calling getExternalContext().getFlash() on the FacesContext at startup or shutdown time will cause a no-op implementation of the Flash to be returned.void
setEnableViewStateIdRendering
(Boolean enableViewStateIdRendering) If true, the view state hidden field will be rendered with both the id and name attributes having the value of "jakarta.faces.ViewState".void
setExpressionFactory
(Class<? extends ExpressionFactory> expressionFactory) This parameter specifies a class that implements the ExpressionFactory.void
setFaceletCache
(String faceletCache) Javadoc not found.void
setFaceletFactory
(Class<?> faceletFactory) The value of this option is a fully qualfified class that extends the com.sun.faces.facelets.FaceletFactory abstract class.void
setFaceletsProcessingFileExtensionProcessAs
(String faceletsProcessingFileExtensionProcessAs) Javadoc not found.void
setForceAlwaysWriteFlashCookie
(Boolean forceAlwaysWriteFlashCookie) If true, then the flash cookie will always be written, regardless of whether or not the flash has data.void
setForceLoadConfiguration
(Boolean forceLoadConfiguration) There is a chance for an NPE in com.sun.faces.application.WebappLifecycleListener with some configurations.void
setGenerateUniqueServerStateIds
(Boolean generateUniqueServerStateIds) If true, generate random server view state ids.void
setInjectionProvider
(Class<? extends InjectionProvider> injectionProvider) This parameter specifies a class that implements the InjectionProvider.void
setManagedBeanFactoryDecorator
(String managedBeanFactoryDecorator) Javadoc not found.void
setNamespaceParameters
(Boolean namespaceParameters) If true, then view state hidden field is namespaced according to NamingContainer rules.void
setNumberOfConcurrentFlashUsers
(Integer numberOfConcurrentFlashUsers) Number of concurrent flash users.void
setNumberOfFlashesBetweenFlashReapings
(Integer numberOfFlashesBetweenFlashReapings) Number flashes between flash repaings.void
setNumberOfLogicalViews
(Integer numberOfLogicalViews) Defines the maximum number of serialized views stored in the session.void
setNumberOfViewsInSession
(Integer numberOfViewsInSession) Definies the maximum number of serialized logical views per view.void
setPreferXhtml
(Boolean preferXhtml) For the case where a browser supports XHTML and HTML without a quality.void
setRegisterConverterPropertyEditors
(Boolean registerConverterPropertyEditors) If true, allow EL Coercion to use JSF Custom converters.void
setResourceUpdateCheckPeriod
(Duration resourceUpdateCheckPeriod) When jakarta.faces.PROJECT_STATE is Production, UnitTest, or SystemTest resource paths will be cached to reduce the overhead of resource path compuation.void
setResponseBufferSize
(DataSize responseBufferSize) This parameter specifies the size, in bytes, of the buffer that is used to write all generated JSP content excluding state.void
setSendPoweredByHeader
(Boolean sendPoweredByHeader) The servlet specification defines an optional header that can be sent by a container to communicate the version of the JSP/Servlet the response was generated by.void
setSerializationProvider
(Class<? extends SerializationProvider> serializationProvider) This parameter specifies a class that implements the SerializationProvider SPI.void
setSerializeServerState
(Boolean serializeServerState) If enabled the component state (not the tree) will be serialized before being stored in the session.void
setValidateXml
(Boolean validateXml) When true, enable validation of faces-config.xml files, at the expense of a slightly slower start time.void
setVerifyObjects
(Boolean verifyObjects) When true, JSF makes during startup sure all that registered managed beans components, validators, etc can be instantiated by the runtime, at the expense of a slightly slower start time.void
setWriteStateAtFormEnd
(Boolean writeStateAtFormEnd) Per the renderkit doc specification, the state information for the view will be written out prior to closing the form tag.toString()
-
Constructor Details
-
MojarraProperties
public MojarraProperties()
-
-
Method Details
-
getClientStateTimeout
Maximum time, in seconds, that client state will be considered valid by the default StateManager/ResponseStateManager implementations. If the time between requests exceeds the configured time, a jakarta.faces.application.ViewExpiredException. will be thrown. It is important to note that if this feature is enabled, and client requests are recieved with view state produced from a previous version, the ViewExpiredException will be thrown immediately. -
getClientStateWriteBufferSize
The size, in bytes, of the buffer that is used to write client state. It should be noted, that the buffer used is split - half is for raw bytes, the other half is for the Base64 encoded characters of said bytes. So, for example, if the default, 8192, is used, then 4096 of that is used for the bytes, and the other 4096 is used for the Base64 encoded characters. -
getCompressViewState
When true, the view is compressed after it is serialized and before base64 encoded. Works with client state saving only. As of 1.2_09, this option also impacts server side state saving when com.sun.faces.serializeServerState is set to true (this has a large impact of the size of the state in the session when using this option, at the expense of more CPU of course). -
getDisableClientStateEncryption
Since Mojarra 2.2, the client state is by default always encrypted. When true, the client state encryption is disabled. See also com.sun.faces.ClientStateSavingPassword - recommendations for actual password? -
getEnableClientStateDebugging
When true, the client state will as test be unserialized before writing and any serialization exceptions will be logged aInteger with a debug path to the cause of the serialization error. -
getGenerateUniqueServerStateIds
If true, generate random server view state ids. If false, create server view state ids sequentially. This resembles closely the JSF 1.x behavior, but this is more sensitive to CSRF. -
getNumberOfLogicalViews
Defines the maximum number of serialized views stored in the session. Works with server state saving only (note the implementation unintentionally has swapped the meaning, as we cannot change this without breaking what people have become used to we have updated this here). See com.sun.faces.numberOfViewsInSession vs com.sun.faces.numberOfLogicalViews for detail. -
getNumberOfViewsInSession
Definies the maximum number of serialized logical views per view. Works with server state saving only (note the implementation unintentionally has swapped the meaning, as we cannot change this without breaking what people have become used to we have updated this here) See com.sun.faces.numberOfViewsInSession vs com.sun.faces.numberOfLogicalViews for detail. -
getSerializeServerState
If enabled the component state (not the tree) will be serialized before being stored in the session. This may be desirable for applications that may have issues with view state being sensitive to model changes after state saving which are reflected back in view state. This has since JSF 2.2 been replaced by jakarta.faces.SERIALIZE_SERVER_STATE. -
getWriteStateAtFormEnd
Per the renderkit doc specification, the state information for the view will be written out prior to closing the form tag. However, it may be desirable to have the state information written out after the opening form tag. If this is the case, specifiy this parameter in the web.xml with a value of false. -
getAllowTextChildren
If true, allow children of h:inputText and h:outputText to be rendered. In 1.2, they would always be rendered before the value of tag. As of 2.0, children of UIInput and UIOutput components will not be rendered by the default renderer implementations. Set this option to true if this behavior is required, but note that doing so may cause issues when using Ajax. See issue 1154 for details. -
getAutoCompleteOffOnViewState
If false, don't use autocomplete="off" on view state hidden input field. This attribute is by default always rendered in order to fix a Firefox related bug, but it is invalid on a hidden input field as per w3 HTML validator. So, when false, then beware of the Firefox bug which may trigger "unexpected" ViewExpiredException. See issue 1129 for details. -
getCompressJavaScript
If true, then the JavaScript rendered by h:commandLink will be compressed to reduce the amount of whitespace transmitted in the response. If false then the JavaScript will be rendered to the client in a well formatted manner. -
getDisableUnicodeEscaping
By default any characters above a certain range will be escaped as either an HTML entity or a decimal reference. This behavior is not always desirable. To allow more flexibility how content is rendered to a client, this option was introduced. Valid configuration values are: false, true, and auto with false being the default. When the option value is false, Mojarra will continue to escaped no matter the response encoding type. If the configuration value is true, Then no escaping will occur assuming that the response encoding can properly handle all characters. If the configuration option is auto then the response encoding will be checked. If the encoding is of the UTF family of encodings no unicode or html entity encoding will occur, however, if the response stream encoding is ISO-8859-1 then the ISO characters above a certain range will be encoded as HTML entities and any characters above that range will be written as decimal references. -
getDisableIdUniquenessCheck
If true, then component ID uniqueness won't be checked if ProjectStage is Production to enhance performance. See issue 2414 for details. -
getEnabledJsStyleHiding
If true, inlined JavaScript rendered by the HTML ResponseWriter implementation will be rendered so that the script is hidden from older browser implementations which does not recognize<script/>
elements. -
getEnableScriptsInAttributeValues
If false, attribute values with javascript: or script: will not be rendered within attribute values to prevent potential XSS attacks. -
getEnableViewStateIdRendering
If true, the view state hidden field will be rendered with both the id and name attributes having the value of "jakarta.faces.ViewState". This is what the spec requires, however, if there are multiple forms within a view and the response content-type is XHTML, the result will be XHTML that will fail validation due to multiple ID attributes with the same value: jakarta.faces.ViewState. Setting this parameter to false will result in the ID attribute not being rendered. Keep in mind however, that doing this may break integration with AJAX frameworks that get the state field via ID. See issue 433 for details. -
getPreferXhtml
For the case where a browser supports XHTML and HTML without a quality. When enabled and this case occurs, then XHTML will be set as the content type. This setting is not recommended and should be only used to fix broken applications designed with XHTML output in mind instead of HTML(5) output. -
getResponseBufferSize
This parameter specifies the size, in bytes, of the buffer that is used to write all generated JSP content excluding state. Note that this is ignored when Facelets is used. For Facelets, use jakarta.faces.FACELETS_BUFFER_SIZE instead. -
getCacheResourceModificationTimestamp
If true, cache the modification time of the resource and use the cached time to tell if the resource needs to be refreshed. -
getCompressableMimeTypes
Specify mime types that should be gzip compressed. Mime types can be specified by their exact name (i.e. text/css) or a wildcard can be used after the slash (i.e. text/*). The resource will not be compressed on each request, instead when building the cache, the resource will be compressed to a temporary directory and those bytes will be served instead. -
getDefaultResourceMaxAge
This affects the value of the Expires response header that will be sent for a resource. The logic is basically Date.getTime() + valueOf(defaultResourceManxAge). Increase this value to increase the amount of time that a Resource is valid. The value is in milliseconds (so the default value of 604800000 is 7 days). -
getEnableFaceletsResourceResolverCompositeComponents
See issue 3684 for details. -
getEnableMissingResourceLibraryDetection
If enabled, the runtime will check for the existence of a resource library before checking for the resource itself. If not found, an appropriate error message will be included in the log and in the view if ProjectStage is Development. -
getResourceUpdateCheckPeriod
When jakarta.faces.PROJECT_STATE is Production, UnitTest, or SystemTest resource paths will be cached to reduce the overhead of resource path compuation. By default, updates (i.e. new files, new directories, new versions, etc.) will be checked for every 5 minutes. If a change is detected, the cache will be cleared and rebuilt. If the value of this option is -1, the cache will never be cleared and new resources will not be picked up. The value is in minutes. -
getEnableAgressiveSessionDirtying
If true, makes it so every session attribute is touched in for every request through the lifecycle. This makes it much harder to make mistakes that cause session replication to fail. -
getEnableDistributable
If true, signal JSF that the application is deployed to a clustered environment, so that session dirtying will be explicitly performed, hereby forcing session replication. This is automatically true when <distributable /> entry is present in web.xml. -
getAnnotationScanPackages
The value of this context init parameter is a whitespace separated list of values that control which class packages are scanned for jakarta.faces annotations. To restrict which jars/packages are scanned, use the following entry format: jar:'jar name':'comma separated list of packages' So an example would be: jar:a.jar:com.acme.package1,com.acme.package2. -
getDisplayConfiguration
If true then all web configuration information (context initialization parameters and environment entries) will be written to the log. This is useful during development to confirm your application is configured as expected. -
getEnableCoreTagLibValidator
When true, enable validation of standard Core TagLibs, at the expense of a slightly slower start time. -
getEnableHtmlTagLibValidator
When true, enable validation of standard Html TagLibs, at the expense of a slightly slower start time. -
getEnableLazyBeanValidation
When true, managed beans will be validated when first created. If false, managed beans will be validated when the application is started, at the expense of a slightly slower start time. -
getEnableThreading
When enabled, the runtime initialization and default ResourceHandler implementation will use threads to perform their functions. Set this value to false if threads aren't desired (as in the case of running within the Google Application Engine). Note that when this option is disabled, the ResourceHandler will not pick up new versions of resources when ProjectStage is development. See issue 2385 for details. -
getForceLoadConfiguration
There is a chance for an NPE in com.sun.faces.application.WebappLifecycleListener with some configurations. Take for example, installing JSF in a container such that JSF will be available to all web applications. The NPE will occur for an application that doesn't have the FacesServlet defined within its web.xml. The workaround for this issue is, within the global web.xml for the container (JBoss and Tomcat both have one) add either a FacesServlet definition (no mapping) or add the context init parameter, com.sun.faces.forceLoadConfiguration, with a value of true. See issue 670 for details. -
getValidateXml
When true, enable validation of faces-config.xml files, at the expense of a slightly slower start time. -
getVerifyObjects
When true, JSF makes during startup sure all that registered managed beans components, validators, etc can be instantiated by the runtime, at the expense of a slightly slower start time. -
getEnableTransitionTimeNoOpFlash
If true, the act of calling getExternalContext().getFlash() on the FacesContext at startup or shutdown time will cause a no-op implementation of the Flash to be returned. This should prevent startup/shutdown exceptions caused by invalid/stale flash cookies. See "bugdb 17024459" for details. -
getExpressionFactory
This parameter specifies a class that implements the ExpressionFactory. -
getForceAlwaysWriteFlashCookie
If true, then the flash cookie will always be written, regardless of whether or not the flash has data. This should prevent problems on multiple successive redirects. See issue 3735 for details. -
getInjectionProvider
This parameter specifies a class that implements the InjectionProvider. -
getNamespaceParameters
If true, then view state hidden field is namespaced according to NamingContainer rules. See issue 3031 for details. -
getRegisterConverterPropertyEditors
If true, allow EL Coercion to use JSF Custom converters. -
getSendPoweredByHeader
The servlet specification defines an optional header that can be sent by a container to communicate the version of the JSP/Servlet the response was generated by. If this is enabled, then X-Powered-By=JSF/2.2 header is included in all responses. -
getSerializationProvider
This parameter specifies a class that implements the SerializationProvider SPI. This implementation represents a hook the JSF implementation will use in order to allow the use of alternate Serialization implementations. -
getFaceletFactory
The value of this option is a fully qualfified class that extends the com.sun.faces.facelets.FaceletFactory abstract class. This option allows developers to customize the behavior or completely replace the default com.sun.faces.facelets.FaceletFactory implementation. Some rules about what is expected of custom implementations.If the custom implementation has a public single argument constructor where the argument type is com.sun.faces.facelets.FaceletFactory, the default FaceletFactory implementation will be passed to the constructor. If the single argument constructor is not present, the custom implementation will be constructed by invoking a public no-argument constructor. -
getDisallowDoctypeDecl
When this context param is set to true, this would set a feature on the SAX parser to disallow DOCTYPE declarations. When set to false, this would set a feature on the SAX parser to allow DOCTYPE declarations. When this context param is not specified, whether or not DOCTYPE declarations are allowed would just depend on the SAXParserFactory implementation in use, as is the case today. -
getManagedBeanFactoryDecorator
Javadoc not found. -
getNumberOfConcurrentFlashUsers
Number of concurrent flash users. -
getNumberOfFlashesBetweenFlashReapings
Number flashes between flash repaings. -
getDuplicateJARPattern
Javadoc not found. -
getFaceletCache
Javadoc not found. -
getFaceletsProcessingFileExtensionProcessAs
Javadoc not found. -
getDisableVersionTracking
Javadoc not found. -
getEnableJSStyleHiding
Javadoc not found. -
getEnabledLoadBundle11Compatibility
Javadoc not found. -
getEnableRestoreView11Compatibility
Javadoc not found. -
getEnableGroovyScripting
Javadoc not found. -
getEnableHttpMethodRestrictionPhaseListener
add the HttpMethodRestrictionPhaseListener if the parameter is enabled. -
getAllowedHttpMethods
A white space separated list of case sensitive HTTP method names that are allowed to be processed by this servlet. * means allow all. -
setClientStateTimeout
Maximum time, in seconds, that client state will be considered valid by the default StateManager/ResponseStateManager implementations. If the time between requests exceeds the configured time, a jakarta.faces.application.ViewExpiredException. will be thrown. It is important to note that if this feature is enabled, and client requests are recieved with view state produced from a previous version, the ViewExpiredException will be thrown immediately. -
setClientStateWriteBufferSize
The size, in bytes, of the buffer that is used to write client state. It should be noted, that the buffer used is split - half is for raw bytes, the other half is for the Base64 encoded characters of said bytes. So, for example, if the default, 8192, is used, then 4096 of that is used for the bytes, and the other 4096 is used for the Base64 encoded characters. -
setCompressViewState
When true, the view is compressed after it is serialized and before base64 encoded. Works with client state saving only. As of 1.2_09, this option also impacts server side state saving when com.sun.faces.serializeServerState is set to true (this has a large impact of the size of the state in the session when using this option, at the expense of more CPU of course). -
setDisableClientStateEncryption
Since Mojarra 2.2, the client state is by default always encrypted. When true, the client state encryption is disabled. See also com.sun.faces.ClientStateSavingPassword - recommendations for actual password? -
setEnableClientStateDebugging
When true, the client state will as test be unserialized before writing and any serialization exceptions will be logged aInteger with a debug path to the cause of the serialization error. -
setGenerateUniqueServerStateIds
If true, generate random server view state ids. If false, create server view state ids sequentially. This resembles closely the JSF 1.x behavior, but this is more sensitive to CSRF. -
setNumberOfLogicalViews
Defines the maximum number of serialized views stored in the session. Works with server state saving only (note the implementation unintentionally has swapped the meaning, as we cannot change this without breaking what people have become used to we have updated this here). See com.sun.faces.numberOfViewsInSession vs com.sun.faces.numberOfLogicalViews for detail. -
setNumberOfViewsInSession
Definies the maximum number of serialized logical views per view. Works with server state saving only (note the implementation unintentionally has swapped the meaning, as we cannot change this without breaking what people have become used to we have updated this here) See com.sun.faces.numberOfViewsInSession vs com.sun.faces.numberOfLogicalViews for detail. -
setSerializeServerState
If enabled the component state (not the tree) will be serialized before being stored in the session. This may be desirable for applications that may have issues with view state being sensitive to model changes after state saving which are reflected back in view state. This has since JSF 2.2 been replaced by jakarta.faces.SERIALIZE_SERVER_STATE. -
setWriteStateAtFormEnd
Per the renderkit doc specification, the state information for the view will be written out prior to closing the form tag. However, it may be desirable to have the state information written out after the opening form tag. If this is the case, specifiy this parameter in the web.xml with a value of false. -
setAllowTextChildren
If true, allow children of h:inputText and h:outputText to be rendered. In 1.2, they would always be rendered before the value of tag. As of 2.0, children of UIInput and UIOutput components will not be rendered by the default renderer implementations. Set this option to true if this behavior is required, but note that doing so may cause issues when using Ajax. See issue 1154 for details. -
setAutoCompleteOffOnViewState
If false, don't use autocomplete="off" on view state hidden input field. This attribute is by default always rendered in order to fix a Firefox related bug, but it is invalid on a hidden input field as per w3 HTML validator. So, when false, then beware of the Firefox bug which may trigger "unexpected" ViewExpiredException. See issue 1129 for details. -
setCompressJavaScript
If true, then the JavaScript rendered by h:commandLink will be compressed to reduce the amount of whitespace transmitted in the response. If false then the JavaScript will be rendered to the client in a well formatted manner. -
setDisableUnicodeEscaping
By default any characters above a certain range will be escaped as either an HTML entity or a decimal reference. This behavior is not always desirable. To allow more flexibility how content is rendered to a client, this option was introduced. Valid configuration values are: false, true, and auto with false being the default. When the option value is false, Mojarra will continue to escaped no matter the response encoding type. If the configuration value is true, Then no escaping will occur assuming that the response encoding can properly handle all characters. If the configuration option is auto then the response encoding will be checked. If the encoding is of the UTF family of encodings no unicode or html entity encoding will occur, however, if the response stream encoding is ISO-8859-1 then the ISO characters above a certain range will be encoded as HTML entities and any characters above that range will be written as decimal references. -
setDisableIdUniquenessCheck
If true, then component ID uniqueness won't be checked if ProjectStage is Production to enhance performance. See issue 2414 for details. -
setEnabledJsStyleHiding
If true, inlined JavaScript rendered by the HTML ResponseWriter implementation will be rendered so that the script is hidden from older browser implementations which does not recognize<script/>
elements. -
setEnableScriptsInAttributeValues
If false, attribute values with javascript: or script: will not be rendered within attribute values to prevent potential XSS attacks. -
setEnableViewStateIdRendering
If true, the view state hidden field will be rendered with both the id and name attributes having the value of "jakarta.faces.ViewState". This is what the spec requires, however, if there are multiple forms within a view and the response content-type is XHTML, the result will be XHTML that will fail validation due to multiple ID attributes with the same value: jakarta.faces.ViewState. Setting this parameter to false will result in the ID attribute not being rendered. Keep in mind however, that doing this may break integration with AJAX frameworks that get the state field via ID. See issue 433 for details. -
setPreferXhtml
For the case where a browser supports XHTML and HTML without a quality. When enabled and this case occurs, then XHTML will be set as the content type. This setting is not recommended and should be only used to fix broken applications designed with XHTML output in mind instead of HTML(5) output. -
setResponseBufferSize
This parameter specifies the size, in bytes, of the buffer that is used to write all generated JSP content excluding state. Note that this is ignored when Facelets is used. For Facelets, use jakarta.faces.FACELETS_BUFFER_SIZE instead. -
setCacheResourceModificationTimestamp
If true, cache the modification time of the resource and use the cached time to tell if the resource needs to be refreshed. -
setCompressableMimeTypes
Specify mime types that should be gzip compressed. Mime types can be specified by their exact name (i.e. text/css) or a wildcard can be used after the slash (i.e. text/*). The resource will not be compressed on each request, instead when building the cache, the resource will be compressed to a temporary directory and those bytes will be served instead. -
setDefaultResourceMaxAge
This affects the value of the Expires response header that will be sent for a resource. The logic is basically Date.getTime() + valueOf(defaultResourceManxAge). Increase this value to increase the amount of time that a Resource is valid. The value is in milliseconds (so the default value of 604800000 is 7 days). -
setEnableFaceletsResourceResolverCompositeComponents
public void setEnableFaceletsResourceResolverCompositeComponents(Boolean enableFaceletsResourceResolverCompositeComponents) See issue 3684 for details. -
setEnableMissingResourceLibraryDetection
If enabled, the runtime will check for the existence of a resource library before checking for the resource itself. If not found, an appropriate error message will be included in the log and in the view if ProjectStage is Development. -
setResourceUpdateCheckPeriod
When jakarta.faces.PROJECT_STATE is Production, UnitTest, or SystemTest resource paths will be cached to reduce the overhead of resource path compuation. By default, updates (i.e. new files, new directories, new versions, etc.) will be checked for every 5 minutes. If a change is detected, the cache will be cleared and rebuilt. If the value of this option is -1, the cache will never be cleared and new resources will not be picked up. The value is in minutes. -
setEnableAgressiveSessionDirtying
If true, makes it so every session attribute is touched in for every request through the lifecycle. This makes it much harder to make mistakes that cause session replication to fail. -
setEnableDistributable
If true, signal JSF that the application is deployed to a clustered environment, so that session dirtying will be explicitly performed, hereby forcing session replication. This is automatically true when <distributable /> entry is present in web.xml. -
setAnnotationScanPackages
The value of this context init parameter is a whitespace separated list of values that control which class packages are scanned for jakarta.faces annotations. To restrict which jars/packages are scanned, use the following entry format: jar:'jar name':'comma separated list of packages' So an example would be: jar:a.jar:com.acme.package1,com.acme.package2. -
setDisplayConfiguration
If true then all web configuration information (context initialization parameters and environment entries) will be written to the log. This is useful during development to confirm your application is configured as expected. -
setEnableCoreTagLibValidator
When true, enable validation of standard Core TagLibs, at the expense of a slightly slower start time. -
setEnableHtmlTagLibValidator
When true, enable validation of standard Html TagLibs, at the expense of a slightly slower start time. -
setEnableLazyBeanValidation
When true, managed beans will be validated when first created. If false, managed beans will be validated when the application is started, at the expense of a slightly slower start time. -
setEnableThreading
When enabled, the runtime initialization and default ResourceHandler implementation will use threads to perform their functions. Set this value to false if threads aren't desired (as in the case of running within the Google Application Engine). Note that when this option is disabled, the ResourceHandler will not pick up new versions of resources when ProjectStage is development. See issue 2385 for details. -
setForceLoadConfiguration
There is a chance for an NPE in com.sun.faces.application.WebappLifecycleListener with some configurations. Take for example, installing JSF in a container such that JSF will be available to all web applications. The NPE will occur for an application that doesn't have the FacesServlet defined within its web.xml. The workaround for this issue is, within the global web.xml for the container (JBoss and Tomcat both have one) add either a FacesServlet definition (no mapping) or add the context init parameter, com.sun.faces.forceLoadConfiguration, with a value of true. See issue 670 for details. -
setValidateXml
When true, enable validation of faces-config.xml files, at the expense of a slightly slower start time. -
setVerifyObjects
When true, JSF makes during startup sure all that registered managed beans components, validators, etc can be instantiated by the runtime, at the expense of a slightly slower start time. -
setEnableTransitionTimeNoOpFlash
If true, the act of calling getExternalContext().getFlash() on the FacesContext at startup or shutdown time will cause a no-op implementation of the Flash to be returned. This should prevent startup/shutdown exceptions caused by invalid/stale flash cookies. See "bugdb 17024459" for details. -
setExpressionFactory
This parameter specifies a class that implements the ExpressionFactory. -
setForceAlwaysWriteFlashCookie
If true, then the flash cookie will always be written, regardless of whether or not the flash has data. This should prevent problems on multiple successive redirects. See issue 3735 for details. -
setInjectionProvider
This parameter specifies a class that implements the InjectionProvider. -
setNamespaceParameters
If true, then view state hidden field is namespaced according to NamingContainer rules. See issue 3031 for details. -
setRegisterConverterPropertyEditors
If true, allow EL Coercion to use JSF Custom converters. -
setSendPoweredByHeader
The servlet specification defines an optional header that can be sent by a container to communicate the version of the JSP/Servlet the response was generated by. If this is enabled, then X-Powered-By=JSF/2.2 header is included in all responses. -
setSerializationProvider
This parameter specifies a class that implements the SerializationProvider SPI. This implementation represents a hook the JSF implementation will use in order to allow the use of alternate Serialization implementations. -
setFaceletFactory
The value of this option is a fully qualfified class that extends the com.sun.faces.facelets.FaceletFactory abstract class. This option allows developers to customize the behavior or completely replace the default com.sun.faces.facelets.FaceletFactory implementation. Some rules about what is expected of custom implementations.If the custom implementation has a public single argument constructor where the argument type is com.sun.faces.facelets.FaceletFactory, the default FaceletFactory implementation will be passed to the constructor. If the single argument constructor is not present, the custom implementation will be constructed by invoking a public no-argument constructor. -
setDisallowDoctypeDecl
When this context param is set to true, this would set a feature on the SAX parser to disallow DOCTYPE declarations. When set to false, this would set a feature on the SAX parser to allow DOCTYPE declarations. When this context param is not specified, whether or not DOCTYPE declarations are allowed would just depend on the SAXParserFactory implementation in use, as is the case today. -
setManagedBeanFactoryDecorator
Javadoc not found. -
setNumberOfConcurrentFlashUsers
Number of concurrent flash users. -
setNumberOfFlashesBetweenFlashReapings
Number flashes between flash repaings. -
setDuplicateJARPattern
Javadoc not found. -
setFaceletCache
Javadoc not found. -
setFaceletsProcessingFileExtensionProcessAs
public void setFaceletsProcessingFileExtensionProcessAs(String faceletsProcessingFileExtensionProcessAs) Javadoc not found. -
setDisableVersionTracking
Javadoc not found. -
setEnableJSStyleHiding
Javadoc not found. -
setEnabledLoadBundle11Compatibility
Javadoc not found. -
setEnableRestoreView11Compatibility
Javadoc not found. -
setEnableGroovyScripting
Javadoc not found. -
setEnableHttpMethodRestrictionPhaseListener
public void setEnableHttpMethodRestrictionPhaseListener(Boolean enableHttpMethodRestrictionPhaseListener) add the HttpMethodRestrictionPhaseListener if the parameter is enabled. -
setAllowedHttpMethods
A white space separated list of case sensitive HTTP method names that are allowed to be processed by this servlet. * means allow all. -
equals
-
canEqual
-
hashCode
public int hashCode() -
toString
-