Package org.owasp.dependencycheck.xml.suppression

Class SuppressionHandler

  • All Implemented Interfaces:
    org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler
    @NotThreadSafe
public class SuppressionHandler
extends org.xml.sax.helpers.DefaultHandler
    A handler to load suppression rules.
    Author:
    Jeremy Long

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String CPE
      The CPE element name.
      static java.lang.String CVE
      The CVE element name.
      static java.lang.String CVSS_BELOW
      The cvssBelow element name.
      static java.lang.String CWE
      The CWE element name.
      static java.lang.String FILE_PATH
      The file path element name.
      static java.lang.String GAV
      The GAV element name.
      static java.lang.String NOTES
      The CVE element name.
      static java.lang.String PACKAGE_URL
      The Package URL element name.
      static java.lang.String SHA1
      The sha1 hash element name.
      static java.lang.String SUPPRESS
      The suppress node, indicates the start of a new rule.
      static java.lang.String VULNERABILITY_NAME
      The vulnerabilityName element name.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void characters​(char[] ch, int start, int length)
      Collects the body text of the node being processed.
      void endElement​(java.lang.String uri, java.lang.String localName, java.lang.String qName)
      Handles the end element event.
      java.util.List<SuppressionRule> getSuppressionRules()
      Get the value of suppressionRules.
      void startElement​(java.lang.String uri, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes attributes)
      Handles the start element event.

      • Methods inherited from class org.xml.sax.helpers.DefaultHandler

        endDocument, endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl, warning

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • SUPPRESS

        public static final java.lang.String SUPPRESS
        The suppress node, indicates the start of a new rule.
        See Also:
        Constant Field Values

      • FILE_PATH

        public static final java.lang.String FILE_PATH
        The file path element name.
        See Also:
        Constant Field Values

      • SHA1

        public static final java.lang.String SHA1
        The sha1 hash element name.
        See Also:
        Constant Field Values

      • VULNERABILITY_NAME

        public static final java.lang.String VULNERABILITY_NAME
        The vulnerabilityName element name.
        See Also:
        Constant Field Values

      • NOTES

        public static final java.lang.String NOTES
        The CVE element name.
        See Also:
        Constant Field Values

      • PACKAGE_URL

        public static final java.lang.String PACKAGE_URL
        The Package URL element name.
        See Also:
        Constant Field Values

      • CVSS_BELOW

        public static final java.lang.String CVSS_BELOW
        The cvssBelow element name.
        See Also:
        Constant Field Values

    • Constructor Detail

      • SuppressionHandler

        public SuppressionHandler()

    • Method Detail

      • getSuppressionRules

        public java.util.List<SuppressionRule> getSuppressionRules()
        Get the value of suppressionRules.
        Returns:
        the value of suppressionRules

      • startElement

        public void startElement​(java.lang.String uri,
                         java.lang.String localName,
                         java.lang.String qName,
                         org.xml.sax.Attributes attributes)
                  throws org.xml.sax.SAXException
        Handles the start element event.
        Specified by:
        startElement in interface org.xml.sax.ContentHandler
        Overrides:
        startElement in class org.xml.sax.helpers.DefaultHandler
        Parameters:
        uri - the URI of the element being processed
        localName - the local name of the element being processed
        qName - the qName of the element being processed
        attributes - the attributes of the element being processed
        Throws:
        org.xml.sax.SAXException - thrown if there is an exception processing

      • endElement

        public void endElement​(java.lang.String uri,
                       java.lang.String localName,
                       java.lang.String qName)
                throws org.xml.sax.SAXException
        Handles the end element event.
        Specified by:
        endElement in interface org.xml.sax.ContentHandler
        Overrides:
        endElement in class org.xml.sax.helpers.DefaultHandler
        Parameters:
        uri - the URI of the element
        localName - the local name of the element
        qName - the qName of the element
        Throws:
        org.xml.sax.SAXException - thrown if there is an exception processing

      • characters

        public void characters​(char[] ch,
                       int start,
                       int length)
                throws org.xml.sax.SAXException
        Collects the body text of the node being processed.
        Specified by:
        characters in interface org.xml.sax.ContentHandler
        Overrides:
        characters in class org.xml.sax.helpers.DefaultHandler
        Parameters:
        ch - the char array of text
        start - the start position to copy text from in the char array
        length - the number of characters to copy from the char array
        Throws:
        org.xml.sax.SAXException - thrown if there is a parsing exception