1 /**
2 * Portions of this software was developed by employees of the National Institute
3 * of Standards and Technology (NIST), an agency of the Federal Government and is
4 * being made available as a public service. Pursuant to title 17 United States
5 * Code Section 105, works of NIST employees are not subject to copyright
6 * protection in the United States. This software may be subject to foreign
7 * copyright. Permission in the United States and in foreign countries, to the
8 * extent that NIST may hold copyright, to use, copy, modify, create derivative
9 * works, and distribute this software and its documentation without fee is hereby
10 * granted on a non-exclusive basis, provided that this notice and disclaimer
11 * of warranty appears in all copies.
12 *
13 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
14 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
15 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
17 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
18 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE. IN NO EVENT
19 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
20 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
21 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
22 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
23 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
24 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
25 */
26
27 package gov.nist.secauto.decima.xml.assessment.schema;
28
29 import gov.nist.secauto.decima.core.assessment.result.AssessmentResultBuilder;
30 import gov.nist.secauto.decima.core.assessment.result.TestResult;
31 import gov.nist.secauto.decima.core.assessment.result.TestState;
32 import gov.nist.secauto.decima.core.assessment.result.TestStatus;
33 import gov.nist.secauto.decima.xml.document.XMLDocument;
34
35 import org.xml.sax.ErrorHandler;
36 import org.xml.sax.SAXException;
37 import org.xml.sax.SAXParseException;
38
39 public class AssessmentSAXErrorHandler implements ErrorHandler {
40 private final SchemaAssessment schemaAssessment;
41 private final XMLDocument assessedDocument;
42 private final String derivedRequirementId;
43 private final AssessmentResultBuilder builder;
44 private final SAXLocationXPathResolver saxLocationXPathResolver;
45 private boolean treatWarningsAsErrors = false;
46
47 /**
48 * Constructs a {@link ErrorHandler} that is capable of asserting any SAX errors as a Decima
49 * {@link TestResult}.
50 *
51 * @param schemaAssessment
52 * the assessment this handler supports
53 * @param assessedDocument
54 * the XML document target of the SAX operation
55 * @param derivedRequirementId
56 * the derived requirement to associate the SAX errors/warnings with
57 * @param builder
58 * the {@link AssessmentResultBuilder} to use to post the {@link TestResult} to
59 * @param saxLocationXPathResolver
60 * an XPathResolver to use to lookup error locations
61 */
62 public AssessmentSAXErrorHandler(SchemaAssessment schemaAssessment, XMLDocument assessedDocument,
63 String derivedRequirementId, AssessmentResultBuilder builder, SAXLocationXPathResolver saxLocationXPathResolver) {
64 this.schemaAssessment = schemaAssessment;
65 this.assessedDocument = assessedDocument;
66 this.derivedRequirementId = derivedRequirementId;
67 this.builder = builder;
68 this.saxLocationXPathResolver = saxLocationXPathResolver;
69 builder.assignTestStatus(schemaAssessment, assessedDocument, derivedRequirementId, TestState.TESTED);
70 }
71
72 /**
73 * Retrieve the assessment this handler supports.
74 *
75 * @return the schemaAssessment
76 */
77 public SchemaAssessment getSchemaAssessment() {
78 return schemaAssessment;
79 }
80
81 /**
82 * Retieve the document this handler is reporting issues for.
83 *
84 * @return the assessedDocument
85 */
86 public XMLDocument getAssessedDocument() {
87 return assessedDocument;
88 }
89
90 @Override
91 public void warning(SAXParseException ex) throws SAXException {
92 TestStatus status = (treatWarningsAsErrors ? TestStatus.FAIL : TestStatus.WARNING);
93 newSAXAssertionResult(status, ex);
94 }
95
96 @Override
97 public void error(SAXParseException ex) throws SAXException {
98 newSAXAssertionResult(TestStatus.FAIL, ex);
99 }
100
101 @Override
102 public void fatalError(SAXParseException ex) throws SAXException {
103 error(ex);
104 }
105
106 private SAXTestResult newSAXAssertionResult(TestStatus status, SAXParseException ex) {
107 SAXTestResultl/assessment/schema/SAXTestResult.html#SAXTestResult">SAXTestResult retval = new SAXTestResult(assessedDocument, status, ex, saxLocationXPathResolver.getCurrentXPath());
108 builder.addTestResult(getSchemaAssessment(), getAssessedDocument(), derivedRequirementId, retval);
109 return retval;
110 }
111 }