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.util;
28
29 import gov.nist.secauto.decima.core.assessment.Assessment;
30 import gov.nist.secauto.decima.core.assessment.AssessmentException;
31 import gov.nist.secauto.decima.core.assessment.AssessmentExecutionHelper;
32 import gov.nist.secauto.decima.core.assessment.result.AssessmentResultBuilder;
33 import gov.nist.secauto.decima.core.document.Document;
34
35 import java.util.ArrayList;
36 import java.util.Collections;
37 import java.util.List;
38
39 /**
40 * This class provides support for a list of assessments that get evaluated in a series.
41 *
42 * @param <DOC>
43 * the type of document that is the target of the assessment
44 */
45 public class AssessmentSequence<DOC extends Document> implements Assessment<DOC> {
46 private final List<? extends Assessment<DOC>> assessments;
47
48 public AssessmentSequence(List<? extends Assessment<DOC>> assessments) {
49 this.assessments = Collections.unmodifiableList(new ArrayList<>(assessments));
50 }
51
52 @Override
53 public String getAssessmentType() {
54 return "SEQUENCE";
55 }
56
57 public List<Assessment<DOC>> getAssessments() {
58 return Collections.unmodifiableList(assessments);
59 }
60
61 @Override
62 public List<Assessment<DOC>> getExecutableAssessments(DOC targetDocument) throws AssessmentException {
63 return AssessmentExecutionHelper.getExecutableAssessments(targetDocument, getAssessments());
64 }
65
66 @Override
67 public void execute(DOC targetDocument, AssessmentResultBuilder builder) throws AssessmentException {
68
69 throw new UnsupportedOperationException(
70 "The execute method must be called from instances returned by getExecutableAssessments(Document).");
71 }
72
73 @Override
74 public String getName(boolean includeDetail) {
75 StringBuilder sb = new StringBuilder();
76 sb.append("sequence {");
77 boolean first = true;
78 for (Assessment<DOC> assessment : getAssessments()) {
79 if (!first) {
80 sb.append(", ");
81 }
82 sb.append(assessment.getName(includeDetail));
83 }
84 sb.append("}");
85 return sb.toString();
86 }
87
88 }