Package gov.nist.secauto.oscal.lib.model

Class Risk

java.lang.Object

gov.nist.secauto.oscal.lib.model.Risk

All Implemented Interfaces:

gov.nist.secauto.metaschema.core.model.IBoundObject

@MetaschemaAssembly(formalName="Identified Risk",
                    description="An identified risk.",
                    name="risk",
                    moduleClass=OscalAssessmentCommonModule.class,
                    valueConstraints=@ValueConstraints(allowedValues=@AllowedValues(level=ERROR,target="prop[has-oscal-namespace(\'http://csrc.nist.gov/ns/oscal\')]/@name",values={@AllowedValue(value="false-positive",description="The risk has been confirmed to be a false positive."),@AllowedValue(value="accepted",description="The risk has been accepted. No further action will be taken."),@AllowedValue(value="risk-adjusted",description="The risk has been adjusted."),@AllowedValue(value="priority",description="A numeric value indicating the sequence in which risks should be addressed. (Lower numbers are higher priority)")}),matches=@Matches(level=ERROR,target="prop[has-oscal-namespace(\'http://csrc.nist.gov/ns/oscal\') and @name=\'priority\']/@value",typeAdapter=gov.nist.secauto.metaschema.core.datatype.adapter.IntegerAdapter.class)))
public class Risk
extends Object
implements gov.nist.secauto.metaschema.core.model.IBoundObject

An identified risk.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Risk.MitigatingFactor	Describes an existing mitigating factor that may affect the overall determination of the risk, with an optional link to an implementation statement in the SSP.
static class	Risk.RelatedObservation	Relates the finding to a set of referenced observations that were used to determine the finding.
static class	Risk.RiskLog	A log of all risk-related tasks taken.

Constructor Summary

Constructors

Constructor	Description
Risk()
Risk(gov.nist.secauto.metaschema.core.model.IMetaschemaData data)

Method Summary

Modifier and Type	Method	Description
boolean	addCharacterization(Characterization item)	Add a new Characterization item to the underlying collection.
boolean	addLink(Link item)	Add a new Link item to the underlying collection.
boolean	addMitigatingFactor(Risk.MitigatingFactor item)	Add a new Risk.MitigatingFactor item to the underlying collection.
boolean	addOrigin(Origin item)	Add a new Origin item to the underlying collection.
boolean	addProp(Property item)	Add a new Property item to the underlying collection.
boolean	addRelatedObservation(Risk.RelatedObservation item)	Add a new Risk.RelatedObservation item to the underlying collection.
boolean	addResponse(Response item)	Add a new Response item to the underlying collection.
boolean	addThreatId(ThreatId item)	Add a new ThreatId item to the underlying collection.
List<Characterization>	getCharacterizations()
ZonedDateTime	getDeadline()
gov.nist.secauto.metaschema.core.datatype.markup.MarkupMultiline	getDescription()
List<Link>	getLinks()
gov.nist.secauto.metaschema.core.model.IMetaschemaData	getMetaschemaData()
List<Risk.MitigatingFactor>	getMitigatingFactors()
List<Origin>	getOrigins()
List<Property>	getProps()
List<Risk.RelatedObservation>	getRelatedObservations()
List<Response>	getRemediations()
Risk.RiskLog	getRiskLog()
gov.nist.secauto.metaschema.core.datatype.markup.MarkupMultiline	getStatement()
String	getStatus()
List<ThreatId>	getThreatIds()
gov.nist.secauto.metaschema.core.datatype.markup.MarkupLine	getTitle()
UUID	getUuid()
boolean	removeCharacterization(Characterization item)	Remove the first matching Characterization item from the underlying collection.
boolean	removeLink(Link item)	Remove the first matching Link item from the underlying collection.
boolean	removeMitigatingFactor(Risk.MitigatingFactor item)	Remove the first matching Risk.MitigatingFactor item from the underlying collection.
boolean	removeOrigin(Origin item)	Remove the first matching Origin item from the underlying collection.
boolean	removeProp(Property item)	Remove the first matching Property item from the underlying collection.
boolean	removeRelatedObservation(Risk.RelatedObservation item)	Remove the first matching Risk.RelatedObservation item from the underlying collection.
boolean	removeResponse(Response item)	Remove the first matching Response item from the underlying collection.
boolean	removeThreatId(ThreatId item)	Remove the first matching ThreatId item from the underlying collection.
void	setCharacterizations(List<Characterization> value)
void	setDeadline(ZonedDateTime value)
void	setDescription(gov.nist.secauto.metaschema.core.datatype.markup.MarkupMultiline value)
void	setLinks(List<Link> value)
void	setMitigatingFactors(List<Risk.MitigatingFactor> value)
void	setOrigins(List<Origin> value)
void	setProps(List<Property> value)
void	setRelatedObservations(List<Risk.RelatedObservation> value)
void	setRemediations(List<Response> value)
void	setRiskLog(Risk.RiskLog value)
void	setStatement(gov.nist.secauto.metaschema.core.datatype.markup.MarkupMultiline value)
void	setStatus(String value)
void	setThreatIds(List<ThreatId> value)
void	setTitle(gov.nist.secauto.metaschema.core.datatype.markup.MarkupLine value)
void	setUuid(UUID value)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

Risk

public Risk()

Risk

public Risk(gov.nist.secauto.metaschema.core.model.IMetaschemaData data)

Method Details

getMetaschemaData

public gov.nist.secauto.metaschema.core.model.IMetaschemaData getMetaschemaData()

Specified by:

getMetaschemaData in interface gov.nist.secauto.metaschema.core.model.IBoundObject

getUuid

public UUID getUuid()

setUuid

public void setUuid(UUID value)

getTitle

public gov.nist.secauto.metaschema.core.datatype.markup.MarkupLine getTitle()

setTitle

public void setTitle(gov.nist.secauto.metaschema.core.datatype.markup.MarkupLine value)

getDescription

public gov.nist.secauto.metaschema.core.datatype.markup.MarkupMultiline getDescription()

setDescription

public void setDescription(gov.nist.secauto.metaschema.core.datatype.markup.MarkupMultiline value)

getStatement

public gov.nist.secauto.metaschema.core.datatype.markup.MarkupMultiline getStatement()

setStatement

public void setStatement(gov.nist.secauto.metaschema.core.datatype.markup.MarkupMultiline value)

getProps

public List<Property> getProps()

setProps

public void setProps(List<Property> value)

addProp

public boolean addProp(Property item)

Add a new Property item to the underlying collection.

Parameters:

item - the item to add

Returns:

true

removeProp

public boolean removeProp(Property item)

Remove the first matching Property item from the underlying collection.

Parameters:

item - the item to remove

Returns:

true if the item was removed or false otherwise

getLinks

public List<Link> getLinks()

setLinks

public void setLinks(List<Link> value)

addLink

public boolean addLink(Link item)

Add a new Link item to the underlying collection.

Parameters:

item - the item to add

Returns:

true

removeLink

public boolean removeLink(Link item)

Remove the first matching Link item from the underlying collection.

Parameters:

item - the item to remove

Returns:

true if the item was removed or false otherwise

getStatus

public String getStatus()

setStatus

public void setStatus(String value)

getOrigins

public List<Origin> getOrigins()

setOrigins

public void setOrigins(List<Origin> value)

addOrigin

public boolean addOrigin(Origin item)

Add a new Origin item to the underlying collection.

Parameters:

item - the item to add

Returns:

true

removeOrigin

public boolean removeOrigin(Origin item)

Remove the first matching Origin item from the underlying collection.

Parameters:

item - the item to remove

Returns:

true if the item was removed or false otherwise

getThreatIds

public List<ThreatId> getThreatIds()

setThreatIds

public void setThreatIds(List<ThreatId> value)

addThreatId

public boolean addThreatId(ThreatId item)

Add a new ThreatId item to the underlying collection.

Parameters:

item - the item to add

Returns:

true

removeThreatId

public boolean removeThreatId(ThreatId item)

Remove the first matching ThreatId item from the underlying collection.

Parameters:

item - the item to remove

Returns:

true if the item was removed or false otherwise

getCharacterizations

public List<Characterization> getCharacterizations()

setCharacterizations

public void setCharacterizations(List<Characterization> value)

addCharacterization

public boolean addCharacterization(Characterization item)

Add a new Characterization item to the underlying collection.

Parameters:

item - the item to add

Returns:

true

removeCharacterization

public boolean removeCharacterization(Characterization item)

Remove the first matching Characterization item from the underlying collection.

Parameters:

item - the item to remove

Returns:

true if the item was removed or false otherwise

getMitigatingFactors

public List<Risk.MitigatingFactor> getMitigatingFactors()

setMitigatingFactors

public void setMitigatingFactors(List<Risk.MitigatingFactor> value)

addMitigatingFactor

public boolean addMitigatingFactor(Risk.MitigatingFactor item)

Add a new Risk.MitigatingFactor item to the underlying collection.

Parameters:

item - the item to add

Returns:

true

removeMitigatingFactor

public boolean removeMitigatingFactor(Risk.MitigatingFactor item)

Remove the first matching Risk.MitigatingFactor item from the underlying collection.

Parameters:

item - the item to remove

Returns:

true if the item was removed or false otherwise

getDeadline

public ZonedDateTime getDeadline()

setDeadline

public void setDeadline(ZonedDateTime value)

getRemediations

public List<Response> getRemediations()

setRemediations

public void setRemediations(List<Response> value)

addResponse

public boolean addResponse(Response item)

Add a new Response item to the underlying collection.

Parameters:

item - the item to add

Returns:

true

removeResponse

public boolean removeResponse(Response item)

Remove the first matching Response item from the underlying collection.

Parameters:

item - the item to remove

Returns:

true if the item was removed or false otherwise

getRiskLog

public Risk.RiskLog getRiskLog()

setRiskLog

public void setRiskLog(Risk.RiskLog value)

getRelatedObservations

public List<Risk.RelatedObservation> getRelatedObservations()

setRelatedObservations

public void setRelatedObservations(List<Risk.RelatedObservation> value)

addRelatedObservation

public boolean addRelatedObservation(Risk.RelatedObservation item)

Add a new Risk.RelatedObservation item to the underlying collection.

Parameters:

item - the item to add

Returns:

true

removeRelatedObservation

public boolean removeRelatedObservation(Risk.RelatedObservation item)

Remove the first matching Risk.RelatedObservation item from the underlying collection.

Parameters:

item - the item to remove

Returns:

true if the item was removed or false otherwise

toString

public String toString()

Overrides:

toString in class Object