io.jmix.core

Class CoreProperties

java.lang.Object

io.jmix.core.CoreProperties

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

Constructor Summary

Constructors

Constructor and Description

CoreProperties(java.lang.String webHostName, java.lang.String webPort, java.lang.String confDir, java.lang.String workDir, java.lang.String tempDir, java.lang.String dbDir, java.util.List<java.lang.String> availableLocales, int crossDataStoreReferenceLoadingBatchSize, boolean idGenerationForEntitiesInAdditionalDataStoresEnabled, int dom4jMaxPoolSize, int dom4jMaxBorrowWaitMillis, java.lang.String anonymousAuthenticationTokenKey, java.lang.String defaultFileStorage, boolean entitySerializationTokenRequired, java.lang.String entitySerializationTokenEncryptionKey, boolean fetchPlanSerializationUseView, boolean triggerFilesEnabled, java.time.Duration triggerFilesProcessInterval)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAnonymousAuthenticationTokenKey()
java.util.List<java.util.Locale>	getAvailableLocales() List of locales supported by the application.
java.lang.String	getConfDir()
int	getCrossDataStoreReferenceLoadingBatchSize()
java.lang.String	getDbDir()
java.lang.String	getDefaultFileStorage()
int	getDom4jMaxBorrowWaitMillis() Timeout to borrow SAXParser instance from object pool.
int	getDom4jMaxPoolSize() Maximum number of SAXParser instances available for concurrent use.
java.lang.String	getEntitySerializationTokenEncryptionKey()
java.lang.String	getTempDir()
java.time.Duration	getTriggerFilesProcessInterval() Defines the period in milliseconds of trigger files processing
java.lang.String	getWebHostName() This web application host name.
java.lang.String	getWebPort() This web application port.
java.lang.String	getWorkDir()
boolean	isEntitySerializationTokenRequired()
boolean	isFetchPlanSerializationUseView()
boolean	isIdGenerationForEntitiesInAdditionalDataStoresEnabled() Whether to generate identifiers for entities located in additional data stores.
boolean	isTriggerFilesEnabled()

Methods inherited from class java.lang.Object

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

Constructor Detail

CoreProperties

public CoreProperties(java.lang.String webHostName,
                      java.lang.String webPort,
                      java.lang.String confDir,
                      java.lang.String workDir,
                      java.lang.String tempDir,
                      java.lang.String dbDir,
                      java.util.List<java.lang.String> availableLocales,
                      @DefaultValue(value="50")
                      int crossDataStoreReferenceLoadingBatchSize,
                      @DefaultValue(value="true")
                      boolean idGenerationForEntitiesInAdditionalDataStoresEnabled,
                      @DefaultValue(value="100")
                      int dom4jMaxPoolSize,
                      @DefaultValue(value="1000")
                      int dom4jMaxBorrowWaitMillis,
                      @DefaultValue(value="de72c623-6d3d-458c-a187-c526de515ecd")
                      java.lang.String anonymousAuthenticationTokenKey,
                      java.lang.String defaultFileStorage,
                      @DefaultValue(value="false")
                      boolean entitySerializationTokenRequired,
                      @DefaultValue(value="KEY")
                      java.lang.String entitySerializationTokenEncryptionKey,
                      @DefaultValue(value="false")
                      boolean fetchPlanSerializationUseView,
                      @DefaultValue(value="true")
                      boolean triggerFilesEnabled,
                      @DefaultValue(value="5000")
                      java.time.Duration triggerFilesProcessInterval)

Method Detail

getWebHostName

public java.lang.String getWebHostName()

This web application host name.

getWebPort

public java.lang.String getWebPort()

This web application port.

getConfDir

public java.lang.String getConfDir()

getWorkDir

public java.lang.String getWorkDir()

getTempDir

public java.lang.String getTempDir()

getDbDir

public java.lang.String getDbDir()

getDefaultFileStorage

@Nullable
public java.lang.String getDefaultFileStorage()

getAvailableLocales

public java.util.List<java.util.Locale> getAvailableLocales()

List of locales supported by the application. If not specified, contains the single Locale.ENGLISH element.

getCrossDataStoreReferenceLoadingBatchSize

public int getCrossDataStoreReferenceLoadingBatchSize()

isIdGenerationForEntitiesInAdditionalDataStoresEnabled

public boolean isIdGenerationForEntitiesInAdditionalDataStoresEnabled()

Whether to generate identifiers for entities located in additional data stores. Default is true.

getDom4jMaxPoolSize

public int getDom4jMaxPoolSize()

Maximum number of SAXParser instances available for concurrent use.

getDom4jMaxBorrowWaitMillis

public int getDom4jMaxBorrowWaitMillis()

Timeout to borrow SAXParser instance from object pool.

getAnonymousAuthenticationTokenKey

public java.lang.String getAnonymousAuthenticationTokenKey()

Returns:

a key that is used in AnonymousAuthenticationProvider and AnonymousAuthenticationFilter

isEntitySerializationTokenRequired

public boolean isEntitySerializationTokenRequired()

Returns:

true if entity serialization uses security token data for deserialization entities with row level security

getEntitySerializationTokenEncryptionKey

public java.lang.String getEntitySerializationTokenEncryptionKey()

isFetchPlanSerializationUseView

public boolean isFetchPlanSerializationUseView()

isTriggerFilesEnabled

public boolean isTriggerFilesEnabled()

Returns:

true if enables the processing of bean invocation trigger files. Default value: true The trigger file is a file that is placed in the triggers subdirectory of the application's temporary directory. The file name consists of two parts separated with a #: the first part is the bean class, the second part is the method name of the bean to invoke. For example: io.jmix.core.Messages#clearCache. The trigger files handler monitors the folder for new trigger files, invokes the appropriate methods and then removes the files.

getTriggerFilesProcessInterval

public java.time.Duration getTriggerFilesProcessInterval()

Defines the period in milliseconds of trigger files processing