XmlModule.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.metaschema.core.model.xml;
import gov.nist.secauto.metaschema.core.datatype.markup.MarkupLine;
import gov.nist.secauto.metaschema.core.datatype.markup.MarkupMultiline;
import gov.nist.secauto.metaschema.core.model.AbstractModule;
import gov.nist.secauto.metaschema.core.model.IAssemblyDefinition;
import gov.nist.secauto.metaschema.core.model.IFieldDefinition;
import gov.nist.secauto.metaschema.core.model.IFlagContainer;
import gov.nist.secauto.metaschema.core.model.IFlagDefinition;
import gov.nist.secauto.metaschema.core.model.IModule;
import gov.nist.secauto.metaschema.core.model.MetaschemaException;
import gov.nist.secauto.metaschema.core.model.xml.xmlbeans.GlobalAssemblyDefinitionType;
import gov.nist.secauto.metaschema.core.model.xml.xmlbeans.GlobalFieldDefinitionType;
import gov.nist.secauto.metaschema.core.model.xml.xmlbeans.GlobalFlagDefinitionType;
import gov.nist.secauto.metaschema.core.model.xml.xmlbeans.METASCHEMADocument;
import gov.nist.secauto.metaschema.core.model.xml.xmlbeans.METASCHEMADocument.METASCHEMA;
import gov.nist.secauto.metaschema.core.util.ObjectUtils;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.apache.xmlbeans.XmlCursor;
import java.net.URI;
import java.util.Collection;
import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import edu.umd.cs.findbugs.annotations.NonNull;
@SuppressWarnings("PMD.CouplingBetweenObjects")
class XmlModule
extends AbstractModule {
private static final Logger LOGGER = LogManager.getLogger(XmlModule.class);
@NonNull
private final URI location;
@NonNull
private final METASCHEMADocument module;
private final Map<String, ? extends IFlagDefinition> flagDefinitions;
private final Map<String, ? extends IFieldDefinition> fieldDefinitions;
private final Map<String, ? extends IAssemblyDefinition> assemblyDefinitions;
private final Map<String, ? extends IAssemblyDefinition> rootAssemblyDefinitions;
/**
* Constructs a new Metaschema instance.
*
* @param resource
* the resource from which the module was loaded
* @param moduleXml
* the XML source of the module definition bound to Java objects
* @param importedModules
* the modules imported by this module
* @throws MetaschemaException
* if a processing error occurs
*/
XmlModule( // NOPMD - unavoidable
@NonNull URI resource,
@NonNull METASCHEMADocument moduleXml,
@NonNull List<IModule> importedModules) throws MetaschemaException {
super(importedModules);
this.location = ObjectUtils.requireNonNull(resource, "resource");
Objects.requireNonNull(moduleXml.getMETASCHEMA());
this.module = moduleXml;
METASCHEMA metaschemaNode = module.getMETASCHEMA();
// handle definitions in this module
{
// start with flag definitions
try (XmlCursor cursor = metaschemaNode.newCursor()) {
cursor.selectPath("declare namespace m='http://csrc.nist.gov/ns/oscal/metaschema/1.0';$this/m:define-flag");
Map<String, IFlagDefinition> flagDefinitions = new LinkedHashMap<>(); // NOPMD - intentional
while (cursor.toNextSelection()) {
GlobalFlagDefinitionType obj = ObjectUtils.notNull((GlobalFlagDefinitionType) cursor.getObject());
XmlGlobalFlagDefinition flag = new XmlGlobalFlagDefinition(obj, this); // NOPMD - intentional
if (LOGGER.isTraceEnabled()) {
LOGGER.trace("New flag definition '{}'", flag.toCoordinates());
}
flagDefinitions.put(flag.getName(), flag);
}
this.flagDefinitions
= flagDefinitions.isEmpty() ? Collections.emptyMap() : Collections.unmodifiableMap(flagDefinitions);
}
}
{
// now field definitions
try (XmlCursor cursor = metaschemaNode.newCursor()) {
cursor.selectPath("declare namespace m='http://csrc.nist.gov/ns/oscal/metaschema/1.0';$this/m:define-field");
Map<String, IFieldDefinition> fieldDefinitions = new LinkedHashMap<>(); // NOPMD - intentional
while (cursor.toNextSelection()) {
GlobalFieldDefinitionType obj = ObjectUtils.notNull((GlobalFieldDefinitionType) cursor.getObject());
XmlGlobalFieldDefinition field = new XmlGlobalFieldDefinition(obj, this); // NOPMD - intentional
if (LOGGER.isTraceEnabled()) {
LOGGER.trace("New field definition '{}'", field.toCoordinates());
}
fieldDefinitions.put(field.getName(), field);
}
this.fieldDefinitions
= fieldDefinitions.isEmpty() ? Collections.emptyMap() : Collections.unmodifiableMap(fieldDefinitions);
}
}
{
// finally assembly definitions
Map<String, IAssemblyDefinition> assemblyDefinitions = new LinkedHashMap<>(); // NOPMD - intentional
Map<String, IAssemblyDefinition> rootAssemblyDefinitions = new LinkedHashMap<>(); // NOPMD - intentional
try (XmlCursor cursor = metaschemaNode.newCursor()) {
cursor.selectPath(
"declare namespace m='http://csrc.nist.gov/ns/oscal/metaschema/1.0';$this/m:define-assembly");
while (cursor.toNextSelection()) {
GlobalAssemblyDefinitionType obj = ObjectUtils.notNull((GlobalAssemblyDefinitionType) cursor.getObject());
XmlGlobalAssemblyDefinition assembly = new XmlGlobalAssemblyDefinition(obj, this); // NOPMD - intentional
if (LOGGER.isTraceEnabled()) {
LOGGER.trace("New assembly definition '{}'", assembly.toCoordinates());
}
assemblyDefinitions.put(assembly.getName(), assembly);
if (assembly.isRoot()) {
rootAssemblyDefinitions.put(ObjectUtils.notNull(assembly.getRootName()), assembly);
}
}
this.assemblyDefinitions
= assemblyDefinitions.isEmpty() ? Collections.emptyMap() : Collections.unmodifiableMap(assemblyDefinitions);
this.rootAssemblyDefinitions = rootAssemblyDefinitions.isEmpty() ? Collections.emptyMap()
: Collections.unmodifiableMap(rootAssemblyDefinitions);
}
}
}
@NonNull
@Override
public URI getLocation() {
return location;
}
/**
* Get the XMLBeans representation of the Metaschema module.
*
* @return the XMLBean for the Metaschema module
*/
@NonNull
protected METASCHEMADocument.METASCHEMA getXmlModule() {
return ObjectUtils.notNull(module.getMETASCHEMA());
}
@SuppressWarnings("null")
@Override
public MarkupLine getName() {
return MarkupStringConverter.toMarkupString(getXmlModule().getSchemaName());
}
@SuppressWarnings("null")
@Override
public String getVersion() {
return getXmlModule().getSchemaVersion();
}
@SuppressWarnings("null")
@Override
public MarkupMultiline getRemarks() {
return getXmlModule().isSetRemarks() ? MarkupStringConverter.toMarkupString(getXmlModule().getRemarks())
: null;
}
@SuppressWarnings("null")
@Override
public String getShortName() {
return getXmlModule().getShortName();
}
@SuppressWarnings("null")
@Override
public URI getXmlNamespace() {
return URI.create(getXmlModule().getNamespace());
}
@SuppressWarnings("null")
@Override
public URI getJsonBaseUri() {
return URI.create(getXmlModule().getJsonBaseUri());
}
private Map<String, ? extends IAssemblyDefinition> getAssemblyDefinitionMap() {
return assemblyDefinitions;
}
@SuppressWarnings("null")
@Override
public Collection<? extends IAssemblyDefinition> getAssemblyDefinitions() {
return getAssemblyDefinitionMap().values();
}
@Override
public IAssemblyDefinition getAssemblyDefinitionByName(@NonNull String name) {
return getAssemblyDefinitionMap().get(name);
}
private Map<String, ? extends IFieldDefinition> getFieldDefinitionMap() {
return fieldDefinitions;
}
@SuppressWarnings("null")
@Override
public Collection<? extends IFieldDefinition> getFieldDefinitions() {
return getFieldDefinitionMap().values();
}
@Override
public IFieldDefinition getFieldDefinitionByName(@NonNull String name) {
return getFieldDefinitionMap().get(name);
}
@SuppressWarnings("null")
@Override
public List<? extends IFlagContainer> getAssemblyAndFieldDefinitions() {
return Stream.concat(getAssemblyDefinitions().stream(), getFieldDefinitions().stream())
.collect(Collectors.toList());
}
private Map<String, ? extends IFlagDefinition> getFlagDefinitionMap() {
return flagDefinitions;
}
@SuppressWarnings("null")
@Override
public Collection<? extends IFlagDefinition> getFlagDefinitions() {
return getFlagDefinitionMap().values();
}
@Override
public IFlagDefinition getFlagDefinitionByName(@NonNull String name) {
return getFlagDefinitionMap().get(name);
}
private Map<String, ? extends IAssemblyDefinition> getRootAssemblyDefinitionMap() {
return rootAssemblyDefinitions;
}
@SuppressWarnings("null")
@Override
public Collection<? extends IAssemblyDefinition> getRootAssemblyDefinitions() {
return getRootAssemblyDefinitionMap().values();
}
}