Skip to content

docs: update lyo 7.x migration guide for JDK 21 and JSON4J removal #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
berezovskyi wants to merge 1 commit into
base: gh-pages
Choose a base branch
from
Open

docs: update lyo 7.x migration guide for JDK 21 and JSON4J removal #45

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
38 changes: 35 additions & 3 deletions docs-new/eclipse_lyo/migration-6x-7x.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,16 +25,17 @@ Migration from Lyo 6.x to 7.x involves:

| Component | Lyo 6.x | Lyo 7.x |
|-----------|---------|---------|
| **JDK baseline** | 17 | 17 (21 planned) |
| **JDK baseline** | 17 | 21 |
| **Apache Jena** | 4.8 | 4.10 (5.x planned) |
| **Jersey** | 3.1.5 | 3.1.5 (3.1.10 planned) |
| **Jakarta EE** | EE10 | EE10 |

### Breaking Changes Summary

- ❌ **JDK 17 support removed** (JDK 21+ required)
- ❌ **`oslc4j-json4j-provider` removed** (deprecated dependency)
- 🔄 **Apache Jena 4.10 API changes** (minor breaking changes)
- ✅ **Most applications should migrate seamlessly**
- ✅ **Most applications should migrate seamlessly if compiled with Java 21**

## Step-by-Step Migration

Expand All @@ -60,14 +61,32 @@ grep -r "org.apache.jena" src/
### Phase 2: Dependency Updates

#### 2.1 Update Lyo Version
Update the Lyo version in your properties. Note that starting with version `7.0.0.Alpha4`, Eclipse Lyo introduced a **Bill of Materials (BOM)** to simplify dependency management and ensure version convergence across different Lyo artifacts:

```xml
<properties>
<lyo.version>7.0.0.Alpha3</lyo.version>
<lyo.version>7.0.0-Alpha.10</lyo.version> <!-- Use the latest available version -->
<!-- Other versions remain the same -->
<jersey.version>3.1.5</jersey.version>
</properties>
```

You can optionally manage Lyo dependencies via the new BOM in `<dependencyManagement>`:

```xml
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.eclipse.lyo</groupId>
<artifactId>lyo-bom</artifactId>
<version>${lyo.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
```

#### 2.2 Remove Deprecated Dependencies
If using the deprecated JSON4J provider:

Expand All @@ -82,6 +101,19 @@ If using the deprecated JSON4J provider:
-->
```

!!! note "Wink JSON4J Classes Usage"
If the project code (such as generated selection/creation dialogue methods) still imports and uses classes from `org.apache.wink.json4j.*` (like `JSONObject`, `JSONArray`, or `JSONException`), a direct dependency on Apache Wink JSON4J shall be added to the `pom.xml` to avoid compilation errors:

```xml
<dependency>
<groupId>org.apache.wink</groupId>
<artifactId>wink-json4j</artifactId>
<version>1.4</version>
</dependency>
```

The `Json4JProvidersRegistry` and `JsonHelper` imports and registrations shall also be removed from the JAX-RS Application registration logic, as these specific helpers were part of the removed `oslc4j-json4j-provider` wrapper.

### Phase 3: Code Changes (Minimal Expected)

#### 3.1 JSON4J Provider Replacement
Expand Down
Loading