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
33 import java.util.Collections;
34 import java.util.LinkedList;
35 import java.util.List;
36
37 public class AssessmentExecutionHelper {
38
39 /**
40 * Performs the provided assessment over the provided document recording assessment results using
41 * the provided builder.
42 *
43 * @param <DOC>
44 * the {@link Document} type used as the target of the assessment
45 * @param assessment
46 * the assessment to perform
47 * @param assessmentTarget
48 * the document to perform the assessment over
49 * @param builder
50 * a non-null result builder instance
51 * @throws AssessmentException
52 * if an error occurs while performing the assessment
53 */
54 public static <DOC extends Document> void executeAssessment(Assessment<DOC> assessment, DOC assessmentTarget,
55 AssessmentResultBuilder builder) throws AssessmentException {
56
57 LoggingHandler handler = builder.getLoggingHandler();
58
59 handler.assessmentStarted(assessment, assessmentTarget);
60 try {
61 assessment.execute(assessmentTarget, builder);
62 handler.assessmentCompleted(assessment, assessmentTarget);
63 } catch (AssessmentException ex) {
64 handler.assessmentError(assessment, assessmentTarget, ex);
65 throw ex;
66 } catch (Throwable th) {
67 handler.assessmentError(assessment, assessmentTarget, th);
68 throw new AssessmentException(
69 "An unexpected error occured while processing the assessment: " + assessment.getName(false), th);
70 }
71 }
72
73 /**
74 * Retrieves the sequence of executable {@link Assessment} instances for a given collection of
75 * assessments for the provided target {@link Document}.
76 *
77 * @param <DOC>
78 * the {@link Document} type used as the target of the assessment
79 * @param targetDocument
80 * the {@link Document} that the assessments will be eventually executed against
81 * @param assessments
82 * a sequence of {@link Assessment} instances to process
83 * @return a list of executable {@link Assessment} instances
84 * @throws AssessmentException
85 * if an error occurred while determining the {@link Assessment} instances that executable
86 */
87 public static <DOC extends Document> List<Assessment<DOC>> getExecutableAssessments(DOC targetDocument,
88 List<? extends Assessment<DOC>> assessments) throws AssessmentException {
89
90 List<Assessment<DOC>> retval = new LinkedList<>();
91 for (Assessment<DOC> assessment : assessments) {
92 retval.addAll(assessment.getExecutableAssessments(targetDocument));
93 }
94 return Collections.unmodifiableList(retval);
95 }
96
97 }