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.oscal.lib.profile.resolver.selection;
28
29 import gov.nist.secauto.metaschema.model.common.util.ObjectUtils;
30 import gov.nist.secauto.oscal.lib.model.control.catalog.IControl;
31
32 import org.apache.commons.lang3.tuple.Pair;
33
34 import java.util.Arrays;
35 import java.util.Set;
36 import java.util.function.Function;
37 import java.util.stream.Collectors;
38
39 import edu.umd.cs.findbugs.annotations.NonNull;
40
41 public interface IControlSelectionFilter extends Function<IControl, Pair<Boolean, Boolean>> {
42
43 @NonNull
44 Pair<Boolean, Boolean> NON_MATCH = ObjectUtils.notNull(Pair.of(false, false));
45 @NonNull
46 Pair<Boolean, Boolean> MATCH = ObjectUtils.notNull(Pair.of(true, true));
47
48 @NonNull
49 IControlSelectionFilter ALL_MATCH = new IControlSelectionFilter() {
50 @Override
51 public Pair<Boolean, Boolean> apply(IControl control) {
52 return MATCH;
53 }
54 };
55
56 @NonNull
57 IControlSelectionFilter NONE_MATCH = new IControlSelectionFilter() {
58 @Override
59 public Pair<Boolean, Boolean> apply(IControl control) {
60 return NON_MATCH;
61 }
62 };
63
64 @NonNull
65 static IControlSelectionFilter matchIds(@NonNull String... identifiers) {
66 return new IControlSelectionFilter() {
67 private Set<String> keys = Arrays.stream(identifiers).collect(Collectors.toUnmodifiableSet());
68
69 @Override
70 public @NonNull Pair<Boolean, Boolean> apply(IControl control) {
71 return ObjectUtils.notNull(Pair.of(keys.contains(control.getId()), false));
72 }
73
74 };
75 }
76
77 /**
78 * Determines if the control is matched by this filter. This method returns a
79 * {@link Pair} where the first member of the pair indicates if the control
80 * matches, and the second indicates if the match applies to child controls as
81 * well.
82 *
83 * @param control
84 * the control to check for a match
85 * @return a pair indicating the status of the match ({@code true} for a match
86 * or {@code false} otherwise), and if a match applies to child controls
87 */
88 @NonNull
89 @Override
90 Pair<Boolean, Boolean> apply(IControl control);
91 }