Application configurations for server
This is application configurations for server in webswing.config.
| Admin console label | Config field Id | Description | Default value | Type | Variable replacement |
|---|---|---|---|---|---|
| Enabled | enabled | If true, application will be started automatically, when server starts. | true | boolean |
|
| Context Path | path | Url context path where the application will be deployed. | String |
||
| Name | name | Application name. | My Application | String |
✅ |
| Icon | icon | Path to icon displayed in application selection dialog. Recommended size 256x256. | String |
✅ | |
| Web Home Folder | webHomeDir | Application's home directory for web-related content. This will be the base directory of any relative classpath entries specified. | ${user.dir} | String |
✅ |
| Web Folder | webFolder | Folder to be used to store customized static web files like HTML, CSS or Javascript. | String |
✅ | |
| Restricted Resources | restrictedResources | Defined path-prefix restricts access to resources only to authenticated users (e.g. '/docs'). Applies to static resources inside 'Web Folder' or packaged with Webswing. (e.g. '/myapp/docs/index.html') | List<String> |
✅ | |
| File viewers | fileViewers | Configures URL handlers for files based on their extension and associated AWT Desktop file operations. | List<FileViewerConfig> |
✅ | |
| Localization Folder | langFolder | Folder to be used to store customized messages and translations in supported languages. English is available by default. | String |
✅ | |
| CORS Origins | allowedCorsOrigins | If you are embedding Webswing to page on different domain, you have to enable Cross-origin resource sharing (CORS) by adding the domain in this list. Use * to allow all domains. | List<String> |
||
| Security | security | WebswingSecurityConfig |
|||
| Session Mode | sessionMode | Select session behavior when user reconnects to application. 1.ALWAYS_NEW_SESSION: New application is started for every Webswing session. (Session timeout will be set to 0) 2.CONTINUE_FOR_TAB: Webswing session can be resumed by the same user within the same browser tab after connection is terminated or user refresh the page. (Session timeout applies) 3.CONTINUE_FOR_BROWSER: Webswing session can be resumed by the same user in the same browser after connection is terminated (Session timeout applies). 4.CONTINUE_FOR_USER: Application session can be resumed by the same user from any computer after the connection is terminated (Session timeout applies). 5.CONTINUE_FOR_ANYONE: Application session can be resumed by any user from any computer after the connection is terminated (Session timeout applies). | CONTINUE_FOR_BROWSER | SessionMode |
|
| Max. Connections | maxClients | Maximum number of simultaneous connected sessions for this application. | 1 | String |
✅ |
| Max. Connections Per User | maxClientsPerUser | Maximum number of simultaneous connected sessions for this application per user. Use -1 for unrestricted. | -1 | String |
✅ |
| Session Stealing | allowStealSession | If enabled, and session mode 'CONTINUE_FOR_USER' is selected, user can resume Webswing session even if the connection is open in other browser. Former browser window will be disconnected. | true | boolean |
|
| Auto Logout | autoLogout | If enabled, user is automatically logged out after application shutdown or after disconnect due to inactivity timeout. | true | boolean |
|
| Goodbye URL | goodbyeUrl | Absolute or relative URL to redirect to, when application exits. Use '/' to navigate back to Application selector. | String |
✅ | |
| Monitor App Responsiveness | monitorEdtEnabled | If True, Webswing will display a progress animation if Swing's Event Dispatch thread is not responding. | true | boolean |
|
| Loading Animation delay | loadingAnimationDelay | If EDT thread is blocked for more then defined delay in seconds, dialog with loading animation is displayed appears. Delay must be >= 2 seconds. | 2 | int |
|
| Allow Session Recording | recordingAllowed | true | boolean |
||
| Require Recording Consent | recordingConsentRequired | If enabled, triggering Session recording from admin console will show a dialog for users to provide their consent before Session recording is started | false | boolean |
|
| Allow Session Mirroring | mirroringAllowed | true | boolean |
||
| Require Mirroring Consent | mirroringConsentRequired | If enabled, triggering Mirror View from admin console will show a dialog for users to provide their consent before Mirror View is started | false | boolean |
|
| Upload Size Limit | uploadMaxSize | Maximum size of upload for single file (in MB). Set 0 for unlimited size. | 5 | double |
|
| Data Store | dataStore | WebswingDataStoreConfig |
|||
| Javascript Bootstrap Options | bootstrapOptions | Set advanced bootstrap options used to initialize javascript client. Some of these options can be overridden in custom index.js using Webswing Javascript API. | List<BootstrapOptionsEntry> |
||
| BlackList | blacklist | Blacklisted features | List<String> |
||
| WhiteList | whitelist | Whitelisted features | List<String> |
FileViewerConfig
| Admin console label | Config field Id | Description | Default value | Type | Variable replacement |
|---|---|---|---|---|---|
| Operations | operation | Specifies the AWT Desktop action performed on the file, such as open, edit, print or a combination (e.g. open_edit). | OperationTypes Enum Values: open, edit, print, open_edit, open_print, print_edit, open_edit_print |
||
| File type | fileType | Comma separated list of file extension (e.g. pdf, gif) | String |
||
| URL | url | File viewer relative URL. Use ${file} in the URL template to insert the blob identifier. Use '${file}' value to trigger the browser's default action for the file. | String |
WebswingDataStoreConfig
| Admin console label | Config field Id | Description | Default value | Type | Variable replacement |
|---|---|---|---|---|---|
| Direct Transfer | directTransfer | If enabled, file transfer between browser and application will use WebSocket connection. Use this option if your deployment doesn't allow shared access to single data store. | true | boolean |
|
| Data Store Module Class Path | classPath | Additional classpath for built-in data store module or for defining custom data store module. | List<String> |
✅ | |
| Data Store Module Name | module | Select one of built-in modules or enter full class name of custom data store module (has to implement org.webswing.server.common.datastore.WebswingDataStoreModule interface). Note the class and its dependencies has to be on classpath defined above. | INHERITED | String |
|
| Data Store Module Config | config | Data store module specific configuration. | FileSystemDataStoreModuleConfig |
BootstrapOptionsEntry
| Admin console label | Config field Id | Description | Default value | Type | Variable replacement |
|---|---|---|---|---|---|
| Setting | setting | String |
|||
| Value | value | String |
✅ |
FileSystemDataStoreModuleConfig
| Admin console label | Config field Id | Description | Default value | Type | Variable replacement |
|---|---|---|---|---|---|
| Transfer Folder | transferFolder | Folder to be used to store application uploads and downloads. This folder must be accessible by application and server. | ${" + Constants.ROOT_DIR_PATH + "}/datastore/transfer | String |
✅ |