# openfin/java-example architecture

> Architecture diagram of the GitHub repository openfin/java-example, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-21). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/openfin/java-example
- Repository: https://github.com/openfin/java-example

## Overview

This repository is an example application for the OpenFin Java adapter, rather than the adapter implementation itself. Its principal workflow starts with a user launching the Java demo, which connects to the OpenFin Runtime, creates an HTML5 application, and controls its window. A separate example embeds an application in a Swing canvas. Other demo classes indicate channel, layout, notification, and FX examples. Relationships below rely on README walkthroughs; source excerpts were not provided, so additional wiring is left unspecified.

Main entry points: [`src/main/java/com/openfin/desktop/demo/OpenFinDesktopDemo.java`](https://github.com/openfin/java-example/blob/master/src/main/java/com/openfin/desktop/demo/OpenFinDesktopDemo.java) (Desktop demo), [`src/main/java/com/openfin/desktop/demo/WindowEmbedDemo.java`](https://github.com/openfin/java-example/blob/master/src/main/java/com/openfin/desktop/demo/WindowEmbedDemo.java) (Swing embed demo), [`src/main/java/com/openfin/desktop/demo/AppCreateDialog.java`](https://github.com/openfin/java-example/blob/master/src/main/java/com/openfin/desktop/demo/AppCreateDialog.java) (App configuration dialog), [`src/main/java/com/openfin/desktop/demo/PubSubTest.java`](https://github.com/openfin/java-example/blob/master/src/main/java/com/openfin/desktop/demo/PubSubTest.java) (Publish and subscribe)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_runtime["Runtime Connection"]
  node_main_demo["Desktop demo"]
  node_runtime_setup["Runtime setup"]
  node_openfin_runtime["OpenFin Runtime"]
end

subgraph group_apps["Application Examples"]
  node_app_dialog["App configuration dialog"]
  node_html_app["HTML5 application"]
  node_window_controls["Window controls"]
  node_embed_demo["Swing embed demo"]
end

subgraph group_features["Adapter Features"]
  node_bus_demo["Publish and subscribe<br/>[PubSubTest.java]"]
  node_channel_demo["Channel example"]
  node_layout_demo["Layout service demo"]
  node_notification_demo["Notification demo"]
  node_fx_demo["JavaFX demo<br/>[FxDemo.java]"]
end

node_user(("Example user"))

node_user -->|"starts"| node_main_demo
node_main_demo -->|"configures and connects"| node_runtime_setup
node_runtime_setup -->|"launches and connects"| node_openfin_runtime
node_user -->|"enters configuration"| node_app_dialog
node_main_demo -->|"opens"| node_app_dialog
node_main_demo -->|"creates and runs"| node_html_app
node_app_dialog -->|"provides options"| node_html_app
node_user -->|"controls"| node_window_controls
node_window_controls -->|"resizes and updates"| node_html_app
node_user -->|"starts embedding"| node_embed_demo
node_embed_demo -->|"connects to"| node_runtime_setup
node_embed_demo -->|"creates and embeds"| node_html_app
node_user -->|"uses messaging"| node_bus_demo

click node_main_demo "https://github.com/openfin/java-example/blob/master/src/main/java/com/openfin/desktop/demo/OpenFinDesktopDemo.java"
click node_runtime_setup "https://github.com/openfin/java-example/blob/master/src/main/java/com/openfin/desktop/demo/OpenFinDesktopDemo.java"
click node_app_dialog "https://github.com/openfin/java-example/blob/master/src/main/java/com/openfin/desktop/demo/AppCreateDialog.java"
click node_window_controls "https://github.com/openfin/java-example/blob/master/src/main/java/com/openfin/desktop/demo/OpenFinDesktopDemo.java"
click node_embed_demo "https://github.com/openfin/java-example/blob/master/src/main/java/com/openfin/desktop/demo/WindowEmbedDemo.java"
click node_bus_demo "https://github.com/openfin/java-example/blob/master/src/main/java/com/openfin/desktop/demo/PubSubTest.java"
click node_channel_demo "https://github.com/openfin/java-example/blob/master/src/main/java/com/openfin/desktop/demo/ChannelExample.java"
click node_layout_demo "https://github.com/openfin/java-example/blob/master/src/main/java/com/openfin/desktop/demo/LayoutServiceDemo.java"
click node_notification_demo "https://github.com/openfin/java-example/blob/master/src/main/java/com/openfin/desktop/demo/NotificationServiceDemo.java"
click node_fx_demo "https://github.com/openfin/java-example/blob/master/src/main/java/com/openfin/desktop/demo/FxDemo.java"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_main_demo,node_runtime_setup,node_openfin_runtime,node_user toneBlue
class node_app_dialog,node_html_app,node_window_controls,node_embed_demo toneAmber
class node_bus_demo,node_channel_demo,node_layout_demo,node_notification_demo,node_fx_demo toneMint
```

## Components

### Runtime Connection

- [Desktop demo](https://github.com/openfin/java-example/blob/master/src/main/java/com/openfin/desktop/demo/OpenFinDesktopDemo.java): `src/main/java/com/openfin/desktop/demo/OpenFinDesktopDemo.java`
- [Runtime setup](https://github.com/openfin/java-example/blob/master/src/main/java/com/openfin/desktop/demo/OpenFinDesktopDemo.java): `src/main/java/com/openfin/desktop/demo/OpenFinDesktopDemo.java`
- **OpenFin Runtime**

### Application Examples

- [App configuration dialog](https://github.com/openfin/java-example/blob/master/src/main/java/com/openfin/desktop/demo/AppCreateDialog.java): `src/main/java/com/openfin/desktop/demo/AppCreateDialog.java`
- **HTML5 application**
- [Window controls](https://github.com/openfin/java-example/blob/master/src/main/java/com/openfin/desktop/demo/OpenFinDesktopDemo.java): `src/main/java/com/openfin/desktop/demo/OpenFinDesktopDemo.java`
- [Swing embed demo](https://github.com/openfin/java-example/blob/master/src/main/java/com/openfin/desktop/demo/WindowEmbedDemo.java): `src/main/java/com/openfin/desktop/demo/WindowEmbedDemo.java`

### Adapter Features

- [Publish and subscribe](https://github.com/openfin/java-example/blob/master/src/main/java/com/openfin/desktop/demo/PubSubTest.java): `src/main/java/com/openfin/desktop/demo/PubSubTest.java`
- [Channel example](https://github.com/openfin/java-example/blob/master/src/main/java/com/openfin/desktop/demo/ChannelExample.java): `src/main/java/com/openfin/desktop/demo/ChannelExample.java`
- [Layout service demo](https://github.com/openfin/java-example/blob/master/src/main/java/com/openfin/desktop/demo/LayoutServiceDemo.java): `src/main/java/com/openfin/desktop/demo/LayoutServiceDemo.java`
- [Notification demo](https://github.com/openfin/java-example/blob/master/src/main/java/com/openfin/desktop/demo/NotificationServiceDemo.java): `src/main/java/com/openfin/desktop/demo/NotificationServiceDemo.java`
- [JavaFX demo](https://github.com/openfin/java-example/blob/master/src/main/java/com/openfin/desktop/demo/FxDemo.java): `src/main/java/com/openfin/desktop/demo/FxDemo.java`

### Other components

- **Example user**

## Connections

- Example user → Desktop demo: starts (evidence: `README.md`)
- Desktop demo → Runtime setup: configures and connects (evidence: `README.md`)
- Runtime setup → OpenFin Runtime: launches and connects (evidence: `README.md`)
- Example user → App configuration dialog: enters configuration (evidence: `README.md`)
- Desktop demo → App configuration dialog: opens (evidence: `README.md`)
- Desktop demo → HTML5 application: creates and runs (evidence: `README.md`)
- App configuration dialog → HTML5 application: provides options (evidence: `README.md`)
- Example user → Window controls: controls (evidence: `README.md`)
- Window controls → HTML5 application: resizes and updates (evidence: `README.md`)
- Example user → Swing embed demo: starts embedding (evidence: `README.md`)
- Swing embed demo → Runtime setup: connects to (evidence: `README.md`)
- Swing embed demo → HTML5 application: creates and embeds (evidence: `README.md`)
- Example user → Publish and subscribe: uses messaging (evidence: `README.md`)
