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.swid.swidval;
28
29 import gov.nist.secauto.decima.core.assessment.result.AssessmentResultBuilder;
30 import gov.nist.secauto.decima.core.assessment.result.DefaultAssessmentResultBuilder;
31 import gov.nist.secauto.decima.core.assessment.util.AssessmentLoggingHandler;
32 import gov.nist.secauto.decima.core.assessment.util.AssessmentSummarizingLoggingHandler;
33 import gov.nist.secauto.decima.core.assessment.util.LoggingHandler;
34 import gov.nist.secauto.decima.core.assessment.util.OverallSummaryLoggingHandler;
35 import gov.nist.secauto.decima.core.assessment.util.TestResultLoggingHandler;
36
37 import org.apache.logging.log4j.Level;
38
39 import java.util.Objects;
40
41 public class SWIDAssessmentResultBuilderFactory {
42 protected static final String PROPERTY_KEY_AUTHORITATIVE = "authoritative";
43 protected static final String PROPERTY_KEY_TAG_TYPE = "tag-type";
44
45 /**
46 * Creates a new An {@link AssessmentResultBuilder} tailored to the SWID tag requirements model.
47 *
48 * @param tagType
49 * the type of tag to validate (i.e., primary, patch, corpus, supplemental)
50 * @param authoritative
51 * {@code true} if the tag is produced by a 1st or 2nd party software provider, or
52 * {@code false} otherwise
53 * @return the new builder
54 */
55 public static AssessmentResultBuilder newAssessmentResultBuilder(TagType tagType, boolean authoritative) {
56 Objects.requireNonNull(tagType, "tagType");
57
58 LoggingHandler loggingHandler = new TestResultLoggingHandler(SWIDRequirementsManager.getInstance());
59 loggingHandler = new AssessmentLoggingHandler(Level.INFO, loggingHandler);
60 loggingHandler = new AssessmentSummarizingLoggingHandler(Level.INFO, loggingHandler);
61 loggingHandler = new OverallSummaryLoggingHandler(Level.INFO, loggingHandler);
62 DefaultAssessmentResultBuilder retval
63 = new DefaultAssessmentResultBuilder(new SWIDValResultStatusBehavior(tagType, authoritative));
64 retval.setLoggingHandler(loggingHandler);
65 retval.assignProperty(PROPERTY_KEY_AUTHORITATIVE, Boolean.toString(authoritative));
66 retval.assignProperty(PROPERTY_KEY_TAG_TYPE, tagType.getName());
67 return retval;
68 }
69 }