WebConfig (CUBA 7.2 API)

All Superinterfaces:

Config
```
public interface WebConfig
extends Config
```
Web Client configuration parameters interface.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`getAllowAnonymousAccess()` Defines whether anonymous user is allowed to access the app.
`boolean`	`getAllowHandleBrowserHistoryBack()` Deprecated. use `getUrlHandlingMode()` instead
`int`	`getAppFoldersRefreshPeriodSec()`
`int`	`getAppLogMaxItemsCount()`
`java.lang.String`	`getAppWindowMode()`
`java.lang.String`	`getAppWindowTheme()`
`java.lang.Integer`	`getBackgroundThreadsCount()`
`int`	`getClientBackgroundTasksLatencySeconds()`
`boolean`	`getCloseIdleHttpSessions()`
`java.util.List<java.lang.String>`	`getCubaHttpFilterBypassUrls()`
`int`	`getCustomDeviceWidthForViewport()`
`boolean`	`getDefaultScreenCanBeClosed()` Defines whether default screen can be closed or not when TABBED work area mode is used.
`java.lang.String`	`getDefaultScreenId()` Defines which screen should be opened after login.
`java.util.List<java.lang.String>`	`getExternalHttpFilterBypassUrls()` Enables to pass additional Cuba HTTP Filter bypass URLs from application components.
`int`	`getFoldersPaneDefaultWidth()`
`boolean`	`getFoldersPaneEnabled()`
`boolean`	`getFoldersPaneVisibleByDefault()`
`boolean`	`getForceRefreshAuthenticatedTabs()` Defines whether app should perform force refresh for browser tabs with authenticated sessions.
`boolean`	`getHtmlSanitizerEnabled()` Defines whether to sanitize the value of components using `HtmlSanitizer` to prevent Cross-site Scripting (XSS) in HTML context.
`int`	`getHttpSessionExpirationTimeoutSec()`
`java.lang.String`	`getInitialScreenId()` Defines the screen that will be open for non-authenticated user when an application opened.
`java.util.List<java.lang.String>`	`getLinkHandlerActions()`
`java.lang.String`	`getLoginAction()`
`java.lang.String`	`getLoginDialogDefaultPassword()`
`java.lang.String`	`getLoginDialogDefaultUser()`
`boolean`	`getLoginDialogPoweredByLinkVisible()`
`java.lang.String`	`getLoginScreenId()` Defines the screen that will be used as Login screen: new `LoginScreen` or legacy `AppLoginWindow`.
`int`	`getLogLongRequestsThresholdSec()`
`java.util.List<java.lang.String>`	`getLoweredAttentionPatterns()` Defines the list of regular expression patterns that are applied to each row of the log in the Server Log window.
`java.lang.String`	`getMainScreenId()` Defines the screen that will be used as Main screen: new `MainScreen` or legacy `AppMainWindow`.
`int`	`getMainTabCaptionLength()`
`MainTabSheetMode`	`getMainTabSheetMode()` Sets whether default `CubaMainTabSheet` or `CubaManagedTabSheet` will be used in AppWorkArea.
`ManagedMainTabSheetMode`	`getManagedMainTabSheetMode()` Sets how the managed main TabSheet switches its tabs: hides or unloads them.
`java.lang.Integer`	`getMaxActiveBackgroundTasksCount()` Deprecated. use `getBackgroundThreadsCount()`
`int`	`getMaxTabCount()`
`java.lang.Integer`	`getMinBackgroundThreadsCount()` Deprecated. use `getBackgroundThreadsCount()`
`java.lang.String`	`getPageInitialScale()`
`boolean`	`getProductionMode()`
`boolean`	`getPushEnabled()`
`int`	`getPushLongPollingSuspendTimeoutMs()` Returns push timeout in milliseconds, which is used in case of using long polling transport, i.e.
`boolean`	`getRememberMeEnabled()`
`java.lang.String`	`getResourcesRoot()`
`java.lang.String`	`getServerErrorPageTemplate()`
`boolean`	`getShowBreadCrumbs()`
`boolean`	`getShowFolderIcons()`
`double`	`getTableCacheRate()` This property adjusts a possible caching mechanism of table implementation.
`int`	`getTablePageLength()` Sets the page length for Table implementation - count of rows for first rendering of Table.
`int`	`getUiHeartbeatIntervalSec()`
`java.lang.String`	`getUnsupportedPagePath()` Defines the path to the unsupported HTML page that is shown when an application doesn't support the current browser version.
`UrlHandlingMode`	`getUrlHandlingMode()`
`boolean`	`getUseDeviceWidthForViewport()`
`boolean`	`getUseInverseHeader()`
`boolean`	`getUseLocalServiceInvocation()`
`boolean`	`getUsePushLongPolling()`
`boolean`	`getUserCanChooseDefaultScreen()` Defines whether a user is able to choose the default screen or not.
`boolean`	`getUseRedirectWithBlankPageForLinkAction()`
`boolean`	`getUseSessionFixationProtection()` Reinitialize session after login to protect from Session Fixation attacks.
`java.util.List<java.lang.String>`	`getViewFileExtensions()`
`long`	`getWebJarResourcesCacheTime()` Enables to configure whether WebJar resources should be cached or not.
`long`	`getWebResourcesCacheTime()` Enables to configure whether web resources should be cached or not.
`java.lang.String`	`getWidgetSet()`
`void`	`setDefaultScreenCanBeClosed(boolean value)`
`void`	`setDefaultScreenId(java.lang.String screenId)`
`void`	`setUserCanChooseDefaultScreen(boolean b)`

- Method Detail
  - getUseLocalServiceInvocation
```
boolean getUseLocalServiceInvocation()
```
    Returns:
    
    Whether to use local invocations instead of HTTPInvoker. Makes sense for improving performance, if the WEB and CORE applications started on the same JVM (same Tomcat instance).
  - getLoginDialogDefaultUser
```
@Default(value="admin")
java.lang.String getLoginDialogDefaultUser()
```
    Returns:
    
    Default user login to set in the login dialog.
  - getLoginDialogDefaultPassword
```
@Default(value="admin")
java.lang.String getLoginDialogDefaultPassword()
```
    Returns:
    
    Default user password to set in the login dialog.
  - getLoginDialogPoweredByLinkVisible
```
boolean getLoginDialogPoweredByLinkVisible()
```
    Returns:
    
    true if powered by link on loginWindow is shown
  - getHttpSessionExpirationTimeoutSec
```
int getHttpSessionExpirationTimeoutSec()
```
    Returns:
    
    HTTP session expiration timeout in seconds.
    Should be equals or less than middleware user session timeout cuba.userSessionExpirationTimeoutSec
  - getCubaHttpFilterBypassUrls
```
@Default(value="/ws/,/dispatch/,/front/")
java.util.List<java.lang.String> getCubaHttpFilterBypassUrls()
```
    Returns:
    
    Comma-separated list of URLs for CubaHttpFilter to bypass.
  - getExternalHttpFilterBypassUrls
```
java.util.List<java.lang.String> getExternalHttpFilterBypassUrls()
```
    Enables to pass additional Cuba HTTP Filter bypass URLs from application components.
    Related to getCubaHttpFilterBypassUrls().
    
    Returns:
    
    Comma-separated list of URLs for CubaHttpFilter to bypass.
  - getAppWindowMode
```
@Default(value="TABBED")
java.lang.String getAppWindowMode()
```
    Returns:
    
    Default main window mode. Takes place until the user did not change its own preference through user settings.
  - getMaxTabCount
```
int getMaxTabCount()
```
    Returns:
    
    Maximum number of opened tabs. 0 for unlimited.
  - getLogLongRequestsThresholdSec
```
int getLogLongRequestsThresholdSec()
```
    Returns:
    
    Request execution time in seconds, after which a message log will be logged.
  - getFoldersPaneEnabled
```
boolean getFoldersPaneEnabled()
```
    Returns:
    
    Whether to enable the Folders Pane functionality.
  - getAppFoldersRefreshPeriodSec
```
int getAppFoldersRefreshPeriodSec()
```
    Returns:
    
    AppFolders refresh period in seconds.
  - getShowFolderIcons
```
boolean getShowFolderIcons()
```
    Returns:
    
    Whether to use icons for folders.
  - getFoldersPaneVisibleByDefault
```
boolean getFoldersPaneVisibleByDefault()
```
    Returns:
    
    Whether to show CubaFoldersPane on first login.
  - getFoldersPaneDefaultWidth
```
int getFoldersPaneDefaultWidth()
```
    Returns:
    
    Default CubaFoldersPane width.
  - getShowBreadCrumbs
```
boolean getShowBreadCrumbs()
```
    Returns:
    
    true if WindowBreadCrumbs is shown, false - otherwise
  - getMainTabCaptionLength
```
int getMainTabCaptionLength()
```
    Returns:
    
    Maximum number of symbols in main tabs captions.
  - getAllowHandleBrowserHistoryBack
```
@Deprecated
boolean getAllowHandleBrowserHistoryBack()
```
    Deprecated. use getUrlHandlingMode() instead
    
    Returns:
    
    Whether to handle back button click in browser on server-side.
  - getUrlHandlingMode
```
@Default(value="URL_ROUTES")
UrlHandlingMode getUrlHandlingMode()
```
    Returns:
    
    how URL changes should be handled
    
    See Also:
    
    UrlHandlingMode
  - getAppWindowTheme
```
@Default(value="halo")
java.lang.String getAppWindowTheme()
```
    Returns:
    
    Theme
  - getUseInverseHeader
```
boolean getUseInverseHeader()
```
    Returns:
    
    Whether to use inverse header colors if it is supported by theme.
  - getViewFileExtensions
```
@Default(value="htm|html|jpg|png|jpeg|pdf")
java.util.List<java.lang.String> getViewFileExtensions()
```
    Returns:
    
    List of file extensions which should be shown in the browser instead of downloading as attachments.
  - getResourcesRoot
```
java.lang.String getResourcesRoot()
```
  - getBackgroundThreadsCount
```
@Nullable
java.lang.Integer getBackgroundThreadsCount()
```
    Returns:
    
    number of background task threads.
  - getMinBackgroundThreadsCount
```
@Deprecated
java.lang.Integer getMinBackgroundThreadsCount()
```
    Deprecated. use getBackgroundThreadsCount()
    
    Returns:
    
    minimum number of background task threads.
  - getMaxActiveBackgroundTasksCount
```
@Deprecated
java.lang.Integer getMaxActiveBackgroundTasksCount()
```
    Deprecated. use getBackgroundThreadsCount()
    
    Returns:
    
    maximum number of active background tasks.
  - getClientBackgroundTasksLatencySeconds
```
int getClientBackgroundTasksLatencySeconds()
```
  - getLoginAction
```
java.lang.String getLoginAction()
```
    Returns:
    
    an action to force login.
    An action is represented by the last part of URL.
  - getLinkHandlerActions
```
@Default(value="open|o")
java.util.List<java.lang.String> getLinkHandlerActions()
```
    Returns:
    
    list of URL actions to call LinkHandler
    An action is represented by the last part of URL.
  - getUseSessionFixationProtection
```
boolean getUseSessionFixationProtection()
```
    Reinitialize session after login to protect from Session Fixation attacks.
  - getRememberMeEnabled
```
boolean getRememberMeEnabled()
```
    Returns:
    
    true if remember me checkbox is enabled on login window
  - getTablePageLength
```
int getTablePageLength()
```
    Sets the page length for Table implementation - count of rows for first rendering of Table. After first partial rendering Table will request rest of rows from the server.
    Setting page length 0 disables paging.
    If Table has fixed height the client side may update the page length automatically the correct value.
  - getTableCacheRate
```
double getTableCacheRate()
```
    This property adjusts a possible caching mechanism of table implementation.
    Table component may fetch and render some rows outside visible area. With complex tables (for example containing layouts and components), the client side may become unresponsive. Setting the value lower, UI will become more responsive. With higher values scrolling in client will hit server less frequently.
    The amount of cached rows will be cacheRate multiplied with pageLength getTablePageLength() both below and above visible area.
  - getUseRedirectWithBlankPageForLinkAction
```
boolean getUseRedirectWithBlankPageForLinkAction()
```
    Returns:
    
    Whether to redirect by blank html page on getting URL request action
  - getAppLogMaxItemsCount
```
int getAppLogMaxItemsCount()
```
    Returns:
    
    Maximum number of items stored in the AppLog queue
  - getUiHeartbeatIntervalSec
```
int getUiHeartbeatIntervalSec()
```
    Returns:
    
    the interval of the heartbeat requests for Web Client UI. If set to -1 then Web Client uses calculated value getHttpSessionExpirationTimeoutSec() / 3. Set to 0 in order to disable heartbeat requests.
  - getCloseIdleHttpSessions
```
boolean getCloseIdleHttpSessions()
```
    Returns:
    
    true if Web Client closes the UIs and the session after the getHttpSessionExpirationTimeoutSec() expires after the last non-heartbeat request.
  - getUsePushLongPolling
```
boolean getUsePushLongPolling()
```
    Returns:
    
    true if push should use long polling transport instead of websocket+xhr
  - getPushLongPollingSuspendTimeoutMs
```
int getPushLongPollingSuspendTimeoutMs()
```
    Returns push timeout in milliseconds, which is used in case of using long polling transport, i.e. cuba.web.pushLongPolling="true".
    
    Returns:
    
    push timeout in milliseconds
  - getPushEnabled
```
boolean getPushEnabled()
```
    Returns:
    
    true if push is enabled
  - getProductionMode
```
boolean getProductionMode()
```
    Returns:
    
    true if production mode is enabled
  - getWidgetSet
```
@Default(value="com.haulmont.cuba.web.widgets.WidgetSet")
java.lang.String getWidgetSet()
```
    Returns:
    
    GWT widgetset class
  - getUseDeviceWidthForViewport
```
boolean getUseDeviceWidthForViewport()
```
    Returns:
    
    true if device width is used as view port width. Affects "viewport" meta tag of Vaadin HTML pages.
  - getCustomDeviceWidthForViewport
```
int getCustomDeviceWidthForViewport()
```
    Returns:
    
    custom view port width for HTML page. Affects "viewport" meta tag of Vaadin HTML pages.
  - getPageInitialScale
```
java.lang.String getPageInitialScale()
```
    Returns:
    
    initial scale of HTML page if cuba.web.customDeviceWidthForViewport is set or cuba.web.useDeviceWidthForViewport is true. Affects "viewport" meta tag of Vaadin HTML pages.
  - getMainTabSheetMode
```
@Default(value="DEFAULT")
MainTabSheetMode getMainTabSheetMode()
```
    Sets whether default CubaMainTabSheet or CubaManagedTabSheet will be used in AppWorkArea.
    
    Returns:
    
    one of MainTabSheetMode values
  - getManagedMainTabSheetMode
```
@Default(value="HIDE_TABS")
ManagedMainTabSheetMode getManagedMainTabSheetMode()
```
    Sets how the managed main TabSheet switches its tabs: hides or unloads them.
    
    Returns:
    
    one of ManagedMainTabSheetMode values
  - getServerErrorPageTemplate
```
@Default(value="/com/haulmont/cuba/web/sys/errors/server-error.html")
java.lang.String getServerErrorPageTemplate()
```
    Returns:
    
    Template path for Internal Server Error page (HTTP Status 500).
  - getDefaultScreenId
```
java.lang.String getDefaultScreenId()
```
    Defines which screen should be opened after login. This setting will be applied to all users.
  - setDefaultScreenId
```
void setDefaultScreenId(java.lang.String screenId)
```
  - getUserCanChooseDefaultScreen
```
boolean getUserCanChooseDefaultScreen()
```
    Defines whether a user is able to choose the default screen or not.
  - setUserCanChooseDefaultScreen
```
void setUserCanChooseDefaultScreen(boolean b)
```
  - getDefaultScreenCanBeClosed
```
boolean getDefaultScreenCanBeClosed()
```
    Defines whether default screen can be closed or not when TABBED work area mode is used.
  - setDefaultScreenCanBeClosed
```
void setDefaultScreenCanBeClosed(boolean value)
```
  - getLoweredAttentionPatterns
```
@Default(value="at com.sun[\\.]proxy[\\.][\\$]Proxy|at groovy[\\.]|at java[\\.]lang[\\.]reflect[\\.]Constructor[\\.]newInstance|at java[\\.]lang[\\.]reflect[\\.]Method[\\.]invoke|at java[\\.]rmi[\\.]|at java[\\.]security[\\.]AccessControlContext[\\$]1[\\.]doIntersectionPrivilege|at java[\\.]security[\\.]AccessController[\\.]doPrivileged|at java[\\.]security[\\.]ProtectionDomain[\\$]1[\\.]doIntersectionPrivilege|at java[\\.]security[\\.]ProtectionDomain[\\$]JavaSecurityAccessImpl[\\.]doIntersectionPrivilege|at java[\\.]util[\\.]Spliterators[\\$]|at java[\\.]util[\\.]stream[\\.]AbstractPipeline[\\.]copyInto|at java[\\.]util[\\.]stream[\\.]AbstractPipeline[\\.]evaluate|at java[\\.]util[\\.]stream[\\.]AbstractPipeline[\\.]wrapAndCopyInto|at java[\\.]util[\\.]stream[\\.]ReduceOps[\\$]|at java[\\.]util[\\.]stream[\\.]ReferencePipeline[\\$]|at org[\\.]codehaus[\\.]groovy[\\.]|at org[\\.]gradle[\\.]|at sun[\\.]reflect[\\.]|at sun[\\.]rmi[\\.]|at com[\\.]vaadin[\\.]event[\\.]EventRouter[\\.]fireEvent|at com[\\.]vaadin[\\.]server[\\.]ServerRpcManager")
java.util.List<java.lang.String> getLoweredAttentionPatterns()
```
    Defines the list of regular expression patterns that are applied to each row of the log in the Server Log window. If at least one pattern is matched, then this row will be marked as lowered attention row.
  - getWebResourcesCacheTime
```
long getWebResourcesCacheTime()
```
    Enables to configure whether web resources should be cached or not.
    Zero cache time disables caching at all.
    
    Returns:
    
    web resources cache time in seconds
  - getWebJarResourcesCacheTime
```
long getWebJarResourcesCacheTime()
```
    Enables to configure whether WebJar resources should be cached or not.
    Zero cache time disables caching at all.
    
    Returns:
    
    WebJar resources cache time in seconds
  - getUnsupportedPagePath
```
java.lang.String getUnsupportedPagePath()
```
    Defines the path to the unsupported HTML page that is shown when an application doesn't support the current browser version.
    
    Returns:
    
    path to the unsupported HTML page
  - getLoginScreenId
```
java.lang.String getLoginScreenId()
```
    Defines the screen that will be used as Login screen: new LoginScreen or legacy AppLoginWindow.
    Set the property to "login" to use new LoginScreen or "loginWindow" to use legacy AppLoginWindow.
    
    Returns:
    
    login screen id
  - getMainScreenId
```
java.lang.String getMainScreenId()
```
    Defines the screen that will be used as Main screen: new MainScreen or legacy AppMainWindow.
    Set the property to "main" to use new MainScreen or "mainWindow" to use legacy AppMainWindow.
    
    Returns:
    
    main screen id
  - getInitialScreenId
```
java.lang.String getInitialScreenId()
```
    Defines the screen that will be open for non-authenticated user when an application opened.
    
    Returns:
    
    initial screen id
  - getForceRefreshAuthenticatedTabs
```
boolean getForceRefreshAuthenticatedTabs()
```
    Defines whether app should perform force refresh for browser tabs with authenticated sessions.
    Notification that session is changed in another tab is shown by default.
    
    Returns:
    
    true if app should perform force refresh for browser tabs with authenticated sessions or false otherwise
  - getAllowAnonymousAccess
```
boolean getAllowAnonymousAccess()
```
    Defines whether anonymous user is allowed to access the app.
  - getHtmlSanitizerEnabled
```
boolean getHtmlSanitizerEnabled()
```
    Defines whether to sanitize the value of components using HtmlSanitizer to prevent Cross-site Scripting (XSS) in HTML context.

Interface WebConfig

Method Summary

Method Detail

getUseLocalServiceInvocation

getLoginDialogDefaultUser

getLoginDialogDefaultPassword

getLoginDialogPoweredByLinkVisible

getHttpSessionExpirationTimeoutSec

getCubaHttpFilterBypassUrls

getExternalHttpFilterBypassUrls

getAppWindowMode

getMaxTabCount

getLogLongRequestsThresholdSec

getFoldersPaneEnabled

getAppFoldersRefreshPeriodSec

getShowFolderIcons

getFoldersPaneVisibleByDefault

getFoldersPaneDefaultWidth

getShowBreadCrumbs

getMainTabCaptionLength

getAllowHandleBrowserHistoryBack

getUrlHandlingMode

getAppWindowTheme

getUseInverseHeader

getViewFileExtensions

getResourcesRoot

getBackgroundThreadsCount

getMinBackgroundThreadsCount

getMaxActiveBackgroundTasksCount

getClientBackgroundTasksLatencySeconds

getLoginAction

getLinkHandlerActions

getUseSessionFixationProtection

getRememberMeEnabled

getTablePageLength

getTableCacheRate

getUseRedirectWithBlankPageForLinkAction

getAppLogMaxItemsCount

getUiHeartbeatIntervalSec

getCloseIdleHttpSessions

getUsePushLongPolling

getPushLongPollingSuspendTimeoutMs

getPushEnabled

getProductionMode

getWidgetSet

getUseDeviceWidthForViewport

getCustomDeviceWidthForViewport

getPageInitialScale

getMainTabSheetMode

getManagedMainTabSheetMode

getServerErrorPageTemplate

getDefaultScreenId

setDefaultScreenId

getUserCanChooseDefaultScreen

setUserCanChooseDefaultScreen

getDefaultScreenCanBeClosed

setDefaultScreenCanBeClosed

getLoweredAttentionPatterns

getWebResourcesCacheTime

getWebJarResourcesCacheTime

getUnsupportedPagePath

getLoginScreenId

getMainScreenId

getInitialScreenId

getForceRefreshAuthenticatedTabs

getAllowAnonymousAccess

getHtmlSanitizerEnabled