Common

java.lang.Object
- general.common.Common

```
@Singleton
public class Common
extends java.lang.Object
```
This class provides configuration properties that are common to all modules of JATOS. It mostly takes parameters from application.conf. It is initialized during JATOS start (triggered in GuiceConfig). Since most fields are initialized by the constructor during the JATOS' start (triggered in GuiceConfig), it's safe to access them via static getter methods.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static java.lang.String`	`getBasepath()` JATOS' absolute base path without trailing '/.'
`static java.lang.String`	`getBrandingUrl()` URL where some static HTML can be found that can be shown instead of the default welcome message on the home page
`static java.lang.String`	`getDbDriver()` Database driver as defined in application.conf
`static java.lang.String`	`getDbUrl()` Database URL as defined in application.conf
`static play.mvc.Http.Cookie.SameSite`	`getIdCookiesSameSite()` Which SameSite attribute the ID cookies should set
`static java.lang.String`	`getJatosApiVersion()` JATOS API version (different from JATOS version)
`static java.lang.String`	`getJatosHttpAddress()` JATOS HTTP host address without protocol or port (e.g.
`static int`	`getJatosHttpPort()` Port JATOS is running on
`static java.lang.String`	`getJatosUpdateMsg()` If in update happened during last startup a message might be stored here
`static java.lang.String`	`getJatosUrlBasePath()` HTTP URL base path: will be the prefix for each URL, e.g.
`static java.lang.String`	`getJatosVersion()` JATOS version (full version e.g.
`static java.lang.String`	`getLdapAdminDn()` LDAP admin DN (Distinguished Name) - the admin user is used to search for the actual user that wants to log in
`static java.lang.String`	`getLdapAdminPassword()` LDAP admin password
`static java.util.List<java.lang.String>`	`getLdapBaseDn()` LDAP base DNs (Distinguished Name)
`static int`	`getLdapTimeout()` Read timeout for the LDAP server
`static java.lang.String`	`getLdapUrl()` LDAP URL (with port)
`static java.lang.String`	`getLocale()` Locale used in the GUI.
`static java.lang.String`	`getLogsAppender()` Log appender: can be 'ASYNCFILE' (default) or 'ASYNCSTDOUT'
`static java.lang.String`	`getLogsFilename()` Base name of JATOS log files without the suffix ('.log' or '.gz').
`static java.lang.String`	`getLogsPath()` Path where the application logs are located
`static java.lang.String`	`getMac()` MAC address of the network interface
`static int`	`getMaxResultsDbQuerySize()` Maximal number of results to be fetched from the DB at once
`static java.lang.String`	`getOauthGoogleClientId()` Google Sign-in Client ID for OAuth / OpenId Connect (OIDC)
`static java.lang.String`	`getOidcClientId()` OpenId Connect (OIDC) client ID
`static java.lang.String`	`getOidcClientSecret()` OpenId Connect (OIDC) client secret.
`static java.lang.String`	`getOidcDiscoveryUrl()` OpenId Connect (OIDC) provider discovery URL (ends with ".well-known/openid-configuration")
`static java.lang.String`	`getOidcIdTokenSigningAlgorithm()` OpenId Connect (OIDC) token signing algorithm (e.g.
`static java.lang.String`	`getOidcSigninButtonLogoUrl()` Logo URL of OIDC button in sign-in page
`static java.lang.String`	`getOidcSigninButtonText()` Text of OIDC button in sign-in page
`static java.lang.String`	`getOidcSuccessFeedback()` Success feedback text shown to the user if OIDC sign-in was successful
`static java.lang.String`	`getOrcidClientId()` ORCID'S OpenId Connect (OIDC) client ID
`static java.lang.String`	`getOrcidClientSecret()` ORCID's OpenId Connect (OIDC) client secret.
`static java.lang.String`	`getOrcidDiscoveryUrl()` ORCID's OpenId Connect (OIDC) provider discovery URL (ends with ".well-known/openid-configuration")
`static java.lang.String`	`getOrcidIdTokenSigningAlgorithm()` ORCID's OpenId Connect (OIDC) token signing algorithm (e.g.
`static java.lang.String`	`getOrcidSigninButtonLogoUrl()` Logo URL of ORCID button on the sign-in page
`static java.lang.String`	`getOrcidSigninButtonText()` Text of ORCID button on the sign-in page
`static java.lang.String`	`getOrcidSuccessFeedback()` Success feedback text shown to the user if ORCID sign-in was successful.
`static long`	`getResultDataMaxSize()` Maximal size of result data of one component result in Byte
`static long`	`getResultUploadsLimitPerStudyRun()` Max size of all files uploaded during a single study run in bytes
`static long`	`getResultUploadsMaxFileSize()` Max file size in bytes for a single uploaded file
`static java.lang.String`	`getResultUploadsPath()` Path in the file system where JATOS stores uploaded result files
`static java.lang.String`	`getStudyAssetsRootPath()` Path in the file system to the study assets root directory.
`static java.lang.String`	`getStudyLogsPath()` Path in the file system where JATOS stores its logs for each study
`static java.lang.String`	`getTermsOfUseUrl()` URL to the terms of use that will be shown in a link on the home page
`static java.lang.String`	`getTmpPath()` Path to the JATOS tmp directory.
`static int`	`getUserPasswordMinLength()` Message that will be displayed during user creation that describes password requirements
`static org.apache.commons.lang3.tuple.Pair<java.lang.String,java.lang.String>`	`getUserPasswordStrengthRegex()` Regex that will be used to check the password during user creation
`static boolean`	`getUserSessionAllowKeepSignedin()` If true, the user has the possibility (a checkbox on the GUI's signin page) to keep the user session and to not get signed out automatically due to user a session timeout (neither through normal timeout nor inactivity).
`static int`	`getUserSessionInactivity()` Time in minutes a user can be inactive before they will be signed out (defined in application.conf)
`static int`	`getUserSessionTimeout()` Time in minutes when the Play session will timeout (defined in application.conf)
`static boolean`	`isDonationAllowed()` Should the GUI show a donations button
`static boolean`	`isIdCookiesSecure()` If true, the ID cookies' secure attribute will be set
`static boolean`	`isJatosApiAllowed()` If true, it is allowed to use JATOS' API
`static boolean`	`isLdapAllowed()`
`static boolean`	`isLogsAppenderStdOut()` Returns true if the Logger logs to STDOUT and false otherwise.
`static boolean`	`isMultiNode()` True indicates that this JATOS runs with others in a cluster
`static boolean`	`isOauthGoogleAllowed()`
`static boolean`	`isOidcAllowed()`
`static boolean`	`isOrcidAllowed()`
`static boolean`	`isResultUploadsEnabled()` Are file uploads via jatos.js allowed?
`static boolean`	`isStudyLogsEnabled()` Is study logging enabled
`static boolean`	`isStudyMembersAllowedToAddAllUsers()` If true, it's allowed to add all users that exist on this JATOS server to be added at once as members of a study
`static boolean`	`isUserRoleAllowSuperuser()` If true, it is allowed to grant users the Superuser role
`static boolean`	`showResultDataSizeInStudyManager()` If false, the result data size won't be calculated for the study manager page.
`static boolean`	`showResultFileSizeInStudyManager()` If false, the study result file size won't be calculated for the study manager page.
`static boolean`	`showStudyAssetsSizeInStudyManager()` If false, the study assets folder size won't be calculated for the study manager page.
`static boolean`	`usesMysql()` Does JATOS use an MySQL database?

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getJatosVersion
```
public static java.lang.String getJatosVersion()
```
    JATOS version (full version e.g. v3.5.5-alpha)
  - getJatosApiVersion
```
public static java.lang.String getJatosApiVersion()
```
    JATOS API version (different from JATOS version)
  - getBasepath
```
public static java.lang.String getBasepath()
```
    JATOS' absolute base path without trailing '/.'
  - getStudyAssetsRootPath
```
public static java.lang.String getStudyAssetsRootPath()
```
    Path in the file system to the study assets root directory. If the property is defined in the configuration file then use it as the base path. If property isn't defined, try in default study path instead.
  - isStudyLogsEnabled
```
public static boolean isStudyLogsEnabled()
```
    Is study logging enabled
  - getStudyLogsPath
```
public static java.lang.String getStudyLogsPath()
```
    Path in the file system where JATOS stores its logs for each study
  - isResultUploadsEnabled
```
public static boolean isResultUploadsEnabled()
```
    Are file uploads via jatos.js allowed?
  - getResultUploadsPath
```
public static java.lang.String getResultUploadsPath()
```
    Path in the file system where JATOS stores uploaded result files
  - getResultUploadsMaxFileSize
```
public static long getResultUploadsMaxFileSize()
```
    Max file size in bytes for a single uploaded file
  - getResultUploadsLimitPerStudyRun
```
public static long getResultUploadsLimitPerStudyRun()
```
    Max size of all files uploaded during a single study run in bytes
  - getResultDataMaxSize
```
public static long getResultDataMaxSize()
```
    Maximal size of result data of one component result in Byte
  - getMaxResultsDbQuerySize
```
public static int getMaxResultsDbQuerySize()
```
    Maximal number of results to be fetched from the DB at once
  - getUserSessionTimeout
```
public static int getUserSessionTimeout()
```
    Time in minutes when the Play session will timeout (defined in application.conf)
  - getUserSessionInactivity
```
public static int getUserSessionInactivity()
```
    Time in minutes a user can be inactive before they will be signed out (defined in application.conf)
  - getUserSessionAllowKeepSignedin
```
public static boolean getUserSessionAllowKeepSignedin()
```
    If true, the user has the possibility (a checkbox on the GUI's signin page) to keep the user session and to not get signed out automatically due to user a session timeout (neither through normal timeout nor inactivity). If set to true and the user chooses to keep being signed in, the user session is kept until the user signs out manually or the session cookie is deleted.
  - getDbUrl
```
public static java.lang.String getDbUrl()
```
    Database URL as defined in application.conf
  - usesMysql
```
public static boolean usesMysql()
```
    Does JATOS use an MySQL database?
  - getDbDriver
```
public static java.lang.String getDbDriver()
```
    Database driver as defined in application.conf
  - getMac
```
public static java.lang.String getMac()
```
    MAC address of the network interface
  - getUserPasswordMinLength
```
public static int getUserPasswordMinLength()
```
    Message that will be displayed during user creation that describes password requirements
  - getUserPasswordStrengthRegex
```
public static org.apache.commons.lang3.tuple.Pair<java.lang.String,java.lang.String> getUserPasswordStrengthRegex()
```
    Regex that will be used to check the password during user creation
  - getJatosUrlBasePath
```
public static java.lang.String getJatosUrlBasePath()
```
    HTTP URL base path: will be the prefix for each URL, e.g. /jatos/test -> /myBasePath/jatos/test
  - getJatosUpdateMsg
```
public static java.lang.String getJatosUpdateMsg()
```
    If in update happened during last startup a message might be stored here
  - getJatosHttpAddress
```
public static java.lang.String getJatosHttpAddress()
```
    JATOS HTTP host address without protocol or port (e.g. 192.168.0.1)
  - getJatosHttpPort
```
public static int getJatosHttpPort()
```
    Port JATOS is running on
  - getLdapUrl
```
public static java.lang.String getLdapUrl()
```
    LDAP URL (with port)
  - getLdapBaseDn
```
public static java.util.List<java.lang.String> getLdapBaseDn()
```
    LDAP base DNs (Distinguished Name)
  - getLdapAdminDn
```
public static java.lang.String getLdapAdminDn()
```
    LDAP admin DN (Distinguished Name) - the admin user is used to search for the actual user that wants to log in
  - getLdapAdminPassword
```
public static java.lang.String getLdapAdminPassword()
```
    LDAP admin password
  - isLdapAllowed
```
public static boolean isLdapAllowed()
```
  - getLdapTimeout
```
public static int getLdapTimeout()
```
    Read timeout for the LDAP server
  - isOauthGoogleAllowed
```
public static boolean isOauthGoogleAllowed()
```
  - getOauthGoogleClientId
```
public static java.lang.String getOauthGoogleClientId()
```
    Google Sign-in Client ID for OAuth / OpenId Connect (OIDC)
  - isOidcAllowed
```
public static boolean isOidcAllowed()
```
  - getOidcDiscoveryUrl
```
public static java.lang.String getOidcDiscoveryUrl()
```
    OpenId Connect (OIDC) provider discovery URL (ends with ".well-known/openid-configuration")
  - getOidcClientId
```
public static java.lang.String getOidcClientId()
```
    OpenId Connect (OIDC) client ID
  - getOidcClientSecret
```
public static java.lang.String getOidcClientSecret()
```
    OpenId Connect (OIDC) client secret. Can be null if not used.
  - getOidcIdTokenSigningAlgorithm
```
public static java.lang.String getOidcIdTokenSigningAlgorithm()
```
    OpenId Connect (OIDC) token signing algorithm (e.g. RS256)
  - getOidcSigninButtonText
```
public static java.lang.String getOidcSigninButtonText()
```
    Text of OIDC button in sign-in page
  - getOidcSigninButtonLogoUrl
```
public static java.lang.String getOidcSigninButtonLogoUrl()
```
    Logo URL of OIDC button in sign-in page
  - getOidcSuccessFeedback
```
public static java.lang.String getOidcSuccessFeedback()
```
    Success feedback text shown to the user if OIDC sign-in was successful
  - isOrcidAllowed
```
public static boolean isOrcidAllowed()
```
  - getOrcidDiscoveryUrl
```
public static java.lang.String getOrcidDiscoveryUrl()
```
    ORCID's OpenId Connect (OIDC) provider discovery URL (ends with ".well-known/openid-configuration")
  - getOrcidClientId
```
public static java.lang.String getOrcidClientId()
```
    ORCID'S OpenId Connect (OIDC) client ID
  - getOrcidClientSecret
```
public static java.lang.String getOrcidClientSecret()
```
    ORCID's OpenId Connect (OIDC) client secret.
  - getOrcidIdTokenSigningAlgorithm
```
public static java.lang.String getOrcidIdTokenSigningAlgorithm()
```
    ORCID's OpenId Connect (OIDC) token signing algorithm (e.g. RS256)
  - getOrcidSigninButtonText
```
public static java.lang.String getOrcidSigninButtonText()
```
    Text of ORCID button on the sign-in page
  - getOrcidSigninButtonLogoUrl
```
public static java.lang.String getOrcidSigninButtonLogoUrl()
```
    Logo URL of ORCID button on the sign-in page
  - getOrcidSuccessFeedback
```
public static java.lang.String getOrcidSuccessFeedback()
```
    Success feedback text shown to the user if ORCID sign-in was successful.
  - isDonationAllowed
```
public static boolean isDonationAllowed()
```
    Should the GUI show a donations button
  - getTermsOfUseUrl
```
public static java.lang.String getTermsOfUseUrl()
```
    URL to the terms of use that will be shown in a link on the home page
  - getBrandingUrl
```
public static java.lang.String getBrandingUrl()
```
    URL where some static HTML can be found that can be shown instead of the default welcome message on the home page
  - getLocale
```
public static java.lang.String getLocale()
```
    Locale used in the GUI. If not set, the browser's 'navigator.language' is used.
  - isStudyMembersAllowedToAddAllUsers
```
public static boolean isStudyMembersAllowedToAddAllUsers()
```
    If true, it's allowed to add all users that exist on this JATOS server to be added at once as members of a study
  - isIdCookiesSecure
```
public static boolean isIdCookiesSecure()
```
    If true, the ID cookies' secure attribute will be set
  - getIdCookiesSameSite
```
public static play.mvc.Http.Cookie.SameSite getIdCookiesSameSite()
```
    Which SameSite attribute the ID cookies should set
  - showStudyAssetsSizeInStudyManager
```
public static boolean showStudyAssetsSizeInStudyManager()
```
    If false, the study assets folder size won't be calculated for the study manager page. Sometimes the filesystem is too slow to allow this.
  - showResultDataSizeInStudyManager
```
public static boolean showResultDataSizeInStudyManager()
```
    If false, the result data size won't be calculated for the study manager page. Sometime the database is too slow to allow this.
  - showResultFileSizeInStudyManager
```
public static boolean showResultFileSizeInStudyManager()
```
    If false, the study result file size won't be calculated for the study manager page. Sometimes the filesystem is too slow to allow this.
  - isUserRoleAllowSuperuser
```
public static boolean isUserRoleAllowSuperuser()
```
    If true, it is allowed to grant users the Superuser role
  - isJatosApiAllowed
```
public static boolean isJatosApiAllowed()
```
    If true, it is allowed to use JATOS' API
  - getLogsPath
```
public static java.lang.String getLogsPath()
```
    Path where the application logs are located
  - getLogsFilename
```
public static java.lang.String getLogsFilename()
```
    Base name of JATOS log files without the suffix ('.log' or '.gz'). Default is 'application'.
  - getLogsAppender
```
public static java.lang.String getLogsAppender()
```
    Log appender: can be 'ASYNCFILE' (default) or 'ASYNCSTDOUT'
  - isLogsAppenderStdOut
```
public static boolean isLogsAppenderStdOut()
```
    Returns true if the Logger logs to STDOUT and false otherwise.
  - getTmpPath
```
public static java.lang.String getTmpPath()
```
    Path to the JATOS tmp directory. If not set, it is System.getProperty("java.io.tmpdir").
  - isMultiNode
```
public static boolean isMultiNode()
```
    True indicates that this JATOS runs with others in a cluster

Class Common

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getJatosVersion

getJatosApiVersion

getBasepath

getStudyAssetsRootPath

isStudyLogsEnabled

getStudyLogsPath

isResultUploadsEnabled

getResultUploadsPath

getResultUploadsMaxFileSize

getResultUploadsLimitPerStudyRun

getResultDataMaxSize

getMaxResultsDbQuerySize

getUserSessionTimeout

getUserSessionInactivity

getUserSessionAllowKeepSignedin

getDbUrl

usesMysql

getDbDriver

getMac

getUserPasswordMinLength

getUserPasswordStrengthRegex

getJatosUrlBasePath

getJatosUpdateMsg

getJatosHttpAddress

getJatosHttpPort

getLdapUrl

getLdapBaseDn

getLdapAdminDn

getLdapAdminPassword

isLdapAllowed

getLdapTimeout

isOauthGoogleAllowed

getOauthGoogleClientId

isOidcAllowed

getOidcDiscoveryUrl

getOidcClientId

getOidcClientSecret

getOidcIdTokenSigningAlgorithm

getOidcSigninButtonText

getOidcSigninButtonLogoUrl

getOidcSuccessFeedback

isOrcidAllowed

getOrcidDiscoveryUrl

getOrcidClientId

getOrcidClientSecret

getOrcidIdTokenSigningAlgorithm

getOrcidSigninButtonText

getOrcidSigninButtonLogoUrl

getOrcidSuccessFeedback

isDonationAllowed

getTermsOfUseUrl

getBrandingUrl

getLocale

isStudyMembersAllowedToAddAllUsers

isIdCookiesSecure

getIdCookiesSameSite

showStudyAssetsSizeInStudyManager

showResultDataSizeInStudyManager

showResultFileSizeInStudyManager

isUserRoleAllowSuperuser

isJatosApiAllowed

getLogsPath

getLogsFilename

getLogsAppender

isLogsAppenderStdOut

getTmpPath

isMultiNode