001/* 002 * Portions of this software was developed by employees of the National Institute 003 * of Standards and Technology (NIST), an agency of the Federal Government and is 004 * being made available as a public service. Pursuant to title 17 United States 005 * Code Section 105, works of NIST employees are not subject to copyright 006 * protection in the United States. This software may be subject to foreign 007 * copyright. Permission in the United States and in foreign countries, to the 008 * extent that NIST may hold copyright, to use, copy, modify, create derivative 009 * works, and distribute this software and its documentation without fee is hereby 010 * granted on a non-exclusive basis, provided that this notice and disclaimer 011 * of warranty appears in all copies. 012 * 013 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER 014 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY 015 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF 016 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM 017 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE 018 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE. IN NO EVENT 019 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT, 020 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM, 021 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY, 022 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR 023 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT 024 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER. 025 */ 026 027package gov.nist.secauto.oscal.lib.model.control.catalog; 028 029import gov.nist.secauto.metaschema.model.common.datatype.markup.MarkupLine; 030import gov.nist.secauto.metaschema.model.common.util.CollectionUtil; 031import gov.nist.secauto.metaschema.model.common.util.ObjectUtils; 032import gov.nist.secauto.oscal.lib.model.CatalogGroup; 033import gov.nist.secauto.oscal.lib.model.Control; 034import gov.nist.secauto.oscal.lib.model.ControlPart; 035import gov.nist.secauto.oscal.lib.model.Link; 036import gov.nist.secauto.oscal.lib.model.Parameter; 037import gov.nist.secauto.oscal.lib.model.Property; 038 039import java.util.LinkedList; 040import java.util.List; 041import java.util.Objects; 042import java.util.stream.Stream; 043 044import edu.umd.cs.findbugs.annotations.NonNull; 045 046public abstract class AbstractCatalogGroup 047 implements ICatalogGroup { 048 049 @NonNull 050 @Override 051 public Stream<String> getReferencedParameterIds() { 052 053 // get parameters referenced by the group's parts 054 Stream<String> insertIds = CollectionUtil.listOrEmpty(getParts()).stream() 055 // Get the full part hierarchy 056 .flatMap(part -> Stream.concat(Stream.of(part), part.getPartsRecursively())) 057 // Get the inserts for each part 058 .flatMap(part -> part.getInserts(insert -> "param".equals(insert.getType().toString()))) 059 // Get the param ids for each insert 060 .map(insert -> insert.getIdReference().toString()) 061 .flatMap(ObjectUtils::filterNull); 062 063 // get parameters referenced by the control's parameters 064 Stream<String> parameterIds = CollectionUtil.listOrEmpty(getParams()).stream() 065 .flatMap(ObjectUtils::filterNull) 066 .flatMap(param -> param.getParameterReferences()); 067 068 return ObjectUtils.notNull( 069 Stream.concat(insertIds, parameterIds).distinct()); 070 } 071 072 @NonNull 073 public static Builder builder(@NonNull String id) { 074 return new Builder(id); 075 } 076 077 public static class Builder { 078 @NonNull 079 private final String id; 080 081 private String clazz; 082 private MarkupLine title; 083 private final List<Parameter> params = new LinkedList<>(); 084 private final List<Property> props = new LinkedList<>(); 085 private final List<Link> links = new LinkedList<>(); 086 private final List<ControlPart> parts = new LinkedList<>(); 087 private final List<CatalogGroup> groups = new LinkedList<>(); 088 private final List<Control> controls = new LinkedList<>(); 089 090 public Builder(@NonNull String id) { 091 this.id = ObjectUtils.requireNonNull(id, "id"); 092 } 093 094 @NonNull 095 public Builder clazz(@NonNull String value) { 096 this.clazz = ObjectUtils.requireNonNull(value, "value"); 097 return this; 098 } 099 100 @NonNull 101 public Builder title(@NonNull String markdown) { 102 this.title = MarkupLine.fromMarkdown(Objects.requireNonNull(markdown, "markdown")); 103 return this; 104 } 105 106 @NonNull 107 public Builder title(@NonNull MarkupLine value) { 108 this.title = ObjectUtils.requireNonNull(value, "value"); 109 return this; 110 } 111 112 @NonNull 113 public Builder param(@NonNull Parameter value) { 114 this.params.add(Objects.requireNonNull(value, "value")); 115 return this; 116 } 117 118 @NonNull 119 public Builder prop(@NonNull Property value) { 120 this.props.add(Objects.requireNonNull(value, "value")); 121 return this; 122 } 123 124 @NonNull 125 public Builder link(@NonNull Link value) { 126 this.links.add(Objects.requireNonNull(value, "value")); 127 return this; 128 } 129 130 @NonNull 131 public Builder part(@NonNull ControlPart value) { 132 this.parts.add(Objects.requireNonNull(value, "value")); 133 return this; 134 } 135 136 @NonNull 137 public Builder group(@NonNull CatalogGroup value) { 138 this.groups.add(Objects.requireNonNull(value, "value")); 139 return this; 140 } 141 142 @NonNull 143 public Builder control(@NonNull Control value) { 144 this.controls.add(Objects.requireNonNull(value, "value")); 145 return this; 146 } 147 148 @NonNull 149 public CatalogGroup build() { 150 CatalogGroup retval = new CatalogGroup(); 151 retval.setId(id); 152 153 if (title == null) { 154 throw new IllegalStateException("a title must be provided"); 155 } 156 retval.setTitle(title); 157 158 if (clazz != null) { 159 retval.setClazz(clazz); 160 } 161 if (!params.isEmpty()) { 162 retval.setParams(params); 163 } 164 if (!props.isEmpty()) { 165 retval.setProps(props); 166 } 167 if (!links.isEmpty()) { 168 retval.setLinks(links); 169 } 170 if (!parts.isEmpty()) { 171 retval.setParts(parts); 172 } 173 if (!controls.isEmpty()) { 174 retval.setControls(controls); 175 } 176 if (!groups.isEmpty()) { 177 retval.setGroups(groups); 178 } 179 180 return retval; 181 } 182 } 183}