ByComponent.java
package gov.nist.secauto.oscal.lib.model;
import gov.nist.secauto.metaschema.binding.model.annotations.AllowedValue;
import gov.nist.secauto.metaschema.binding.model.annotations.AllowedValues;
import gov.nist.secauto.metaschema.binding.model.annotations.AssemblyConstraints;
import gov.nist.secauto.metaschema.binding.model.annotations.BoundAssembly;
import gov.nist.secauto.metaschema.binding.model.annotations.BoundField;
import gov.nist.secauto.metaschema.binding.model.annotations.BoundFieldValue;
import gov.nist.secauto.metaschema.binding.model.annotations.BoundFlag;
import gov.nist.secauto.metaschema.binding.model.annotations.GroupAs;
import gov.nist.secauto.metaschema.binding.model.annotations.HasCardinality;
import gov.nist.secauto.metaschema.binding.model.annotations.IndexHasKey;
import gov.nist.secauto.metaschema.binding.model.annotations.IsUnique;
import gov.nist.secauto.metaschema.binding.model.annotations.KeyField;
import gov.nist.secauto.metaschema.binding.model.annotations.MetaschemaAssembly;
import gov.nist.secauto.metaschema.binding.model.annotations.ValueConstraints;
import gov.nist.secauto.metaschema.model.common.JsonGroupAsBehavior;
import gov.nist.secauto.metaschema.model.common.constraint.IConstraint;
import gov.nist.secauto.metaschema.model.common.datatype.adapter.UuidAdapter;
import gov.nist.secauto.metaschema.model.common.datatype.markup.MarkupMultiline;
import gov.nist.secauto.metaschema.model.common.datatype.markup.MarkupMultilineAdapter;
import gov.nist.secauto.metaschema.model.common.util.ObjectUtils;
import java.lang.Override;
import java.lang.String;
import java.util.LinkedList;
import java.util.List;
import java.util.UUID;
import org.apache.commons.lang3.builder.MultilineRecursiveToStringStyle;
import org.apache.commons.lang3.builder.ReflectionToStringBuilder;
/**
* Defines how the referenced component implements a set of controls.
*/
@MetaschemaAssembly(
formalName = "Component Control Implementation",
description = "Defines how the referenced component implements a set of controls.",
name = "by-component",
metaschema = OscalSspMetaschema.class,
remarks = "Use of `set-parameter` in this context, sets the parameter for the control referenced in the containing `implemented-requirement` applied to the referenced component. If the `by-component` is used as a child of a `statement`, then the parameter value also applies only in the context of the referenced statement. If the same parameter is also set in the `control-implementation` or a specific `implemented-requirement`, then this `by-component/set-parameter` value will override the other value(s) in the context of the referenced component, control, and statement (if parent)."
)
@ValueConstraints(
allowedValues = {
@AllowedValues(level = IConstraint.Level.ERROR, target = "link/@rel", allowOthers = true, values = @AllowedValue(value = "imported-from", description = "The hyperlink identifies a URI pointing to the `component` in a `component-definition` that originally described the `component` this component was based on.")),
@AllowedValues(level = IConstraint.Level.ERROR, target = ".//responsible-role/@role-id", allowOthers = true, values = {@AllowedValue(value = "asset-owner", description = "Accountable for ensuring the asset is managed in accordance with organizational policies and procedures."), @AllowedValue(value = "asset-administrator", description = "Responsible for administering a set of assets."), @AllowedValue(value = "security-operations", description = "Members of the security operations center (SOC)."), @AllowedValue(value = "network-operations", description = "Members of the network operations center (NOC)."), @AllowedValue(value = "incident-response", description = "Responsible for responding to an event that could lead to loss of, or disruption to, an organization's operations, services or functions."), @AllowedValue(value = "help-desk", description = "Responsible for providing information and support to users."), @AllowedValue(value = "configuration-management", description = "Responsible for the configuration management processes governing changes to the asset."), @AllowedValue(value = "maintainer", description = "Responsible for the creation and maintenance of a component."), @AllowedValue(value = "provider", description = "Organization responsible for providing the component, if this is different from the \"maintainer\" (e.g., a reseller).")}),
@AllowedValues(level = IConstraint.Level.ERROR, target = "link/@rel", allowOthers = true, values = @AllowedValue(value = "provided-by", description = "A reference to the UUID of a control or statement `by-component` object that is used as evidence of implementation."))
},
indexHasKey = @IndexHasKey(level = IConstraint.Level.ERROR, target = "link[@rel='provided-by']", indexName = "by-component-uuid", keyFields = @KeyField(target = "@href", pattern = "#(.*)"))
)
@AssemblyConstraints(
isUnique = @IsUnique(id = "unique-ssp-by-component-set-parameter", level = IConstraint.Level.ERROR, target = "set-parameter", keyFields = @KeyField(target = "@param-id"), remarks = "Since multiple `set-parameter` entries can be provided, each parameter must be set only once.")
)
public class ByComponent {
@BoundFlag(
formalName = "Component Universally Unique Identifier Reference",
description = "A [machine-oriented](https://pages.nist.gov/OSCAL/concepts/identifier-use/#machine-oriented) identifier reference to the `component` that is implemeting a given control.",
useName = "component-uuid",
required = true,
typeAdapter = UuidAdapter.class
)
private UUID _componentUuid;
@BoundFlag(
formalName = "By-Component Universally Unique Identifier",
description = "A [machine-oriented](https://pages.nist.gov/OSCAL/concepts/identifier-use/#machine-oriented), [globally unique](https://pages.nist.gov/OSCAL/concepts/identifier-use/#globally-unique) identifier with [cross-instance](https://pages.nist.gov/OSCAL/concepts/identifier-use/#cross-instance) scope that can be used to reference this by-component entry elsewhere in [this or other OSCAL instances](https://pages.nist.gov/OSCAL/concepts/identifier-use/#ssp-identifiers). The locally defined *UUID* of the `by-component` entry can be used to reference the data item locally or globally (e.g., in an imported OSCAL instance). This UUID should be assigned [per-subject](https://pages.nist.gov/OSCAL/concepts/identifier-use/#consistency), which means it should be consistently used to identify the same subject across revisions of the document.",
useName = "uuid",
required = true,
typeAdapter = UuidAdapter.class
)
private UUID _uuid;
/**
* "An implementation statement that describes how a control or a control statement is implemented within the referenced system component."
*/
@BoundField(
formalName = "Control Implementation Description",
description = "An implementation statement that describes how a control or a control statement is implemented within the referenced system component.",
useName = "description",
minOccurs = 1
)
@BoundFieldValue(
typeAdapter = MarkupMultilineAdapter.class
)
private MarkupMultiline _description;
@BoundAssembly(
formalName = "Property",
description = "An attribute, characteristic, or quality of the containing object expressed as a namespace qualified name/value pair.",
useName = "prop",
maxOccurs = -1
)
@GroupAs(
name = "props",
inJson = JsonGroupAsBehavior.LIST
)
private List<Property> _props;
@BoundAssembly(
formalName = "Link",
description = "A reference to a local or remote resource, that has a specific relation to the containing object.",
useName = "link",
maxOccurs = -1
)
@GroupAs(
name = "links",
inJson = JsonGroupAsBehavior.LIST
)
private List<Link> _links;
@BoundAssembly(
formalName = "Set Parameter Value",
description = "Identifies the parameter that will be set by the enclosed value.",
useName = "set-parameter",
maxOccurs = -1
)
@GroupAs(
name = "set-parameters",
inJson = JsonGroupAsBehavior.LIST
)
private List<SetParameter> _setParameters;
@BoundAssembly(
formalName = "Implementation Status",
description = "Indicates the degree to which the a given control is implemented.",
useName = "implementation-status",
remarks = "The `implementation-status` is used to qualify the `status` value to indicate the degree to which the control is implemented."
)
private ImplementationStatus _implementationStatus;
/**
* "Identifies content intended for external consumption, such as with leveraged organizations."
*/
@BoundAssembly(
formalName = "Export",
description = "Identifies content intended for external consumption, such as with leveraged organizations.",
useName = "export"
)
private Export _export;
/**
* "Describes a control implementation inherited by a leveraging system."
*/
@BoundAssembly(
formalName = "Inherited Control Implementation",
description = "Describes a control implementation inherited by a leveraging system.",
useName = "inherited",
maxOccurs = -1
)
@GroupAs(
name = "inherited",
inJson = JsonGroupAsBehavior.LIST
)
private List<Inherited> _inherited;
/**
* "Describes how this system satisfies a responsibility imposed by a leveraged system."
*/
@BoundAssembly(
formalName = "Satisfied Control Implementation Responsibility",
description = "Describes how this system satisfies a responsibility imposed by a leveraged system.",
useName = "satisfied",
maxOccurs = -1
)
@GroupAs(
name = "satisfied",
inJson = JsonGroupAsBehavior.LIST
)
private List<Satisfied> _satisfied;
@BoundAssembly(
formalName = "Responsible Role",
description = "A reference to a role with responsibility for performing a function relative to the containing object, optionally associated with a set of persons and/or organizations that perform that role.",
useName = "responsible-role",
maxOccurs = -1
)
@GroupAs(
name = "responsible-roles",
inJson = JsonGroupAsBehavior.LIST
)
private List<ResponsibleRole> _responsibleRoles;
@BoundField(
formalName = "Remarks",
description = "Additional commentary about the containing object.",
useName = "remarks"
)
@BoundFieldValue(
typeAdapter = MarkupMultilineAdapter.class
)
private MarkupMultiline _remarks;
public ByComponent() {
}
public UUID getComponentUuid() {
return _componentUuid;
}
public void setComponentUuid(UUID value) {
_componentUuid = value;
}
public UUID getUuid() {
return _uuid;
}
public void setUuid(UUID value) {
_uuid = value;
}
public MarkupMultiline getDescription() {
return _description;
}
public void setDescription(MarkupMultiline value) {
_description = value;
}
public List<Property> getProps() {
return _props;
}
public void setProps(List<Property> value) {
_props = value;
}
/**
* Add a new {@link Property} item to the underlying collection.
* @param item the item to add
* @return {@code true}
*/
public boolean addProp(Property item) {
Property value = ObjectUtils.requireNonNull(item,"item cannot be null");
if (_props == null) {
_props = new LinkedList<>();
}
return _props.add(value);
}
/**
* Remove the first matching {@link Property} item from the underlying collection.
* @param item the item to remove
* @return {@code true} if the item was removed or {@code false} otherwise
*/
public boolean removeProp(Property item) {
Property value = ObjectUtils.requireNonNull(item,"item cannot be null");
return _props == null ? false : _props.remove(value);
}
public List<Link> getLinks() {
return _links;
}
public void setLinks(List<Link> value) {
_links = value;
}
/**
* Add a new {@link Link} item to the underlying collection.
* @param item the item to add
* @return {@code true}
*/
public boolean addLink(Link item) {
Link value = ObjectUtils.requireNonNull(item,"item cannot be null");
if (_links == null) {
_links = new LinkedList<>();
}
return _links.add(value);
}
/**
* Remove the first matching {@link Link} item from the underlying collection.
* @param item the item to remove
* @return {@code true} if the item was removed or {@code false} otherwise
*/
public boolean removeLink(Link item) {
Link value = ObjectUtils.requireNonNull(item,"item cannot be null");
return _links == null ? false : _links.remove(value);
}
public List<SetParameter> getSetParameters() {
return _setParameters;
}
public void setSetParameters(List<SetParameter> value) {
_setParameters = value;
}
/**
* Add a new {@link SetParameter} item to the underlying collection.
* @param item the item to add
* @return {@code true}
*/
public boolean addSetParameter(SetParameter item) {
SetParameter value = ObjectUtils.requireNonNull(item,"item cannot be null");
if (_setParameters == null) {
_setParameters = new LinkedList<>();
}
return _setParameters.add(value);
}
/**
* Remove the first matching {@link SetParameter} item from the underlying collection.
* @param item the item to remove
* @return {@code true} if the item was removed or {@code false} otherwise
*/
public boolean removeSetParameter(SetParameter item) {
SetParameter value = ObjectUtils.requireNonNull(item,"item cannot be null");
return _setParameters == null ? false : _setParameters.remove(value);
}
public ImplementationStatus getImplementationStatus() {
return _implementationStatus;
}
public void setImplementationStatus(ImplementationStatus value) {
_implementationStatus = value;
}
public Export getExport() {
return _export;
}
public void setExport(Export value) {
_export = value;
}
public List<Inherited> getInherited() {
return _inherited;
}
public void setInherited(List<Inherited> value) {
_inherited = value;
}
/**
* Add a new {@link Inherited} item to the underlying collection.
* @param item the item to add
* @return {@code true}
*/
public boolean addInherited(Inherited item) {
Inherited value = ObjectUtils.requireNonNull(item,"item cannot be null");
if (_inherited == null) {
_inherited = new LinkedList<>();
}
return _inherited.add(value);
}
/**
* Remove the first matching {@link Inherited} item from the underlying collection.
* @param item the item to remove
* @return {@code true} if the item was removed or {@code false} otherwise
*/
public boolean removeInherited(Inherited item) {
Inherited value = ObjectUtils.requireNonNull(item,"item cannot be null");
return _inherited == null ? false : _inherited.remove(value);
}
public List<Satisfied> getSatisfied() {
return _satisfied;
}
public void setSatisfied(List<Satisfied> value) {
_satisfied = value;
}
/**
* Add a new {@link Satisfied} item to the underlying collection.
* @param item the item to add
* @return {@code true}
*/
public boolean addSatisfied(Satisfied item) {
Satisfied value = ObjectUtils.requireNonNull(item,"item cannot be null");
if (_satisfied == null) {
_satisfied = new LinkedList<>();
}
return _satisfied.add(value);
}
/**
* Remove the first matching {@link Satisfied} item from the underlying collection.
* @param item the item to remove
* @return {@code true} if the item was removed or {@code false} otherwise
*/
public boolean removeSatisfied(Satisfied item) {
Satisfied value = ObjectUtils.requireNonNull(item,"item cannot be null");
return _satisfied == null ? false : _satisfied.remove(value);
}
public List<ResponsibleRole> getResponsibleRoles() {
return _responsibleRoles;
}
public void setResponsibleRoles(List<ResponsibleRole> value) {
_responsibleRoles = value;
}
/**
* Add a new {@link ResponsibleRole} item to the underlying collection.
* @param item the item to add
* @return {@code true}
*/
public boolean addResponsibleRole(ResponsibleRole item) {
ResponsibleRole value = ObjectUtils.requireNonNull(item,"item cannot be null");
if (_responsibleRoles == null) {
_responsibleRoles = new LinkedList<>();
}
return _responsibleRoles.add(value);
}
/**
* Remove the first matching {@link ResponsibleRole} item from the underlying collection.
* @param item the item to remove
* @return {@code true} if the item was removed or {@code false} otherwise
*/
public boolean removeResponsibleRole(ResponsibleRole item) {
ResponsibleRole value = ObjectUtils.requireNonNull(item,"item cannot be null");
return _responsibleRoles == null ? false : _responsibleRoles.remove(value);
}
public MarkupMultiline getRemarks() {
return _remarks;
}
public void setRemarks(MarkupMultiline value) {
_remarks = value;
}
@Override
public String toString() {
return new ReflectionToStringBuilder(this, MultilineRecursiveToStringStyle.MULTI_LINE_STYLE).toString();
}
/**
* Describes a control implementation inherited by a leveraging system.
*/
@MetaschemaAssembly(
formalName = "Inherited Control Implementation",
description = "Describes a control implementation inherited by a leveraging system.",
name = "inherited",
metaschema = OscalSspMetaschema.class
)
@AssemblyConstraints(
isUnique = @IsUnique(id = "unique-inherited-responsible-role", level = IConstraint.Level.ERROR, target = "responsible-role", keyFields = @KeyField(target = "@role-id"), remarks = "Since `responsible-role` associates multiple `party-uuid` entries with a single `role-id`, each role-id must be referenced only once.")
)
public static class Inherited {
@BoundFlag(
formalName = "Inherited Universally Unique Identifier",
description = "A [machine-oriented](https://pages.nist.gov/OSCAL/concepts/identifier-use/#machine-oriented), [globally unique](https://pages.nist.gov/OSCAL/concepts/identifier-use/#globally-unique) identifier with [cross-instance](https://pages.nist.gov/OSCAL/concepts/identifier-use/#cross-instance) scope that can be used to reference this inherited entry elsewhere in [this or other OSCAL instances](https://pages.nist.gov/OSCAL/concepts/identifier-use/#ssp-identifiers). The locally defined *UUID* of the `inherited control implementation` can be used to reference the data item locally or globally (e.g., in an imported OSCAL instance). This UUID should be assigned [per-subject](https://pages.nist.gov/OSCAL/concepts/identifier-use/#consistency), which means it should be consistently used to identify the same subject across revisions of the document.",
useName = "uuid",
required = true,
typeAdapter = UuidAdapter.class
)
private UUID _uuid;
@BoundFlag(
formalName = "Provided UUID",
description = "A [machine-oriented](https://pages.nist.gov/OSCAL/concepts/identifier-use/#machine-oriented) identifier reference to an inherited control implementation that a leveraging system is inheriting from a leveraged system.",
useName = "provided-uuid",
typeAdapter = UuidAdapter.class
)
private UUID _providedUuid;
/**
* "An implementation statement that describes the aspects of a control or control statement implementation that a leveraging system is inheriting from a leveraged system."
*/
@BoundField(
formalName = "Inherited Control Implementation Description",
description = "An implementation statement that describes the aspects of a control or control statement implementation that a leveraging system is inheriting from a leveraged system.",
useName = "description",
minOccurs = 1
)
@BoundFieldValue(
typeAdapter = MarkupMultilineAdapter.class
)
private MarkupMultiline _description;
@BoundAssembly(
formalName = "Property",
description = "An attribute, characteristic, or quality of the containing object expressed as a namespace qualified name/value pair.",
useName = "prop",
maxOccurs = -1
)
@GroupAs(
name = "props",
inJson = JsonGroupAsBehavior.LIST
)
private List<Property> _props;
@BoundAssembly(
formalName = "Link",
description = "A reference to a local or remote resource, that has a specific relation to the containing object.",
useName = "link",
maxOccurs = -1
)
@GroupAs(
name = "links",
inJson = JsonGroupAsBehavior.LIST
)
private List<Link> _links;
@BoundAssembly(
formalName = "Responsible Role",
description = "A reference to a role with responsibility for performing a function relative to the containing object, optionally associated with a set of persons and/or organizations that perform that role.",
useName = "responsible-role",
maxOccurs = -1
)
@GroupAs(
name = "responsible-roles",
inJson = JsonGroupAsBehavior.LIST
)
private List<ResponsibleRole> _responsibleRoles;
public Inherited() {
}
public UUID getUuid() {
return _uuid;
}
public void setUuid(UUID value) {
_uuid = value;
}
public UUID getProvidedUuid() {
return _providedUuid;
}
public void setProvidedUuid(UUID value) {
_providedUuid = value;
}
public MarkupMultiline getDescription() {
return _description;
}
public void setDescription(MarkupMultiline value) {
_description = value;
}
public List<Property> getProps() {
return _props;
}
public void setProps(List<Property> value) {
_props = value;
}
/**
* Add a new {@link Property} item to the underlying collection.
* @param item the item to add
* @return {@code true}
*/
public boolean addProp(Property item) {
Property value = ObjectUtils.requireNonNull(item,"item cannot be null");
if (_props == null) {
_props = new LinkedList<>();
}
return _props.add(value);
}
/**
* Remove the first matching {@link Property} item from the underlying collection.
* @param item the item to remove
* @return {@code true} if the item was removed or {@code false} otherwise
*/
public boolean removeProp(Property item) {
Property value = ObjectUtils.requireNonNull(item,"item cannot be null");
return _props == null ? false : _props.remove(value);
}
public List<Link> getLinks() {
return _links;
}
public void setLinks(List<Link> value) {
_links = value;
}
/**
* Add a new {@link Link} item to the underlying collection.
* @param item the item to add
* @return {@code true}
*/
public boolean addLink(Link item) {
Link value = ObjectUtils.requireNonNull(item,"item cannot be null");
if (_links == null) {
_links = new LinkedList<>();
}
return _links.add(value);
}
/**
* Remove the first matching {@link Link} item from the underlying collection.
* @param item the item to remove
* @return {@code true} if the item was removed or {@code false} otherwise
*/
public boolean removeLink(Link item) {
Link value = ObjectUtils.requireNonNull(item,"item cannot be null");
return _links == null ? false : _links.remove(value);
}
public List<ResponsibleRole> getResponsibleRoles() {
return _responsibleRoles;
}
public void setResponsibleRoles(List<ResponsibleRole> value) {
_responsibleRoles = value;
}
/**
* Add a new {@link ResponsibleRole} item to the underlying collection.
* @param item the item to add
* @return {@code true}
*/
public boolean addResponsibleRole(ResponsibleRole item) {
ResponsibleRole value = ObjectUtils.requireNonNull(item,"item cannot be null");
if (_responsibleRoles == null) {
_responsibleRoles = new LinkedList<>();
}
return _responsibleRoles.add(value);
}
/**
* Remove the first matching {@link ResponsibleRole} item from the underlying collection.
* @param item the item to remove
* @return {@code true} if the item was removed or {@code false} otherwise
*/
public boolean removeResponsibleRole(ResponsibleRole item) {
ResponsibleRole value = ObjectUtils.requireNonNull(item,"item cannot be null");
return _responsibleRoles == null ? false : _responsibleRoles.remove(value);
}
@Override
public String toString() {
return new ReflectionToStringBuilder(this, MultilineRecursiveToStringStyle.MULTI_LINE_STYLE).toString();
}
}
/**
* Describes how this system satisfies a responsibility imposed by a leveraged system.
*/
@MetaschemaAssembly(
formalName = "Satisfied Control Implementation Responsibility",
description = "Describes how this system satisfies a responsibility imposed by a leveraged system.",
name = "satisfied",
metaschema = OscalSspMetaschema.class
)
@AssemblyConstraints(
isUnique = @IsUnique(id = "unique-satisfied-responsible-role", level = IConstraint.Level.ERROR, target = "responsible-role", keyFields = @KeyField(target = "@role-id"), remarks = "Since `responsible-role` associates multiple `party-uuid` entries with a single `role-id`, each role-id must be referenced only once.")
)
public static class Satisfied {
@BoundFlag(
formalName = "Satisfied Universally Unique Identifier",
description = "A [machine-oriented](https://pages.nist.gov/OSCAL/concepts/identifier-use/#machine-oriented), [globally unique](https://pages.nist.gov/OSCAL/concepts/identifier-use/#globally-unique) identifier with [cross-instance](https://pages.nist.gov/OSCAL/concepts/identifier-use/#cross-instance) scope that can be used to reference this satisfied control implementation entry elsewhere in [this or other OSCAL instances](https://pages.nist.gov/OSCAL/concepts/identifier-use/#ssp-identifiers). The locally defined *UUID* of the `control implementation` can be used to reference the data item locally or globally (e.g., in an imported OSCAL instance). This UUID should be assigned [per-subject](https://pages.nist.gov/OSCAL/concepts/identifier-use/#consistency), which means it should be consistently used to identify the same subject across revisions of the document.",
useName = "uuid",
required = true,
typeAdapter = UuidAdapter.class
)
private UUID _uuid;
@BoundFlag(
formalName = "Responsibility UUID",
description = "A [machine-oriented](https://pages.nist.gov/OSCAL/concepts/identifier-use/#machine-oriented) identifier reference to a control implementation that satisfies a responsibility imposed by a leveraged system.",
useName = "responsibility-uuid",
typeAdapter = UuidAdapter.class
)
private UUID _responsibilityUuid;
/**
* "An implementation statement that describes the aspects of a control or control statement implementation that a leveraging system is implementing based on a requirement from a leveraged system."
*/
@BoundField(
formalName = "Satisfied Control Implementation Responsibility Description",
description = "An implementation statement that describes the aspects of a control or control statement implementation that a leveraging system is implementing based on a requirement from a leveraged system.",
useName = "description",
minOccurs = 1
)
@BoundFieldValue(
typeAdapter = MarkupMultilineAdapter.class
)
private MarkupMultiline _description;
@BoundAssembly(
formalName = "Property",
description = "An attribute, characteristic, or quality of the containing object expressed as a namespace qualified name/value pair.",
useName = "prop",
maxOccurs = -1
)
@GroupAs(
name = "props",
inJson = JsonGroupAsBehavior.LIST
)
private List<Property> _props;
@BoundAssembly(
formalName = "Link",
description = "A reference to a local or remote resource, that has a specific relation to the containing object.",
useName = "link",
maxOccurs = -1
)
@GroupAs(
name = "links",
inJson = JsonGroupAsBehavior.LIST
)
private List<Link> _links;
@BoundAssembly(
formalName = "Responsible Role",
description = "A reference to a role with responsibility for performing a function relative to the containing object, optionally associated with a set of persons and/or organizations that perform that role.",
useName = "responsible-role",
maxOccurs = -1
)
@GroupAs(
name = "responsible-roles",
inJson = JsonGroupAsBehavior.LIST
)
private List<ResponsibleRole> _responsibleRoles;
@BoundField(
formalName = "Remarks",
description = "Additional commentary about the containing object.",
useName = "remarks"
)
@BoundFieldValue(
typeAdapter = MarkupMultilineAdapter.class
)
private MarkupMultiline _remarks;
public Satisfied() {
}
public UUID getUuid() {
return _uuid;
}
public void setUuid(UUID value) {
_uuid = value;
}
public UUID getResponsibilityUuid() {
return _responsibilityUuid;
}
public void setResponsibilityUuid(UUID value) {
_responsibilityUuid = value;
}
public MarkupMultiline getDescription() {
return _description;
}
public void setDescription(MarkupMultiline value) {
_description = value;
}
public List<Property> getProps() {
return _props;
}
public void setProps(List<Property> value) {
_props = value;
}
/**
* Add a new {@link Property} item to the underlying collection.
* @param item the item to add
* @return {@code true}
*/
public boolean addProp(Property item) {
Property value = ObjectUtils.requireNonNull(item,"item cannot be null");
if (_props == null) {
_props = new LinkedList<>();
}
return _props.add(value);
}
/**
* Remove the first matching {@link Property} item from the underlying collection.
* @param item the item to remove
* @return {@code true} if the item was removed or {@code false} otherwise
*/
public boolean removeProp(Property item) {
Property value = ObjectUtils.requireNonNull(item,"item cannot be null");
return _props == null ? false : _props.remove(value);
}
public List<Link> getLinks() {
return _links;
}
public void setLinks(List<Link> value) {
_links = value;
}
/**
* Add a new {@link Link} item to the underlying collection.
* @param item the item to add
* @return {@code true}
*/
public boolean addLink(Link item) {
Link value = ObjectUtils.requireNonNull(item,"item cannot be null");
if (_links == null) {
_links = new LinkedList<>();
}
return _links.add(value);
}
/**
* Remove the first matching {@link Link} item from the underlying collection.
* @param item the item to remove
* @return {@code true} if the item was removed or {@code false} otherwise
*/
public boolean removeLink(Link item) {
Link value = ObjectUtils.requireNonNull(item,"item cannot be null");
return _links == null ? false : _links.remove(value);
}
public List<ResponsibleRole> getResponsibleRoles() {
return _responsibleRoles;
}
public void setResponsibleRoles(List<ResponsibleRole> value) {
_responsibleRoles = value;
}
/**
* Add a new {@link ResponsibleRole} item to the underlying collection.
* @param item the item to add
* @return {@code true}
*/
public boolean addResponsibleRole(ResponsibleRole item) {
ResponsibleRole value = ObjectUtils.requireNonNull(item,"item cannot be null");
if (_responsibleRoles == null) {
_responsibleRoles = new LinkedList<>();
}
return _responsibleRoles.add(value);
}
/**
* Remove the first matching {@link ResponsibleRole} item from the underlying collection.
* @param item the item to remove
* @return {@code true} if the item was removed or {@code false} otherwise
*/
public boolean removeResponsibleRole(ResponsibleRole item) {
ResponsibleRole value = ObjectUtils.requireNonNull(item,"item cannot be null");
return _responsibleRoles == null ? false : _responsibleRoles.remove(value);
}
public MarkupMultiline getRemarks() {
return _remarks;
}
public void setRemarks(MarkupMultiline value) {
_remarks = value;
}
@Override
public String toString() {
return new ReflectionToStringBuilder(this, MultilineRecursiveToStringStyle.MULTI_LINE_STYLE).toString();
}
}
/**
* Identifies content intended for external consumption, such as with leveraged organizations.
*/
@MetaschemaAssembly(
formalName = "Export",
description = "Identifies content intended for external consumption, such as with leveraged organizations.",
name = "export",
metaschema = OscalSspMetaschema.class
)
@ValueConstraints(
indexHasKey = @IndexHasKey(level = IConstraint.Level.ERROR, target = "responsibility", indexName = "by-component-export-provided-uuid", keyFields = @KeyField(target = "@provided-uuid"))
)
@AssemblyConstraints(
hasCardinality = @HasCardinality(level = IConstraint.Level.ERROR, target = "provided|responsibility", minOccurs = 1)
)
public static class Export {
/**
* "An implementation statement that describes the aspects of the control or control statement implementation that can be available to another system leveraging this system."
*/
@BoundField(
formalName = "Control Implementation Export Description",
description = "An implementation statement that describes the aspects of the control or control statement implementation that can be available to another system leveraging this system.",
useName = "description"
)
@BoundFieldValue(
typeAdapter = MarkupMultilineAdapter.class
)
private MarkupMultiline _description;
@BoundAssembly(
formalName = "Property",
description = "An attribute, characteristic, or quality of the containing object expressed as a namespace qualified name/value pair.",
useName = "prop",
maxOccurs = -1
)
@GroupAs(
name = "props",
inJson = JsonGroupAsBehavior.LIST
)
private List<Property> _props;
@BoundAssembly(
formalName = "Link",
description = "A reference to a local or remote resource, that has a specific relation to the containing object.",
useName = "link",
maxOccurs = -1
)
@GroupAs(
name = "links",
inJson = JsonGroupAsBehavior.LIST
)
private List<Link> _links;
/**
* "Describes a capability which may be inherited by a leveraging system."
*/
@BoundAssembly(
formalName = "Provided Control Implementation",
description = "Describes a capability which may be inherited by a leveraging system.",
useName = "provided",
maxOccurs = -1
)
@GroupAs(
name = "provided",
inJson = JsonGroupAsBehavior.LIST
)
private List<Provided> _provided;
/**
* "Describes a control implementation responsibility imposed on a leveraging system."
*/
@BoundAssembly(
formalName = "Control Implementation Responsibility",
description = "Describes a control implementation responsibility imposed on a leveraging system.",
useName = "responsibility",
maxOccurs = -1
)
@GroupAs(
name = "responsibilities",
inJson = JsonGroupAsBehavior.LIST
)
private List<Responsibility> _responsibilities;
@BoundField(
formalName = "Remarks",
description = "Additional commentary about the containing object.",
useName = "remarks"
)
@BoundFieldValue(
typeAdapter = MarkupMultilineAdapter.class
)
private MarkupMultiline _remarks;
public Export() {
}
public MarkupMultiline getDescription() {
return _description;
}
public void setDescription(MarkupMultiline value) {
_description = value;
}
public List<Property> getProps() {
return _props;
}
public void setProps(List<Property> value) {
_props = value;
}
/**
* Add a new {@link Property} item to the underlying collection.
* @param item the item to add
* @return {@code true}
*/
public boolean addProp(Property item) {
Property value = ObjectUtils.requireNonNull(item,"item cannot be null");
if (_props == null) {
_props = new LinkedList<>();
}
return _props.add(value);
}
/**
* Remove the first matching {@link Property} item from the underlying collection.
* @param item the item to remove
* @return {@code true} if the item was removed or {@code false} otherwise
*/
public boolean removeProp(Property item) {
Property value = ObjectUtils.requireNonNull(item,"item cannot be null");
return _props == null ? false : _props.remove(value);
}
public List<Link> getLinks() {
return _links;
}
public void setLinks(List<Link> value) {
_links = value;
}
/**
* Add a new {@link Link} item to the underlying collection.
* @param item the item to add
* @return {@code true}
*/
public boolean addLink(Link item) {
Link value = ObjectUtils.requireNonNull(item,"item cannot be null");
if (_links == null) {
_links = new LinkedList<>();
}
return _links.add(value);
}
/**
* Remove the first matching {@link Link} item from the underlying collection.
* @param item the item to remove
* @return {@code true} if the item was removed or {@code false} otherwise
*/
public boolean removeLink(Link item) {
Link value = ObjectUtils.requireNonNull(item,"item cannot be null");
return _links == null ? false : _links.remove(value);
}
public List<Provided> getProvided() {
return _provided;
}
public void setProvided(List<Provided> value) {
_provided = value;
}
/**
* Add a new {@link Provided} item to the underlying collection.
* @param item the item to add
* @return {@code true}
*/
public boolean addProvided(Provided item) {
Provided value = ObjectUtils.requireNonNull(item,"item cannot be null");
if (_provided == null) {
_provided = new LinkedList<>();
}
return _provided.add(value);
}
/**
* Remove the first matching {@link Provided} item from the underlying collection.
* @param item the item to remove
* @return {@code true} if the item was removed or {@code false} otherwise
*/
public boolean removeProvided(Provided item) {
Provided value = ObjectUtils.requireNonNull(item,"item cannot be null");
return _provided == null ? false : _provided.remove(value);
}
public List<Responsibility> getResponsibilities() {
return _responsibilities;
}
public void setResponsibilities(List<Responsibility> value) {
_responsibilities = value;
}
/**
* Add a new {@link Responsibility} item to the underlying collection.
* @param item the item to add
* @return {@code true}
*/
public boolean addResponsibility(Responsibility item) {
Responsibility value = ObjectUtils.requireNonNull(item,"item cannot be null");
if (_responsibilities == null) {
_responsibilities = new LinkedList<>();
}
return _responsibilities.add(value);
}
/**
* Remove the first matching {@link Responsibility} item from the underlying collection.
* @param item the item to remove
* @return {@code true} if the item was removed or {@code false} otherwise
*/
public boolean removeResponsibility(Responsibility item) {
Responsibility value = ObjectUtils.requireNonNull(item,"item cannot be null");
return _responsibilities == null ? false : _responsibilities.remove(value);
}
public MarkupMultiline getRemarks() {
return _remarks;
}
public void setRemarks(MarkupMultiline value) {
_remarks = value;
}
@Override
public String toString() {
return new ReflectionToStringBuilder(this, MultilineRecursiveToStringStyle.MULTI_LINE_STYLE).toString();
}
/**
* Describes a capability which may be inherited by a leveraging system.
*/
@MetaschemaAssembly(
formalName = "Provided Control Implementation",
description = "Describes a capability which may be inherited by a leveraging system.",
name = "provided",
metaschema = OscalSspMetaschema.class
)
@AssemblyConstraints(
isUnique = @IsUnique(id = "unique-provided-responsible-role", level = IConstraint.Level.ERROR, target = "responsible-role", keyFields = @KeyField(target = "@role-id"), remarks = "Since `responsible-role` associates multiple `party-uuid` entries with a single `role-id`, each role-id must be referenced only once.")
)
public static class Provided {
@BoundFlag(
formalName = "Provided Universally Unique Identifier",
description = "A [machine-oriented](https://pages.nist.gov/OSCAL/concepts/identifier-use/#machine-oriented), [globally unique](https://pages.nist.gov/OSCAL/concepts/identifier-use/#globally-unique) identifier with [cross-instance](https://pages.nist.gov/OSCAL/concepts/identifier-use/#cross-instance) scope that can be used to reference this provided entry elsewhere in [this or other OSCAL instances](https://pages.nist.gov/OSCAL/concepts/identifier-use/#ssp-identifiers). The locally defined *UUID* of the `provided` entry can be used to reference the data item locally or globally (e.g., in an imported OSCAL instance). This UUID should be assigned [per-subject](https://pages.nist.gov/OSCAL/concepts/identifier-use/#consistency), which means it should be consistently used to identify the same subject across revisions of the document.",
useName = "uuid",
required = true,
typeAdapter = UuidAdapter.class
)
private UUID _uuid;
/**
* "An implementation statement that describes the aspects of the control or control statement implementation that can be provided to another system leveraging this system."
*/
@BoundField(
formalName = "Provided Control Implementation Description",
description = "An implementation statement that describes the aspects of the control or control statement implementation that can be provided to another system leveraging this system.",
useName = "description",
minOccurs = 1
)
@BoundFieldValue(
typeAdapter = MarkupMultilineAdapter.class
)
private MarkupMultiline _description;
@BoundAssembly(
formalName = "Property",
description = "An attribute, characteristic, or quality of the containing object expressed as a namespace qualified name/value pair.",
useName = "prop",
maxOccurs = -1
)
@GroupAs(
name = "props",
inJson = JsonGroupAsBehavior.LIST
)
private List<Property> _props;
@BoundAssembly(
formalName = "Link",
description = "A reference to a local or remote resource, that has a specific relation to the containing object.",
useName = "link",
maxOccurs = -1
)
@GroupAs(
name = "links",
inJson = JsonGroupAsBehavior.LIST
)
private List<Link> _links;
@BoundAssembly(
formalName = "Responsible Role",
description = "A reference to a role with responsibility for performing a function relative to the containing object, optionally associated with a set of persons and/or organizations that perform that role.",
useName = "responsible-role",
maxOccurs = -1
)
@GroupAs(
name = "responsible-roles",
inJson = JsonGroupAsBehavior.LIST
)
private List<ResponsibleRole> _responsibleRoles;
@BoundField(
formalName = "Remarks",
description = "Additional commentary about the containing object.",
useName = "remarks"
)
@BoundFieldValue(
typeAdapter = MarkupMultilineAdapter.class
)
private MarkupMultiline _remarks;
public Provided() {
}
public UUID getUuid() {
return _uuid;
}
public void setUuid(UUID value) {
_uuid = value;
}
public MarkupMultiline getDescription() {
return _description;
}
public void setDescription(MarkupMultiline value) {
_description = value;
}
public List<Property> getProps() {
return _props;
}
public void setProps(List<Property> value) {
_props = value;
}
/**
* Add a new {@link Property} item to the underlying collection.
* @param item the item to add
* @return {@code true}
*/
public boolean addProp(Property item) {
Property value = ObjectUtils.requireNonNull(item,"item cannot be null");
if (_props == null) {
_props = new LinkedList<>();
}
return _props.add(value);
}
/**
* Remove the first matching {@link Property} item from the underlying collection.
* @param item the item to remove
* @return {@code true} if the item was removed or {@code false} otherwise
*/
public boolean removeProp(Property item) {
Property value = ObjectUtils.requireNonNull(item,"item cannot be null");
return _props == null ? false : _props.remove(value);
}
public List<Link> getLinks() {
return _links;
}
public void setLinks(List<Link> value) {
_links = value;
}
/**
* Add a new {@link Link} item to the underlying collection.
* @param item the item to add
* @return {@code true}
*/
public boolean addLink(Link item) {
Link value = ObjectUtils.requireNonNull(item,"item cannot be null");
if (_links == null) {
_links = new LinkedList<>();
}
return _links.add(value);
}
/**
* Remove the first matching {@link Link} item from the underlying collection.
* @param item the item to remove
* @return {@code true} if the item was removed or {@code false} otherwise
*/
public boolean removeLink(Link item) {
Link value = ObjectUtils.requireNonNull(item,"item cannot be null");
return _links == null ? false : _links.remove(value);
}
public List<ResponsibleRole> getResponsibleRoles() {
return _responsibleRoles;
}
public void setResponsibleRoles(List<ResponsibleRole> value) {
_responsibleRoles = value;
}
/**
* Add a new {@link ResponsibleRole} item to the underlying collection.
* @param item the item to add
* @return {@code true}
*/
public boolean addResponsibleRole(ResponsibleRole item) {
ResponsibleRole value = ObjectUtils.requireNonNull(item,"item cannot be null");
if (_responsibleRoles == null) {
_responsibleRoles = new LinkedList<>();
}
return _responsibleRoles.add(value);
}
/**
* Remove the first matching {@link ResponsibleRole} item from the underlying collection.
* @param item the item to remove
* @return {@code true} if the item was removed or {@code false} otherwise
*/
public boolean removeResponsibleRole(ResponsibleRole item) {
ResponsibleRole value = ObjectUtils.requireNonNull(item,"item cannot be null");
return _responsibleRoles == null ? false : _responsibleRoles.remove(value);
}
public MarkupMultiline getRemarks() {
return _remarks;
}
public void setRemarks(MarkupMultiline value) {
_remarks = value;
}
@Override
public String toString() {
return new ReflectionToStringBuilder(this, MultilineRecursiveToStringStyle.MULTI_LINE_STYLE).toString();
}
}
/**
* Describes a control implementation responsibility imposed on a leveraging system.
*/
@MetaschemaAssembly(
formalName = "Control Implementation Responsibility",
description = "Describes a control implementation responsibility imposed on a leveraging system.",
name = "responsibility",
metaschema = OscalSspMetaschema.class
)
@AssemblyConstraints(
isUnique = @IsUnique(id = "unique-responsibility-responsible-role", level = IConstraint.Level.ERROR, target = "responsible-role", keyFields = @KeyField(target = "@role-id"), remarks = "Since `responsible-role` associates multiple `party-uuid` entries with a single `role-id`, each role-id must be referenced only once.")
)
public static class Responsibility {
@BoundFlag(
formalName = "Responsibility Universally Unique Identifier",
description = "A [machine-oriented](https://pages.nist.gov/OSCAL/concepts/identifier-use/#machine-oriented), [globally unique](https://pages.nist.gov/OSCAL/concepts/identifier-use/#globally-unique) identifier with [cross-instance](https://pages.nist.gov/OSCAL/concepts/identifier-use/#cross-instance) scope that can be used to reference this responsibility elsewhere in [this or other OSCAL instances](https://pages.nist.gov/OSCAL/concepts/identifier-use/#ssp-identifiers). The locally defined *UUID* of the `responsibility` can be used to reference the data item locally or globally (e.g., in an imported OSCAL instance). This UUID should be assigned [per-subject](https://pages.nist.gov/OSCAL/concepts/identifier-use/#consistency), which means it should be consistently used to identify the same subject across revisions of the document.",
useName = "uuid",
required = true,
typeAdapter = UuidAdapter.class
)
private UUID _uuid;
@BoundFlag(
formalName = "Provided UUID",
description = "A [machine-oriented](https://pages.nist.gov/OSCAL/concepts/identifier-use/#machine-oriented) identifier reference to an inherited control implementation that a leveraging system is inheriting from a leveraged system.",
useName = "provided-uuid",
typeAdapter = UuidAdapter.class
)
private UUID _providedUuid;
/**
* "An implementation statement that describes the aspects of the control or control statement implementation that a leveraging system must implement to satisfy the control provided by a leveraged system."
*/
@BoundField(
formalName = "Control Implementation Responsibility Description",
description = "An implementation statement that describes the aspects of the control or control statement implementation that a leveraging system must implement to satisfy the control provided by a leveraged system.",
useName = "description",
minOccurs = 1
)
@BoundFieldValue(
typeAdapter = MarkupMultilineAdapter.class
)
private MarkupMultiline _description;
@BoundAssembly(
formalName = "Property",
description = "An attribute, characteristic, or quality of the containing object expressed as a namespace qualified name/value pair.",
useName = "prop",
maxOccurs = -1
)
@GroupAs(
name = "props",
inJson = JsonGroupAsBehavior.LIST
)
private List<Property> _props;
@BoundAssembly(
formalName = "Link",
description = "A reference to a local or remote resource, that has a specific relation to the containing object.",
useName = "link",
maxOccurs = -1
)
@GroupAs(
name = "links",
inJson = JsonGroupAsBehavior.LIST
)
private List<Link> _links;
@BoundAssembly(
formalName = "Responsible Role",
description = "A reference to a role with responsibility for performing a function relative to the containing object, optionally associated with a set of persons and/or organizations that perform that role.",
useName = "responsible-role",
maxOccurs = -1,
remarks = "A role defined at the by-component level takes precedence over the same role defined on the parent implemented-requirement or on the referenced component."
)
@GroupAs(
name = "responsible-roles",
inJson = JsonGroupAsBehavior.LIST
)
private List<ResponsibleRole> _responsibleRoles;
@BoundField(
formalName = "Remarks",
description = "Additional commentary about the containing object.",
useName = "remarks"
)
@BoundFieldValue(
typeAdapter = MarkupMultilineAdapter.class
)
private MarkupMultiline _remarks;
public Responsibility() {
}
public UUID getUuid() {
return _uuid;
}
public void setUuid(UUID value) {
_uuid = value;
}
public UUID getProvidedUuid() {
return _providedUuid;
}
public void setProvidedUuid(UUID value) {
_providedUuid = value;
}
public MarkupMultiline getDescription() {
return _description;
}
public void setDescription(MarkupMultiline value) {
_description = value;
}
public List<Property> getProps() {
return _props;
}
public void setProps(List<Property> value) {
_props = value;
}
/**
* Add a new {@link Property} item to the underlying collection.
* @param item the item to add
* @return {@code true}
*/
public boolean addProp(Property item) {
Property value = ObjectUtils.requireNonNull(item,"item cannot be null");
if (_props == null) {
_props = new LinkedList<>();
}
return _props.add(value);
}
/**
* Remove the first matching {@link Property} item from the underlying collection.
* @param item the item to remove
* @return {@code true} if the item was removed or {@code false} otherwise
*/
public boolean removeProp(Property item) {
Property value = ObjectUtils.requireNonNull(item,"item cannot be null");
return _props == null ? false : _props.remove(value);
}
public List<Link> getLinks() {
return _links;
}
public void setLinks(List<Link> value) {
_links = value;
}
/**
* Add a new {@link Link} item to the underlying collection.
* @param item the item to add
* @return {@code true}
*/
public boolean addLink(Link item) {
Link value = ObjectUtils.requireNonNull(item,"item cannot be null");
if (_links == null) {
_links = new LinkedList<>();
}
return _links.add(value);
}
/**
* Remove the first matching {@link Link} item from the underlying collection.
* @param item the item to remove
* @return {@code true} if the item was removed or {@code false} otherwise
*/
public boolean removeLink(Link item) {
Link value = ObjectUtils.requireNonNull(item,"item cannot be null");
return _links == null ? false : _links.remove(value);
}
public List<ResponsibleRole> getResponsibleRoles() {
return _responsibleRoles;
}
public void setResponsibleRoles(List<ResponsibleRole> value) {
_responsibleRoles = value;
}
/**
* Add a new {@link ResponsibleRole} item to the underlying collection.
* @param item the item to add
* @return {@code true}
*/
public boolean addResponsibleRole(ResponsibleRole item) {
ResponsibleRole value = ObjectUtils.requireNonNull(item,"item cannot be null");
if (_responsibleRoles == null) {
_responsibleRoles = new LinkedList<>();
}
return _responsibleRoles.add(value);
}
/**
* Remove the first matching {@link ResponsibleRole} item from the underlying collection.
* @param item the item to remove
* @return {@code true} if the item was removed or {@code false} otherwise
*/
public boolean removeResponsibleRole(ResponsibleRole item) {
ResponsibleRole value = ObjectUtils.requireNonNull(item,"item cannot be null");
return _responsibleRoles == null ? false : _responsibleRoles.remove(value);
}
public MarkupMultiline getRemarks() {
return _remarks;
}
public void setRemarks(MarkupMultiline value) {
_remarks = value;
}
@Override
public String toString() {
return new ReflectionToStringBuilder(this, MultilineRecursiveToStringStyle.MULTI_LINE_STYLE).toString();
}
}
}
}