Package org.joinfaces.autoconfigure.omnifaces

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

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<? extends CacheProvider>	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 to true if you want to render the combined CSS resources inline (embedded in HTML) instead of as a resource.
Boolean	getCombinedResourceHandlerInlineJs()	Set to true 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<? extends CacheProvider> 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 to true if you want to render the combined CSS resources inline (embedded in HTML) instead of as a resource.
void	setCombinedResourceHandlerInlineJs(Boolean combinedResourceHandlerInlineJs)	Set to true 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()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

OmnifacesProperties

public OmnifacesProperties()

Method Details

getCacheProvider

public Class<? extends CacheProvider> getCacheProvider()

org.omnifaces.CACHE_PROVIDER.

See Also:

• CacheInitializer.CACHE_PROVIDER_INIT_PARAM_NAME

getDefaultcache

public String getDefaultcache()

org.omnifaces.defaultcache.

See Also:

• CacheInstancePerScopeProvider.DEFAULT_CACHE_PARAM_NAME

getExceptionTypesToUnwrap

public List<Class<? extends Throwable>> getExceptionTypesToUnwrap()

org.omnifaces.EXCEPTION_TYPES_TO_UNWRAP.

See Also:

• FullAjaxExceptionHandler.PARAM_NAME_EXCEPTION_TYPES_TO_UNWRAP

getFacesViewsDispatchMethod

public String getFacesViewsDispatchMethod()

org.omnifaces.FACES_VIEWS_DISPATCH_METHOD.

See Also:

• FacesViews#FACES_VIEWS_DISPATCH_METHOD_PARAM_NAME

getFacesViewsEnabled

public Boolean getFacesViewsEnabled()

org.omnifaces.FACES_VIEWS_ENABLED.

See Also:

• FacesViews.FACES_VIEWS_ENABLED_PARAM_NAME

getFacesViewsExtensionAction

public String getFacesViewsExtensionAction()

org.omnifaces.FACES_VIEWS_EXTENSION_ACTION.

See Also:

• FacesViews.FACES_VIEWS_EXTENSION_ACTION_PARAM_NAME

getFacesViewsFilterAfterDeclaredFilters

public String getFacesViewsFilterAfterDeclaredFilters()

org.omnifaces.FACES_VIEWS_FILTER_AFTER_DECLARED_FILTERS.

See Also:

• FacesViews.FACES_VIEWS_FILTER_AFTER_DECLARED_FILTERS_PARAM_NAME

getFacesViewsPathAction

public String getFacesViewsPathAction()

org.omnifaces.FACES_VIEWS_PATH_ACTION.

See Also:

• FacesViews.FACES_VIEWS_PATH_ACTION_PARAM_NAME

getFacesViewsScanPaths

public List<String> getFacesViewsScanPaths()

List of paths that are to be scanned by faces views.

See Also:

• FacesViews.FACES_VIEWS_SCAN_PATHS_PARAM_NAME

getFacesViewsScannedViewsAlwaysExtensionless

public Boolean getFacesViewsScannedViewsAlwaysExtensionless()

org.omnifaces.FACES_VIEWS_SCANNED_VIEWS_ALWAYS_EXTENSIONLESS.

See Also:

• FacesViews.FACES_VIEWS_SCANNED_VIEWS_EXTENSIONLESS_PARAM_NAME

getFacesViewsViewHandlerMode

public String getFacesViewsViewHandlerMode()

org.omnifaces.FACES_VIEWS_VIEW_HANDLER_MODE.

See Also:

• FacesViews#FACES_VIEWS_VIEW_HANDLER_MODE_PARAM_NAME

getHtml5RenderKitPassthroughAttributes

public String getHtml5RenderKitPassthroughAttributes()

org.omnifaces.HTML5_RENDER_KIT_PASSTHROUGH_ATTRIBUTES.

See Also:

• Html5RenderKit#PARAM_NAME_PASSTHROUGH_ATTRIBUTES

getCdnResourceHandlerDisabled

public Boolean getCdnResourceHandlerDisabled()

org.omnifaces.CDN_RESOURCE_HANDLER_DISABLED.

See Also:

• CDNResourceHandler.PARAM_NAME_CDN_DISABLED

getCdnResourceHandlerUrls

public String getCdnResourceHandlerUrls()

org.omnifaces.CDN_RESOURCE_HANDLER_URLS.

See Also:

• CDNResourceHandler.PARAM_NAME_CDN_RESOURCES

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 to Development.

See Also:

• CombinedResourceHandler.PARAM_NAME_CACHE_TTL

getCombinedResourceHandlerDisabled

public Boolean getCombinedResourceHandlerDisabled()

org.omnifaces.COMBINED_RESOURCE_HANDLER_DISABLED.

See Also:

• CombinedResourceHandler.PARAM_NAME_DISABLED

getCombinedResourceHandlerExcludedResources

public List<String> getCombinedResourceHandlerExcludedResources()

List of resource identifiers of <h:head> resources which needs to be excluded from combining.

See Also:

• CombinedResourceHandler.PARAM_NAME_EXCLUDED_RESOURCES

getCombinedResourceHandlerInlineCss

public Boolean getCombinedResourceHandlerInlineCss()

Set to true if you want to render the combined CSS resources inline (embedded in HTML) instead of as a resource.

See Also:

• CombinedResourceHandler.PARAM_NAME_INLINE_CSS

getCombinedResourceHandlerInlineJs

public Boolean getCombinedResourceHandlerInlineJs()

Set to true if you want to render the combined JS resources inline (embedded in HTML) instead of as a resource.

See Also:

• CombinedResourceHandler.PARAM_NAME_INLINE_JS

getCombinedResourceHandlerSuppressedResources

public List<String> getCombinedResourceHandlerSuppressedResources()

List of resource identifiers of <h:head> resources which needs to be suppressed and removed.

See Also:

• CombinedResourceHandler.PARAM_NAME_SUPPRESSED_RESOURCES

getCacheSettingApplicationMaxCapacity

public Integer getCacheSettingApplicationMaxCapacity()

Sets the maximum number of elements that will be stored per web module (application scope). Default: no limit

See Also:

• CacheInitializer.CACHE_PROVIDER_SETTING_INIT_PARAM_PREFIX
• CacheInstancePerScopeProvider.APP_MAX_CAP_PARAM_NAME

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.

See Also:

• CacheInitializerListener#CACHE_PROVIDER_SETTING_INIT_PARAM_PREFIX
• CacheInstancePerScopeProvider.APP_TTL_PARAM_NAME

getCacheSettingSessionMaxCapacity

public Integer getCacheSettingSessionMaxCapacity()

Sets the maximum number of elements that will be stored per session. Default: no limit.

See Also:

• CacheInitializerListener#CACHE_PROVIDER_SETTING_INIT_PARAM_PREFIX
• CacheInstancePerScopeProvider.SESSION_MAX_CAP_PARAM_NAME

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.

See Also:

• CacheInitializerListener#CACHE_PROVIDER_SETTING_INIT_PARAM_PREFIX
• CacheInstancePerScopeProvider.SESSION_TTL_PARAM_NAME

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 the BufferedHttpServletResponse 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<? extends CacheProvider> cacheProvider)

org.omnifaces.CACHE_PROVIDER.

See Also:

• CacheInitializer.CACHE_PROVIDER_INIT_PARAM_NAME

setDefaultcache

public void setDefaultcache(String defaultcache)

org.omnifaces.defaultcache.

See Also:

• CacheInstancePerScopeProvider.DEFAULT_CACHE_PARAM_NAME

setExceptionTypesToUnwrap

public void setExceptionTypesToUnwrap(List<Class<? extends Throwable>> exceptionTypesToUnwrap)

org.omnifaces.EXCEPTION_TYPES_TO_UNWRAP.

See Also:

• FullAjaxExceptionHandler.PARAM_NAME_EXCEPTION_TYPES_TO_UNWRAP

setFacesViewsDispatchMethod

public void setFacesViewsDispatchMethod(String facesViewsDispatchMethod)

org.omnifaces.FACES_VIEWS_DISPATCH_METHOD.

See Also:

• FacesViews#FACES_VIEWS_DISPATCH_METHOD_PARAM_NAME

setFacesViewsEnabled

public void setFacesViewsEnabled(Boolean facesViewsEnabled)

org.omnifaces.FACES_VIEWS_ENABLED.

See Also:

• FacesViews.FACES_VIEWS_ENABLED_PARAM_NAME

setFacesViewsExtensionAction

public void setFacesViewsExtensionAction(String facesViewsExtensionAction)

org.omnifaces.FACES_VIEWS_EXTENSION_ACTION.

See Also:

• FacesViews.FACES_VIEWS_EXTENSION_ACTION_PARAM_NAME

setFacesViewsFilterAfterDeclaredFilters

public void setFacesViewsFilterAfterDeclaredFilters(String facesViewsFilterAfterDeclaredFilters)

org.omnifaces.FACES_VIEWS_FILTER_AFTER_DECLARED_FILTERS.

See Also:

• FacesViews.FACES_VIEWS_FILTER_AFTER_DECLARED_FILTERS_PARAM_NAME

setFacesViewsPathAction

public void setFacesViewsPathAction(String facesViewsPathAction)

org.omnifaces.FACES_VIEWS_PATH_ACTION.

See Also:

• FacesViews.FACES_VIEWS_PATH_ACTION_PARAM_NAME

setFacesViewsScanPaths

public void setFacesViewsScanPaths(List<String> facesViewsScanPaths)

List of paths that are to be scanned by faces views.

See Also:

• FacesViews.FACES_VIEWS_SCAN_PATHS_PARAM_NAME

setFacesViewsScannedViewsAlwaysExtensionless

public void setFacesViewsScannedViewsAlwaysExtensionless(Boolean facesViewsScannedViewsAlwaysExtensionless)

org.omnifaces.FACES_VIEWS_SCANNED_VIEWS_ALWAYS_EXTENSIONLESS.

See Also:

• FacesViews.FACES_VIEWS_SCANNED_VIEWS_EXTENSIONLESS_PARAM_NAME

setFacesViewsViewHandlerMode

public void setFacesViewsViewHandlerMode(String facesViewsViewHandlerMode)

org.omnifaces.FACES_VIEWS_VIEW_HANDLER_MODE.

See Also:

• FacesViews#FACES_VIEWS_VIEW_HANDLER_MODE_PARAM_NAME

setHtml5RenderKitPassthroughAttributes

public void setHtml5RenderKitPassthroughAttributes(String html5RenderKitPassthroughAttributes)

org.omnifaces.HTML5_RENDER_KIT_PASSTHROUGH_ATTRIBUTES.

See Also:

• Html5RenderKit#PARAM_NAME_PASSTHROUGH_ATTRIBUTES

setCdnResourceHandlerDisabled

public void setCdnResourceHandlerDisabled(Boolean cdnResourceHandlerDisabled)

org.omnifaces.CDN_RESOURCE_HANDLER_DISABLED.

See Also:

• CDNResourceHandler.PARAM_NAME_CDN_DISABLED

setCdnResourceHandlerUrls

public void setCdnResourceHandlerUrls(String cdnResourceHandlerUrls)

org.omnifaces.CDN_RESOURCE_HANDLER_URLS.

See Also:

• CDNResourceHandler.PARAM_NAME_CDN_RESOURCES

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 to Development.

See Also:

• CombinedResourceHandler.PARAM_NAME_CACHE_TTL

setCombinedResourceHandlerDisabled

public void setCombinedResourceHandlerDisabled(Boolean combinedResourceHandlerDisabled)

org.omnifaces.COMBINED_RESOURCE_HANDLER_DISABLED.

See Also:

• CombinedResourceHandler.PARAM_NAME_DISABLED

setCombinedResourceHandlerExcludedResources

public void setCombinedResourceHandlerExcludedResources(List<String> combinedResourceHandlerExcludedResources)

List of resource identifiers of <h:head> resources which needs to be excluded from combining.

See Also:

• CombinedResourceHandler.PARAM_NAME_EXCLUDED_RESOURCES

setCombinedResourceHandlerInlineCss

public void setCombinedResourceHandlerInlineCss(Boolean combinedResourceHandlerInlineCss)

Set to true if you want to render the combined CSS resources inline (embedded in HTML) instead of as a resource.

See Also:

• CombinedResourceHandler.PARAM_NAME_INLINE_CSS

setCombinedResourceHandlerInlineJs

public void setCombinedResourceHandlerInlineJs(Boolean combinedResourceHandlerInlineJs)

Set to true if you want to render the combined JS resources inline (embedded in HTML) instead of as a resource.

See Also:

• CombinedResourceHandler.PARAM_NAME_INLINE_JS

setCombinedResourceHandlerSuppressedResources

public void setCombinedResourceHandlerSuppressedResources(List<String> combinedResourceHandlerSuppressedResources)

List of resource identifiers of <h:head> resources which needs to be suppressed and removed.

See Also:

• CombinedResourceHandler.PARAM_NAME_SUPPRESSED_RESOURCES

setCacheSettingApplicationMaxCapacity

public void setCacheSettingApplicationMaxCapacity(Integer cacheSettingApplicationMaxCapacity)

Sets the maximum number of elements that will be stored per web module (application scope). Default: no limit

See Also:

• CacheInitializer.CACHE_PROVIDER_SETTING_INIT_PARAM_PREFIX
• CacheInstancePerScopeProvider.APP_MAX_CAP_PARAM_NAME

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.

See Also:

• CacheInitializerListener#CACHE_PROVIDER_SETTING_INIT_PARAM_PREFIX
• CacheInstancePerScopeProvider.APP_TTL_PARAM_NAME

setCacheSettingSessionMaxCapacity

public void setCacheSettingSessionMaxCapacity(Integer cacheSettingSessionMaxCapacity)

Sets the maximum number of elements that will be stored per session. Default: no limit.

See Also:

• CacheInitializerListener#CACHE_PROVIDER_SETTING_INIT_PARAM_PREFIX
• CacheInstancePerScopeProvider.SESSION_MAX_CAP_PARAM_NAME

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.

See Also:

• CacheInitializerListener#CACHE_PROVIDER_SETTING_INIT_PARAM_PREFIX
• CacheInstancePerScopeProvider.SESSION_TTL_PARAM_NAME

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 the BufferedHttpServletResponse 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.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object