Package org.cyclonedx.generators.xml

Class BomXmlGenerator

java.lang.Object

org.cyclonedx.CycloneDxSchema

org.cyclonedx.generators.AbstractBomGenerator

org.cyclonedx.generators.xml.BomXmlGenerator

public class BomXmlGenerator
extends AbstractBomGenerator

Field Summary

Fields

Modifier and Type	Field	Description
private final com.fasterxml.jackson.dataformat.xml.util.DefaultXmlPrettyPrinter	prettyPrinter
protected static final String	PROLOG

Fields inherited from class org.cyclonedx.generators.AbstractBomGenerator

bom, format, mapper, version

Fields inherited from class org.cyclonedx.CycloneDxSchema

ALL_VERSIONS, NS_BOM_10, NS_BOM_11, NS_BOM_12, NS_BOM_13, NS_BOM_14, NS_BOM_15, NS_BOM_16, NS_BOM_LATEST, NS_DEPENDENCY_GRAPH_10, VERSION_LATEST

Constructor Summary

Constructors

Constructor	Description
BomXmlGenerator(Bom bom, Version version)	Constructs a new BomXmlGenerator object.

Method Summary

Modifier and Type	Method	Description
private DocumentBuilder	buildSecureDocumentBuilder()	Constructs a new document builder with security features enabled.
Document	generate()	Creates a CycloneDX BoM from a set of Components.
protected Document	generateDocument(Bom bom)
private void	registerDependencyModule(com.fasterxml.jackson.databind.ObjectMapper mapper, boolean useNamespace)
private void	setupObjectMapper()
String	toString()	Creates a text representation of a CycloneDX BoM Document.
(package private) String	toXML(Bom bom, boolean prettyPrint)
String	toXmlString()

Methods inherited from class org.cyclonedx.generators.AbstractBomGenerator

getFormat, getSchemaVersion, setupObjectMapper

Methods inherited from class org.cyclonedx.CycloneDxSchema

getJsonSchema, getXmlSchema, getXmlSchema

Methods inherited from class java.lang.Object

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

Field Details

prettyPrinter

private final com.fasterxml.jackson.dataformat.xml.util.DefaultXmlPrettyPrinter prettyPrinter

PROLOG

protected static final String PROLOG

See Also:

• Constant Field Values

Constructor Details

BomXmlGenerator

public BomXmlGenerator(Bom bom,
 Version version)

Constructs a new BomXmlGenerator object.

Parameters:

bom - the BOM to generate

version - the version of the CycloneDX schema to use.

Method Details

setupObjectMapper

private void setupObjectMapper()

registerDependencyModule

private void registerDependencyModule(com.fasterxml.jackson.databind.ObjectMapper mapper,
 boolean useNamespace)

buildSecureDocumentBuilder

private DocumentBuilder buildSecureDocumentBuilder()
                                            throws ParserConfigurationException

Constructs a new document builder with security features enabled.

Returns:

a new document builder

Throws:

ParserConfigurationException - thrown if there is a parser configuration exception

generateDocument

protected Document generateDocument(Bom bom)
                             throws ParserConfigurationException

Throws:

ParserConfigurationException

toXML

String toXML(Bom bom,
 boolean prettyPrint)
      throws GeneratorException

Throws:

GeneratorException

generate

public Document generate()
                  throws ParserConfigurationException

Creates a CycloneDX BoM from a set of Components.

Returns:

an XML Document representing a CycloneDX BoM

Throws:

ParserConfigurationException - if an error occurs

Since:

1.1.0

toXmlString

public String toXmlString()
                   throws GeneratorException

Throws:

GeneratorException

toString

public String toString()

Creates a text representation of a CycloneDX BoM Document. This method calls toXmlString() and will return an empty string if toXmlString() throws an exception. It's preferred to call toXmlString() directly so that exceptions can be caught.

Overrides:

toString in class Object

Returns:

a String of the BoM

Since:

1.1.0