Skip to main content
The nexus-spring-boot-starter artifact is hosted on the GitLab Maven Package Registry. It is public - no token is required to install.

1. Register the repository

Add the registry to your project. Use the numeric project ID rather than the URL path so your build is resilient to any future repository moves.

2. Add the dependency

The OpenFeature provider is a second artifact, nexus-openfeature-spring-boot, released at the same version as the starter; use the two at one version.

Requirements

  • Java 17 or newer. Every release is tested on JDK 17, 21 and 25.
  • Spring Boot 3.5, 4.0 or 4.1. The starter is built against 4.0 and every pipeline run tests 3.5.16, 4.0.9 and 4.1.2. One artifact covers all three: there is no -boot3 / -boot4 variant and no framework version in the coordinates. Spring Boot 3.5 is out of its open-source support (since 2026-06-30) but still supported by the SDK.
  • Jackson - whichever major your framework brings (Jackson 2 on Spring Boot 3, Jackson 3 on Spring Boot 4). Both are declared <optional>, so the starter never adds a second JSON library to your classpath. See JSON values.
  • SLF4J - already on the Spring Boot classpath.
  • For the aws_iam WIF provider only: software.amazon.awssdk:auth and software.amazon.awssdk:regions. See Workload identity.

Verify the installation

On startup the application log shows two lines from the logger dev.westyx.nexus.NexusClient:
The second line names what the first sync delivered - names only, never a value. See Logging. If neither appears, the auto-configuration did not fire. Common causes:
  • No endpoint: neither nexus.base-url nor the WESTYX_SERVICE_ENDPOINT environment variable is set. The auto-configuration activates on either; the run’s condition report (--debug) names both under “Nexus endpoint”.
  • A NexusClient bean of your own - the auto-configuration backs off when one is already registered.

Verifying connectivity

Before writing any code, confirm your endpoint and API key work with a plain curl:
A valid response returns a JSON snapshot with your configs, secrets, and flags. An HTTP 401 means the key is wrong; HTTP 404 means the slug is wrong; HTTP 403 with environment_disabled means the environment is switched off in the console. To watch the live SSE stream:
You should see event:resync arrive within a second. Press Ctrl+C to stop.

Troubleshooting

  • Could not transfer artifact dev.westyx.nexus:nexus-spring-boot-starter - your build has not picked up the GitLab registry. Confirm the <repositories> block is in your pom.xml, not just ~/.m2/settings.xml; repository declarations in settings.xml need a matching active <profile>.
  • 401 Unauthorized from the registry - the registry is configured with an old path. Switch to the numeric-ID URL above.
  • The context fails to start with NexusInitException - the initial sync failed; its cause names why. See Error handling.