Skip to content

Commit

Permalink
Update Native Image Inspection Tool doc
Browse files Browse the repository at this point in the history
  • Loading branch information
olyagpl committed Apr 22, 2024
1 parent d5c241a commit c56982f
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions docs/reference-manual/native-image/InspectTool.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ redirect_from: /reference-manual/native-image/inspect/

# Native Image Inspection Tool

Native Image provides the inspection tool to list all methods included in a native executable or a native shared library. Run the command `$JAVA_HOME/bin/native-image-inspect <path_to_binary>` to list classes, methods, fields, and constructors in the JSON format that validates against the JSON schema defined in [`native-image-inspect-schema-v0.2.0.json`](assets/native-image-inspect-schema-v0.2.0.json).

> Note: The inspection tool is not available in GraalVM Community Edition.
Native Image provides the inspection tool to list all methods included in a native executable or a native shared library.
Run the command `$JAVA_HOME/bin/native-image-inspect <path_to_binary>` to list classes, methods, fields, and constructors in the JSON format that validates against the JSON schema defined in [`native-image-inspect-schema-v0.2.0.json`](assets/native-image-inspect-schema-v0.2.0.json).
(Not available in GraalVM Community Edition.)

The `native-image` builder, by default, includes metadata in the native executable which then enables the inspection tool to list the included methods.

Expand All @@ -20,9 +20,7 @@ Images compiled with this option will not be able to be inspected by the tool.
## Software Bill of Materials (SBOM)

Native Image can embed a Software Bill of Materials (SBOM) at build time to detect any libraries that may be susceptible to known security vulnerabilities.
Native Image provides the `--enable-sbom` option to embed an SBOM into a native executable.

> Note: Embedding a Software Bill of Materials (SBOM) is not available in GraalVM Community Edition. The feature is currently experimental.
Native Image provides the `--enable-sbom` option to embed an SBOM into a native executable (not available in GraalVM Community Edition).

The tool is able to extract the compressed SBOM using an optional `--sbom` parameter accessible through `$JAVA_HOME/bin/native-image-inspect --sbom <path_to_binary>`.

Expand Down

0 comments on commit c56982f

Please sign in to comment.