Class CycloneDxSchema

java.lang.Object

org.cyclonedx.CycloneDxSchema

Direct Known Subclasses:

AbstractBomGenerator, 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

Field Summary

Fields

Modifier and Type	Field	Description
static final List<Version>	ALL_VERSIONS
static final String	NS_BOM_10
static final String	NS_BOM_11
static final String	NS_BOM_12
static final String	NS_BOM_13
static final String	NS_BOM_14
static final String	NS_BOM_15
static final String	NS_BOM_16
static final String	NS_BOM_LATEST
static final String	NS_DEPENDENCY_GRAPH_10	Deprecated.
static final Version	VERSION_LATEST

Constructor Summary

Constructors

Constructor	Description
CycloneDxSchema()

Method Summary

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

Methods inherited from class Object

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

Field Details

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_BOM_14

public static final String NS_BOM_14

See Also:

• Constant Field Values

NS_BOM_15

public static final String NS_BOM_15

See Also:

• Constant Field Values

NS_BOM_16

public static final String NS_BOM_16

See Also:

• Constant Field Values

NS_DEPENDENCY_GRAPH_10

@Deprecated
public static final String NS_DEPENDENCY_GRAPH_10

Deprecated.

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 Version VERSION_LATEST

ALL_VERSIONS

public static final List<Version> ALL_VERSIONS

Constructor Details

CycloneDxSchema

public CycloneDxSchema()

Method Details

getJsonSchema

public com.networknt.schema.JsonSchema getJsonSchema(Version schemaVersion,
 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

mapper - is to provide a Jackson ObjectMapper

Returns:

a Schema

Throws:

IOException - when errors are encountered

Since:

6.0.0

getXmlSchema

public Schema getXmlSchema(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