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.profile.resolver.selection;
028
029import gov.nist.secauto.metaschema.model.common.util.ObjectUtils;
030import gov.nist.secauto.oscal.lib.model.control.catalog.IControl;
031
032import org.apache.commons.lang3.tuple.Pair;
033
034import java.util.Arrays;
035import java.util.Set;
036import java.util.function.Function;
037import java.util.stream.Collectors;
038
039import edu.umd.cs.findbugs.annotations.NonNull;
040
041public interface IControlSelectionFilter extends Function<IControl, Pair<Boolean, Boolean>> {
042
043  @NonNull
044  Pair<Boolean, Boolean> NON_MATCH = ObjectUtils.notNull(Pair.of(false, false));
045  @NonNull
046  Pair<Boolean, Boolean> MATCH = ObjectUtils.notNull(Pair.of(true, true));
047
048  @NonNull
049  IControlSelectionFilter ALL_MATCH = new IControlSelectionFilter() {
050    @Override
051    public Pair<Boolean, Boolean> apply(IControl control) {
052      return MATCH;
053    }
054  };
055
056  @NonNull
057  IControlSelectionFilter NONE_MATCH = new IControlSelectionFilter() {
058    @Override
059    public Pair<Boolean, Boolean> apply(IControl control) {
060      return NON_MATCH;
061    }
062  };
063
064  @NonNull
065  static IControlSelectionFilter matchIds(@NonNull String... identifiers) {
066    return new IControlSelectionFilter() {
067      private Set<String> keys = Arrays.stream(identifiers).collect(Collectors.toUnmodifiableSet());
068
069      @Override
070      public @NonNull Pair<Boolean, Boolean> apply(IControl control) {
071        return ObjectUtils.notNull(Pair.of(keys.contains(control.getId()), false));
072      }
073
074    };
075  }
076
077  /**
078   * Determines if the control is matched by this filter. This method returns a
079   * {@link Pair} where the first member of the pair indicates if the control
080   * matches, and the second indicates if the match applies to child controls as
081   * well.
082   *
083   * @param control
084   *          the control to check for a match
085   * @return a pair indicating the status of the match ({@code true} for a match
086   *         or {@code false} otherwise), and if a match applies to child controls
087   */
088  @NonNull
089  @Override
090  Pair<Boolean, Boolean> apply(IControl control);
091}