Class OmnifacesProperties
- java.lang.Object
-
- org.joinfaces.autoconfigure.omnifaces.OmnifacesProperties
-
- All Implemented Interfaces:
ServletContextInitParameterProperties
@ConfigurationProperties(prefix="joinfaces.omnifaces") public class OmnifacesProperties extends Object implements ServletContextInitParameterProperties
Configuration properties of OmniFaces. Taken from https://central.maven.org/maven2/org/omnifaces/omnifaces/1.13/omnifaces-1.13-javadoc.jar
-
-
Constructor Summary
Constructors Constructor Description OmnifacesProperties()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected boolean
canEqual(Object other)
boolean
equals(Object o)
Boolean
getCacheInstallBufferFilter()
Boolean that when true installs a Servlet Filter (Servlet 3.0+ only) that works in conjunction with the useBuffer attribute of the Cache component to enable an alternative way to grab the content that needs to be cached.Class<?>
getCacheProvider()
org.omnifaces.CACHE_PROVIDER.Integer
getCacheSettingApplicationMaxCapacity()
Sets the maximum number of elements that will be stored per web module (application scope).Duration
getCacheSettingApplicationTtl()
Sets the maximum amount of time in seconds that cached content is valid for the application scope.Integer
getCacheSettingSessionMaxCapacity()
Sets the maximum number of elements that will be stored per session.Duration
getCacheSettingSessionTtl()
Sets the maximum amount of time in seconds that cached content is valid for the session scope.Boolean
getCdnResourceHandlerDisabled()
org.omnifaces.CDN_RESOURCE_HANDLER_DISABLED.String
getCdnResourceHandlerUrls()
org.omnifaces.CDN_RESOURCE_HANDLER_URLS.Duration
getCombinedResourceHandlerCacheTtl()
Set with a value greater than 0 to activate server-side caching of the combined resource files.Boolean
getCombinedResourceHandlerDisabled()
org.omnifaces.COMBINED_RESOURCE_HANDLER_DISABLED.List<String>
getCombinedResourceHandlerExcludedResources()
List of resource identifiers of<h:head>
resources which needs to be excluded from combining.Boolean
getCombinedResourceHandlerInlineCss()
Set totrue
if you want to render the combined CSS resources inline (embedded in HTML) instead of as a resource.Boolean
getCombinedResourceHandlerInlineJs()
Set totrue
if you want to render the combined JS resources inline (embedded in HTML) instead of as a resource.List<String>
getCombinedResourceHandlerSuppressedResources()
List of resource identifiers of<h:head>
resources which needs to be suppressed and removed.String
getDefaultcache()
org.omnifaces.defaultcache.List<Class<? extends Throwable>>
getExceptionTypesToUnwrap()
org.omnifaces.EXCEPTION_TYPES_TO_UNWRAP.String
getFacesViewsDispatchMethod()
org.omnifaces.FACES_VIEWS_DISPATCH_METHOD.Boolean
getFacesViewsEnabled()
org.omnifaces.FACES_VIEWS_ENABLED.String
getFacesViewsExtensionAction()
org.omnifaces.FACES_VIEWS_EXTENSION_ACTION.String
getFacesViewsFilterAfterDeclaredFilters()
org.omnifaces.FACES_VIEWS_FILTER_AFTER_DECLARED_FILTERS.String
getFacesViewsPathAction()
org.omnifaces.FACES_VIEWS_PATH_ACTION.Boolean
getFacesViewsScannedViewsAlwaysExtensionless()
org.omnifaces.FACES_VIEWS_SCANNED_VIEWS_ALWAYS_EXTENSIONLESS.List<String>
getFacesViewsScanPaths()
List of paths that are to be scanned by faces views.String
getFacesViewsViewHandlerMode()
org.omnifaces.FACES_VIEWS_VIEW_HANDLER_MODE.String
getHtml5RenderKitPassthroughAttributes()
org.omnifaces.HTML5_RENDER_KIT_PASSTHROUGH_ATTRIBUTES.int
hashCode()
void
setCacheInstallBufferFilter(Boolean cacheInstallBufferFilter)
Boolean that when true installs a Servlet Filter (Servlet 3.0+ only) that works in conjunction with the useBuffer attribute of the Cache component to enable an alternative way to grab the content that needs to be cached.void
setCacheProvider(Class<?> cacheProvider)
org.omnifaces.CACHE_PROVIDER.void
setCacheSettingApplicationMaxCapacity(Integer cacheSettingApplicationMaxCapacity)
Sets the maximum number of elements that will be stored per web module (application scope).void
setCacheSettingApplicationTtl(Duration cacheSettingApplicationTtl)
Sets the maximum amount of time in seconds that cached content is valid for the application scope.void
setCacheSettingSessionMaxCapacity(Integer cacheSettingSessionMaxCapacity)
Sets the maximum number of elements that will be stored per session.void
setCacheSettingSessionTtl(Duration cacheSettingSessionTtl)
Sets the maximum amount of time in seconds that cached content is valid for the session scope.void
setCdnResourceHandlerDisabled(Boolean cdnResourceHandlerDisabled)
org.omnifaces.CDN_RESOURCE_HANDLER_DISABLED.void
setCdnResourceHandlerUrls(String cdnResourceHandlerUrls)
org.omnifaces.CDN_RESOURCE_HANDLER_URLS.void
setCombinedResourceHandlerCacheTtl(Duration combinedResourceHandlerCacheTtl)
Set with a value greater than 0 to activate server-side caching of the combined resource files.void
setCombinedResourceHandlerDisabled(Boolean combinedResourceHandlerDisabled)
org.omnifaces.COMBINED_RESOURCE_HANDLER_DISABLED.void
setCombinedResourceHandlerExcludedResources(List<String> combinedResourceHandlerExcludedResources)
List of resource identifiers of<h:head>
resources which needs to be excluded from combining.void
setCombinedResourceHandlerInlineCss(Boolean combinedResourceHandlerInlineCss)
Set totrue
if you want to render the combined CSS resources inline (embedded in HTML) instead of as a resource.void
setCombinedResourceHandlerInlineJs(Boolean combinedResourceHandlerInlineJs)
Set totrue
if you want to render the combined JS resources inline (embedded in HTML) instead of as a resource.void
setCombinedResourceHandlerSuppressedResources(List<String> combinedResourceHandlerSuppressedResources)
List of resource identifiers of<h:head>
resources which needs to be suppressed and removed.void
setDefaultcache(String defaultcache)
org.omnifaces.defaultcache.void
setExceptionTypesToUnwrap(List<Class<? extends Throwable>> exceptionTypesToUnwrap)
org.omnifaces.EXCEPTION_TYPES_TO_UNWRAP.void
setFacesViewsDispatchMethod(String facesViewsDispatchMethod)
org.omnifaces.FACES_VIEWS_DISPATCH_METHOD.void
setFacesViewsEnabled(Boolean facesViewsEnabled)
org.omnifaces.FACES_VIEWS_ENABLED.void
setFacesViewsExtensionAction(String facesViewsExtensionAction)
org.omnifaces.FACES_VIEWS_EXTENSION_ACTION.void
setFacesViewsFilterAfterDeclaredFilters(String facesViewsFilterAfterDeclaredFilters)
org.omnifaces.FACES_VIEWS_FILTER_AFTER_DECLARED_FILTERS.void
setFacesViewsPathAction(String facesViewsPathAction)
org.omnifaces.FACES_VIEWS_PATH_ACTION.void
setFacesViewsScannedViewsAlwaysExtensionless(Boolean facesViewsScannedViewsAlwaysExtensionless)
org.omnifaces.FACES_VIEWS_SCANNED_VIEWS_ALWAYS_EXTENSIONLESS.void
setFacesViewsScanPaths(List<String> facesViewsScanPaths)
List of paths that are to be scanned by faces views.void
setFacesViewsViewHandlerMode(String facesViewsViewHandlerMode)
org.omnifaces.FACES_VIEWS_VIEW_HANDLER_MODE.void
setHtml5RenderKitPassthroughAttributes(String html5RenderKitPassthroughAttributes)
org.omnifaces.HTML5_RENDER_KIT_PASSTHROUGH_ATTRIBUTES.String
toString()
-
-
-
Method Detail
-
getCacheProvider
public Class<?> getCacheProvider()
org.omnifaces.CACHE_PROVIDER.
-
getDefaultcache
public String getDefaultcache()
org.omnifaces.defaultcache.
-
getExceptionTypesToUnwrap
public List<Class<? extends Throwable>> getExceptionTypesToUnwrap()
org.omnifaces.EXCEPTION_TYPES_TO_UNWRAP.
-
getFacesViewsDispatchMethod
public String getFacesViewsDispatchMethod()
org.omnifaces.FACES_VIEWS_DISPATCH_METHOD.
-
getFacesViewsEnabled
public Boolean getFacesViewsEnabled()
org.omnifaces.FACES_VIEWS_ENABLED.
-
getFacesViewsExtensionAction
public String getFacesViewsExtensionAction()
org.omnifaces.FACES_VIEWS_EXTENSION_ACTION.
-
getFacesViewsFilterAfterDeclaredFilters
public String getFacesViewsFilterAfterDeclaredFilters()
org.omnifaces.FACES_VIEWS_FILTER_AFTER_DECLARED_FILTERS.
-
getFacesViewsPathAction
public String getFacesViewsPathAction()
org.omnifaces.FACES_VIEWS_PATH_ACTION.
-
getFacesViewsScanPaths
public List<String> getFacesViewsScanPaths()
List of paths that are to be scanned by faces views.
-
getFacesViewsScannedViewsAlwaysExtensionless
public Boolean getFacesViewsScannedViewsAlwaysExtensionless()
org.omnifaces.FACES_VIEWS_SCANNED_VIEWS_ALWAYS_EXTENSIONLESS.
-
getFacesViewsViewHandlerMode
public String getFacesViewsViewHandlerMode()
org.omnifaces.FACES_VIEWS_VIEW_HANDLER_MODE.
-
getHtml5RenderKitPassthroughAttributes
public String getHtml5RenderKitPassthroughAttributes()
org.omnifaces.HTML5_RENDER_KIT_PASSTHROUGH_ATTRIBUTES.
-
getCdnResourceHandlerDisabled
public Boolean getCdnResourceHandlerDisabled()
org.omnifaces.CDN_RESOURCE_HANDLER_DISABLED.
-
getCdnResourceHandlerUrls
public String getCdnResourceHandlerUrls()
org.omnifaces.CDN_RESOURCE_HANDLER_URLS.
-
getCombinedResourceHandlerCacheTtl
public Duration getCombinedResourceHandlerCacheTtl()
Set with a value greater than 0 to activate server-side caching of the combined resource files. The value is interpreted as cache TTL (time to live) in seconds and is only effective when the JSF project stage is not set toDevelopment
.
-
getCombinedResourceHandlerDisabled
public Boolean getCombinedResourceHandlerDisabled()
org.omnifaces.COMBINED_RESOURCE_HANDLER_DISABLED.
-
getCombinedResourceHandlerExcludedResources
public List<String> getCombinedResourceHandlerExcludedResources()
List of resource identifiers of<h:head>
resources which needs to be excluded from combining.
-
getCombinedResourceHandlerInlineCss
public Boolean getCombinedResourceHandlerInlineCss()
Set totrue
if you want to render the combined CSS resources inline (embedded in HTML) instead of as a resource.
-
getCombinedResourceHandlerInlineJs
public Boolean getCombinedResourceHandlerInlineJs()
Set totrue
if you want to render the combined JS resources inline (embedded in HTML) instead of as a resource.
-
getCombinedResourceHandlerSuppressedResources
public List<String> getCombinedResourceHandlerSuppressedResources()
List of resource identifiers of<h:head>
resources which needs to be suppressed and removed.
-
getCacheSettingApplicationMaxCapacity
public Integer getCacheSettingApplicationMaxCapacity()
Sets the maximum number of elements that will be stored per web module (application scope). Default: no limit
-
getCacheSettingApplicationTtl
public Duration getCacheSettingApplicationTtl()
Sets the maximum amount of time in seconds that cached content is valid for the application scope. Can be overriden by individal cache components. Default: no limit.
-
getCacheSettingSessionMaxCapacity
public Integer getCacheSettingSessionMaxCapacity()
Sets the maximum number of elements that will be stored per session. Default: no limit.
-
getCacheSettingSessionTtl
public Duration getCacheSettingSessionTtl()
Sets the maximum amount of time in seconds that cached content is valid for the session scope. Can be overriden by individal cache components. Default: no limit.
-
getCacheInstallBufferFilter
public Boolean getCacheInstallBufferFilter()
Boolean that when true installs a Servlet Filter (Servlet 3.0+ only) that works in conjunction with the useBuffer attribute of the Cache component to enable an alternative way to grab the content that needs to be cached. This is a convenience setting that is a short-cut for installing theBufferedHttpServletResponse
filter manually. If more finegrained control is needed regarding which place in the filter chain the filter appears and which resources it exactly filters, this setting should not be used and the mentioned filter should be manually configured. Default: false.
-
setCacheProvider
public void setCacheProvider(Class<?> cacheProvider)
org.omnifaces.CACHE_PROVIDER.
-
setDefaultcache
public void setDefaultcache(String defaultcache)
org.omnifaces.defaultcache.
-
setExceptionTypesToUnwrap
public void setExceptionTypesToUnwrap(List<Class<? extends Throwable>> exceptionTypesToUnwrap)
org.omnifaces.EXCEPTION_TYPES_TO_UNWRAP.
-
setFacesViewsDispatchMethod
public void setFacesViewsDispatchMethod(String facesViewsDispatchMethod)
org.omnifaces.FACES_VIEWS_DISPATCH_METHOD.
-
setFacesViewsEnabled
public void setFacesViewsEnabled(Boolean facesViewsEnabled)
org.omnifaces.FACES_VIEWS_ENABLED.
-
setFacesViewsExtensionAction
public void setFacesViewsExtensionAction(String facesViewsExtensionAction)
org.omnifaces.FACES_VIEWS_EXTENSION_ACTION.
-
setFacesViewsFilterAfterDeclaredFilters
public void setFacesViewsFilterAfterDeclaredFilters(String facesViewsFilterAfterDeclaredFilters)
org.omnifaces.FACES_VIEWS_FILTER_AFTER_DECLARED_FILTERS.
-
setFacesViewsPathAction
public void setFacesViewsPathAction(String facesViewsPathAction)
org.omnifaces.FACES_VIEWS_PATH_ACTION.
-
setFacesViewsScanPaths
public void setFacesViewsScanPaths(List<String> facesViewsScanPaths)
List of paths that are to be scanned by faces views.
-
setFacesViewsScannedViewsAlwaysExtensionless
public void setFacesViewsScannedViewsAlwaysExtensionless(Boolean facesViewsScannedViewsAlwaysExtensionless)
org.omnifaces.FACES_VIEWS_SCANNED_VIEWS_ALWAYS_EXTENSIONLESS.
-
setFacesViewsViewHandlerMode
public void setFacesViewsViewHandlerMode(String facesViewsViewHandlerMode)
org.omnifaces.FACES_VIEWS_VIEW_HANDLER_MODE.
-
setHtml5RenderKitPassthroughAttributes
public void setHtml5RenderKitPassthroughAttributes(String html5RenderKitPassthroughAttributes)
org.omnifaces.HTML5_RENDER_KIT_PASSTHROUGH_ATTRIBUTES.
-
setCdnResourceHandlerDisabled
public void setCdnResourceHandlerDisabled(Boolean cdnResourceHandlerDisabled)
org.omnifaces.CDN_RESOURCE_HANDLER_DISABLED.
-
setCdnResourceHandlerUrls
public void setCdnResourceHandlerUrls(String cdnResourceHandlerUrls)
org.omnifaces.CDN_RESOURCE_HANDLER_URLS.
-
setCombinedResourceHandlerCacheTtl
public void setCombinedResourceHandlerCacheTtl(Duration combinedResourceHandlerCacheTtl)
Set with a value greater than 0 to activate server-side caching of the combined resource files. The value is interpreted as cache TTL (time to live) in seconds and is only effective when the JSF project stage is not set toDevelopment
.
-
setCombinedResourceHandlerDisabled
public void setCombinedResourceHandlerDisabled(Boolean combinedResourceHandlerDisabled)
org.omnifaces.COMBINED_RESOURCE_HANDLER_DISABLED.
-
setCombinedResourceHandlerExcludedResources
public void setCombinedResourceHandlerExcludedResources(List<String> combinedResourceHandlerExcludedResources)
List of resource identifiers of<h:head>
resources which needs to be excluded from combining.
-
setCombinedResourceHandlerInlineCss
public void setCombinedResourceHandlerInlineCss(Boolean combinedResourceHandlerInlineCss)
Set totrue
if you want to render the combined CSS resources inline (embedded in HTML) instead of as a resource.
-
setCombinedResourceHandlerInlineJs
public void setCombinedResourceHandlerInlineJs(Boolean combinedResourceHandlerInlineJs)
Set totrue
if you want to render the combined JS resources inline (embedded in HTML) instead of as a resource.
-
setCombinedResourceHandlerSuppressedResources
public void setCombinedResourceHandlerSuppressedResources(List<String> combinedResourceHandlerSuppressedResources)
List of resource identifiers of<h:head>
resources which needs to be suppressed and removed.
-
setCacheSettingApplicationMaxCapacity
public void setCacheSettingApplicationMaxCapacity(Integer cacheSettingApplicationMaxCapacity)
Sets the maximum number of elements that will be stored per web module (application scope). Default: no limit
-
setCacheSettingApplicationTtl
public void setCacheSettingApplicationTtl(Duration cacheSettingApplicationTtl)
Sets the maximum amount of time in seconds that cached content is valid for the application scope. Can be overriden by individal cache components. Default: no limit.
-
setCacheSettingSessionMaxCapacity
public void setCacheSettingSessionMaxCapacity(Integer cacheSettingSessionMaxCapacity)
Sets the maximum number of elements that will be stored per session. Default: no limit.
-
setCacheSettingSessionTtl
public void setCacheSettingSessionTtl(Duration cacheSettingSessionTtl)
Sets the maximum amount of time in seconds that cached content is valid for the session scope. Can be overriden by individal cache components. Default: no limit.
-
setCacheInstallBufferFilter
public void setCacheInstallBufferFilter(Boolean cacheInstallBufferFilter)
Boolean that when true installs a Servlet Filter (Servlet 3.0+ only) that works in conjunction with the useBuffer attribute of the Cache component to enable an alternative way to grab the content that needs to be cached. This is a convenience setting that is a short-cut for installing theBufferedHttpServletResponse
filter manually. If more finegrained control is needed regarding which place in the filter chain the filter appears and which resources it exactly filters, this setting should not be used and the mentioned filter should be manually configured. Default: false.
-
canEqual
protected boolean canEqual(Object other)
-
-