001package gov.nist.secauto.oscal.lib.model;
002
003import gov.nist.secauto.metaschema.core.datatype.markup.MarkupLine;
004import gov.nist.secauto.metaschema.core.datatype.markup.MarkupMultiline;
005import gov.nist.secauto.metaschema.databind.IBindingContext;
006import gov.nist.secauto.metaschema.databind.model.AbstractBoundModule;
007import gov.nist.secauto.metaschema.databind.model.IBoundModule;
008import gov.nist.secauto.metaschema.databind.model.annotations.MetaschemaModule;
009import java.lang.Override;
010import java.lang.String;
011import java.net.URI;
012import java.util.List;
013
014@MetaschemaModule(
015    assemblies = {
016        Catalog.class,
017        CatalogGroup.class,
018        Control.class
019    },
020    imports = {
021        OscalControlCommonModule.class,
022        OscalMetadataModule.class
023    },
024    remarks = "The OSCAL Control Catalog format can be used to describe a collection of security controls and related control enhancements, along with contextualizing documentation and metadata. The root of the Control Catalog format is `catalog`."
025)
026public final class OscalCatalogModule extends AbstractBoundModule {
027  private static final MarkupLine NAME = MarkupLine.fromMarkdown("OSCAL Control Catalog Model");
028
029  private static final String SHORT_NAME = "oscal-catalog";
030
031  private static final String VERSION = "1.1.3";
032
033  private static final URI XML_NAMESPACE = URI.create("http://csrc.nist.gov/ns/oscal/1.0");
034
035  private static final URI JSON_BASE_URI = URI.create("http://csrc.nist.gov/ns/oscal");
036
037  private static final MarkupMultiline REMARKS = MarkupMultiline.fromMarkdown("The OSCAL Control Catalog format can be used to describe a collection of security controls and related control enhancements, along with contextualizing documentation and metadata. The root of the Control Catalog format is `catalog`.");
038
039  public OscalCatalogModule(List<? extends IBoundModule> importedModules,
040      IBindingContext bindingContext) {
041    super(importedModules, bindingContext);
042  }
043
044  @Override
045  public MarkupLine getName() {
046    return NAME;
047  }
048
049  @Override
050  public String getShortName() {
051    return SHORT_NAME;
052  }
053
054  @Override
055  public String getVersion() {
056    return VERSION;
057  }
058
059  @Override
060  public URI getXmlNamespace() {
061    return XML_NAMESPACE;
062  }
063
064  @Override
065  public URI getJsonBaseUri() {
066    return JSON_BASE_URI;
067  }
068
069  @Override
070  public MarkupMultiline getRemarks() {
071    return REMARKS;
072  }
073}