Class XmlParser

java.lang.Object
org.cyclonedx.CycloneDxSchema
org.cyclonedx.parsers.XmlParser
All Implemented Interfaces:
Parser
public class XmlParser extends CycloneDxSchema implements Parser
XmlParser is responsible for validating and parsing CycloneDX bill-of-material XML documents and returning a Bom object.
Since:
3.0.0

  • Field Details

    • mapper

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

    • NAMESPACE_TO_VERSION_MAP

      private static final Map<String,String> NAMESPACE_TO_VERSION_MAP

  • Constructor Details

    • XmlParser

      public XmlParser()

  • Method Details

    • parse

      public Bom parse(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(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(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

    • injectSchemaVersion

      private Bom injectSchemaVersion(Bom bom, String schemaVersion)
      Uses reflection to set the schemaVersion field inside a Bom instance. The schemaVersion is 'not user serviceable' so no methods for setting it are provided, other than the constructor, which xstream does not use.
      Parameters:
      bom - the Bom to set the schemaVersion for
      schemaVersion - the value of the schema version
      Returns:
      the updated Bom
      Since:
      3.0.0

    • validate

      public List<ParseException> validate(File file) throws 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:
      IOException - when errors are encountered

    • validate

      public List<ParseException> validate(File file, Version schemaVersion) throws 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:
      IOException - when errors are encountered

    • validate

      public List<ParseException> validate(byte[] bomBytes) throws 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:
      IOException - when errors are encountered

    • validate

      public List<ParseException> validate(byte[] bomBytes, Version schemaVersion) throws 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:
      IOException - when errors are encountered

    • validate

      public List<ParseException> validate(Reader reader) throws 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:
      IOException - when errors are encountered

    • validate

      public List<ParseException> validate(Reader reader, Version schemaVersion) throws 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:
      IOException - when errors are encountered

    • validate

      public List<ParseException> validate(InputStream inputStream) throws 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:
      IOException - when errors are encountered

    • validate

      public List<ParseException> validate(InputStream inputStream, Version schemaVersion) throws 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:
      IOException - when errors are encountered

    • validate

      public List<ParseException> validate(Source source, Version schemaVersion) throws IOException
      Throws:
      IOException

    • isValid

      public boolean isValid(File file) throws 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:
      IOException - when errors are encountered

    • isValid

      public boolean isValid(File file, Version schemaVersion) throws 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:
      IOException - when errors are encountered

    • isValid

      public boolean isValid(byte[] bomBytes) throws 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:
      IOException - when errors are encountered

    • isValid

      public boolean isValid(byte[] bomBytes, Version schemaVersion) throws 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:
      IOException - when errors are encountered

    • isValid

      public boolean isValid(Reader reader) throws 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:
      IOException - when errors are encountered

    • isValid

      public boolean isValid(Reader reader, Version schemaVersion) throws 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:
      IOException - when errors are encountered

    • isValid

      public boolean isValid(InputStream inputStream) throws 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:
      IOException - when errors are encountered

    • isValid

      public boolean isValid(InputStream inputStream, Version schemaVersion) throws 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:
      IOException - when errors are encountered

    • identifySchemaVersion

      private String identifySchemaVersion(InputSource in) throws ParserConfigurationException, IOException, SAXException
      Throws:
      ParserConfigurationException
      IOException
      SAXException

    • extractAllNamespaceDeclarations

      private List<String> extractAllNamespaceDeclarations(InputSource in) throws ParserConfigurationException, IOException, SAXException
      Throws:
      ParserConfigurationException
      IOException
      SAXException

    • extractNamespaces

      private void extractNamespaces(Node node, List<String> namespaces)

    • createSecureDocument

      private Document createSecureDocument(InputSource in) throws ParserConfigurationException, IOException, SAXException
      Throws:
      ParserConfigurationException
      IOException
      SAXException