com.haulmont.cuba.core.app

Interface ServerConfig

All Superinterfaces:

Config

public interface ServerConfig
extends Config

Configuration parameters interface used by the CORE layer.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SYNC_NEW_USER_SESSION_REPLICATION_PROP

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAnonymousLogin() Login name of the anonymous user.
boolean	getAutomaticDatabaseUpdate()
int	getBruteForceBlockIntervalSec()
boolean	getBruteForceProtectionEnabled() Whether the brute-force protection on user login is enabled.
int	getCrossDataStoreReferenceLoadingBatchSize()
boolean	getDataManagerChecksSecurityOnMiddleware() Indicates that DataManager should always apply security restrictions on the middleware.
java.lang.String	getDbDir()
int	getDefaultQueryTimeoutSec()
boolean	getDisableLoadValuesIfConstraints() If set to true and query loading values is affected by security constraints, an exception is thrown
boolean	getEntityAttributePermissionChecking() If set to false, attribute permissions are not enforced on Middleware.
java.lang.String	getExceptionReportEmailBodyTemplate()
java.lang.String	getExceptionReportEmailSubjectTemplate()
java.lang.String	getFileStorageDir()
boolean	getImmutableFileStorage() An immutable file storage throws exception on attempt to write an existing file.
boolean	getInMemoryDistinct()
java.lang.String	getJmxUserLogin() Login name which is used by default in system authentication
java.lang.String	getKeyForSecurityTokenEncryption() <= 16 symbols string, used as key for AES encryption of security token
boolean	getLogInternalServiceInvocation() Warning in the log when a service is invoked from inside middleware.
int	getMaxLoginAttemptsNumber()
java.lang.String	getResetPasswordEmailBodyTemplate()
java.lang.String	getResetPasswordEmailSubjectTemplate()
boolean	getRestStoreTokensInDb()
boolean	getSchedulingActive()
long	getSchedulingInterval()
int	getSchedulingThreadPoolSize()
boolean	getSyncNewUserSessionReplication() Indicates that a new user session created on login should be sent to the cluster synchronously.
java.lang.String	getTrustedClientPassword()
java.lang.String	getTrustedClientPermittedIpList()
boolean	getUseEntityDataStoreForIdSequence()
boolean	getUseReadOnlyTransactionForLoad()
int	getUserSessionExpirationTimeoutSec()
java.lang.String	getUserSessionProviderUrl()
int	getUserSessionSendTimeoutSec()
int	getUserSessionTouchTimeoutSec() UserSessionsAPI will update last used timestamp for a session only if the old value is older than the current + timeout.
boolean	getUseSpringApplicationEventsToSetupAttributeAccess() Indicates that Spring application events should be used to setup attribute access (true - old behavior, false - new recommended behavior)
void	setDefaultQueryTimeoutSec(int timeout)
void	setInMemoryDistinct(boolean value)
void	setSchedulingActive(boolean value)
void	setSchedulingInterval(long value)
void	setSchedulingThreadPoolSize(int value)
void	setUserSessionExpirationTimeoutSec(int timeout)
void	setUserSessionSendTimeoutSec(int timeout)

Field Detail

SYNC_NEW_USER_SESSION_REPLICATION_PROP

static final java.lang.String SYNC_NEW_USER_SESSION_REPLICATION_PROP

See Also:

Constant Field Values

Method Detail

getUserSessionProviderUrl

java.lang.String getUserSessionProviderUrl()

Returns:

URL of a user session provider - usually the main middleware unit. This URL is used by middleware units which don't login themselves but get existing sessions from the main app.

getTrustedClientPassword

java.lang.String getTrustedClientPassword()

Returns:

Password used by LoginService.loginTrusted() method. Trusted client may login without providing a user password. This is used for external authentication.

Must be equal to password set for the same property on the client.

getTrustedClientPermittedIpList

java.lang.String getTrustedClientPermittedIpList()

getResetPasswordEmailBodyTemplate

@Default(value="/com/haulmont/cuba/security/app/email/reset-password-body.gsp")
java.lang.String getResetPasswordEmailBodyTemplate()

getResetPasswordEmailSubjectTemplate

@Default(value="/com/haulmont/cuba/security/app/email/reset-password-subject.gsp")
java.lang.String getResetPasswordEmailSubjectTemplate()

getExceptionReportEmailBodyTemplate

@Default(value="/com/haulmont/cuba/core/app/exceptionemail/exception-report-template-body.gsp")
java.lang.String getExceptionReportEmailBodyTemplate()

Returns:

Path to the exception report email body template.

getExceptionReportEmailSubjectTemplate

@Default(value="/com/haulmont/cuba/core/app/exceptionemail/exception-report-template-subject.gsp")
java.lang.String getExceptionReportEmailSubjectTemplate()

Returns:

Path to the exception report email subject template.

getUserSessionExpirationTimeoutSec

int getUserSessionExpirationTimeoutSec()

Returns:

User session expiration timeout in seconds. Not the same as HTTP session timeout, but should have the same value.

setUserSessionExpirationTimeoutSec

void setUserSessionExpirationTimeoutSec(int timeout)

getUserSessionSendTimeoutSec

int getUserSessionSendTimeoutSec()

Returns:

User session ping timeout in cluster. If ping is performed by UserSessionsAPI.getAndRefresh(java.util.UUID), user session is sent to the cluster only after this timeout

setUserSessionSendTimeoutSec

void setUserSessionSendTimeoutSec(int timeout)

getUserSessionTouchTimeoutSec

int getUserSessionTouchTimeoutSec()

UserSessionsAPI will update last used timestamp for a session only if the old value is older than the current + timeout.

getDbDir

java.lang.String getDbDir()

Returns:

DB scripts directory. Does not end with "/"

getAutomaticDatabaseUpdate

boolean getAutomaticDatabaseUpdate()

Returns:

Whether the server should try to init/update database on each startup.

getFileStorageDir

java.lang.String getFileStorageDir()

Returns:

FileStorageAPI storage directory. If not set, cuba.dataDir/filestorage will be used.

getImmutableFileStorage

boolean getImmutableFileStorage()

An immutable file storage throws exception on attempt to write an existing file.

Returns:

whether file storage is immutable.

getSchedulingActive

boolean getSchedulingActive()

Returns:

Scheduled tasks execution control.

setSchedulingActive

void setSchedulingActive(boolean value)

getSchedulingInterval

long getSchedulingInterval()

Returns:

Scheduled tasks execution control.

setSchedulingInterval

void setSchedulingInterval(long value)

getSchedulingThreadPoolSize

int getSchedulingThreadPoolSize()

Returns:

Maximum size of thread pool which is used to process scheduled tasks

setSchedulingThreadPoolSize

void setSchedulingThreadPoolSize(int value)

getInMemoryDistinct

boolean getInMemoryDistinct()

Returns:

Tells DataService to ensure distinct results by processing them in memory, instead of issue 'select distinct' to the database.

setInMemoryDistinct

void setInMemoryDistinct(boolean value)

getDefaultQueryTimeoutSec

int getDefaultQueryTimeoutSec()

Returns:

Default database query timeout in seconds. If 0, middleware doesn't apply any timeout to queries.

setDefaultQueryTimeoutSec

void setDefaultQueryTimeoutSec(int timeout)

getSyncNewUserSessionReplication

boolean getSyncNewUserSessionReplication()

Indicates that a new user session created on login should be sent to the cluster synchronously.

getEntityAttributePermissionChecking

boolean getEntityAttributePermissionChecking()

If set to false, attribute permissions are not enforced on Middleware. This is appropriate if only server-side clients are used.

getDisableLoadValuesIfConstraints

boolean getDisableLoadValuesIfConstraints()

If set to true and query loading values is affected by security constraints, an exception is thrown

getKeyForSecurityTokenEncryption

java.lang.String getKeyForSecurityTokenEncryption()

<= 16 symbols string, used as key for AES encryption of security token

getDataManagerChecksSecurityOnMiddleware

boolean getDataManagerChecksSecurityOnMiddleware()

Indicates that DataManager should always apply security restrictions on the middleware.

getUseSpringApplicationEventsToSetupAttributeAccess

boolean getUseSpringApplicationEventsToSetupAttributeAccess()

Indicates that Spring application events should be used to setup attribute access (true - old behavior, false - new recommended behavior)

getBruteForceProtectionEnabled

boolean getBruteForceProtectionEnabled()

Whether the brute-force protection on user login is enabled.

getMaxLoginAttemptsNumber

int getMaxLoginAttemptsNumber()

Returns:

a maximum number of unsuccessful login attempts

getBruteForceBlockIntervalSec

int getBruteForceBlockIntervalSec()

Returns:

a time interval in seconds for which a user is blocked after a series of unsuccessful login attempts

getAnonymousLogin

@Default(value="anonymous")
java.lang.String getAnonymousLogin()

Login name of the anonymous user.

getJmxUserLogin

@Default(value="admin")
java.lang.String getJmxUserLogin()

Login name which is used by default in system authentication

getLogInternalServiceInvocation

boolean getLogInternalServiceInvocation()

Warning in the log when a service is invoked from inside middleware.

getCrossDataStoreReferenceLoadingBatchSize

int getCrossDataStoreReferenceLoadingBatchSize()

Returns:

batch size for loading related entities from different data stores

getUseReadOnlyTransactionForLoad

boolean getUseReadOnlyTransactionForLoad()

Returns:

use read-only transactions in DataManager load operations and do not commit them

getRestStoreTokensInDb

boolean getRestStoreTokensInDb()

Returns:

whether to store REST API OAuth tokens in the database

getUseEntityDataStoreForIdSequence

boolean getUseEntityDataStoreForIdSequence()

Returns:

if true, sequences for BaseLongIdEntity and BaseIntegerIdEntity subclasses are created in data stores of these entities. Otherwise (by default), sequences for all entities are created in the main data store.