Class OmnifacesProperties

    • Constructor Detail

      • OmnifacesProperties

        public OmnifacesProperties()
    • Method Detail

      • getCacheProvider

        public Class<?> getCacheProvider()
        org.omnifaces.CACHE_PROVIDER.
        See Also:
        CacheInitializerListener.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 Integer 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:
        CacheInitializerListener.CACHE_PROVIDER_SETTING_INIT_PARAM_PREFIX, CacheInstancePerScopeProvider.APP_MAX_CAP_PARAM_NAME
      • getCacheSettingApplicationTtl

        public Integer 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 Integer 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<?> cacheProvider)
        org.omnifaces.CACHE_PROVIDER.
        See Also:
        CacheInitializerListener.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​(Integer 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:
        CacheInitializerListener.CACHE_PROVIDER_SETTING_INIT_PARAM_PREFIX, CacheInstancePerScopeProvider.APP_MAX_CAP_PARAM_NAME
      • setCacheSettingApplicationTtl

        public void setCacheSettingApplicationTtl​(Integer 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​(Integer 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.
      • canEqual

        protected boolean canEqual​(Object other)
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object