AbstractParameter.java

/*
 * Portions of this software was developed by employees of the National Institute
 * of Standards and Technology (NIST), an agency of the Federal Government and is
 * being made available as a public service. Pursuant to title 17 United States
 * Code Section 105, works of NIST employees are not subject to copyright
 * protection in the United States. This software may be subject to foreign
 * copyright. Permission in the United States and in foreign countries, to the
 * extent that NIST may hold copyright, to use, copy, modify, create derivative
 * works, and distribute this software and its documentation without fee is hereby
 * granted on a non-exclusive basis, provided that this notice and disclaimer
 * of warranty appears in all copies.
 *
 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE.  IN NO EVENT
 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
 */

package gov.nist.secauto.oscal.lib.model.control;

import gov.nist.secauto.metaschema.model.common.datatype.markup.MarkupLine;
import gov.nist.secauto.metaschema.model.common.datatype.markup.MarkupMultiline;
import gov.nist.secauto.metaschema.model.common.util.CollectionUtil;
import gov.nist.secauto.metaschema.model.common.util.ObjectUtils;
import gov.nist.secauto.oscal.lib.model.Link;
import gov.nist.secauto.oscal.lib.model.Parameter;
import gov.nist.secauto.oscal.lib.model.ParameterConstraint;
import gov.nist.secauto.oscal.lib.model.ParameterGuideline;
import gov.nist.secauto.oscal.lib.model.ParameterSelection;
import gov.nist.secauto.oscal.lib.model.Property;
import gov.nist.secauto.oscal.lib.model.metadata.IProperty;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.LinkedList;
import java.util.List;
import java.util.Objects;
import java.util.stream.Stream;

import edu.umd.cs.findbugs.annotations.NonNull;

public abstract class AbstractParameter implements IParameter {

  @Override
  public Stream<String> getParameterReferences() {

    // handle prop name="aggregates"
    Stream<String> aggregatesIds = CollectionUtil.listOrEmpty(getProps()).stream()
        .filter(Objects::nonNull)
        .filter(prop -> prop.isNamespaceEqual(IProperty.OSCAL_NAMESPACE) && "aggregates".equals(prop.getName()))
        .map(prop -> prop.getValue());

    // handle select/choice/insert
    ParameterSelection selection = getSelect();

    Stream<String> selectInsertIds;
    if (selection == null) {
      selectInsertIds = Stream.empty();
    } else {
      selectInsertIds = CollectionUtil.listOrEmpty(selection.getChoice()).stream()
          .filter(Objects::nonNull)
          .flatMap(choice -> choice.getInserts(insert -> "param".equals(insert.getType().toString())).stream()
              .map(insert -> insert.getIdReference().toString()));
    }
    Stream<String> retval = Stream.concat(aggregatesIds, selectInsertIds)
        .filter(Objects::nonNull)
        .distinct();
    assert retval != null;
    return retval;
  }

  @NonNull
  public static Builder builder(@NonNull String id) {
    return new Builder(id);
  }

  public static class Builder {
    @NonNull
    private final String id;

    private String clazz;
    private final List<Property> props = new LinkedList<>();
    private final List<Link> links = new LinkedList<>();
    private MarkupLine label;
    private MarkupMultiline usage;
    private final List<ParameterConstraint> constraints = new LinkedList<>();
    private final List<ParameterGuideline> guidelines = new LinkedList<>();
    private List<String> values = new LinkedList<>();
    private ParameterSelection selection;
    private MarkupMultiline remarks;

    public Builder(@NonNull String id) {
      this.id = ObjectUtils.requireNonNull(id);
    }

    @NonNull
    public Builder clazz(@NonNull String value) {
      this.clazz = ObjectUtils.requireNonNull(value);
      return this;
    }

    @NonNull
    public Builder prop(@NonNull Property value) {
      this.props.add(ObjectUtils.requireNonNull(value));
      return this;
    }

    @NonNull
    public Builder link(@NonNull Link value) {
      this.links.add(ObjectUtils.requireNonNull(value));
      return this;
    }

    @NonNull
    public Builder label(@NonNull String markdown) {
      return label(MarkupLine.fromMarkdown(Objects.requireNonNull(markdown)));
    }

    @NonNull
    public Builder label(@NonNull MarkupLine value) {
      this.label = ObjectUtils.requireNonNull(value);
      return this;
    }

    @NonNull
    public Builder usage(@NonNull String markdown) {
      return usage(MarkupMultiline.fromMarkdown(ObjectUtils.requireNonNull(markdown)));
    }

    @NonNull
    public Builder usage(@NonNull MarkupMultiline value) {
      this.usage = ObjectUtils.requireNonNull(value);
      return this;
    }

    @NonNull
    public Builder constraint(@NonNull ParameterConstraint value) {
      this.constraints.add(ObjectUtils.requireNonNull(value));
      return this;
    }

    @NonNull
    public Builder guideline(@NonNull ParameterGuideline value) {
      this.guidelines.add(ObjectUtils.requireNonNull(value));
      return this;
    }

    @SuppressWarnings("null")
    @NonNull
    public Builder values(@NonNull String... values) {
      return values(Arrays.asList(values));
    }

    @NonNull
    public Builder values(@NonNull Collection<String> values) {
      this.values = new ArrayList<>(values);
      return this;
    }

    @NonNull
    public Builder select(@NonNull ParameterSelection value) {
      this.selection = Objects.requireNonNull(value);
      return this;
    }

    @NonNull
    public Builder remarks(@NonNull MarkupMultiline value) {
      this.remarks = Objects.requireNonNull(value);
      return this;
    }

    @NonNull
    public Parameter build() {
      Parameter retval = new Parameter();
      retval.setId(id);

      if (clazz != null) {
        retval.setClazz(clazz);
      }
      if (!props.isEmpty()) {
        retval.setProps(props);
      }
      if (!links.isEmpty()) {
        retval.setLinks(links);
      }
      if (label != null) {
        retval.setLabel(label);
      }
      if (usage != null) {
        retval.setUsage(usage);
      }
      if (!constraints.isEmpty()) {
        retval.setConstraints(constraints);
      }
      if (!guidelines.isEmpty()) {
        retval.setGuidelines(guidelines);
      }
      if (!values.isEmpty()) {
        retval.setValues(values);
      }
      if (selection != null) {
        retval.setSelect(selection);
      }
      if (remarks != null) {
        retval.setRemarks(remarks);
      }
      return retval;
    }
  }
}