FlatteningStructuringVisitor.java
/*
* SPDX-FileCopyrightText: none
* SPDX-License-Identifier: CC0-1.0
*/
package gov.nist.secauto.oscal.lib.profile.resolver.merge;
import gov.nist.secauto.metaschema.core.metapath.item.node.IAssemblyNodeItem;
import gov.nist.secauto.metaschema.core.metapath.item.node.IDocumentNodeItem;
import gov.nist.secauto.metaschema.core.metapath.item.node.IRootAssemblyNodeItem;
import gov.nist.secauto.metaschema.core.util.ObjectUtils;
import gov.nist.secauto.oscal.lib.model.BackMatter.Resource;
import gov.nist.secauto.oscal.lib.model.CatalogGroup;
import gov.nist.secauto.oscal.lib.model.Control;
import gov.nist.secauto.oscal.lib.model.ControlPart;
import gov.nist.secauto.oscal.lib.model.Metadata.Location;
import gov.nist.secauto.oscal.lib.model.Metadata.Party;
import gov.nist.secauto.oscal.lib.model.Metadata.Role;
import gov.nist.secauto.oscal.lib.model.Parameter;
import gov.nist.secauto.oscal.lib.profile.resolver.policy.ReferenceCountingVisitor;
import gov.nist.secauto.oscal.lib.profile.resolver.selection.DefaultResult;
import gov.nist.secauto.oscal.lib.profile.resolver.selection.FilterNonSelectedVisitor;
import gov.nist.secauto.oscal.lib.profile.resolver.support.AbstractCatalogEntityVisitor;
import gov.nist.secauto.oscal.lib.profile.resolver.support.IEntityItem;
import gov.nist.secauto.oscal.lib.profile.resolver.support.IEntityItem.ItemType;
import gov.nist.secauto.oscal.lib.profile.resolver.support.IIndexer;
import gov.nist.secauto.oscal.lib.profile.resolver.support.IIndexer.SelectionStatus;
import java.net.URI;
import java.util.EnumSet;
import java.util.UUID;
import edu.umd.cs.findbugs.annotations.NonNull;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
public class FlatteningStructuringVisitor
extends AbstractCatalogEntityVisitor<IIndexer, Void> {
private static final FlatteningStructuringVisitor SINGLETON = new FlatteningStructuringVisitor();
@SuppressFBWarnings(value = "SING_SINGLETON_GETTER_NOT_SYNCHRONIZED", justification = "class initialization")
public static FlatteningStructuringVisitor instance() {
return SINGLETON;
}
@SuppressFBWarnings(value = "SING_SINGLETON_HAS_NONPRIVATE_CONSTRUCTOR",
justification = "public constructor allows for extension usecases")
public FlatteningStructuringVisitor() {
super(ObjectUtils.notNull(EnumSet.of(ItemType.GROUP, ItemType.CONTROL)));
}
@Override
protected Void newDefaultResult(IIndexer state) {
// do nothing
return null;
}
@Override
protected Void aggregateResults(Void first, Void second, IIndexer state) {
// do nothing
return null;
}
@Override
public Void visitCatalog(@NonNull IDocumentNodeItem catalogItem, IIndexer index) {
index.resetSelectionStatus();
index.setSelectionStatus(catalogItem, SelectionStatus.SELECTED);
super.visitCatalog(catalogItem, index);
for (ItemType itemType : ItemType.values()) {
assert itemType != null;
for (IEntityItem item : index.getEntitiesByItemType(itemType)) {
item.resetReferenceCount();
}
}
// process references, looking for orphaned links to groups
URI catalogUri = ObjectUtils.requireNonNull(catalogItem.getDocumentUri());
ReferenceCountingVisitor.instance().visitCatalog(catalogItem, index, catalogUri);
FlatteningFilterNonSelectedVisitor.instance().visitCatalog(catalogItem, index);
return null;
}
@Override
public Void visitGroup(
IAssemblyNodeItem item,
Void childResult,
IIndexer index) {
CatalogGroup group = ObjectUtils.requireNonNull((CatalogGroup) item.getValue());
String id = group.getId();
if (id != null) {
IEntityItem entity = index.getEntity(ItemType.GROUP, id);
assert entity != null;
// refresh the instance
entity.setInstance(item);
}
index.setSelectionStatus(item, SelectionStatus.UNSELECTED);
handlePartSelection(item, index, SelectionStatus.UNSELECTED);
return super.visitGroup(item, childResult, index);
}
@Override
public Void visitControl(
IAssemblyNodeItem item,
Void childResult,
IIndexer index) {
Control control = ObjectUtils.requireNonNull((Control) item.getValue());
String id = ObjectUtils.requireNonNull(control.getId());
IEntityItem entity = index.getEntity(ItemType.CONTROL, id);
assert entity != null;
// refresh the instance
entity.setInstance(item);
index.setSelectionStatus(item, SelectionStatus.SELECTED);
handlePartSelection(item, index, SelectionStatus.SELECTED);
return null;
}
@Override
protected Void visitParameter(
IAssemblyNodeItem item,
IAssemblyNodeItem catalogOrGroupOrControl,
IIndexer index) {
Parameter parameter = ObjectUtils.requireNonNull((Parameter) item.getValue());
String id = ObjectUtils.requireNonNull(parameter.getId());
IEntityItem entity = index.getEntity(ItemType.PARAMETER, id);
assert entity != null;
// refresh the instance
entity.setInstance(item);
return null;
}
@Override
protected void visitRole(
IAssemblyNodeItem item,
IAssemblyNodeItem metadataItem,
IIndexer index) {
Role role = ObjectUtils.requireNonNull((Role) item.getValue());
String id = ObjectUtils.requireNonNull(role.getId());
IEntityItem entity = index.getEntity(ItemType.ROLE, id);
assert entity != null;
// refresh the instance
entity.setInstance(item);
}
@Override
protected void visitLocation(
IAssemblyNodeItem item,
IAssemblyNodeItem metadataItem,
IIndexer index) {
Location location = ObjectUtils.requireNonNull((Location) item.getValue());
UUID uuid = ObjectUtils.requireNonNull(location.getUuid());
IEntityItem entity = index.getEntity(ItemType.LOCATION, uuid);
assert entity != null;
// refresh the instance
entity.setInstance(item);
}
@Override
protected void visitParty(
IAssemblyNodeItem item,
IAssemblyNodeItem metadataItem,
IIndexer index) {
Party location = ObjectUtils.requireNonNull((Party) item.getValue());
UUID uuid = ObjectUtils.requireNonNull(location.getUuid());
IEntityItem entity = index.getEntity(ItemType.PARTY, uuid);
assert entity != null;
// refresh the instance
entity.setInstance(item);
}
@Override
protected void visitResource(
IAssemblyNodeItem item,
IRootAssemblyNodeItem rootItem,
IIndexer index) {
Resource location = ObjectUtils.requireNonNull((Resource) item.getValue());
UUID uuid = ObjectUtils.requireNonNull(location.getUuid());
IEntityItem entity = index.getEntity(ItemType.RESOURCE, uuid);
assert entity != null;
// refresh the instance
entity.setInstance(item);
}
private static void handlePartSelection(
@NonNull IAssemblyNodeItem groupOrControlItem,
@NonNull IIndexer index,
@NonNull SelectionStatus selectionStatus) {
CHILD_PART_METAPATH.evaluate(groupOrControlItem).stream()
.map(item -> (IAssemblyNodeItem) item)
.forEachOrdered(partItem -> {
index.setSelectionStatus(ObjectUtils.requireNonNull(partItem), selectionStatus);
ControlPart part = ObjectUtils.requireNonNull((ControlPart) partItem.getValue());
String id = part.getId();
if (id != null) {
IEntityItem entity = index.getEntity(ItemType.PART, id);
assert entity != null;
// refresh the instance
entity.setInstance(partItem);
}
});
}
private static final class FlatteningFilterNonSelectedVisitor
extends FilterNonSelectedVisitor {
private static final FlatteningFilterNonSelectedVisitor SINGLETON = new FlatteningFilterNonSelectedVisitor();
@SuppressFBWarnings(value = "SING_SINGLETON_GETTER_NOT_SYNCHRONIZED", justification = "class initialization")
public static FlatteningFilterNonSelectedVisitor instance() {
return SINGLETON;
}
@Override
public DefaultResult visitControl(IAssemblyNodeItem item, DefaultResult childResult,
Context context) {
assert childResult != null;
Control control = ObjectUtils.requireNonNull((Control) item.getValue());
IIndexer index = context.getIndexer();
// this control should always be found in the index
IEntityItem entity = ObjectUtils.requireNonNull(
index.getEntity(ItemType.CONTROL, ObjectUtils.requireNonNull(control.getId()), false));
IAssemblyNodeItem parent = ObjectUtils.notNull(item.getParentContentNodeItem());
DefaultResult retval = new DefaultResult();
if (SelectionStatus.SELECTED.equals(index.getSelectionStatus(item))) {
// keep this control
// always promote the control and any children
retval.promoteControl(control);
retval.appendPromoted(childResult);
childResult.applyRemovesTo(control);
if (parent.getValue() instanceof Control && SelectionStatus.SELECTED.equals(index.getSelectionStatus(parent))) {
retval.removeControl(control);
}
} else {
// remove this control and promote any needed children
if (SelectionStatus.SELECTED.equals(index.getSelectionStatus(parent))) {
retval.removeControl(control);
}
retval.appendPromoted(ObjectUtils.notNull(childResult));
index.removeItem(entity);
// remove any associated parts from the index
removePartsFromIndex(item, index);
}
return retval;
}
}
}