Application configurations for sessionpool
This is application configurations for sessionpool in webswing.config.
| Admin console label | Config field Id | Description | Default value | Type | Variable replacement |
|---|---|---|---|---|---|
| Enabled | enabled | If true, this application will be available in the Session-pool. | true | boolean |
|
| Home Folder | homeDir | Application's home directory. This will be the base directory of any relative classpath entries specified. | ${user.dir} | String |
✅ |
| Theme | theme | Select one of the default window decoration themes or a enter path to a XFWM4 theme folder. | String Values: "Murrine", "Agualemon", "Sassandra", "Therapy", "Totem", "Vertex", "Vertex-Light" |
✅ | |
| Fonts | fontConfig | Customize logical font mappings and define physical fonts available to application. These fonts (TTF only) will be used for DirectDraw as native fonts. Key: name of font (e.g. dialog|dialoginput|sansserif|serif|monospaced), Value: path to font file. | Map<String, String> Values: "dialog", "dialoginput", "sansserif", "serif", "monospaced" |
✅ | |
| DirectDraw Rendering | directdraw | DirectDraw rendering mode uses canvas instructions to render the application instead of server-rendered png images. DirectDraw improves performance but is not recomended for applications with lot of graphics content. | true | boolean |
|
| Enable Debug Mode | debug | Enables remote debug for this application. To start the application in debug mode use '?debugPort=8000' url param. | false | boolean |
|
| Enable Test Mode | testMode | Enables test mode for this application to be able to test it in Webswing Test Tool. | false | boolean |
|
| Working Directory | userDir | The User working directory. Path from which the application process will be started. (See the Java System Property: 'user.dir') | String |
✅ | |
| JRE Executable | jreExecutable | Path to java executable that will be used to spawn application process. Java 8, 11, 17 and 21 are supported. | ${java.home}/bin/java | String |
✅ |
| Java Version | javaVersion | Java version of the JRE executable defined above. Expected values are starting with '1.8', '11', '17' or '21'. | ${java.version} | String |
✅ |
| Class Path | classPathEntries | Application's classpath. Absolute or relative path to jar file or classes directory. At least one classPath entry should be specified containing the main class. Supports ? and * wildcards. | List<String> |
✅ | |
| System Class Path | systemClassPathEntries | System Class Path to include libraries with custom JCE, JAAS or similar service provider implementation. Supports ? and * wildcards. | List<String> |
✅ | |
| JavaFX Support | javaFx | Enables native or embedded JavaFX framework support. | false | boolean |
|
| JavaFX Version | javaFxVersion | Version of JavaFX libraries used. Expected values are starting with '1.8', '11', '17' or '21'. | 11 | String |
✅ |
| JavaFX embedded in JDK | javaFxEmbeddedInJdk | Enable if JavaFX libraries are included in JDK that is used to start the app. In that case JavaFX classpath is not used. | false | boolean |
|
| JavaFX Classpath | javaFxClassPathEntries | (Only valid for Java 11+) JavaFX jar libraries to be included in classpath. Supports ? and * wildcards. | List<String> |
✅ | |
| JVM Arguments | vmArgs | Commandline arguments processed by Java Virtual Machine. (e.g. '-Xmx128m') | String |
✅ | |
| Launcher System Properties | launcherSystemProperties | System properties installed when the Session is launched - ie. when the session is assigned to User. Used to define user specific system properties for Idle sessions. (e.g. '-Dworkspace=/tmp/${user}' or '-Dapp.locale=${clientLocale}' | String |
✅ | |
| Launcher Type | launcherType | Select the application type. Applet, regular Desktop Application or SWT Application. | Desktop | LauncherType Enum Values: Applet, Desktop, Swt |
|
| Launcher Configuration | launcherConfig | Launcher type specific configuration options | AppletLauncherConfig DesktopLauncherConfig SwtLauncherConfig |
||
| Pre-launch | prelaunchType | Select type of app pre-launch. 1. NONE: No pre-launch process applied. 2. MAIN_CLASS: Use 'mainClass' and 'args' from Desktop launcher config to start the application in pre-launch phase. Select this to speed up connecting user to an idle instance. 3. CUSTOM: Define custom pre-launch main class and args to be executed in pre-launch phase before the app main is executed. Use this to bootstrap your application with Webswing-specific code. | NONE | PrelaunchType Enum Values: NONE, MAIN_CLASS, CUSTOM |
|
| Pre-launch Main Class | prelaunchMainClass | Main class to execute as part of instance process startup. Use this if you want to prepare your application before launch, especially when using IDLE instances. Note that call to this main class is still without user context, no user-related information is available at this point. | String |
||
| Pre-launch Main Arguments | prelaunchMainArgs | Pre-launch main method arguments. This string will be passed to the pre-launch main method's (String[] args). | String |
||
| Session Timeout | swingSessionTimeout | Specifies how long (seconds) will be the application left running after the user closes the browser. User can reconnect in this interval and continue in last session. | 300 | int |
|
| Timeout if Inactive | timeoutIfInactive | If True, then inactivity of User for longer then defined 'Inactivity Timeout' period will trigger the defined 'Inactivity Action'. | false | boolean |
|
| Inactivity Timeout | inactivityTimeout | Defines how long (in seconds) can user stay inactive (no mouse or keyboard events) before the 'Inactivity Action' is triggered | int |
||
| Inactivity Action | inactivityAction | Specifies the behavior on user inactivity. 1. 'SHUTDOWN' will terminate the session. 2.'DISCONNECT' will disconnect the user. 3. 'LOCK' will lock user session while keeping it connected with lock-screen overlay displayed. Unlock requires user re-login. | SHUTDOWN | InactivityAction Enum Values: SHUTDOWN, DISCONNECT, LOCK |
|
| Idle Instances | idleInstancesCount | How many idle instances should be started in background waiting for user connection. Please read the documentation for restrictions that apply to idle instances. | 0 | int |
|
| Session Logging | sessionLogging | If enabled, sessions are logged into a separate log file. | false | boolean |
|
| Maximum Session Logs Size | sessionLogMaxFileSize | Maximum size of all session log files. After file size is exceeded, old log files are deleted. | ${webswing.sessionLog.maxSize:-1000MB} | String |
✅ |
| Session Log Size | sessionLogFileSize | Maximum size of a single session log file. | ${webswing.sessionLog.size:-10MB} | String |
✅ |
| Statistics Logging | allowStatisticsLogging | If enabled, statistics will be logged for sessions. | true | boolean |
|
| Isolated Filesystem | isolatedFs | If true, file chooser dialogs will be restricted to access only the 'Upload Folder' of current application. | true | boolean |
|
| Uploading Files | allowUpload | If selected, the JFileChooser integration will allow users to upload files to folder opened in the file chooser dialog | true | boolean |
|
| Deleting Files | allowDelete | If selected, the JFileChooser integration will allow users to delete files displayed in the file chooser dialog | true | boolean |
|
| Downloading Files | allowDownload | If selected, the JFileChooser integration will allow users to download files displayed in the file chooser dialog | true | boolean |
|
| Auto-Download from Save Dialog | allowAutoDownload | If selected, the JFileChooser dialog's save mode will trigger file download as soon as the selected file is available on filesystem. This feature doesn't work reliably in Linux/MacOS environment. | false | boolean |
|
| Transparent Open File Dialog | transparentFileOpen | If selected, the JFileChooser dialog's open mode will open a client side file browser and transparently upload selected files and triggers selection. | true | boolean |
|
| Transparent Save File Dialog | transparentFileSave | If selected, the JFileChooser dialog's save mode will open a client side dialog to enter the file name to be saved. | true | boolean |
|
| Upload Folder | transferDir | If Isolated Filesystem is enabled. This will be the folder on the server where the user can upload and download files from. Multiple folders can be defined using path separator (${path.separator}) | ${user}/upload | String |
✅ |
| Clear Upload Folder | clearTransferDir | If enabled, all files in the 'Upload Folder' will be deleted when the application process is terminated. | true | boolean |
|
| Thread Dumps Folder | threadDumpsFolder | Folder to be used to store application thread dumps. | ${" + Constants.ROOT_DIR_PATH + "}/datastore/dumps | String |
✅ |
| Recordings Folder | recordingsFolder | Folder to be used to store application recordings. | ${" + Constants.ROOT_DIR_PATH + "}/datastore/recordings | String |
✅ |
| Allow JsLink | allowJsLink | If enabled, the JSLink feature will be enabled, allowing application to invoke javascript and vice versa. (See org.webswing.toolkit.api.jslink.JSObject in Webswing API) | false | boolean |
|
| JsLink White List | jsLinkWhitelist | List of allowed Java classes. Calls to declared methods of these classes are allowed via JsLink. Supports trailing * wildcard. Use single * entry to allow any class. Leave empty to disallow everything. E.g. org.webswing.* | List<String> |
||
| Allow Local Clipboard | allowLocalClipboard | Enables built-in integration of client's local clipboard. Due to some browsers security limitations clipboard toolbar may be displayed. | true | boolean |
|
| Allow Server Printing | allowServerPrinting | Enables native printing on devices configured on server's OS. If disabled a pdf is generated and sent to client browser. | false | boolean |
|
| Embed Fonts in PDF | fontEmbeddingEnabled | Embed fonts defined in font configuration into printed PDF file. | false | boolean |
|
| Docking Mode | dockMode | Select the mode for undocking windows to a separate browser window: 1.ALL: all windows can be undocked. 2.MARKED: only windows marked with WebswingDockableWindow interface can be undocked. 3.NONE: disable undocking | NONE | DockMode Enum Values: ALL, MARKED, NONE |
|
| Docking Type | dockType | Select the default type of undocked window: 1.POPUP: undocked window opens in a popup. 2.TAB: undocked window opens in a new tab | POPUP | DockType Enum Values: POPUP, TAB |
|
| Multi-screen Support | multiScreenSupportEnabled | Enables multi-screen support. Provides extended user screen information in Webswing API and let's you position undocked windows on any user screen. Currently works in Chrome and Edge browsers. | false | boolean |
|
| Advanced Settings | advancedSettings | Set advanced app settings. | List<AppSettingsEntry> |
||
| BlackList | blacklist | Blacklisted features | List<String> |
||
| WhiteList | whitelist | Whitelisted features | List<String> |
AppletLauncherConfig
| Admin console label | Config field Id | Description | Default value | Type | Variable replacement |
|---|---|---|---|---|---|
| Applet Class | appletClass | Applet's fully qualified main class name. Must implement the java.applet.Applet interface. (ie. 'com.mypackage.MyApplet') | String |
✅ | |
| Applet Parameters | parameters | Applets start parameters. Set of key-value pairs accessible to applet at startup. | Map<String, String> |
✅ |
DesktopLauncherConfig
| Admin console label | Config field Id | Description | Default value | Type | Variable replacement |
|---|---|---|---|---|---|
| Main Class | mainClass | Swing application fully qualified class name. (ie. 'com.mypackage.Main') | String |
✅ | |
| Main Arguments | args | Swing application main method arguments. This string will be passed to the main method's (String[] args) | String |
✅ |
SwtLauncherConfig
| Admin console label | Config field Id | Description | Default value | Type | Variable replacement |
|---|---|---|---|---|---|
| Main Class | mainClass | SWT application's fully qualified main class name. (ie. 'com.mypackage.Main') | String |
✅ | |
| Main Arguments | args | SWT application's main method arguments. This string will be passed to the main method's (String[] args) | String |
✅ | |
| SWTSwing Library Path | swtSwingLibraryPath | SWTSwing Library classpath. Absolute or relative path to jar file. (https://github.com/Chrriis/SWTSwing) | ${webswing.rootDir}/apps/swt/SwtSwingLibrary.jar | String |
✅ |
AppSettingsEntry
| Admin console label | Config field Id | Description | Default value | Type | Variable replacement |
|---|---|---|---|---|---|
| Setting | setting | String |
|||
| Value | value | String |
✅ |