Package gov.nist.secauto.oscal.lib.model
Class AssessmentResults
java.lang.Object
gov.nist.secauto.oscal.lib.model.AbstractOscalInstance
gov.nist.secauto.oscal.lib.model.AssessmentResults
- All Implemented Interfaces:
gov.nist.secauto.metaschema.core.model.IBoundObject
,IOscalInstance
@MetaschemaAssembly(formalName="Security Assessment Results (SAR)",
description="Security assessment results, such as those provided by a FedRAMP assessor in the FedRAMP Security Assessment Report.",
name="assessment-results",
moduleClass=OscalArModule.class,
rootName="assessment-results",
valueConstraints=@ValueConstraints(lets=@Let(name="all-imports",target="recurse-depth(\'.[import-ap]/doc(resolve-uri(Q{http://csrc.nist.gov/ns/oscal/1.0}resolve-reference(import-ap/@href)))/assessment-plan|.[import-ssp]/doc(resolve-uri(Q{http://csrc.nist.gov/ns/oscal/1.0}resolve-reference(import-ssp/@href)))/system-security-plan|.[import-profile]/resolve-profile(doc(resolve-uri(Q{http://csrc.nist.gov/ns/oscal/1.0}resolve-reference(import-profile/@href))))/catalog\')")),
modelConstraints=@AssemblyConstraints(index={@Index(id="oscal-ar-index-metadata-scoped-role-id",formalName="In-Scope Role Identifiers",description="An index of role identifiers that are in-scope for the assessment-result model. Roles are collected from imported assessment-plans, which in turn includes referenced system-securtity-plans, which in turn includes referenced profiles and catalogs. For a given role @id, a locally declared role takes precedence over a role that is imported, the role that was last imported.",level=ERROR,target="map:merge($all-imports/metadata/role ! map:entry(@id,.))?*",name="index-imports-metadata-role-id",keyFields=@KeyField(target="@id")),@Index(id="oscal-ar-index-metadata-scoped-location-uuid",level=ERROR,target="map:merge($all-imports/metadata/location ! map:entry(@uuid,.))?*",name="index-imports-metadata-location-uuid",keyFields=@KeyField(target="@uuid")),@Index(id="oscal-ar-index-metadata-scoped-party-uuid",level=ERROR,target="map:merge($all-imports/metadata/party ! map:entry(@uuid,.))?*",name="index-imports-metadata-party-uuid",keyFields=@KeyField(target="@uuid")),@Index(id="oscal-ar-index-metadata-scoped-party-organization-uuid",level=ERROR,target="map:merge($all-imports/metadata/party[@type=\'organization\'] ! map:entry(@uuid,.))?*",name="index-imports-metadata-party-organization-uuid",keyFields=@KeyField(target="@uuid")),@Index(id="oscal-ar-index-metadata-scoped-property-uuid",level=ERROR,target="map:merge($all-imports//prop[@uuid] ! map:entry(@uuid,.))?*",name="index-imports-metadata-property-uuid",keyFields=@KeyField(target="@uuid"))},unique={@IsUnique(id="oscal-unique-document-id",formalName="Unique Document Identifier",description="Ensure all document identifiers have a unique combination of @scheme and value.",level=ERROR,target="document-id",keyFields={@KeyField(target="@scheme"),@KeyField}),@IsUnique(id="oscal-unique-property-in-context-location",formalName="Unique Properties",description="Ensure all properties are unique for a given location using a unique combination of @ns, @name, @class. @group. and @value.",level=ERROR,target=".//prop",keyFields={@KeyField(target="path(..)"),@KeyField(target="@name"),@KeyField(target="@ns"),@KeyField(target="@class"),@KeyField(target="@group"),@KeyField(target="@value")}),@IsUnique(id="oscal-unique-link-in-context-location",formalName="Unique Links",description="Ensure all links are unique for a given location using a unique combination of @href, @rel, and @media-type.",level=ERROR,target=".//link",keyFields={@KeyField(target="path(..)"),@KeyField(target="@href"),@KeyField(target="@rel"),@KeyField(target="@media-type")}),@IsUnique(id="oscal-unique-responsibility-in-context-location",formalName="Unique Responsibilities",description="Ensure all responsible-roles and responsible-parties are unique for a given location using a unique combination of @role-id and the combination of @party-uuid values.",level=ERROR,target=".//(responsible-party|responsible-role)",keyFields={@KeyField(target="path(..)"),@KeyField(target="@role-id"),@KeyField(target="@party-uuid")},remarks="Since `responsible-party` and `responsible-role` associate multiple `party-uuid` entries with a single `role-id`, each role-id must be referenced only once.")}))
public class AssessmentResults
extends AbstractOscalInstance
implements gov.nist.secauto.metaschema.core.model.IBoundObject
Security assessment results, such as those provided by a FedRAMP assessor in the FedRAMP Security Assessment Report.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Used to define data objects that are used in the assessment plan, that do not appear in the referenced SSP. -
Constructor Summary
ConstructorsConstructorDescriptionAssessmentResults
(gov.nist.secauto.metaschema.core.model.IMetaschemaData data) -
Method Summary
Modifier and TypeMethodDescriptionboolean
Add a newResult
item to the underlying collection.gov.nist.secauto.metaschema.core.model.IMetaschemaData
getUuid()
boolean
removeResult
(Result item) Remove the first matchingResult
item from the underlying collection.void
setBackMatter
(BackMatter value) void
setImportAp
(ImportAp value) void
void
setMetadata
(Metadata value) void
setResults
(List<Result> value) void
toString()
Methods inherited from class gov.nist.secauto.oscal.lib.model.AbstractOscalInstance
getResourceByUuid
-
Constructor Details
-
AssessmentResults
public AssessmentResults() -
AssessmentResults
-
-
Method Details
-
getMetaschemaData
- Specified by:
getMetaschemaData
in interfacegov.nist.secauto.metaschema.core.model.IBoundObject
-
getUuid
- Specified by:
getUuid
in interfaceIOscalInstance
-
setUuid
-
getMetadata
- Specified by:
getMetadata
in interfaceIOscalInstance
-
setMetadata
-
getImportAp
-
setImportAp
-
getLocalDefinitions
-
setLocalDefinitions
-
getResults
-
setResults
-
addResult
Add a newResult
item to the underlying collection.- Parameters:
item
- the item to add- Returns:
true
-
removeResult
Remove the first matchingResult
item from the underlying collection.- Parameters:
item
- the item to remove- Returns:
true
if the item was removed orfalse
otherwise
-
getBackMatter
- Specified by:
getBackMatter
in interfaceIOscalInstance
-
setBackMatter
-
toString
-