Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

SCM integrations for Java and Kotlin

How Snyk scans Maven and Gradle applications through SCM integrations, including dependency trees and supported scopes

Available SCM integrations

Maven

When scanning Maven applications, Snyk creates a Project per pom.xml file. The Project includes all direct and indirect dependencies associated with that file.

The Project includes only the production dependencies in the compile, provided, and runtime scopes.

For Maven, Snyk can generate a dependency tree from POM through the SCM integration or the CLI:

  • Locally and using continuous integration/continuous delivery (CI/CD): Snyk interacts with the package manager to produce a list of dependencies.

  • SCM integration: Snyk approximates the build as if it were built at that time.

Snyk ignores developer dependencies (scope=test) because they are not pushed to production and are generally considered noise. To include them in the CLI, add --dev.

Because Maven resolves dependencies in the order it encounters them in the POM file, list dev dependencies last in the POM file. Otherwise, Snyk can report dev dependencies.

Gradle

For Gradle, Snyk interacts with the package manager to produce a list of dependencies. Typically, Gradle executes code and other actions during the build process that impact the installed dependencies, so Snyk recommends using the CLI if a gradle.lockfile is not present.

For Gradle, after you select a Project for import, Snyk builds the dependency tree based on the build.gradle file and (optional) gradle.lockfile.

Snyk includes only production dependencies in the api, compile, classpath, implementation, runtime, and runtimeOnly configurations.

If possible, enable Gradle lockfiles in your application. When present, Snyk can more accurately resolve the final version of dependencies used in the Project.

For Kotlin, Snyk supports the following manifest files:

  • build.gradle (Groovy DSL) for both SCM and CLI

  • build.gradle.kts (Kotlin DSL) for CLI only

Maven and Gradle Projects using gradle.lockfile

If you use Maven, or Gradle with a gradle.lockfile, the SCM integration is an efficient way to use Snyk and get visibility. You can also use the CLI, IDE, or CI/CD integrations to test, gate, or monitor.

Typically, you can instrument testing as part of a build system or adopt a lockfile as part of your process.

  • Large companies commonly start by monitoring applications daily through the SCM integration, and turn on PR Checks only for key applications.

  • As developers become familiar with Snyk capabilities, they widen the scope of applications with PR Checks for gating.

  • Use CI/CD to passively monitor and then turn on gating by using the snyk [product] test and monitor commands.

Gradle Projects without a lockfile

If you use Gradle without a gradle.lockfile, it is possible that the full dependency tree is not apparent or artifacts are pulled in from external resources. Snyk recommends the following:

  • Use the CLI or IDE workflow for local scans.

  • Use CI/CD to passively monitor and then turn on gating by using the snyk [product] test and monitor commands.

  • Start by turning on gating and failing the build on one Project so developers become familiar with the process. Then use passive monitoring for the rest of the portfolio.

Improved Gradle SCM scanning

Release status

Improved Gradle SCM scanning is in Early Access. You can enable the feature by using Snyk Preview.

Supported Gradle features

Improved Gradle SCM scanning does not support the following Gradle features:

  • Custom configuration in buildSrc directories

  • Dependencies introduced through plugins

Enable improved Gradle SCM scanning

To enable this feature, follow these steps for your Snyk Organization:

  1. Configure package repository integrations (if you use Artifactory or Nexus, visit Package repository integrations).

  2. Enable Improved Gradle scanning in Snyk Preview.

After Improved Gradle SCM scanning is enabled:

  • Snyk automatically updates existing Gradle Groovy DSL Projects in previously imported SCM repositories on the next manual or recurring test.

  • Re-import the repository to start seeing results for Gradle Kotlin DSL Projects.

Package repository integrations

If your application build uses private package repositories, you must configure the relevant Snyk integration to get the most accurate results.

To use package repository integrations with the Improved Gradle scanning feature, use the configuration instructions and settings for Maven. Improved Gradle scans detect and use these settings.

In the Java language settings, you can integrate Snyk with your private package repositories (for example, Artifactory or Nexus). With this integration, Snyk can build a complete dependency tree when scanning Maven or Gradle Projects that reference private packages.

Package registry integrations (Artifactory/Nexus) for Maven

Artifactory and Nexus package registry integrations are available only with Snyk Enterprise plans.

Snyk Open Source uses Artifactory or Nexus to resolve transitive dependencies through private packages.

You can connect Snyk to a publicly available instance using a username and password, or to a private server on your network using Snyk Broker.

Snyk Open Source provides integrations with Artifactory and Nexus, both as local gatekeepers and interacting with the registry for security testing. Visit Nexus Repository Manager setup and Artifactory Registry setup.

For users who do not have a Snyk Enterprise integration with Artifactory or Nexus, Snyk recommends using the CLI, because it works with the dependencies that your build system makes available locally.

For more information on package registry integrations, including Maven, visit the following resources:

Configure language settings for Java

You can configure language settings for your open source libraries and licensing at the Organization level. The configuration settings apply to all Projects in that Organization. To configure:

  1. In the Snyk Web UI, navigate to Settings > Snyk Open Source > Languages > Java.

  2. Click Edit settings.

  3. Configure the settings for Maven.

  4. Click Update Settings to save changes.

APIs

Customers develop advanced dependency management strategies and can choose not to use the standard and frequently used package managers.

For on-time testing using the Snyk API, you can use the Test endpoints. Examples include Test for issues in a (Maven) public package by group id, artifact id and version and List issues for a package.

Last updated

Was this helpful?