Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/styles/config/vocabularies/Docs/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,6 @@ Workbox
WSL
Xcode
XPath

# Accepted abbreviations whose plural and/or possessive forms otherwise give an error
API
APIs
Expand All @@ -282,13 +281,14 @@ VAPID
VUs
XHR
XSS

# Names of React hooks
useForm

# Layout and CSS terms
[cC]olspans?
[rR]eflows?
varargs
XLarge
XXLarge
appenders?
Splunk
[Ii]nterop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,18 @@ This page lists the runtime knobs SwingBridge reads from JVM system properties,
|`swingbridge.errorReporting.enabled`
|`true`
|When set to `false`, the launch-failure error view shows only the failure header — the exception type, message, and stack trace are suppressed and the report-submission form is hidden. See <<#swing-bridge.configuration.error-reporting, Launch Failure Error View>> below.

|`swingbridge.consoleLogPrefix`
|`false`
|When set to `true`, every console line written by an embedded Swing application is prefixed with that instance's run ID (`[swing:<runId>]`), so concurrent users' output can be told apart in the server console. See <<logging#swing-bridge.logging, Logging & Identifying Logs per User>>.

|`swingbridge.includeUserInLogs`
|`false`
|When set to `true`, the logged-in user's name is added to every attributed log line across all channels — the console prefix becomes `[swing:<runId>\|<user>]` and the `%swingUser` / `%X{swingUser}` pattern tokens render the name. Off by default because a user's name is personal data; without it, the name appears only in the per-instance correlation line. Requires an identity to have been published. See <<logging#swing-bridge.logging.identity.per-line, Showing the Name on Every Line>>.

|`swingbridge.log.user`
|—
|Not set by the operator: an embedded Swing application sets this property at runtime, after its own login, to publish the authenticated user's name for log attribution. The value is routed per session, so concurrent users can't overwrite each other. See <<logging#swing-bridge.logging.identity, Adding the User's Name to the Logs>>.
|===

For Spring Boot, set system properties through `<systemPropertyVariables>` on the `spring-boot-maven-plugin` (see <<installation-from-scratch#swing-bridge.installation-from-scratch.project-setup, Project Setup>>) or pass `-D` flags on the command line. For a packaged JAR, pass them with `-D` on the command line:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,9 @@ Add the following parent section, properties, and dependencies to your `pom.xml`
<artifactId>swing-bridge-graphics</artifactId>
<version>${swing-bridge.version}</version>
</dependency>
<!-- The exclusion keeps Spring Boot's default Logback as the SLF4J
backend. See Logging & Identifying Logs per User for the trade-offs and
for standardizing on Log4j2 instead. -->
<dependency>
<groupId>com.vaadin</groupId>
<artifactId>swing-bridge-flow</artifactId>
Expand Down Expand Up @@ -148,6 +151,8 @@ Add the following parent section, properties, and dependencies to your `pom.xml`
</dependencies>
----

The `log4j-slf4j2-impl` exclusion keeps Spring Boot's default Logback as the logging backend. See <<logging#swing-bridge.logging.frameworks.slf4j, Logging & Identifying Logs per User>> for the trade-offs, and for standardizing on Log4j2 instead so that embedded Swing applications' direct Log4j calls end up in the same log files.

SwingBridge requires certain JVM flags so that Maven can access internal Java modules during compilation. Create a `.mvn/jvm.config` file in the project root with the following content:

.`.mvn/jvm.config`
Expand Down
Loading
Loading