Skip to content

docs: align Java SDK documentation #987

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

Merged
jonathannorris merged 3 commits into from
Aug 7, 2026
Merged

docs: align Java SDK documentation #987

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
83f0474
docs: align Java SDK documentation
jonathannorris Aug 6, 2026
1548027
docs: use a compatible Java SDK version range
jonathannorris Aug 6, 2026
333a862
docs: separate Java client shutdown guidance
jonathannorris Aug 6, 2026
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 docs/sdk/server-side-sdks/java/java-install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,14 +63,14 @@ You can use the SDK in your Maven project by adding the following to your _pom.x
<dependency>
<groupId>com.devcycle</groupId>
<artifactId>java-server-sdk</artifactId>
<version>LATEST</version>
<version>[2.9.3,3.0.0)</version>
Comment thread
jonathannorris marked this conversation as resolved.
<scope>compile</scope>
</dependency>
```

:::info

Refer to the latest version of the SDK on [maven central](https://maven.org/artifact/com.devcycle/java-server-sdk) if you would not prefer Maven or Gradle to pull the latest version automatically by using `+`
This range accepts compatible releases from `2.9.3` up to, but not including, `3.0.0`. Refer to [Maven Central](https://maven.org/artifact/com.devcycle/java-server-sdk) for the latest available release.

:::

Expand All @@ -79,7 +79,7 @@ Refer to the latest version of the SDK on [maven central](https://maven.org/arti
Alternatively you can use the SDK in your Gradle project by adding the following to _build.gradle_:

```yaml
implementation("com.devcycle:java-server-sdk:+")
implementation("com.devcycle:java-server-sdk:[2.9.3,3.0.0)")
```
[//]: # 'wizard-install-end'

Expand Down
6 changes: 3 additions & 3 deletions docs/sdk/server-side-sdks/java/java-openfeature.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,14 +38,14 @@ You can use the Java SDK in your Maven project by adding the following to your _
<dependency>
<groupId>com.devcycle</groupId>
<artifactId>java-server-sdk</artifactId>
<version>LATEST</version>
<version>[2.9.3,3.0.0)</version>
<scope>compile</scope>
</dependency>
```

:::info

Refer to the latest version of the SDK on [maven central](https://maven.org/artifact/com.devcycle/java-server-sdk) if you would not prefer Maven or Gradle to pull the latest version automatically by using `+`
This range accepts compatible releases from `2.9.3` up to, but not including, `3.0.0`. Refer to [Maven Central](https://maven.org/artifact/com.devcycle/java-server-sdk) for the latest available release.

:::

Expand All @@ -54,7 +54,7 @@ Refer to the latest version of the SDK on [maven central](https://maven.org/arti
Alternatively you can use the SDK in your Gradle project by adding the following to _build.gradle_:

```yaml
implementation("com.devcycle:java-server-sdk:+")
implementation("com.devcycle:java-server-sdk:[2.9.3,3.0.0)")
```
[//]: # 'wizard-install-end'

Expand Down
8 changes: 8 additions & 0 deletions docs/sdk/server-side-sdks/java/java-usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,14 @@ customData.put("some-key", "some-value");
client.setClientCustomData(customData);
```

## Shutdown

Close the client during application shutdown to stop background polling, realtime connections, and event queue workers:

```java
client.close();
```
Comment thread
jonathannorris marked this conversation as resolved.

## Override Logging

The SDK logs to stdout by default and does not require any specific logging package. To integrate with your own logging system, such as Java Logging or SLF4J, you can create a wrapper that implements the IDevCycleLogger interface. Then you can set the logger into the Java Server SDK setting the Custom Logger property in the options object used to initialize the client.
Expand Down
Loading