@ConfigurationProperties(prefix="jsf.omnifaces") public class OmnifacesProperties extends java.lang.Object implements ServletContextInitParameterProperties
Constructor and Description |
---|
OmnifacesProperties() |
Modifier and Type | Method and Description |
---|---|
protected boolean |
canEqual(java.lang.Object other) |
boolean |
equals(java.lang.Object o) |
java.lang.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.
|
java.lang.Class<?> |
getCacheProvider()
org.omnifaces.CACHE_PROVIDER.
|
java.lang.Integer |
getCacheSettingApplicationMaxCapacity()
Sets the maximum number of elements that will be stored per web module (application scope).
|
java.lang.Integer |
getCacheSettingApplicationTtl()
Sets the maximum amount of time in seconds that cached content is valid for the application scope.
|
java.lang.Integer |
getCacheSettingSessionMaxCapacity()
Sets the maximum number of elements that will be stored per session.
|
java.lang.Integer |
getCacheSettingSessionTtl()
Sets the maximum amount of time in seconds that cached content is valid for the session scope.
|
java.lang.Boolean |
getCdnResourceHandlerDisabled()
org.omnifaces.CDN_RESOURCE_HANDLER_DISABLED.
|
java.lang.String |
getCdnResourceHandlerUrls()
org.omnifaces.CDN_RESOURCE_HANDLER_URLS.
|
java.lang.Integer |
getCombinedResourceHandlerCacheTtl()
Set with a value greater than 0 to activate server-side caching of the combined resource files.
|
java.lang.Boolean |
getCombinedResourceHandlerDisabled()
org.omnifaces.COMBINED_RESOURCE_HANDLER_DISABLED.
|
java.util.List<java.lang.String> |
getCombinedResourceHandlerExcludedResources()
List of resource identifiers of
<h:head> resources which needs to be excluded
from combining. |
java.lang.Boolean |
getCombinedResourceHandlerInlineCss()
Set to
true if you want to render the combined CSS resources inline (embedded in HTML) instead of as a
resource. |
java.lang.Boolean |
getCombinedResourceHandlerInlineJs()
Set to
true if you want to render the combined JS resources inline (embedded in HTML) instead of as a
resource. |
java.util.List<java.lang.String> |
getCombinedResourceHandlerSuppressedResources()
List of resource identifiers of
<h:head> resources which needs to be suppressed
and removed. |
java.lang.String |
getDefaultcache()
org.omnifaces.defaultcache.
|
java.util.List<java.lang.Class<? extends java.lang.Throwable>> |
getExceptionTypesToUnwrap()
org.omnifaces.EXCEPTION_TYPES_TO_UNWRAP.
|
java.lang.String |
getFacesViewsDispatchMethod()
org.omnifaces.FACES_VIEWS_DISPATCH_METHOD.
|
java.lang.Boolean |
getFacesViewsEnabled()
org.omnifaces.FACES_VIEWS_ENABLED.
|
java.lang.String |
getFacesViewsExtensionAction()
org.omnifaces.FACES_VIEWS_EXTENSION_ACTION.
|
java.lang.String |
getFacesViewsFilterAfterDeclaredFilters()
org.omnifaces.FACES_VIEWS_FILTER_AFTER_DECLARED_FILTERS.
|
java.lang.String |
getFacesViewsPathAction()
org.omnifaces.FACES_VIEWS_PATH_ACTION.
|
java.lang.Boolean |
getFacesViewsScannedViewsAlwaysExtensionless()
org.omnifaces.FACES_VIEWS_SCANNED_VIEWS_ALWAYS_EXTENSIONLESS.
|
java.util.List<java.lang.String> |
getFacesViewsScanPaths()
List of paths that are to be scanned by faces views.
|
java.lang.String |
getFacesViewsViewHandlerMode()
org.omnifaces.FACES_VIEWS_VIEW_HANDLER_MODE.
|
java.lang.String |
getHtml5RenderKitPassthroughAttributes()
org.omnifaces.HTML5_RENDER_KIT_PASSTHROUGH_ATTRIBUTES.
|
int |
hashCode() |
void |
setCacheInstallBufferFilter(java.lang.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(java.lang.Class<?> cacheProvider)
org.omnifaces.CACHE_PROVIDER.
|
void |
setCacheSettingApplicationMaxCapacity(java.lang.Integer cacheSettingApplicationMaxCapacity)
Sets the maximum number of elements that will be stored per web module (application scope).
|
void |
setCacheSettingApplicationTtl(java.lang.Integer cacheSettingApplicationTtl)
Sets the maximum amount of time in seconds that cached content is valid for the application scope.
|
void |
setCacheSettingSessionMaxCapacity(java.lang.Integer cacheSettingSessionMaxCapacity)
Sets the maximum number of elements that will be stored per session.
|
void |
setCacheSettingSessionTtl(java.lang.Integer cacheSettingSessionTtl)
Sets the maximum amount of time in seconds that cached content is valid for the session scope.
|
void |
setCdnResourceHandlerDisabled(java.lang.Boolean cdnResourceHandlerDisabled)
org.omnifaces.CDN_RESOURCE_HANDLER_DISABLED.
|
void |
setCdnResourceHandlerUrls(java.lang.String cdnResourceHandlerUrls)
org.omnifaces.CDN_RESOURCE_HANDLER_URLS.
|
void |
setCombinedResourceHandlerCacheTtl(java.lang.Integer combinedResourceHandlerCacheTtl)
Set with a value greater than 0 to activate server-side caching of the combined resource files.
|
void |
setCombinedResourceHandlerDisabled(java.lang.Boolean combinedResourceHandlerDisabled)
org.omnifaces.COMBINED_RESOURCE_HANDLER_DISABLED.
|
void |
setCombinedResourceHandlerExcludedResources(java.util.List<java.lang.String> combinedResourceHandlerExcludedResources)
List of resource identifiers of
<h:head> resources which needs to be excluded
from combining. |
void |
setCombinedResourceHandlerInlineCss(java.lang.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(java.lang.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(java.util.List<java.lang.String> combinedResourceHandlerSuppressedResources)
List of resource identifiers of
<h:head> resources which needs to be suppressed
and removed. |
void |
setDefaultcache(java.lang.String defaultcache)
org.omnifaces.defaultcache.
|
void |
setExceptionTypesToUnwrap(java.util.List<java.lang.Class<? extends java.lang.Throwable>> exceptionTypesToUnwrap)
org.omnifaces.EXCEPTION_TYPES_TO_UNWRAP.
|
void |
setFacesViewsDispatchMethod(java.lang.String facesViewsDispatchMethod)
org.omnifaces.FACES_VIEWS_DISPATCH_METHOD.
|
void |
setFacesViewsEnabled(java.lang.Boolean facesViewsEnabled)
org.omnifaces.FACES_VIEWS_ENABLED.
|
void |
setFacesViewsExtensionAction(java.lang.String facesViewsExtensionAction)
org.omnifaces.FACES_VIEWS_EXTENSION_ACTION.
|
void |
setFacesViewsFilterAfterDeclaredFilters(java.lang.String facesViewsFilterAfterDeclaredFilters)
org.omnifaces.FACES_VIEWS_FILTER_AFTER_DECLARED_FILTERS.
|
void |
setFacesViewsPathAction(java.lang.String facesViewsPathAction)
org.omnifaces.FACES_VIEWS_PATH_ACTION.
|
void |
setFacesViewsScannedViewsAlwaysExtensionless(java.lang.Boolean facesViewsScannedViewsAlwaysExtensionless)
org.omnifaces.FACES_VIEWS_SCANNED_VIEWS_ALWAYS_EXTENSIONLESS.
|
void |
setFacesViewsScanPaths(java.util.List<java.lang.String> facesViewsScanPaths)
List of paths that are to be scanned by faces views.
|
void |
setFacesViewsViewHandlerMode(java.lang.String facesViewsViewHandlerMode)
org.omnifaces.FACES_VIEWS_VIEW_HANDLER_MODE.
|
void |
setHtml5RenderKitPassthroughAttributes(java.lang.String html5RenderKitPassthroughAttributes)
org.omnifaces.HTML5_RENDER_KIT_PASSTHROUGH_ATTRIBUTES.
|
java.lang.String |
toString() |
public java.lang.Class<?> getCacheProvider()
CacheInitializerListener.CACHE_PROVIDER_INIT_PARAM_NAME
public java.lang.String getDefaultcache()
CacheInstancePerScopeProvider.DEFAULT_CACHE_PARAM_NAME
public java.util.List<java.lang.Class<? extends java.lang.Throwable>> getExceptionTypesToUnwrap()
FullAjaxExceptionHandler.PARAM_NAME_EXCEPTION_TYPES_TO_UNWRAP
public java.lang.String getFacesViewsDispatchMethod()
FacesViews.FACES_VIEWS_DISPATCH_METHOD_PARAM_NAME
public java.lang.Boolean getFacesViewsEnabled()
FacesViews.FACES_VIEWS_ENABLED_PARAM_NAME
public java.lang.String getFacesViewsExtensionAction()
FacesViews.FACES_VIEWS_EXTENSION_ACTION_PARAM_NAME
public java.lang.String getFacesViewsFilterAfterDeclaredFilters()
FacesViews.FACES_VIEWS_FILTER_AFTER_DECLARED_FILTERS_PARAM_NAME
public java.lang.String getFacesViewsPathAction()
FacesViews.FACES_VIEWS_PATH_ACTION_PARAM_NAME
public java.util.List<java.lang.String> getFacesViewsScanPaths()
FacesViews.FACES_VIEWS_SCAN_PATHS_PARAM_NAME
public java.lang.Boolean getFacesViewsScannedViewsAlwaysExtensionless()
FacesViews.FACES_VIEWS_SCANNED_VIEWS_EXTENSIONLESS_PARAM_NAME
public java.lang.String getFacesViewsViewHandlerMode()
FacesViews.FACES_VIEWS_VIEW_HANDLER_MODE_PARAM_NAME
public java.lang.String getHtml5RenderKitPassthroughAttributes()
Html5RenderKit.PARAM_NAME_PASSTHROUGH_ATTRIBUTES
public java.lang.Boolean getCdnResourceHandlerDisabled()
CDNResourceHandler.PARAM_NAME_CDN_DISABLED
public java.lang.String getCdnResourceHandlerUrls()
CDNResourceHandler.PARAM_NAME_CDN_RESOURCES
public java.lang.Integer getCombinedResourceHandlerCacheTtl()
Development
.CombinedResourceHandler.PARAM_NAME_CACHE_TTL
public java.lang.Boolean getCombinedResourceHandlerDisabled()
CombinedResourceHandler.PARAM_NAME_DISABLED
public java.util.List<java.lang.String> getCombinedResourceHandlerExcludedResources()
<h:head>
resources which needs to be excluded
from combining.CombinedResourceHandler.PARAM_NAME_EXCLUDED_RESOURCES
public java.lang.Boolean getCombinedResourceHandlerInlineCss()
true
if you want to render the combined CSS resources inline (embedded in HTML) instead of as a
resource.CombinedResourceHandler.PARAM_NAME_INLINE_CSS
public java.lang.Boolean getCombinedResourceHandlerInlineJs()
true
if you want to render the combined JS resources inline (embedded in HTML) instead of as a
resource.CombinedResourceHandler.PARAM_NAME_INLINE_JS
public java.util.List<java.lang.String> getCombinedResourceHandlerSuppressedResources()
<h:head>
resources which needs to be suppressed
and removed.CombinedResourceHandler.PARAM_NAME_SUPPRESSED_RESOURCES
public java.lang.Integer getCacheSettingApplicationMaxCapacity()
CacheInitializerListener.CACHE_PROVIDER_SETTING_INIT_PARAM_PREFIX
,
CacheInstancePerScopeProvider.APP_MAX_CAP_PARAM_NAME
public java.lang.Integer getCacheSettingApplicationTtl()
CacheInitializerListener.CACHE_PROVIDER_SETTING_INIT_PARAM_PREFIX
,
CacheInstancePerScopeProvider.APP_TTL_PARAM_NAME
public java.lang.Integer getCacheSettingSessionMaxCapacity()
CacheInitializerListener.CACHE_PROVIDER_SETTING_INIT_PARAM_PREFIX
,
CacheInstancePerScopeProvider.SESSION_MAX_CAP_PARAM_NAME
public java.lang.Integer getCacheSettingSessionTtl()
CacheInitializerListener.CACHE_PROVIDER_SETTING_INIT_PARAM_PREFIX
,
CacheInstancePerScopeProvider.SESSION_TTL_PARAM_NAME
public java.lang.Boolean getCacheInstallBufferFilter()
org.omnifaces.servlet.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.public void setCacheProvider(java.lang.Class<?> cacheProvider)
CacheInitializerListener.CACHE_PROVIDER_INIT_PARAM_NAME
public void setDefaultcache(java.lang.String defaultcache)
CacheInstancePerScopeProvider.DEFAULT_CACHE_PARAM_NAME
public void setExceptionTypesToUnwrap(java.util.List<java.lang.Class<? extends java.lang.Throwable>> exceptionTypesToUnwrap)
FullAjaxExceptionHandler.PARAM_NAME_EXCEPTION_TYPES_TO_UNWRAP
public void setFacesViewsDispatchMethod(java.lang.String facesViewsDispatchMethod)
FacesViews.FACES_VIEWS_DISPATCH_METHOD_PARAM_NAME
public void setFacesViewsEnabled(java.lang.Boolean facesViewsEnabled)
FacesViews.FACES_VIEWS_ENABLED_PARAM_NAME
public void setFacesViewsExtensionAction(java.lang.String facesViewsExtensionAction)
FacesViews.FACES_VIEWS_EXTENSION_ACTION_PARAM_NAME
public void setFacesViewsFilterAfterDeclaredFilters(java.lang.String facesViewsFilterAfterDeclaredFilters)
FacesViews.FACES_VIEWS_FILTER_AFTER_DECLARED_FILTERS_PARAM_NAME
public void setFacesViewsPathAction(java.lang.String facesViewsPathAction)
FacesViews.FACES_VIEWS_PATH_ACTION_PARAM_NAME
public void setFacesViewsScanPaths(java.util.List<java.lang.String> facesViewsScanPaths)
FacesViews.FACES_VIEWS_SCAN_PATHS_PARAM_NAME
public void setFacesViewsScannedViewsAlwaysExtensionless(java.lang.Boolean facesViewsScannedViewsAlwaysExtensionless)
FacesViews.FACES_VIEWS_SCANNED_VIEWS_EXTENSIONLESS_PARAM_NAME
public void setFacesViewsViewHandlerMode(java.lang.String facesViewsViewHandlerMode)
FacesViews.FACES_VIEWS_VIEW_HANDLER_MODE_PARAM_NAME
public void setHtml5RenderKitPassthroughAttributes(java.lang.String html5RenderKitPassthroughAttributes)
Html5RenderKit.PARAM_NAME_PASSTHROUGH_ATTRIBUTES
public void setCdnResourceHandlerDisabled(java.lang.Boolean cdnResourceHandlerDisabled)
CDNResourceHandler.PARAM_NAME_CDN_DISABLED
public void setCdnResourceHandlerUrls(java.lang.String cdnResourceHandlerUrls)
CDNResourceHandler.PARAM_NAME_CDN_RESOURCES
public void setCombinedResourceHandlerCacheTtl(java.lang.Integer combinedResourceHandlerCacheTtl)
Development
.CombinedResourceHandler.PARAM_NAME_CACHE_TTL
public void setCombinedResourceHandlerDisabled(java.lang.Boolean combinedResourceHandlerDisabled)
CombinedResourceHandler.PARAM_NAME_DISABLED
public void setCombinedResourceHandlerExcludedResources(java.util.List<java.lang.String> combinedResourceHandlerExcludedResources)
<h:head>
resources which needs to be excluded
from combining.CombinedResourceHandler.PARAM_NAME_EXCLUDED_RESOURCES
public void setCombinedResourceHandlerInlineCss(java.lang.Boolean combinedResourceHandlerInlineCss)
true
if you want to render the combined CSS resources inline (embedded in HTML) instead of as a
resource.CombinedResourceHandler.PARAM_NAME_INLINE_CSS
public void setCombinedResourceHandlerInlineJs(java.lang.Boolean combinedResourceHandlerInlineJs)
true
if you want to render the combined JS resources inline (embedded in HTML) instead of as a
resource.CombinedResourceHandler.PARAM_NAME_INLINE_JS
public void setCombinedResourceHandlerSuppressedResources(java.util.List<java.lang.String> combinedResourceHandlerSuppressedResources)
<h:head>
resources which needs to be suppressed
and removed.CombinedResourceHandler.PARAM_NAME_SUPPRESSED_RESOURCES
public void setCacheSettingApplicationMaxCapacity(java.lang.Integer cacheSettingApplicationMaxCapacity)
CacheInitializerListener.CACHE_PROVIDER_SETTING_INIT_PARAM_PREFIX
,
CacheInstancePerScopeProvider.APP_MAX_CAP_PARAM_NAME
public void setCacheSettingApplicationTtl(java.lang.Integer cacheSettingApplicationTtl)
CacheInitializerListener.CACHE_PROVIDER_SETTING_INIT_PARAM_PREFIX
,
CacheInstancePerScopeProvider.APP_TTL_PARAM_NAME
public void setCacheSettingSessionMaxCapacity(java.lang.Integer cacheSettingSessionMaxCapacity)
CacheInitializerListener.CACHE_PROVIDER_SETTING_INIT_PARAM_PREFIX
,
CacheInstancePerScopeProvider.SESSION_MAX_CAP_PARAM_NAME
public void setCacheSettingSessionTtl(java.lang.Integer cacheSettingSessionTtl)
CacheInitializerListener.CACHE_PROVIDER_SETTING_INIT_PARAM_PREFIX
,
CacheInstancePerScopeProvider.SESSION_TTL_PARAM_NAME
public void setCacheInstallBufferFilter(java.lang.Boolean cacheInstallBufferFilter)
org.omnifaces.servlet.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.public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
protected boolean canEqual(java.lang.Object other)
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object