View Javadoc
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.requirement;
28  
29  import java.net.URI;
30  import java.net.URISyntaxException;
31  import java.net.URL;
32  import java.util.Collection;
33  import java.util.Collections;
34  import java.util.LinkedHashMap;
35  import java.util.LinkedList;
36  import java.util.List;
37  import java.util.Map;
38  
39  public class DefaultRequirementsManager implements MutableRequirementsManager, RequirementAppender {
40  
41    private List<URI> requirementDefinitions = new LinkedList<>();
42    private Map<String, BaseRequirement> baseRequirements = new LinkedHashMap<>();
43    private Map<String, DerivedRequirement> derivedRequirements = new LinkedHashMap<>();
44  
45    public DefaultRequirementsManager() {
46    }
47  
48    public List<URI> getRequirementDefinitions() {
49      return Collections.unmodifiableList(requirementDefinitions);
50    }
51  
52    @Override
53    public DefaultRequirementsManager addRequirementDefinition(URI definition) {
54      requirementDefinitions.add(definition);
55      return this;
56    }
57  
58    @Override
59    public BaseRequirement getBaseRequirementById(String id) {
60      return baseRequirements.get(id);
61    }
62  
63    @Override
64    public Collection<BaseRequirement> getBaseRequirements() {
65      return baseRequirements.values();
66    }
67  
68    @Override
69    public DerivedRequirement getDerivedRequirementById(String id) {
70      return derivedRequirements.get(id);
71    }
72  
73    @Override
74    public DefaultRequirementsManager addBaseRequirement(BaseRequirement baseRequirement) {
75      if (baseRequirements.containsKey(baseRequirement.getId())) {
76        throw new IllegalArgumentException("A base requirement already exists with the id: " + baseRequirement.getId());
77      }
78      baseRequirements.put(baseRequirement.getId(), baseRequirement);
79  
80      for (DerivedRequirement derivedRequirement : baseRequirement.getDerivedRequirements()) {
81        if (derivedRequirements.containsKey(derivedRequirement.getId())) {
82          throw new IllegalArgumentException(
83              "A derived requirement already exists with the id: " + derivedRequirement.getId());
84        }
85        derivedRequirements.put(derivedRequirement.getId(), derivedRequirement);
86      }
87      return this;
88    }
89  
90    @Override
91    public DefaultRequirementsManager load(URL url, RequirementsParser parser)
92        throws RequirementsParserException, URISyntaxException {
93      parser.parse(url, this);
94      // addRequirementDefinition(url.toURI());
95      return this;
96    }
97  }