Skip to content

Fix full SPDX example #247

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
goneall merged 3 commits into from
Nov 7, 2025
Merged

Fix full SPDX example #247

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
4f09047
Fix full SPDX example
goneall Nov 7, 2025
d7d23ba
Add missing file copyright notice
goneall Nov 7, 2025
dfe421b
Add missing file copyright notice
goneall Nov 7, 2025
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
189 changes: 189 additions & 0 deletions examples/org/spdx/examples/ExpandedLicenseExampleV3.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,189 @@
/**
* SPDX-FileContributor: Gary O'Neall
* SPDX-FileCopyrightText: Copyright (c) 2025 Source Auditor Inc.
* SPDX-FileType: SOURCE
* SPDX-License-Identifier: Apache-2.0
*
* Example of serializing a single expanded license
*/

package org.spdx.examples;

import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
import com.networknt.schema.Error;
import com.networknt.schema.Schema;
import com.networknt.schema.SchemaRegistry;
import com.networknt.schema.SpecificationVersion;
import org.spdx.core.DefaultModelStore;
import org.spdx.core.IModelCopyManager;
import org.spdx.library.LicenseInfoFactory;
import org.spdx.library.ModelCopyManager;
import org.spdx.library.SpdxModelFactory;
import org.spdx.library.model.v3_0_1.SpdxModelClassFactoryV3;
import org.spdx.library.model.v3_0_1.core.CreationInfo;
import org.spdx.library.model.v3_0_1.core.Element;
import org.spdx.library.model.v3_0_1.core.ProfileIdentifierType;
import org.spdx.library.model.v3_0_1.core.SpdxDocument;
import org.spdx.library.model.v3_0_1.expandedlicensing.ExtendableLicense;
import org.spdx.library.model.v3_0_1.simplelicensing.AnyLicenseInfo;
import org.spdx.storage.IModelStore;
import org.spdx.storage.simple.InMemSpdxStore;
import org.spdx.tools.Verify;
import org.spdx.v3jsonldstore.JsonLDStore;

import java.io.*;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;

import static org.spdx.tools.Verify.JSON_SCHEMA_RESOURCE_V3;

/**
* Simple example serializing a single expanded license
*/
public class ExpandedLicenseExampleV3 {

static final ObjectMapper JSON_MAPPER = new ObjectMapper().enable(SerializationFeature.INDENT_OUTPUT);

/**
* @param args args[0] is the file path for the output serialized file
*/
public static void main(String[] args) throws Exception {
if (args.length != 1) {
usage();
System.exit(1);
}
File outFile = new File(args[0]);
if (outFile.exists()) {
System.out.printf("%s already exists.\n", args[0]);
System.exit(1);
}
if (!outFile.createNewFile()) {
System.out.printf("Unable to create file %s\n", args[0]);
System.exit(1);
}
if (!outFile.canWrite()) {
System.out.printf("Can not write to file %s\n", args[0]);
System.exit(1);
}
SpdxModelFactory.init();
IModelCopyManager copyManager = new ModelCopyManager();
try (JsonLDStore modelStore = new JsonLDStore(new InMemSpdxStore())) {
modelStore.setUseExternalListedElements(true); // setting this to false will include all the listed license details in the document
String defaultDocUri = "https://spdx.github.io/spdx-spec/v3.0.1/examples/complex-license-eaa46bdcfa20";
String prefix = defaultDocUri + "#";
DefaultModelStore.initialize(modelStore, defaultDocUri, copyManager);
CreationInfo creationInfo = SpdxModelClassFactoryV3.createCreationInfo(
modelStore, prefix + "garyagent", "Gary O'Neall",
copyManager);
SpdxDocument doc = creationInfo.createSpdxDocument(prefix + "document")
.setDataLicense(LicenseInfoFactory.getListedLicenseById("CC0"))
.addNamespaceMap(creationInfo.createNamespaceMap(modelStore.getNextId(IModelStore.IdType.Anonymous))
.setNamespace(prefix)
.setPrefix("example")
.build())
.addProfileConformance(ProfileIdentifierType.CORE)
.addProfileConformance(ProfileIdentifierType.SOFTWARE)
.addProfileConformance(ProfileIdentifierType.EXPANDED_LICENSING)
.build();
doc.setIdPrefix(prefix);
AnyLicenseInfo complexLicense = doc.createConjunctiveLicenseSet(prefix + "complexlicense")
// CustomLicense
.addMember(doc.createCustomLicense(prefix + "LicenseRef-customlicense1")
.setLicenseText("This is the license text for my custom license")
.setName("Gary's Custom License")
.addSeeAlso("https://example.com")
.build())
// OrLaterOperator
.addMember(doc.createOrLaterOperator(prefix + "complexorlater")
// ListedLicense
.setSubjectLicense(doc.createListedLicense("http://spdx.org/licenses/EPL-1.0")
.setName("Eclipse Public License 1.0")
.setLicenseText("Eclipse Public License - v 1.0\n\nTHE ACCOMPANYING PROGRAM IS PROVIDED" +
" UNDER THE TERMS OF THIS ECLIPSE PUBLIC LICENSE (\"AGREEMENT\"). ANY USE, REPRODUCTION " +
"OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENTS ACCEPTANCE OF THIS AGREEMENT.\n\n1. " +
"DEFINITIONS\n\n\"Contribution\" means:\n a) in the case of the initial Contributor...")
.setIsFsfLibre(true)
.setComment("EPL replaced the CPL on 28 June 2005.")
.addSeeAlso("https://opensource.org/licenses/EPL-1.0")
.build())
.build())
// DisjunctiveLicenseSet
.addMember(doc.createDisjunctiveLicenseSet(prefix + "complexdisjunctive")
// WithAdditionOperator
.addMember(doc.createWithAdditionOperator(prefix + "complexwith")
.setSubjectExtendableLicense((ExtendableLicense) LicenseInfoFactory.parseSPDXLicenseString("GPL-2.0-or-later"))
// ListedLicenseException
.setSubjectAddition(doc.createListedLicenseException("http://spdx.org/licenses/Autoconf-exception-2.0")
.setName("Autoconf exception 2.0")
.setComment("Typically used with GPL-2.0-only or GPL-2.0-or-later")
.setAdditionText("As a special exception, the Free Software Foundation gives unlimited " +
"permission to copy, distribute and modify the ...")
.addSeeAlso("http://ftp.gnu.org/gnu/autoconf/autoconf-2.59.tar.gz")
.build())
.build())
.addMember(doc.createWithAdditionOperator(prefix + "complexwithcustomaddition")
.setSubjectExtendableLicense((ExtendableLicense) LicenseInfoFactory.parseSPDXLicenseString("Apache-2.0"))
// CustomLicenseAddition
.setSubjectAddition(doc.createCustomLicenseAddition(prefix + "complexcustomaddition")
.setName("My License Addition")
.setAdditionText("Custom addition text - just for me")
.addSeeAlso("https://example.com")
.build())
.build())
// ExtendableLicense - Abstract
// IndividualLicensingInfo - used by listed license
// License - Abstract
.addMember(LicenseInfoFactory.parseSPDXLicenseString("MIT"))
.build())
.build();
doc.getRootElements().add(complexLicense);
doc.getElements().add(complexLicense);
List<String> warnings = new ArrayList<>();
Collection<Element> docElements = doc.getElements();
SpdxModelFactory.getSpdxObjects(modelStore, copyManager, null, null, prefix).forEach(
modelObject -> {
if (modelObject instanceof Element) {
Element element = (Element)modelObject;
if (!docElements.contains(element) && !element.equals(doc)) {
warnings.add("Element not in the document elements: " + element.getObjectUri());
docElements.add(element);
}
}
}
);
warnings.addAll(complexLicense.verify());
try (OutputStream outStream = new FileOutputStream(outFile)) {
modelStore.serialize(outStream, doc);
}
SchemaRegistry schemaRegistry =
SchemaRegistry.withDefaultDialect(SpecificationVersion.DRAFT_2020_12);
Schema schema;
try (InputStream is = Verify.class.getResourceAsStream("/" + JSON_SCHEMA_RESOURCE_V3)) {
schema = schemaRegistry.getSchema(is);
}
JsonNode root;
try (InputStream is = new FileInputStream(outFile)) {
root = JSON_MAPPER.readTree(is);
}
List<com.networknt.schema.Error> messages = schema.validate(root);
for (Error msg:messages) {
warnings.add(msg.toString());
}
if (!warnings.isEmpty()) {
System.out.println("Generated document contains the following warnings:");
for (String warning:warnings) {
System.out.print("\t");
System.out.println(warning);
}
}
}
}

private static void usage() {
System.out.println("Generates an SPDX JSON-LD file containing all of the supported classes.");
System.out.println("Usage: FullSpdxV3Example outputfile");
}
}
Loading