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.core.assessment;
28
29 import gov.nist.secauto.decima.core.assessment.result.AssessmentResultBuilder;
30 import gov.nist.secauto.decima.core.assessment.util.LoggingHandler;
31 import gov.nist.secauto.decima.core.document.Document;
32 import gov.nist.secauto.decima.core.util.ObjectUtil;
33
34 import java.util.Collections;
35 import java.util.List;
36 import java.util.Objects;
37
38 /**
39 * Provides common assessment execution functions to support concrete {@link AssessmentExecutor}
40 * implementations.
41 */
42 public abstract class AbstractAssessmentExecutor<DOC extends Document> implements AssessmentExecutor<DOC> {
43 private final List<? extends Assessment<DOC>> assessments;
44
45 public AbstractAssessmentExecutor(List<? extends Assessment<DOC>> assessments) {
46 ObjectUtil.requireNonEmpty(assessments, "assessments");
47 this.assessments = Collections.unmodifiableList(assessments);
48 }
49
50 /**
51 * Retrieves the assessments configured for this executor.
52 *
53 * @return a list of assessments
54 */
55 public List<? extends Assessment<DOC>> getAssessments() {
56 return Collections.unmodifiableList(assessments);
57 }
58
59 protected List<Assessment<DOC>> getExecutableAssessments(DOC targetDocument) throws AssessmentException {
60 return AssessmentExecutionHelper.getExecutableAssessments(targetDocument, getAssessments());
61 }
62
63 @Override
64 public void execute(DOC documentToAssess, AssessmentResultBuilder resultBuilder) throws AssessmentException {
65 Objects.requireNonNull(documentToAssess, "documentToAssess");
66 Objects.requireNonNull(resultBuilder, "resultBuilder");
67
68 resultBuilder.start();
69
70 LoggingHandler handler = resultBuilder.getLoggingHandler();
71
72 handler.assessmentExecutionStarted(documentToAssess);
73
74 executeInternal(documentToAssess, resultBuilder);
75
76 handler.assessmentExecutionCompleted(documentToAssess);
77 }
78
79 protected void executeInternal(DOC documentToAssess, AssessmentResultBuilder resultBuilder)
80 throws AssessmentException {
81 for (Assessment<DOC> assessment : getExecutableAssessments(documentToAssess)) {
82 AssessmentExecutionHelper.executeAssessment(assessment, documentToAssess, resultBuilder);
83 }
84
85 }
86 }