org.cyclonedx

Class CycloneDxSchema

java.lang.Object

org.cyclonedx.CycloneDxSchema

Direct Known Subclasses:

AbstractBomJsonGenerator, AbstractBomXmlGenerator, JsonParser, XmlParser

public abstract class CycloneDxSchema
extends Object

CycloneDxSchema is a base class that provides schema information to BomXmlGenerator, BomJsonGenerator, and Parser. The class can be extended for other implementations as well.

Since:

1.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CycloneDxSchema.Version

Field Summary

Fields

Modifier and Type	Field and Description
static String	NS_BOM_10
static String	NS_BOM_11
static String	NS_BOM_12
static String	NS_BOM_13
static String	NS_BOM_LATEST
static String	NS_DEPENDENCY_GRAPH_10
static CycloneDxSchema.Version	VERSION_LATEST

Constructor Summary

Constructors

Constructor and Description
CycloneDxSchema()

Method Summary

Modifier and Type	Method and Description
com.networknt.schema.JsonSchema	getJsonSchema(CycloneDxSchema.Version schemaVersion, boolean strict, com.fasterxml.jackson.databind.ObjectMapper mapper) Returns the CycloneDX JsonSchema for the specified schema version.
Schema	getXmlSchema(CycloneDxSchema.Version schemaVersion) Returns the CycloneDX XML Schema for the specified schema version.
Schema	getXmlSchema(InputStream... inputStreams)

Methods inherited from class java.lang.Object

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

Field Detail

NS_BOM_10

public static final String NS_BOM_10

See Also:

Constant Field Values

NS_BOM_11

public static final String NS_BOM_11

See Also:

Constant Field Values

NS_BOM_12

public static final String NS_BOM_12

See Also:

Constant Field Values

NS_BOM_13

public static final String NS_BOM_13

See Also:

Constant Field Values

NS_DEPENDENCY_GRAPH_10

public static final String NS_DEPENDENCY_GRAPH_10

See Also:

Constant Field Values

NS_BOM_LATEST

public static final String NS_BOM_LATEST

See Also:

Constant Field Values

VERSION_LATEST

public static final CycloneDxSchema.Version VERSION_LATEST

Constructor Detail

CycloneDxSchema

public CycloneDxSchema()

Method Detail

getJsonSchema

public com.networknt.schema.JsonSchema getJsonSchema(CycloneDxSchema.Version schemaVersion,
                                                     boolean strict,
                                                     com.fasterxml.jackson.databind.ObjectMapper mapper)
                                              throws IOException

Returns the CycloneDX JsonSchema for the specified schema version.

Parameters:

schemaVersion - The version to return the schema for

strict - if true, the strict schema will be used which prohibits non-defined properties from being present in the BOM

Returns:

a Schema

Throws:

IOException - when errors are encountered

Since:

5.0.0

getXmlSchema

public Schema getXmlSchema(CycloneDxSchema.Version schemaVersion)
                    throws SAXException

Returns the CycloneDX XML Schema for the specified schema version.

Parameters:

schemaVersion - The version to return the schema for

Returns:

a Schema

Throws:

SAXException - a SAXException

Since:

2.0.0

getXmlSchema

public Schema getXmlSchema(InputStream... inputStreams)
                    throws SAXException

Throws:

SAXException