Class MyFacesProperties
java.lang.Object
org.joinfaces.autoconfigure.myfaces.MyFacesProperties
- All Implemented Interfaces:
ServletContextInitParameterProperties
@ConfigurationProperties(prefix="joinfaces.myfaces")
public class MyFacesProperties
extends Object
implements ServletContextInitParameterProperties
Configuration properties of MyFaces.
Taken from https://myfaces.apache.org/core22/myfaces-impl/webconfig.html and
from
https://myfaces.apache.org/core22/myfaces-impl/apidocs/constant-values.html
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
Deprecated.Removed in MyFaces 4static class
Spi class of injectionProvider property..static class
Validator class of beanBeforeJsfValidation property. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
boolean
Indicate the encryption algorithm used for encrypt the view state.Defines the initialization vector (Base64 encoded) used for the encryption algorithm.Defines the default mode and padding used for the encryption algorithm.This parameter tells MyFaces if javascript code should be allowed in the rendered HTML output.Add autocomplete="off" to the view state hidden field.Indicates if expressions generated by facelets should be cached or not.This parameter has been removed from 2.Enable or disable CDI support for converters.Enable or disable CDI support for validators.Enable or disable a cache used to 'remember' if a view exists or not and reduce the impact " + "of sucesive calls to ExternalContext.getResource().Controls the size of the cache used to 'remember' if a view exists or not.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).Define the time in minutes where the view state is valid when client side state saving is used.Set the size of the cache used to store strings generated using SectionUniqueIdCounter for component ids.Indicate if the view state should be compressed before encrypted(optional) and encoded.Indicates that the serialized state will be compressed before it is written to the session.Set the time in seconds that check for updates of web.Enable/disable DebugPhaseListener feature, with provide useful information about ValueHolder variables (submittedValue, localValue, value).Indicate the template name used to render the default debug page (see ui:debug tag).Define the default content type that the default ResponseWriter generates, when no match can be derived from HTTP Accept Header.Deprecated.Class<?>
Define an alternate class name that will be used to initialize MyFaces, instead the default jakarta.Enable or disable an early flush which allows to send e.g.Class<? extends Comparator<ELResolver>>
The Class of anComparator<ELResolver/>
implementation.TheClass
of anPredicate<ELResolver>
implementation.If value is a String instance and this param is true, pass it directly without try any change.Deprecated: use JSF 2.0 ExceptionHandler.Indicate if myfaces is responsible to handle errors.Indicate the template name used to render the default error page used by MyFaces specific error handler implementation.Class<? extends ExpressionFactory>
This parameter specifies the ExpressionFactory implementation to use.Indicate the max number of client window ids stored into session by faces flow.Class<? extends FacesInitializer>
Class name of a custom FacesInitializer implementation.comma delimited list of plugin classes which can be hooked into myfaces.Defines whether flash scope is disabled, preventing add the Flash cookie to the response.When the application runs inside Google Application Engine container (GAE), indicate which jar files should be scanned for annotations.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).If this param is set to true, the check for faces servlet mapping is not done.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).Deprecated.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.Indicate if log all web config params should be done before initialize the webapp.Indicate the algorithm used to calculate the Message Authentication Code that is added to the view state.Define the initialization code that are used to initialize the secret key used on the Message Authentication Code algorithm.If is set to "false", the secret key used for MAC algorithm is not cached.no description.Indicate the max number of flash tokens stored into session.Indicates the amount of views (default is not active) that should be stored in session between sequential POST or POST-REDIRECT-GET if org.Defines the amount (default = 20) of the latest views are stored in session.If true, rendered HTML code will be formatted, so that it is "human readable".Defines how to generate the csrf session token.Set the default length of the random key used for the csrf session token.Sets the random algorithm to initialize the secure random id generator.Sets the random class to initialize the secure random id generator.Sets the random provider to initialize the secure random id generator.Adds a random key to the generated view state session token.Set the default length of the random key added to the view state session token.Sets the random algorithm to initialize the secure random id generator.Class<? extends SecureRandom>
Sets the random class to initialize the secure random id generator.Sets the random provider to initialize the secure random id generator.Indicate if the facelet associated to the view should be reapplied when the view is refreshed.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.This param renders the clear javascript on button necessary only for compatibility with hidden fields feature of myfaces.If set true, render the form submit script inline, as in myfaces core 1.This param makes h:form component to render the view state and other hidden fields at the beginning of the form.This param renders hidden fields at the end of h:form for link params when h:commandLink + f:param is used, instead use javascript to create them.Define if the input field that should store the state.Define the default buffer size that is used between Resource.Enable or disable the cache used to "remember" if a resource handled by the default ResourceHandler exists or not.Controls the size of the cache used to check if a resource exists or not.Set the max time in miliseconds set on the "Expires" header for a resource rendered by the default ResourceHandler.Add a code that save the form before submit using a link.Defines the secret (Base64 encoded) used to initialize the secret key for encryption algorithm.If is set to "false", the secret key used for encryption algorithm is not cached.Class<?>
Defines the factory class name using for serialize/deserialize the view state returned by state manager into a byte array.Indicate if the state should be serialized before save it on the session.Class<? extends ServiceProviderFinder>
Class name of a custom ServiceProviderFinder implementation.getSpi()
Allow slash in the library name of a Resource.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.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.Detect if a target (usually head) should be update for the current view in an ajax render operation.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.Use&
entity instead a plain&
character within HTML.This parameter specifies whether or not the ImportHandler will be supported.If set false, myfaces won't support JSP and jakarta.faces.el.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.Indicate if the view state is encrypted or not.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.Deprecated.Validate if the managed beans and navigations rules are correct.If set to true, tag library XML files and faces config XML files using schema will be validated during application start up.Defines if the view pool uses deferred navigation to recycle views when navigation is performed.Defines the type of memory reference that is used to hold the view into memory.Defines the limit of the views that cannot be reused partially.Defines the number of views to be hold per each view metadata definition.Set the view state using a javascript function instead a hidden input field.Enable or disable a cache used to 'remember' the generated facelets unique ids " + "and reduce the impact over memory usage.Wrap content inside script with xml comment to prevent old browsers to display it.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.int
hashCode()
void
setAlgorithm
(String algorithm) Indicate the encryption algorithm used for encrypt the view state.void
setAlgorithmIv
(String algorithmIv) Defines the initialization vector (Base64 encoded) used for the encryption algorithm.void
setAlgorithmParameters
(String algorithmParameters) Defines the default mode and padding used for the encryption algorithm.void
setAllowJavascript
(Boolean allowJavascript) This parameter tells MyFaces if javascript code should be allowed in the rendered HTML output.void
setAutocompleteOffViewState
(Boolean autocompleteOffViewState) Add autocomplete="off" to the view state hidden field.void
setCacheElExpressions
(ELExpressionCacheMode cacheElExpressions) Indicates if expressions generated by facelets should be cached or not.void
setCacheOldViewsInSessionMode
(Boolean cacheOldViewsInSessionMode) This parameter has been removed from 2.void
setCdiManagedConvertersEnabled
(Boolean cdiManagedConvertersEnabled) Enable or disable CDI support for converters.void
setCdiManagedValidatorsEnabled
(Boolean cdiManagedValidatorsEnabled) Enable or disable CDI support for validators.void
setCheckedViewidCacheEnabled
(Boolean checkedViewidCacheEnabled) Enable or disable a cache used to 'remember' if a view exists or not and reduce the impact " + "of sucesive calls to ExternalContext.getResource().void
setCheckedViewidCacheSize
(Integer checkedViewidCacheSize) Controls the size of the cache used to 'remember' if a view exists or not.void
setCheckIdProductionMode
(String checkIdProductionMode) 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).void
setClientViewStateTimeout
(Duration clientViewStateTimeout) Define the time in minutes where the view state is valid when client side state saving is used.void
setComponentUniqueIdsCacheSize
(Integer componentUniqueIdsCacheSize) Set the size of the cache used to store strings generated using SectionUniqueIdCounter for component ids.void
setCompressStateInClient
(Boolean compressStateInClient) Indicate if the view state should be compressed before encrypted(optional) and encoded.void
setCompressStateInSession
(Boolean compressStateInSession) Indicates that the serialized state will be compressed before it is written to the session.void
setConfigRefreshPeriod
(Duration configRefreshPeriod) Set the time in seconds that check for updates of web.void
setDebugPhaseListener
(Boolean debugPhaseListener) Enable/disable DebugPhaseListener feature, with provide useful information about ValueHolder variables (submittedValue, localValue, value).void
setDebugTemplateResource
(String debugTemplateResource) Indicate the template name used to render the default debug page (see ui:debug tag).void
setDefaultResponseWriterContentTypeMode
(String DefaultResponseWriterContentTypeMode) Define the default content type that the default ResponseWriter generates, when no match can be derived from HTTP Accept Header.void
setDefaultWindowMode
(String defaultWindowMode) Deprecated.void
setDelegateFacesServlet
(Class<?> delegateFacesServlet) Define an alternate class name that will be used to initialize MyFaces, instead the default jakarta.void
setEarlyFlushEnabled
(Boolean earlyFlushEnabled) Enable or disable an early flush which allows to send e.g.void
setElResolverComparator
(Class<? extends Comparator<ELResolver>> elResolverComparator) The Class of anComparator<ELResolver/>
implementation.void
setElResolverPredicate
(Class<Predicate<ELResolver>> elResolverPredicate) TheClass
of anPredicate<ELResolver>
implementation.void
setEnumConverterAllowStringPasstrough
(Boolean enumConverterAllowStringPasstrough) If value is a String instance and this param is true, pass it directly without try any change.void
setErrorHandler
(String errorHandler) Deprecated: use JSF 2.0 ExceptionHandler.void
setErrorHandling
(Boolean errorHandling) Indicate if myfaces is responsible to handle errors.void
setErrorTemplateResource
(String errorTemplateResource) Indicate the template name used to render the default error page used by MyFaces specific error handler implementation.void
setExpressionFactory
(Class<? extends ExpressionFactory> expressionFactory) This parameter specifies the ExpressionFactory implementation to use.void
setFacesFlowClientWindowIdsInSession
(Integer facesFlowClientWindowIdsInSession) Indicate the max number of client window ids stored into session by faces flow.void
setFacesInitializer
(Class<? extends FacesInitializer> facesInitializer) Class name of a custom FacesInitializer implementation.void
setFacesInitPlugins
(List<Class<?>> facesInitPlugins) comma delimited list of plugin classes which can be hooked into myfaces.void
setFlashScopeDisabled
(Boolean flashScopeDisabled) Defines whether flash scope is disabled, preventing add the Flash cookie to the response.void
setGaeJsfAnnotationsJarFiles
(String gaeJsfAnnotationsJarFiles) When the application runs inside Google Application Engine container (GAE), indicate which jar files should be scanned for annotations.void
setGaeJsfJarFiles
(String gaeJsfJarFiles) 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).void
setInitializeAlwaysStandalone
(Boolean initializeAlwaysStandalone) If this param is set to true, the check for faces servlet mapping is not done.void
setInitializeSkipJarFacesConfigScan
(Boolean initializeSkipJarFacesConfigScan) 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).void
setJsfJsMode
(String jsfJsMode) Deprecated.void
setLazyLoadConfigObjects
(Boolean lazyLoadConfigObjects) 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.void
setLogWebContextParams
(String logWebContextParams) Indicate if log all web config params should be done before initialize the webapp.void
setMacAlgorithm
(String macAlgorithm) Indicate the algorithm used to calculate the Message Authentication Code that is added to the view state.void
setMacSecret
(String macSecret) Define the initialization code that are used to initialize the secret key used on the Message Authentication Code algorithm.void
setMacSecretCache
(Boolean macSecretCache) If is set to "false", the secret key used for MAC algorithm is not cached.void
setMarkInitialStateWhenApplyBuildView
(Boolean markInitialStateWhenApplyBuildView) no description.void
setNumberOfFlashTokensInSession
(Integer numberOfFlashTokensInSession) Indicate the max number of flash tokens stored into session.void
setNumberOfSequentialViewsInSession
(Integer numberOfSequentialViewsInSession) Indicates the amount of views (default is not active) that should be stored in session between sequential POST or POST-REDIRECT-GET if org.void
setNumberOfViewsInSession
(Integer numberOfViewsInSession) Defines the amount (default = 20) of the latest views are stored in session.void
setPrettyHtml
(Boolean prettyHtml) If true, rendered HTML code will be formatted, so that it is "human readable".void
setRandomKeyInCsrfSessionToken
(String randomKeyInCsrfSessionToken) Defines how to generate the csrf session token.void
setRandomKeyInCsrfSessionTokenLength
(Integer randomKeyInCsrfSessionTokenLength) Set the default length of the random key used for the csrf session token.void
setRandomKeyInCsrfSessionTokenSecureRandomAlgoritm
(String randomKeyInCsrfSessionTokenSecureRandomAlgoritm) Sets the random algorithm to initialize the secure random id generator.void
setRandomKeyInCsrfSessionTokenSecureRandomClass
(String randomKeyInCsrfSessionTokenSecureRandomClass) Sets the random class to initialize the secure random id generator.void
setRandomKeyInCsrfSessionTokenSecureRandomProvider
(String randomKeyInCsrfSessionTokenSecureRandomProvider) Sets the random provider to initialize the secure random id generator.void
setRandomKeyInViewStateSessionToken
(String randomKeyInViewStateSessionToken) Adds a random key to the generated view state session token.void
setRandomKeyInViewStateSessionTokenLength
(Integer randomKeyInViewStateSessionTokenLength) Set the default length of the random key added to the view state session token.void
setRandomKeyInViewStateSessionTokenSecureRandomAlgorithm
(String randomKeyInViewStateSessionTokenSecureRandomAlgorithm) Sets the random algorithm to initialize the secure random id generator.void
setRandomKeyInViewStateSessionTokenSecureRandomClass
(Class<? extends SecureRandom> randomKeyInViewStateSessionTokenSecureRandomClass) Sets the random class to initialize the secure random id generator.void
setRandomKeyInViewStateSessionTokenSecureRandomProvider
(String randomKeyInViewStateSessionTokenSecureRandomProvider) Sets the random provider to initialize the secure random id generator.void
setRefreshTransientBuildOnPss
(String refreshTransientBuildOnPss) Indicate if the facelet associated to the view should be reapplied when the view is refreshed.void
setRefreshTransientBuildOnPssPreserveState
(Boolean refreshTransientBuildOnPssPreserveState) 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.void
setRenderClearJavascriptForButton
(Boolean renderClearJavascriptForButton) This param renders the clear javascript on button necessary only for compatibility with hidden fields feature of myfaces.void
setRenderFormSubmitScriptInline
(Boolean renderFormSubmitScriptInline) If set true, render the form submit script inline, as in myfaces core 1.void
setRenderFormViewStateAtBegin
(Boolean renderFormViewStateAtBegin) This param makes h:form component to render the view state and other hidden fields at the beginning of the form.void
setRenderHiddenFieldsForLinkParams
(Boolean renderHiddenFieldsForLinkParams) This param renders hidden fields at the end of h:form for link params when h:commandLink + f:param is used, instead use javascript to create them.void
setRenderViewstateId
(Boolean renderViewstateId) Define if the input field that should store the state.void
setResourceBufferSize
(DataSize resourceBufferSize) Define the default buffer size that is used between Resource.void
setResourceHandlerCacheEnabled
(Boolean resourceHandlerCacheEnabled) Enable or disable the cache used to "remember" if a resource handled by the default ResourceHandler exists or not.void
setResourceHandlerCacheSize
(Integer resourceHandlerCacheSize) Controls the size of the cache used to check if a resource exists or not.void
setResourceMaxTimeExpires
(Duration resourceMaxTimeExpires) Set the max time in miliseconds set on the "Expires" header for a resource rendered by the default ResourceHandler.void
setSaveFormSubmitLinkIe
(Boolean saveFormSubmitLinkIe) Add a code that save the form before submit using a link.void
Defines the secret (Base64 encoded) used to initialize the secret key for encryption algorithm.void
setSecretCache
(Boolean secretCache) If is set to "false", the secret key used for encryption algorithm is not cached.void
setSerialFactory
(Class<?> serialFactory) Defines the factory class name using for serialize/deserialize the view state returned by state manager into a byte array.void
setSerializeStateInSession
(Boolean serializeStateInSession) Indicate if the state should be serialized before save it on the session.void
setServiceProviderFinder
(Class<? extends ServiceProviderFinder> serviceProviderFinder) Class name of a custom ServiceProviderFinder implementation.void
setStrictJsf2AllowSlashLibraryName
(Boolean strictJsf2AllowSlashLibraryName) Allow slash in the library name of a Resource.void
setStrictJsf2CcElResolver
(String strictJsf2CcElResolver) 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.void
setStrictJsf2FaceletsCompatibility
(Boolean strictJsf2FaceletsCompatibility) 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.void
setStrictJsf2RefreshTargetAjax
(Boolean strictJsf2RefreshTargetAjax) Detect if a target (usually head) should be update for the current view in an ajax render operation.void
setStrictJsf2ViewNotFound
(Boolean strictJsf2ViewNotFound) 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.void
setStrictXhtmlLinks
(Boolean strictXhtmlLinks) Use&
entity instead a plain&
character within HTML.void
setSupportEl3ImportHandler
(Boolean supportEl3ImportHandler) This parameter specifies whether or not the ImportHandler will be supported.void
setSupportJspAndFacesEl
(Boolean supportJspAndFacesEl) If set false, myfaces won't support JSP and jakarta.faces.el.void
setTemporalResourcehandlerCacheEnabled
(Boolean temporalResourcehandlerCacheEnabled) 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.void
setUseEncryption
(Boolean useEncryption) Indicate if the view state is encrypted or not.void
setUseFlashScopePurgeViewsInSession
(Boolean useFlashScopePurgeViewsInSession) 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.void
setUseMultipleJsFilesForJsfUncompressedJs
(Boolean useMultipleJsFilesForJsfUncompressedJs) Deprecated.void
setValidate
(Boolean validate) Validate if the managed beans and navigations rules are correct.void
setValidateXml
(Boolean validateXml) If set to true, tag library XML files and faces config XML files using schema will be validated during application start up.void
setViewPoolDeferredNavigation
(Boolean viewPoolDeferredNavigation) Defines if the view pool uses deferred navigation to recycle views when navigation is performed.void
setViewPoolEntryMode
(String viewPoolEntryMode) Defines the type of memory reference that is used to hold the view into memory.void
setViewPoolMaxDynamicPartialLimit
(Integer viewPoolMaxDynamicPartialLimit) Defines the limit of the views that cannot be reused partially.void
setViewPoolMaxPoolSize
(Integer viewPoolMaxPoolSize) Defines the number of views to be hold per each view metadata definition.void
setViewstateJavascript
(Boolean viewstateJavascript) Set the view state using a javascript function instead a hidden input field.void
setViewUniqueIdsCacheEnabled
(Boolean viewUniqueIdsCacheEnabled) Enable or disable a cache used to 'remember' the generated facelets unique ids " + "and reduce the impact over memory usage.void
setWrapScriptContentWithXmlCommentTag
(Boolean wrapScriptContentWithXmlCommentTag) Wrap content inside script with xml comment to prevent old browsers to display it.void
setWrapTagExceptionsAsContextAware
(Boolean wrapTagExceptionsAsContextAware) 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.toString()
-
Constructor Details
-
MyFacesProperties
public MyFacesProperties()
-
-
Method Details
-
getLogWebContextParams
Indicate if log all web config params should be done before initialize the webapp. -
getEnumConverterAllowStringPasstrough
If value is a String instance and this param is true, pass it directly without try any change. -
getErrorHandler
Deprecated: use JSF 2.0 ExceptionHandler. -
getCheckedViewidCacheSize
Controls the size of the cache used to 'remember' if a view exists or not. -
getCheckedViewidCacheEnabled
Enable or disable a cache used to 'remember' if a view exists or not and reduce the impact " + "of sucesive calls to ExternalContext.getResource(). -
getPrettyHtml
If true, rendered HTML code will be formatted, so that it is "human readable". -
getAllowJavascript
This parameter tells MyFaces if javascript code should be allowed in the rendered HTML output. -
getConfigRefreshPeriod
Set the time in seconds that check for updates of web. -
getViewstateJavascript
Set the view state using a javascript function instead a hidden input field. -
getRenderViewstateId
Define if the input field that should store the state. -
getStrictXhtmlLinks
Use&
entity instead a plain&
character within HTML. -
getRenderClearJavascriptForButton
This param renders the clear javascript on button necessary only for compatibility with hidden fields feature of myfaces. -
getRenderHiddenFieldsForLinkParams
This param renders hidden fields at the end of h:form for link params when h:commandLink + f:param is used, instead use javascript to create them. -
getSaveFormSubmitLinkIe
Add a code that save the form before submit using a link. -
getDelegateFacesServlet
Define an alternate class name that will be used to initialize MyFaces, instead the default jakarta. -
getRefreshTransientBuildOnPss
Indicate if the facelet associated to the view should be reapplied when the view is refreshed. -
getRefreshTransientBuildOnPssPreserveState
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. -
getValidateXml
If set to true, tag library XML files and faces config XML files using schema will be validated during application start up. -
getWrapScriptContentWithXmlCommentTag
Wrap content inside script with xml comment to prevent old browsers to display it. -
getRenderFormSubmitScriptInline
If set true, render the form submit script inline, as in myfaces core 1. -
getDebugPhaseListener
Enable/disable DebugPhaseListener feature, with provide useful information about ValueHolder variables (submittedValue, localValue, value). -
getStrictJsf2RefreshTargetAjax
Detect if a target (usually head) should be update for the current view in an ajax render operation. -
getStrictJsf2CcElResolver
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. -
getDefaultResponseWriterContentTypeMode
Define the default content type that the default ResponseWriter generates, when no match can be derived from HTTP Accept Header. -
getViewUniqueIdsCacheEnabled
Enable or disable a cache used to 'remember' the generated facelets unique ids " + "and reduce the impact over memory usage. -
getComponentUniqueIdsCacheSize
Set the size of the cache used to store strings generated using SectionUniqueIdCounter for component ids. -
getSupportJspAndFacesEl
If set false, myfaces won't support JSP and jakarta.faces.el. JSP are deprecated in " + "JSF 2.X, jakarta.faces.el in in JSF 1.2. Default value is true. -
getGaeJsfJarFiles
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). -
getGaeJsfAnnotationsJarFiles
When the application runs inside Google Application Engine container (GAE), indicate which jar files should be scanned for annotations. -
getStrictJsf2ViewNotFound
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. -
getEarlyFlushEnabled
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. -
getCdiManagedConvertersEnabled
Enable or disable CDI support for converters. -
getCdiManagedValidatorsEnabled
Enable or disable CDI support for validators. -
getStrictJsf2FaceletsCompatibility
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. -
getRenderFormViewStateAtBegin
This param makes h:form component to render the view state and other hidden fields at the beginning of the form. -
getFlashScopeDisabled
Defines whether flash scope is disabled, preventing add the Flash cookie to the response. -
getNumberOfViewsInSession
Defines the amount (default = 20) of the latest views are stored in session. -
getNumberOfSequentialViewsInSession
Indicates the amount of views (default is not active) that should be stored in session between sequential POST or POST-REDIRECT-GET if org. -
getNumberOfFlashTokensInSession
Indicate the max number of flash tokens stored into session. -
getFacesFlowClientWindowIdsInSession
Indicate the max number of client window ids stored into session by faces flow. -
getSupportEl3ImportHandler
This parameter specifies whether or not the ImportHandler will be supported. -
getResourceMaxTimeExpires
Set the max time in miliseconds set on the "Expires" header for a resource rendered by the default ResourceHandler. -
getResourceHandlerCacheSize
Controls the size of the cache used to check if a resource exists or not. -
getResourceHandlerCacheEnabled
Enable or disable the cache used to "remember" if a resource handled by the default ResourceHandler exists or not. -
getUseEncryption
Indicate if the view state is encrypted or not. -
getSecret
Defines the secret (Base64 encoded) used to initialize the secret key for encryption algorithm. -
getSecretCache
If is set to "false", the secret key used for encryption algorithm is not cached. -
getAlgorithm
Indicate the encryption algorithm used for encrypt the view state. -
getAlgorithmIv
Defines the initialization vector (Base64 encoded) used for the encryption algorithm. -
getAlgorithmParameters
Defines the default mode and padding used for the encryption algorithm. -
getSerialFactory
Defines the factory class name using for serialize/deserialize the view state returned by state manager into a byte array.- See Also:
-
org.apache.myfaces.shared.util.serial.SerialFactory
SerialFactory
-
getCompressStateInClient
Indicate if the view state should be compressed before encrypted(optional) and encoded. -
getMacAlgorithm
Indicate the algorithm used to calculate the Message Authentication Code that is added to the view state. -
getMacSecret
Define the initialization code that are used to initialize the secret key used on the Message Authentication Code algorithm. -
getMacSecretCache
If is set to "false", the secret key used for MAC algorithm is not cached. -
getLazyLoadConfigObjects
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. -
getStrictJsf2AllowSlashLibraryName
Allow slash in the library name of a Resource. -
getResourceBufferSize
Define the default buffer size that is used between Resource. -
getRandomKeyInCsrfSessionToken
Defines how to generate the csrf session token. -
getRandomKeyInCsrfSessionTokenLength
Set the default length of the random key used for the csrf session token. -
getRandomKeyInCsrfSessionTokenSecureRandomClass
Sets the random class to initialize the secure random id generator. -
getRandomKeyInCsrfSessionTokenSecureRandomProvider
Sets the random provider to initialize the secure random id generator. -
getRandomKeyInCsrfSessionTokenSecureRandomAlgoritm
Sets the random algorithm to initialize the secure random id generator. -
getClientViewStateTimeout
Define the time in minutes where the view state is valid when client side state saving is used. -
getSerializeStateInSession
Indicate if the state should be serialized before save it on the session. -
getCompressStateInSession
Indicates that the serialized state will be compressed before it is written to the session. -
getCacheOldViewsInSessionMode
This parameter has been removed from 2. -
getUseFlashScopePurgeViewsInSession
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. -
getRandomKeyInViewStateSessionToken
Adds a random key to the generated view state session token. -
getRandomKeyInViewStateSessionTokenLength
Set the default length of the random key added to the view state session token. -
getRandomKeyInViewStateSessionTokenSecureRandomClass
Sets the random class to initialize the secure random id generator. -
getRandomKeyInViewStateSessionTokenSecureRandomProvider
Sets the random provider to initialize the secure random id generator. -
getRandomKeyInViewStateSessionTokenSecureRandomAlgorithm
Sets the random algorithm to initialize the secure random id generator. -
getValidate
Validate if the managed beans and navigations rules are correct. -
getAnnotation
-
getInitializeSkipJarFacesConfigScan
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). -
getElResolverComparator
The Class of anComparator<ELResolver/>
implementation. -
getElResolverPredicate
TheClass
of anPredicate<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'.- See Also:
-
getErrorTemplateResource
Indicate the template name used to render the default error page used by MyFaces specific error handler implementation. -
getDebugTemplateResource
Indicate the template name used to render the default debug page (see ui:debug tag). -
getErrorHandling
Indicate if myfaces is responsible to handle errors. -
getAutocompleteOffViewState
Add autocomplete="off" to the view state hidden field. -
getTemporalResourcehandlerCacheEnabled
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. -
getServiceProviderFinder
Class name of a custom ServiceProviderFinder implementation. -
getSpi
-
getCheckIdProductionMode
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). -
getMarkInitialStateWhenApplyBuildView
no description. -
getWrapTagExceptionsAsContextAware
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. -
getCacheElExpressions
Indicates if expressions generated by facelets should be cached or not. -
getViewPoolMaxPoolSize
Defines the number of views to be hold per each view metadata definition. -
getViewPoolMaxDynamicPartialLimit
Defines the limit of the views that cannot be reused partially. -
getViewPoolEntryMode
Defines the type of memory reference that is used to hold the view into memory. -
getValidator
-
getExpressionFactory
This parameter specifies the ExpressionFactory implementation to use. -
getInitializeAlwaysStandalone
If this param is set to true, the check for faces servlet mapping is not done. -
getFacesInitializer
Class name of a custom FacesInitializer implementation. -
getFacesInitPlugins
comma delimited list of plugin classes which can be hooked into myfaces. -
setLogWebContextParams
Indicate if log all web config params should be done before initialize the webapp. -
setEnumConverterAllowStringPasstrough
If value is a String instance and this param is true, pass it directly without try any change. -
setErrorHandler
Deprecated: use JSF 2.0 ExceptionHandler. -
setCheckedViewidCacheSize
Controls the size of the cache used to 'remember' if a view exists or not. -
setCheckedViewidCacheEnabled
Enable or disable a cache used to 'remember' if a view exists or not and reduce the impact " + "of sucesive calls to ExternalContext.getResource(). -
setPrettyHtml
If true, rendered HTML code will be formatted, so that it is "human readable". -
setAllowJavascript
This parameter tells MyFaces if javascript code should be allowed in the rendered HTML output. -
setConfigRefreshPeriod
Set the time in seconds that check for updates of web. -
setViewstateJavascript
Set the view state using a javascript function instead a hidden input field. -
setRenderViewstateId
Define if the input field that should store the state. -
setStrictXhtmlLinks
Use&
entity instead a plain&
character within HTML. -
setRenderClearJavascriptForButton
This param renders the clear javascript on button necessary only for compatibility with hidden fields feature of myfaces. -
setRenderHiddenFieldsForLinkParams
This param renders hidden fields at the end of h:form for link params when h:commandLink + f:param is used, instead use javascript to create them. -
setSaveFormSubmitLinkIe
Add a code that save the form before submit using a link. -
setDelegateFacesServlet
Define an alternate class name that will be used to initialize MyFaces, instead the default jakarta. -
setRefreshTransientBuildOnPss
Indicate if the facelet associated to the view should be reapplied when the view is refreshed. -
setRefreshTransientBuildOnPssPreserveState
public void setRefreshTransientBuildOnPssPreserveState(Boolean refreshTransientBuildOnPssPreserveState) 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. -
setValidateXml
If set to true, tag library XML files and faces config XML files using schema will be validated during application start up. -
setWrapScriptContentWithXmlCommentTag
Wrap content inside script with xml comment to prevent old browsers to display it. -
setRenderFormSubmitScriptInline
If set true, render the form submit script inline, as in myfaces core 1. -
setDebugPhaseListener
Enable/disable DebugPhaseListener feature, with provide useful information about ValueHolder variables (submittedValue, localValue, value). -
setStrictJsf2RefreshTargetAjax
Detect if a target (usually head) should be update for the current view in an ajax render operation. -
setStrictJsf2CcElResolver
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. -
setDefaultResponseWriterContentTypeMode
Define the default content type that the default ResponseWriter generates, when no match can be derived from HTTP Accept Header. -
setViewUniqueIdsCacheEnabled
Enable or disable a cache used to 'remember' the generated facelets unique ids " + "and reduce the impact over memory usage. -
setComponentUniqueIdsCacheSize
Set the size of the cache used to store strings generated using SectionUniqueIdCounter for component ids. -
setSupportJspAndFacesEl
If set false, myfaces won't support JSP and jakarta.faces.el. JSP are deprecated in " + "JSF 2.X, jakarta.faces.el in in JSF 1.2. Default value is true. -
setGaeJsfJarFiles
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). -
setGaeJsfAnnotationsJarFiles
When the application runs inside Google Application Engine container (GAE), indicate which jar files should be scanned for annotations. -
setStrictJsf2ViewNotFound
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. -
setEarlyFlushEnabled
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. -
setCdiManagedConvertersEnabled
Enable or disable CDI support for converters. -
setCdiManagedValidatorsEnabled
Enable or disable CDI support for validators. -
setStrictJsf2FaceletsCompatibility
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. -
setRenderFormViewStateAtBegin
This param makes h:form component to render the view state and other hidden fields at the beginning of the form. -
setFlashScopeDisabled
Defines whether flash scope is disabled, preventing add the Flash cookie to the response. -
setNumberOfViewsInSession
Defines the amount (default = 20) of the latest views are stored in session. -
setNumberOfSequentialViewsInSession
Indicates the amount of views (default is not active) that should be stored in session between sequential POST or POST-REDIRECT-GET if org. -
setNumberOfFlashTokensInSession
Indicate the max number of flash tokens stored into session. -
setFacesFlowClientWindowIdsInSession
Indicate the max number of client window ids stored into session by faces flow. -
setSupportEl3ImportHandler
This parameter specifies whether or not the ImportHandler will be supported. -
setResourceMaxTimeExpires
Set the max time in miliseconds set on the "Expires" header for a resource rendered by the default ResourceHandler. -
setResourceHandlerCacheSize
Controls the size of the cache used to check if a resource exists or not. -
setResourceHandlerCacheEnabled
Enable or disable the cache used to "remember" if a resource handled by the default ResourceHandler exists or not. -
setUseEncryption
Indicate if the view state is encrypted or not. -
setSecret
Defines the secret (Base64 encoded) used to initialize the secret key for encryption algorithm. -
setSecretCache
If is set to "false", the secret key used for encryption algorithm is not cached. -
setAlgorithm
Indicate the encryption algorithm used for encrypt the view state. -
setAlgorithmIv
Defines the initialization vector (Base64 encoded) used for the encryption algorithm. -
setAlgorithmParameters
Defines the default mode and padding used for the encryption algorithm. -
setSerialFactory
Defines the factory class name using for serialize/deserialize the view state returned by state manager into a byte array.- See Also:
-
org.apache.myfaces.shared.util.serial.SerialFactory
SerialFactory
-
setCompressStateInClient
Indicate if the view state should be compressed before encrypted(optional) and encoded. -
setMacAlgorithm
Indicate the algorithm used to calculate the Message Authentication Code that is added to the view state. -
setMacSecret
Define the initialization code that are used to initialize the secret key used on the Message Authentication Code algorithm. -
setMacSecretCache
If is set to "false", the secret key used for MAC algorithm is not cached. -
setLazyLoadConfigObjects
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. -
setStrictJsf2AllowSlashLibraryName
Allow slash in the library name of a Resource. -
setResourceBufferSize
Define the default buffer size that is used between Resource. -
setRandomKeyInCsrfSessionToken
Defines how to generate the csrf session token. -
setRandomKeyInCsrfSessionTokenLength
Set the default length of the random key used for the csrf session token. -
setRandomKeyInCsrfSessionTokenSecureRandomClass
public void setRandomKeyInCsrfSessionTokenSecureRandomClass(String randomKeyInCsrfSessionTokenSecureRandomClass) Sets the random class to initialize the secure random id generator. -
setRandomKeyInCsrfSessionTokenSecureRandomProvider
public void setRandomKeyInCsrfSessionTokenSecureRandomProvider(String randomKeyInCsrfSessionTokenSecureRandomProvider) Sets the random provider to initialize the secure random id generator. -
setRandomKeyInCsrfSessionTokenSecureRandomAlgoritm
public void setRandomKeyInCsrfSessionTokenSecureRandomAlgoritm(String randomKeyInCsrfSessionTokenSecureRandomAlgoritm) Sets the random algorithm to initialize the secure random id generator. -
setClientViewStateTimeout
Define the time in minutes where the view state is valid when client side state saving is used. -
setSerializeStateInSession
Indicate if the state should be serialized before save it on the session. -
setCompressStateInSession
Indicates that the serialized state will be compressed before it is written to the session. -
setCacheOldViewsInSessionMode
This parameter has been removed from 2. -
setUseFlashScopePurgeViewsInSession
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. -
setRandomKeyInViewStateSessionToken
Adds a random key to the generated view state session token. -
setRandomKeyInViewStateSessionTokenLength
public void setRandomKeyInViewStateSessionTokenLength(Integer randomKeyInViewStateSessionTokenLength) Set the default length of the random key added to the view state session token. -
setRandomKeyInViewStateSessionTokenSecureRandomClass
public void setRandomKeyInViewStateSessionTokenSecureRandomClass(Class<? extends SecureRandom> randomKeyInViewStateSessionTokenSecureRandomClass) Sets the random class to initialize the secure random id generator. -
setRandomKeyInViewStateSessionTokenSecureRandomProvider
public void setRandomKeyInViewStateSessionTokenSecureRandomProvider(String randomKeyInViewStateSessionTokenSecureRandomProvider) Sets the random provider to initialize the secure random id generator. -
setRandomKeyInViewStateSessionTokenSecureRandomAlgorithm
public void setRandomKeyInViewStateSessionTokenSecureRandomAlgorithm(String randomKeyInViewStateSessionTokenSecureRandomAlgorithm) Sets the random algorithm to initialize the secure random id generator. -
setValidate
Validate if the managed beans and navigations rules are correct. -
setInitializeSkipJarFacesConfigScan
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). -
setElResolverComparator
The Class of anComparator<ELResolver/>
implementation. -
setElResolverPredicate
TheClass
of anPredicate<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'.- See Also:
-
setDefaultWindowMode
Deprecated.no description. -
setErrorTemplateResource
Indicate the template name used to render the default error page used by MyFaces specific error handler implementation. -
setDebugTemplateResource
Indicate the template name used to render the default debug page (see ui:debug tag). -
setErrorHandling
Indicate if myfaces is responsible to handle errors. -
setAutocompleteOffViewState
Add autocomplete="off" to the view state hidden field. -
setUseMultipleJsFilesForJsfUncompressedJs
@Deprecated public void setUseMultipleJsFilesForJsfUncompressedJs(Boolean useMultipleJsFilesForJsfUncompressedJs) Deprecated.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. -
setJsfJsMode
Deprecated.Define the mode used for jsf. -
setTemporalResourcehandlerCacheEnabled
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. -
setServiceProviderFinder
Class name of a custom ServiceProviderFinder implementation. -
setCheckIdProductionMode
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). -
setMarkInitialStateWhenApplyBuildView
no description. -
setWrapTagExceptionsAsContextAware
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. -
setCacheElExpressions
Indicates if expressions generated by facelets should be cached or not. -
setViewPoolMaxPoolSize
Defines the number of views to be hold per each view metadata definition. -
setViewPoolMaxDynamicPartialLimit
Defines the limit of the views that cannot be reused partially. -
setViewPoolEntryMode
Defines the type of memory reference that is used to hold the view into memory. -
setExpressionFactory
This parameter specifies the ExpressionFactory implementation to use. -
setInitializeAlwaysStandalone
If this param is set to true, the check for faces servlet mapping is not done. -
setFacesInitializer
Class name of a custom FacesInitializer implementation. -
setFacesInitPlugins
comma delimited list of plugin classes which can be hooked into myfaces. -
equals
-
canEqual
-
hashCode
public int hashCode() -
toString
-
getDefaultWindowMode
@Deprecated @DeprecatedConfigurationProperty(replacement="joinfaces.faces.client-window-mode") public String getDefaultWindowMode()Deprecated.no description. -
getUseMultipleJsFilesForJsfUncompressedJs
@Deprecated @DeprecatedConfigurationProperty(reason="Removed in MyFaces 4.0.0") public Boolean getUseMultipleJsFilesForJsfUncompressedJs()Deprecated.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. -
getJsfJsMode
@Deprecated @DeprecatedConfigurationProperty(reason="Removed in MyFaces 4.0.0") public String getJsfJsMode()Deprecated.Define the mode used for jsf.
-