Skip to main content

Setup and Configuration

Open in ChatGPT

Integrating Webswing with webforJ involves two components: the Webswing server that hosts your Swing app, and the WebswingConnector component in your webforJ app that embeds it.

Prerequisites​

Before you begin, make sure you have the following prerequisites:

  • Java desktop app: a Swing, JavaFX, or SWT app packaged as a JAR file
  • Webswing server: download from webswing.org
  • webforJ version 25.10 or later: required for WebswingConnector support

Architecture overview​

The integration architecture consists of:

  1. Webswing Server: runs your Swing app, captures the GUI rendering, and handles user input
  2. webforJ Application: hosts your web app with the embedded WebswingConnector
  3. Browser Client: displays both the webforJ UI and the embedded Swing app
Port Configuration

Webswing and webforJ must run on different ports to avoid conflicts. Both webforJ and Webswing typically run on port 8080. You should change either the Webswing port or the webforJ port.

Webswing server setup​

Installation and startup​

  1. Download Webswing from the official website
  2. Extract the archive to your preferred location (e.g., /opt/webswing or C:\webswing)
  3. Start the server using the platform-specific scripts:
webswing.sh
  1. Verify the server is running by accessing http://localhost:8080

Application configuration​

Once the server is running, access the admin console at http://localhost:8080/admin to add and configure your Swing app.

In the admin console, configure:

  • Application Name: becomes part of the URL path (e.g., myapp → http://localhost:8080/myapp/)
  • Main Class: the entry point of your Swing app
  • Classpath: path to your app JAR and dependencies
  • JVM Arguments: memory settings, system properties, and other JVM options
  • Home Directory: working directory for the app

After configuration, your Swing app will be accessible at http://localhost:8080/[app-name]/

CORS configuration​

When embedding Webswing in a webforJ app running on a different port or domain, you must configure Cross-Origin Resource Sharing (CORS) in Webswing. This allows the browser to load Webswing content from within your webforJ page.

In the Webswing admin console, navigate to your app's configuration and set:

  • Allowed Origins: Add your webforJ app's origin (e.g., http://localhost:8090 or * for development)

This setting corresponds to the allowedCorsOrigins option in Webswing's app configuration.

webforJ integration​

Once your Webswing server is running with your Swing app configured and CORS enabled, you can integrate it into your webforJ app.

Add dependency​

Add the Webswing integration module to your webforJ project. This provides the WebswingConnector component and related classes.

<dependency>
    <groupId>com.webforj</groupId>
    <artifactId>webforj-webswing</artifactId>
</dependency>

Basic implementation​

Create a view that embeds your Swing app using the WebswingConnector:

SwingAppView.java
package com.example.views;

import com.webforj.annotation.Route;
import com.webforj.component.Composite;
import com.webforj.component.html.elements.Div;
import com.webforj.component.webswing.WebswingConnector;

@Route
public class SwingAppView extends Composite<Div> {
  private WebswingConnector connector;

  public SwingAppView() {
    // Initialize the connector with your Webswing application URL
    connector = new WebswingConnector("http://localhost:8080/myapp/");

    // Set the display dimensions
    connector.setSize("100%", "600px");

    // Add to the view container
    getBoundComponent().add(connector);
  }
}

The connector automatically establishes a connection to the Webswing server when added to the DOM. The Swing app's UI is then rendered within the connector component.

Configuration options​

The WebswingOptions class allows you to customize the connector's behavior. By default, the connector starts automatically when created and uses standard connection settings. You can modify this behavior by creating a WebswingOptions instance and applying it to the connector.

For example, to hide the logout button in a production environment where you manage authentication through your webforJ app:

WebswingConnector connector = new WebswingConnector("http://localhost:8080/myapp/");

WebswingOptions options = new WebswingOptions()
    .setDisableLogout(true);  // Hide the logout button

connector.setOptions(options);

Or if you need manual control over when the connection starts:

// Create connector without auto-start
WebswingConnector connector = new WebswingConnector(url, false);

// Configure and start when ready
WebswingOptions options = new WebswingOptions();
connector.setOptions(options);
connector.start();

The options cover connection management, authentication, debugging, and monitoring.