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

Class Profile

java.lang.Object

gov.nist.secauto.oscal.lib.model.AbstractOscalInstance

gov.nist.secauto.oscal.lib.model.Profile

All Implemented Interfaces:

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

@MetaschemaAssembly(formalName="Profile",
                    description="Each OSCAL profile is defined by a `profile` element.",
                    name="profile",
                    moduleClass=OscalProfileModule.class,
                    rootName="profile",
                    remarks="An OSCAL document that describes a tailoring of controls from one or more catalogs, with possible modification of multiple controls. It provides mechanisms by which controls may be selected (`import`), merged or (re)structured (`merge`), and amended (`modify`). OSCAL profiles may select subsets of controls, set parameter values for them in application, and even adjust the representation of controls as given in and by a catalog. They may also serve as sources for further modification in and by other profiles, that import them.",
                    modelConstraints=@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 Profile
extends AbstractOscalInstance
implements gov.nist.secauto.metaschema.core.model.IBoundObject

Each OSCAL profile is defined by a profile element.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	addImport(ProfileImport item)	Add a new ProfileImport item to the underlying collection.
BackMatter	getBackMatter()
List<ProfileImport>	getImports()
Merge	getMerge()
Metadata	getMetadata()
gov.nist.secauto.metaschema.core.model.IMetaschemaData	getMetaschemaData()
Modify	getModify()
UUID	getUuid()
boolean	removeImport(ProfileImport item)	Remove the first matching ProfileImport item from the underlying collection.
void	setBackMatter(BackMatter value)
void	setImports(List<ProfileImport> value)
void	setMerge(Merge value)
void	setMetadata(Metadata value)
void	setModify(Modify value)
void	setUuid(UUID value)
String	toString()

Methods inherited from class gov.nist.secauto.oscal.lib.model.AbstractOscalInstance

getResourceByUuid

Methods inherited from class java.lang.Object

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

Constructor Details

Profile

public Profile()

Profile

public Profile(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()

Specified by:

getUuid in interface IOscalInstance

setUuid

public void setUuid(UUID value)

getMetadata

public Metadata getMetadata()

Specified by:

getMetadata in interface IOscalInstance

setMetadata

public void setMetadata(Metadata value)

getImports

public List<ProfileImport> getImports()

setImports

public void setImports(List<ProfileImport> value)

addImport

public boolean addImport(ProfileImport item)

Add a new ProfileImport item to the underlying collection.

Parameters:

item - the item to add

Returns:

true

removeImport

public boolean removeImport(ProfileImport item)

Remove the first matching ProfileImport item from the underlying collection.

Parameters:

item - the item to remove

Returns:

true if the item was removed or false otherwise

getMerge

public Merge getMerge()

setMerge

public void setMerge(Merge value)

getModify

public Modify getModify()

setModify

public void setModify(Modify value)

getBackMatter

public BackMatter getBackMatter()

Specified by:

getBackMatter in interface IOscalInstance

setBackMatter

public void setBackMatter(BackMatter value)

toString

public String toString()

Overrides:

toString in class Object