io.jmix.ui

Class UiProperties

java.lang.Object

io.jmix.ui.UiProperties

@ConfigurationProperties(prefix="jmix.ui")
 @ConstructorBinding
public class UiProperties
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description

UiProperties(boolean testMode, boolean performanceTestMode, boolean productionMode, java.lang.String appWindowMode, boolean compositeMenu, boolean allowAnonymousAccess, int jmxConsoleMBeanOperationTimeoutSec, int httpSessionExpirationTimeoutSec, UrlHandlingMode urlHandlingMode, java.util.List<java.lang.String> linkHandlerActions, java.util.List<java.lang.String> viewFileExtensions, int saveExportedByteArrayDataThresholdBytes, long webJarResourcesCacheTime, long backgroundTaskTimeoutCheckInterval, java.lang.Integer defaultMaxFetchSize, java.util.Map<java.lang.String,java.lang.Integer> entityMaxFetchSize, java.lang.Integer defaultPageSize, java.util.Map<java.lang.String,java.lang.Integer> entityPageSize, int maxTabCount, boolean showBreadCrumbs, boolean defaultScreenCanBeClosed, java.lang.String defaultScreenId, java.lang.String loginScreenId, java.lang.String mainScreenId, java.lang.String initialScreenId, boolean localeSelectVisible, boolean forceRefreshAuthenticatedTabs, int mainTabCaptionLength)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAppWindowMode()
long	getBackgroundTaskTimeoutCheckInterval() Interval for checking timeout of a BackgroundTask.
int	getDefaultMaxFetchSize()
int	getDefaultPageSize()
java.lang.String	getDefaultScreenId() Defines which screen should be opened after login.
int	getEntityMaxFetchSize(java.lang.String entityName)
int	getEntityPageSize(java.lang.String entityName)
int	getHttpSessionExpirationTimeoutSec() HTTP session expiration timeout in seconds. Should be equal or less than user session timeout.
java.lang.String	getInitialScreenId() Defines the screen that will be open for non-authenticated user when an application opened.
int	getJmxConsoleMBeanOperationTimeoutSec()
java.util.List<java.lang.String>	getLinkHandlerActions()
java.lang.String	getLoginScreenId() Defines the screen that will be used as Login screen.
java.lang.String	getMainScreenId() Defines the screen that will be used as Main screen.
int	getMainTabCaptionLength() Maximum number of symbols in main tabs captions.
int	getMaxTabCount() Maximum number of opened tabs.
int	getSaveExportedByteArrayDataThresholdBytes()
UrlHandlingMode	getUrlHandlingMode()
java.util.List<java.lang.String>	getViewFileExtensions()
long	getWebJarResourcesCacheTime() Enables to configure whether WebJar resources should be cached or not.
boolean	isAllowAnonymousAccess()
boolean	isCompositeMenu()
boolean	isDefaultScreenCanBeClosed() Defines whether default screen can be closed or not when TABBED work area mode is used.
boolean	isForceRefreshAuthenticatedTabs()
boolean	isLocaleSelectVisible() Whether the locale select field is shown on login screen.
boolean	isPerformanceTestMode()
boolean	isProductionMode()
boolean	isShowBreadCrumbs()
boolean	isTestMode()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UiProperties

public UiProperties(boolean testMode,
                    boolean performanceTestMode,
                    @DefaultValue(value="true")
                    boolean productionMode,
                    @DefaultValue(value="TABBED")
                    java.lang.String appWindowMode,
                    @DefaultValue(value="true")
                    boolean compositeMenu,
                    @DefaultValue(value="false")
                    boolean allowAnonymousAccess,
                    @DefaultValue(value="600")
                    int jmxConsoleMBeanOperationTimeoutSec,
                    @DefaultValue(value="1800")
                    int httpSessionExpirationTimeoutSec,
                    @DefaultValue(value="URL_ROUTES")
                    UrlHandlingMode urlHandlingMode,
                    @DefaultValue(value={"open","o"})
                    java.util.List<java.lang.String> linkHandlerActions,
                    @DefaultValue(value={"htm","html","jpg","png","jpeg","pdf"})
                    java.util.List<java.lang.String> viewFileExtensions,
                    @DefaultValue(value="102400")
                    int saveExportedByteArrayDataThresholdBytes,
                    @DefaultValue(value="31536000")
                    long webJarResourcesCacheTime,
                    @DefaultValue(value="5000")
                    long backgroundTaskTimeoutCheckInterval,
                    @DefaultValue(value="10000")
                    java.lang.Integer defaultMaxFetchSize,
                    @Nullable
                    java.util.Map<java.lang.String,java.lang.Integer> entityMaxFetchSize,
                    @DefaultValue(value="50")
                    java.lang.Integer defaultPageSize,
                    @Nullable
                    java.util.Map<java.lang.String,java.lang.Integer> entityPageSize,
                    @DefaultValue(value="20")
                    int maxTabCount,
                    @DefaultValue(value="true")
                    boolean showBreadCrumbs,
                    @DefaultValue(value="true")
                    boolean defaultScreenCanBeClosed,
                    java.lang.String defaultScreenId,
                    @DefaultValue(value="login")
                    java.lang.String loginScreenId,
                    @DefaultValue(value="main")
                    java.lang.String mainScreenId,
                    java.lang.String initialScreenId,
                    @DefaultValue(value="true")
                    boolean localeSelectVisible,
                    @DefaultValue(value="false")
                    boolean forceRefreshAuthenticatedTabs,
                    @DefaultValue(value="25")
                    int mainTabCaptionLength)

Method Detail

isTestMode

public boolean isTestMode()

isPerformanceTestMode

public boolean isPerformanceTestMode()

getAppWindowMode

public java.lang.String getAppWindowMode()

Returns:

Default main window mode.

getHttpSessionExpirationTimeoutSec

public int getHttpSessionExpirationTimeoutSec()

HTTP session expiration timeout in seconds.
Should be equal or less than user session timeout.

getUrlHandlingMode

public UrlHandlingMode getUrlHandlingMode()

getLinkHandlerActions

public java.util.List<java.lang.String> getLinkHandlerActions()

isAllowAnonymousAccess

public boolean isAllowAnonymousAccess()

isCompositeMenu

public boolean isCompositeMenu()

getViewFileExtensions

public java.util.List<java.lang.String> getViewFileExtensions()

getSaveExportedByteArrayDataThresholdBytes

public int getSaveExportedByteArrayDataThresholdBytes()

getWebJarResourcesCacheTime

public 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

isProductionMode

public boolean isProductionMode()

getJmxConsoleMBeanOperationTimeoutSec

public int getJmxConsoleMBeanOperationTimeoutSec()

Returns:

Timeout (in seconds) for MBean operation invoked in JMX console

getBackgroundTaskTimeoutCheckInterval

public long getBackgroundTaskTimeoutCheckInterval()

Interval for checking timeout of a BackgroundTask.

Returns:

timeout in ms

getDefaultMaxFetchSize

public int getDefaultMaxFetchSize()

getEntityMaxFetchSize

public int getEntityMaxFetchSize(java.lang.String entityName)

getDefaultPageSize

public int getDefaultPageSize()

getEntityPageSize

public int getEntityPageSize(java.lang.String entityName)

getMaxTabCount

public int getMaxTabCount()

Maximum number of opened tabs. 0 for unlimited.

isShowBreadCrumbs

public boolean isShowBreadCrumbs()

Returns:

true if WindowBreadCrumbs is shown in screens, false - otherwise

isDefaultScreenCanBeClosed

public boolean isDefaultScreenCanBeClosed()

Defines whether default screen can be closed or not when TABBED work area mode is used.

getDefaultScreenId

public java.lang.String getDefaultScreenId()

Defines which screen should be opened after login. This setting will be applied to all users.

getLoginScreenId

public java.lang.String getLoginScreenId()

Defines the screen that will be used as Login screen.

Returns:

the login screen id

getMainScreenId

public java.lang.String getMainScreenId()

Defines the screen that will be used as Main screen.

Returns:

the main screen id

getInitialScreenId

public java.lang.String getInitialScreenId()

Defines the screen that will be open for non-authenticated user when an application opened.

Returns:

initial screen id

isForceRefreshAuthenticatedTabs

public boolean isForceRefreshAuthenticatedTabs()

Returns:

true if app should perform force refresh for browser tabs with authenticated sessions or false otherwise

getMainTabCaptionLength

public int getMainTabCaptionLength()

Maximum number of symbols in main tabs captions.

isLocaleSelectVisible

public boolean isLocaleSelectVisible()

Whether the locale select field is shown on login screen.