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.policy;
028
029import gov.nist.secauto.metaschema.model.common.metapath.format.IPathFormatter;
030import gov.nist.secauto.metaschema.model.common.metapath.item.IRequiredValueModelNodeItem;
031import gov.nist.secauto.metaschema.model.common.util.CustomCollectors;
032import gov.nist.secauto.metaschema.model.common.util.ObjectUtils;
033import gov.nist.secauto.oscal.lib.model.Property;
034import gov.nist.secauto.oscal.lib.profile.resolver.support.IEntityItem;
035
036import org.apache.logging.log4j.LogManager;
037import org.apache.logging.log4j.Logger;
038
039import java.net.URI;
040import java.util.List;
041import java.util.Locale;
042
043import edu.umd.cs.findbugs.annotations.NonNull;
044
045public class PropertyReferencePolicy
046    extends AbstractMultiItemTypeReferencePolicy<Property> {
047  private static final Logger LOGGER = LogManager.getLogger(PropertyReferencePolicy.class);
048
049  @NonNull
050  public static PropertyReferencePolicy create(@NonNull IIdentifierParser identifierParser,
051      @NonNull IEntityItem.ItemType itemType) {
052    return create(identifierParser, ObjectUtils.notNull(List.of(itemType)));
053  }
054
055  @NonNull
056  public static PropertyReferencePolicy create(@NonNull IIdentifierParser identifierParser,
057      @NonNull List<IEntityItem.ItemType> itemTypes) {
058    return new PropertyReferencePolicy(identifierParser, itemTypes);
059  }
060
061  public PropertyReferencePolicy(
062      @NonNull IIdentifierParser identifierParser,
063      @NonNull List<IEntityItem.ItemType> itemTypes) {
064    super(identifierParser, itemTypes);
065  }
066
067  @Override
068  public String getReferenceText(@NonNull Property property) {
069    return property.getValue();
070  }
071
072  @Override
073  public void setReferenceText(@NonNull Property property, @NonNull String newValue) {
074    property.setValue(newValue);
075  }
076
077  @Override
078  protected void handleUnselected(
079      @NonNull IRequiredValueModelNodeItem contextItem,
080      @NonNull Property property,
081      @NonNull IEntityItem item,
082      @NonNull ReferenceCountingVisitor.Context visitorContext) {
083    URI linkHref = URI.create(property.getValue());
084    URI sourceUri = item.getSource();
085
086    URI resolved = sourceUri.resolve(linkHref);
087    if (LOGGER.isDebugEnabled()) {
088      LOGGER.atTrace().log("At path '{}', remapping orphaned URI '{}' to '{}'",
089          contextItem.toPath(IPathFormatter.METAPATH_PATH_FORMATER),
090          linkHref.toString(),
091          resolved.toString());
092    }
093    property.setValue(resolved.toString());
094  }
095
096  @Override
097  protected boolean handleIndexMiss(
098      @NonNull IRequiredValueModelNodeItem contextItem,
099      @NonNull Property property,
100      @NonNull List<IEntityItem.ItemType> itemTypes,
101      @NonNull String identifier,
102      @NonNull ReferenceCountingVisitor.Context visitorContext) {
103    if (LOGGER.isWarnEnabled()) {
104      LOGGER.atWarn().log(
105          "The property '{}' at '{}' should reference a {} identified by '{}',"
106              + " but the identifier was not found in the index.",
107          property.getQName(),
108          contextItem.toPath(IPathFormatter.METAPATH_PATH_FORMATER),
109          itemTypes.stream()
110              .map(en -> en.name().toLowerCase(Locale.ROOT))
111              .collect(CustomCollectors.joiningWithOxfordComma("or")),
112          identifier);
113    }
114    return true;
115  }
116}