LinkReferencePolicy.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.profile.resolver.policy;
import gov.nist.secauto.metaschema.model.common.metapath.format.IPathFormatter;
import gov.nist.secauto.metaschema.model.common.metapath.item.IRequiredValueModelNodeItem;
import gov.nist.secauto.metaschema.model.common.util.CollectionUtil;
import gov.nist.secauto.metaschema.model.common.util.CustomCollectors;
import gov.nist.secauto.oscal.lib.model.Link;
import gov.nist.secauto.oscal.lib.profile.resolver.support.IEntityItem;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import java.net.URI;
import java.util.List;
import java.util.Locale;
import edu.umd.cs.findbugs.annotations.NonNull;
public class LinkReferencePolicy
extends AbstractMultiItemTypeReferencePolicy<Link> {
private static final Logger LOGGER = LogManager.getLogger(LinkReferencePolicy.class);
@SuppressWarnings("null")
@NonNull
public static LinkReferencePolicy create(@NonNull IEntityItem.ItemType itemType) {
return create(List.of(itemType));
}
@NonNull
public static LinkReferencePolicy create(@NonNull List<IEntityItem.ItemType> itemTypes) {
return new LinkReferencePolicy(CollectionUtil.requireNonEmpty(itemTypes, "itemTypes"));
}
public LinkReferencePolicy(@NonNull List<IEntityItem.ItemType> itemTypes) {
super(IIdentifierParser.FRAGMENT_PARSER, itemTypes);
}
@Override
public String getReferenceText(@NonNull Link link) {
return link.getHref().toString();
}
@Override
public void setReferenceText(@NonNull Link link, @NonNull String newValue) {
link.setHref(URI.create(newValue));
}
@Override
protected void handleUnselected(
@NonNull IRequiredValueModelNodeItem contextItem,
@NonNull Link link,
@NonNull IEntityItem item,
@NonNull ReferenceCountingVisitor.Context visitorContext) {
URI linkHref = link.getHref();
URI sourceUri = item.getSource();
URI resolved = sourceUri.resolve(linkHref);
if (LOGGER.isTraceEnabled()) {
LOGGER.atTrace().log("At path '{}', remapping orphaned URI '{}' to '{}'",
contextItem.toPath(IPathFormatter.METAPATH_PATH_FORMATER),
linkHref.toString(),
resolved.toString());
}
link.setHref(resolved);
}
@Override
protected boolean handleIndexMiss(
@NonNull IRequiredValueModelNodeItem contextItem,
@NonNull Link link,
@NonNull List<IEntityItem.ItemType> itemTypes,
@NonNull String identifier,
@NonNull ReferenceCountingVisitor.Context visitorContext) {
if (LOGGER.isWarnEnabled()) {
LOGGER.atWarn().log(
"The link at '{}' with rel '{}' should reference a {} identified by '{}'."
+ " The index did not contain the identifier.",
contextItem.toPath(IPathFormatter.METAPATH_PATH_FORMATER),
link.getRel(),
itemTypes.stream()
.map(en -> en.name().toLowerCase(Locale.ROOT))
.collect(CustomCollectors.joiningWithOxfordComma("or")),
identifier);
}
return true;
}
@Override
protected boolean handleIdentifierNonMatch(
@NonNull IRequiredValueModelNodeItem contextItem,
@NonNull Link reference,
@NonNull ReferenceCountingVisitor.Context visitorContext) {
if (LOGGER.isDebugEnabled()) {
LOGGER.atDebug().log("Ignoring URI '{}' at '{}'",
reference.getHref().toString(),
contextItem.toPath(IPathFormatter.METAPATH_PATH_FORMATER));
}
return true;
}
}