Class Validator

java.lang.Object
org.xml.sax.helpers.DefaultHandler
org.custommonkey.xmlunit.Validator
All Implemented Interfaces:
ContentHandler, DTDHandler, EntityResolver, ErrorHandler

public class Validator extends DefaultHandler
Validates XML against its internal or external DOCTYPE, or a completely different DOCTYPE. Usage:
  • new Validator(readerForXML);
    to validate some XML that contains or references an accessible DTD or schema
  • new Validator(readerForXML, systemIdForValidation);
    to validate some XML that references a DTD but using a local systemId to perform the validation
  • new Validator(readerForXML, systemIdForValidation, doctypeName);
    to validate some XML against a completely different DTD
  • Field Details

    • validationInputSource

      private final InputSource validationInputSource
    • messages

      private final StringBuilder messages
    • usingDoctypeReader

      private final boolean usingDoctypeReader
    • systemId

      private final String systemId
    • schemaSource

      private Object schemaSource
    • useSchema

      private boolean useSchema
    • isValid

      private Boolean isValid
  • Constructor Details

    • Validator

      protected Validator(InputSource inputSource, String systemId, boolean usingDoctypeReader)
      Baseline constructor: called by all others
      Parameters:
      inputSource -
      systemId -
      usingDoctypeReader -
    • Validator

      public Validator(Document document, String systemID, String doctype)
      DOM-style constructor: allows Document validation post-manipulation of the DOM tree's contents. This takes a fairly tortuous route to validation as DOM level 2 does not allow creation of Doctype nodes. The supplied systemId and doctype name will replace any Doctype settings in the Document.
      Parameters:
      document -
      systemID -
      doctype -
    • Validator

      public Validator(Reader readerForValidation)
      Basic constructor. Validates the contents of the Reader using the DTD or schema referenced by those contents.
      Parameters:
      readerForValidation -
    • Validator

      public Validator(String stringForValidation)
      Basic constructor. Validates the contents of the String using the DTD or schema referenced by those contents.
      Parameters:
      stringForValidation -
    • Validator

      public Validator(InputSource sourceForValidation)
      Basic constructor. Validates the contents of the InputSource using the DTD or schema referenced by those contents.
      Parameters:
      sourceForValidation -
    • Validator

      public Validator(Reader readerForValidation, String systemID)
      Extended constructor. Validates the contents of the Reader using the DTD specified with the systemID. There must be DOCTYPE instruction in the markup that references the DTD or else the markup will be considered invalid: if there is no DOCTYPE in the markup use the 3-argument constructor
      Parameters:
      readerForValidation -
      systemID -
    • Validator

      public Validator(String stringForValidation, String systemID)
      Extended constructor. Validates the contents of the String using the DTD specified with the systemID. There must be DOCTYPE instruction in the markup that references the DTD or else the markup will be considered invalid: if there is no DOCTYPE in the markup use the 3-argument constructor
      Parameters:
      stringForValidation -
      systemID -
    • Validator

      public Validator(InputSource sourceForValidation, String systemID)
      Extended constructor. Validates the contents of the InputSource using the DTD specified with the systemID. There must be DOCTYPE instruction in the markup that references the DTD or else the markup will be considered invalid: if there is no DOCTYPE in the markup use the 3-argument constructor
      Parameters:
      sourceForValidation -
      systemID -
    • Validator

      public Validator(InputSource sourceForValidation, String systemID, String doctype)
      Full constructor. Validates the contents of the InputSource using the DTD specified with the systemID and named with the doctype name.
      Parameters:
      sourceForValidation -
      systemID -
      doctype -
    • Validator

      public Validator(Reader readerForValidation, String systemID, String doctype)
      Full constructor. Validates the contents of the Reader using the DTD specified with the systemID and named with the doctype name.
      Parameters:
      readerForValidation -
      systemID -
      doctype -
  • Method Details

    • useXMLSchema

      public void useXMLSchema(boolean use)
      Turn on XML Schema validation.

      This feature should work with any XML parser that is JAXP 1.2 compliant and supports XML Schema validation.

      For a fully JAXP 1.2 compliant parser the property http://java.sun.com/xml/jaxp/properties/schemaLanguage is set, if this fails the method falls back to the features http://apache.org/xml/features/validation/schema & http://apache.org/xml/features/validation/dynamic which should cover early versions of Xerces 2 as well.

      Parameters:
      use - indicate that XML Schema should be used to validate documents.
      See Also:
    • isValid

      public boolean isValid()
      Perform the validation of the source against DTD / Schema.
      Returns:
      true if the input supplied to the constructor passes validation, false otherwise
    • assertIsValid

      public void assertIsValid()
      Assert that a document is valid.
    • appendMessage

      private StringBuilder appendMessage(StringBuilder toAppendTo)
      Append any validation message(s) to the specified StringBuffer.
      Parameters:
      toAppendTo -
      Returns:
      specified StringBuffer with message(s) appended
    • toString

      public String toString()
      Overrides:
      toString in class Object
      Returns:
      class name appended with validation messages
    • validate

      private void validate()
      Actually perform validation.
    • validationProblem

      private void validationProblem(ValidationProblem p)
    • invalidate

      private void invalidate(String message)
      Set the validation status flag to false and capture the message for use later.
      Parameters:
      message -
    • setJAXP12SchemaSource

      public void setJAXP12SchemaSource(Object schemaSource)
      As per JAXP 1.2 changes, which introduced a standard way for parsers to support schema validation. Since only W3C Schema support was included in JAXP 1.2, this is the only mechanism currently supported by this method.
      Parameters:
      schemaSource - This can be one of the following:
      • String that points to the URI of the schema
      • InputStream with the contents of the schema
      • SAX InputSource
      • File
      • an array of Objects with the contents being one of the types defined above. An array of Objects can be used only when the schema language has the ability to assemble a schema at runtime. When an array of Objects is passed it is illegal to have two schemas that share the same namespace.
      See Also:
      • "http://java.sun.com/webservices/jaxp/change-requests-11.html"
    • addSchemaSources

      private static void addSchemaSources(Object schemaSources, List<Source> targetList)
    • getOriginalContent

      private static String getOriginalContent(InputSource s) throws IOException
      Throws:
      IOException