Package org.cyclonedx.parsers

Class JsonParser

java.lang.Object

org.cyclonedx.CycloneDxSchema

org.cyclonedx.parsers.JsonParser

All Implemented Interfaces:

Parser

public class JsonParser
extends CycloneDxSchema
implements Parser

JsonParser is responsible for validating and parsing CycloneDX bill-of-material JSON documents and returning a Bom object.

Since:

3.0.0

Field Summary

Fields

Modifier and Type	Field	Description
private com.fasterxml.jackson.databind.ObjectMapper	mapper

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
JsonParser()

Method Summary

Modifier and Type	Method	Description
boolean	isValid(byte[] bomBytes)	Verifies a CycloneDX BOM conforms to the latest version of the specification.
boolean	isValid(byte[] bomBytes, Version schemaVersion)	Verifies a CycloneDX BOM conforms to the specified specification version.
boolean	isValid(java.io.File file)	Verifies a CycloneDX BOM conforms to the latest version of the specification.
boolean	isValid(java.io.File file, Version schemaVersion)	Verifies a CycloneDX BOM conforms to the specified specification version.
boolean	isValid(java.io.InputStream inputStream)	Verifies a CycloneDX BOM conforms to the latest version of the specification.
boolean	isValid(java.io.InputStream inputStream, Version schemaVersion)	Verifies a CycloneDX BOM conforms to the specified specification version.
boolean	isValid(java.io.Reader reader)	Verifies a CycloneDX BOM conforms to the latest version of the specification.
boolean	isValid(java.io.Reader reader, Version schemaVersion)	Verifies a CycloneDX BOM conforms to the specified specification version.
Bom	parse(byte[] bomBytes)	Parses a CycloneDX BOM.
Bom	parse(java.io.File file)	Parses a CycloneDX BOM.
Bom	parse(java.io.InputStream inputStream)	Parses a CycloneDX BOM.
Bom	parse(java.io.Reader reader)	Parses a CycloneDX BOM.
java.util.List<ParseException>	validate(byte[] bomBytes)	Validates a CycloneDX BOM.
java.util.List<ParseException>	validate(byte[] bomBytes, Version schemaVersion)	Validates a CycloneDX BOM conforms to a specific specification version.
java.util.List<ParseException>	validate(com.fasterxml.jackson.databind.JsonNode bomJson, Version schemaVersion)	Verifies a CycloneDX BOM conforms to the specification through JSON validation.
java.util.List<ParseException>	validate(java.io.File file)	Validates a CycloneDX BOM.
java.util.List<ParseException>	validate(java.io.File file, Version schemaVersion)	Validates a CycloneDX BOM conforms to a specific specification version.
java.util.List<ParseException>	validate(java.io.InputStream inputStream)	Validates a CycloneDX BOM.
java.util.List<ParseException>	validate(java.io.InputStream inputStream, Version schemaVersion)	Validates a CycloneDX BOM conforms to a specific specification version.
java.util.List<ParseException>	validate(java.io.Reader reader)	Validates a CycloneDX BOM.
java.util.List<ParseException>	validate(java.io.Reader reader, Version schemaVersion)	Validates a CycloneDX BOM conforms to a specific specification version.
java.util.List<ParseException>	validate(java.lang.String bomString, Version schemaVersion)	Verifies a CycloneDX BOM conforms to the specification through JSON validation.

Methods inherited from class org.cyclonedx.CycloneDxSchema

getJsonSchema, getXmlSchema, getXmlSchema

Methods inherited from class java.lang.Object

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

Field Detail

mapper

private final com.fasterxml.jackson.databind.ObjectMapper mapper

Constructor Detail

JsonParser

public JsonParser()

Method Detail

parse

public Bom parse(java.io.File file)
          throws ParseException

Parses a CycloneDX BOM.

Specified by:

parse in interface Parser

Parameters:

file - a File to parse

Returns:

a Bom object

Throws:

ParseException - when errors are encountered

parse

public Bom parse(byte[] bomBytes)
          throws ParseException

Parses a CycloneDX BOM.

Specified by:

parse in interface Parser

Parameters:

bomBytes - the byte array to parse

Returns:

a Bom object

Throws:

ParseException - when errors are encountered

parse

public Bom parse(java.io.InputStream inputStream)
          throws ParseException

Parses a CycloneDX BOM.

Specified by:

parse in interface Parser

Parameters:

inputStream - the InputStream from which to parse

Returns:

a Bom object

Throws:

ParseException - when errors are encountered

parse

public Bom parse(java.io.Reader reader)
          throws ParseException

Parses a CycloneDX BOM.

Specified by:

parse in interface Parser

Parameters:

reader - the Reader from which to parse

Returns:

a Bom object

Throws:

ParseException - when errors are encountered

validate

public java.util.List<ParseException> validate(java.io.File file)
                                        throws java.io.IOException

Validates a CycloneDX BOM.

Specified by:

validate in interface Parser

Parameters:

file - the CycloneDX BOM file to validate

Returns:

a List of ParseException. If the size of the list is 0, validation was successful

Throws:

java.io.IOException - when errors are encountered

validate

public java.util.List<ParseException> validate(java.io.File file,
                                               Version schemaVersion)
                                        throws java.io.IOException

Validates a CycloneDX BOM conforms to a specific specification version.

Specified by:

validate in interface Parser

Parameters:

file - the CycloneDX BOM file to validate

schemaVersion - the schema version to validate against

Returns:

a List of ParseException. If the size of the list is 0, validation was successful

Throws:

java.io.IOException - when errors are encountered

validate

public java.util.List<ParseException> validate(byte[] bomBytes)
                                        throws java.io.IOException

Validates a CycloneDX BOM.

Specified by:

validate in interface Parser

Parameters:

bomBytes - the byte array to validate

Returns:

a List of ParseException. If the size of the list is 0, validation was successful

Throws:

java.io.IOException - when errors are encountered

validate

public java.util.List<ParseException> validate(byte[] bomBytes,
                                               Version schemaVersion)
                                        throws java.io.IOException

Validates a CycloneDX BOM conforms to a specific specification version.

Specified by:

validate in interface Parser

Parameters:

bomBytes - the byte array to validate

schemaVersion - the schema version to validate against

Returns:

a List of ParseException. If the size of the list is 0, validation was successful

Throws:

java.io.IOException - when errors are encountered

validate

public java.util.List<ParseException> validate(java.io.Reader reader)
                                        throws java.io.IOException

Validates a CycloneDX BOM.

Specified by:

validate in interface Parser

Parameters:

reader - the Reader from which to parse

Returns:

a List of ParseException. If the size of the list is 0, validation was successful

Throws:

java.io.IOException - when errors are encountered

validate

public java.util.List<ParseException> validate(java.io.Reader reader,
                                               Version schemaVersion)
                                        throws java.io.IOException

Validates a CycloneDX BOM conforms to a specific specification version.

Specified by:

validate in interface Parser

Parameters:

reader - the Reader from which to parse

schemaVersion - the schema version to validate against

Returns:

a List of ParseException. If the size of the list is 0, validation was successful

Throws:

java.io.IOException - when errors are encountered

validate

public java.util.List<ParseException> validate(java.io.InputStream inputStream)
                                        throws java.io.IOException

Validates a CycloneDX BOM.

Specified by:

validate in interface Parser

Parameters:

inputStream - the InputStream from which to validate

Returns:

a List of ParseException. If the size of the list is 0, validation was successful

Throws:

java.io.IOException - when errors are encountered

validate

public java.util.List<ParseException> validate(java.io.InputStream inputStream,
                                               Version schemaVersion)
                                        throws java.io.IOException

Validates a CycloneDX BOM conforms to a specific specification version.

Specified by:

validate in interface Parser

Parameters:

inputStream - the InputStream from which to validate

schemaVersion - the schema version to validate against

Returns:

a List of ParseException. If the size of the list is 0, validation was successful

Throws:

java.io.IOException - when errors are encountered

validate

public java.util.List<ParseException> validate(java.lang.String bomString,
                                               Version schemaVersion)
                                        throws java.io.IOException

Verifies a CycloneDX BOM conforms to the specification through JSON validation.

Parameters:

bomString - the CycloneDX BOM to validate

schemaVersion - the schema version to validate against

Returns:

a list of exceptions encountered during validation

Throws:

java.io.IOException - when errors are encountered

Since:

3.0.0

validate

public java.util.List<ParseException> validate(com.fasterxml.jackson.databind.JsonNode bomJson,
                                               Version schemaVersion)
                                        throws java.io.IOException

Verifies a CycloneDX BOM conforms to the specification through JSON validation.

Parameters:

bomJson - the CycloneDX BOM to validate

schemaVersion - the schema version to validate against

Returns:

a list of exceptions encountered during validation

Throws:

java.io.IOException - when errors are encountered

Since:

3.0.0

isValid

public boolean isValid(java.io.File file)
                throws java.io.IOException

Verifies a CycloneDX BOM conforms to the latest version of the specification.

Specified by:

isValid in interface Parser

Parameters:

file - the CycloneDX BOM file to validate

Returns:

true if the file is a valid BOM, false if not

Throws:

java.io.IOException - when errors are encountered

isValid

public boolean isValid(java.io.File file,
                       Version schemaVersion)
                throws java.io.IOException

Verifies a CycloneDX BOM conforms to the specified specification version.

Specified by:

isValid in interface Parser

Parameters:

file - the CycloneDX BOM file to validate

schemaVersion - the schema version to validate against

Returns:

true if the file is a valid BOM, false if not

Throws:

java.io.IOException - when errors are encountered

isValid

public boolean isValid(byte[] bomBytes)
                throws java.io.IOException

Verifies a CycloneDX BOM conforms to the latest version of the specification.

Specified by:

isValid in interface Parser

Parameters:

bomBytes - the byte array to validate

Returns:

true if the file is a valid BOM, false if not

Throws:

java.io.IOException - when errors are encountered

isValid

public boolean isValid(byte[] bomBytes,
                       Version schemaVersion)
                throws java.io.IOException

Verifies a CycloneDX BOM conforms to the specified specification version.

Specified by:

isValid in interface Parser

Parameters:

bomBytes - the byte array to validate

schemaVersion - the schema version to validate against

Returns:

true if the file is a valid BOM, false if not

Throws:

java.io.IOException - when errors are encountered

isValid

public boolean isValid(java.io.Reader reader)
                throws java.io.IOException

Verifies a CycloneDX BOM conforms to the latest version of the specification.

Specified by:

isValid in interface Parser

Parameters:

reader - the Reader from which to validate

Returns:

true if the file is a valid BOM, false if not

Throws:

java.io.IOException - when errors are encountered

isValid

public boolean isValid(java.io.Reader reader,
                       Version schemaVersion)
                throws java.io.IOException

Verifies a CycloneDX BOM conforms to the specified specification version.

Specified by:

isValid in interface Parser

Parameters:

reader - the Reader from which to validate

schemaVersion - the schema version to validate against

Returns:

true if the file is a valid BOM, false if not

Throws:

java.io.IOException - when errors are encountered

isValid

public boolean isValid(java.io.InputStream inputStream)
                throws java.io.IOException

Verifies a CycloneDX BOM conforms to the latest version of the specification.

Specified by:

isValid in interface Parser

Parameters:

inputStream - the InputStream from which to validate

Returns:

true if the file is a valid BOM, false if not

Throws:

java.io.IOException - when errors are encountered

isValid

public boolean isValid(java.io.InputStream inputStream,
                       Version schemaVersion)
                throws java.io.IOException

Verifies a CycloneDX BOM conforms to the specified specification version.

Specified by:

isValid in interface Parser

Parameters:

inputStream - the InputStream from which to validate

schemaVersion - the schema version to validate against

Returns:

true if the file is a valid BOM, false if not

Throws:

java.io.IOException - when errors are encountered