Module org.kohsuke.github.api

Package org.kohsuke.github

Class GHSBOM

java.lang.Object

org.kohsuke.github.GHSBOM

public class GHSBOM
extends Object

Represents an SPDX Software Bill of Materials (SBOM) for a repository.

See Also:

• GHRepository.getSBOM()
• GitHub SBOM API

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GHSBOM.CreationInfo	Represents the creation information for an SBOM.
static class	GHSBOM.ExternalRef	Represents an external reference for a package.
static class	GHSBOM.Package	Represents a package in the SBOM.
static class	GHSBOM.Relationship	Represents a relationship between SPDX elements.

Constructor Summary

Constructors

Constructor	Description
GHSBOM()	Create default GHSBOM instance.

Method Summary

Modifier and Type	Method	Description
GHSBOM.CreationInfo	getCreationInfo()	Gets the creation info.
String	getDataLicense()	Gets the data license.
String	getDocumentDescribes()	Gets the document describes field.
String	getDocumentNamespace()	Gets the document namespace.
String	getName()	Gets the document name.
List<GHSBOM.Package>	getPackages()	Gets the list of packages.
List<GHSBOM.Relationship>	getRelationships()	Gets the relationships.
String	getSPDXID()	Gets the SPDX identifier.
String	getSpdxVersion()	Gets the SPDX version.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

GHSBOM

public GHSBOM()

Create default GHSBOM instance.

Method Details

getCreationInfo

public GHSBOM.CreationInfo getCreationInfo()

Gets the creation info.

Returns:

the creation info

getDataLicense

public String getDataLicense()

Gets the data license.

Returns:

the data license (typically "CC0-1.0")

getDocumentDescribes

@CheckForNull
public String getDocumentDescribes()

Gets the document describes field.

Returns:

the document describes field, or null if not specified

getDocumentNamespace

public String getDocumentNamespace()

Gets the document namespace.

Returns:

the document namespace URI

getName

public String getName()

Gets the document name.

Returns:

the document name

getPackages

public List<GHSBOM.Package> getPackages()

Gets the list of packages.

Returns:

the list of packages

getRelationships

public List<GHSBOM.Relationship> getRelationships()

Gets the relationships.

Returns:

the relationships between SPDX elements

getSPDXID

public String getSPDXID()

Gets the SPDX identifier.

Returns:

the SPDX identifier (typically "SPDXRef-DOCUMENT")

getSpdxVersion

public String getSpdxVersion()

Gets the SPDX version.

Returns:

the SPDX version (e.g., "SPDX-2.3")