Package gov.nist.secauto.oscal.lib.model
Class SystemUser
java.lang.Object
gov.nist.secauto.oscal.lib.model.SystemUser
- All Implemented Interfaces:
 gov.nist.secauto.metaschema.core.model.IBoundObject
@MetaschemaAssembly(formalName="System User",
                    description="A type of user that interacts with the system based on an associated role.",
                    name="system-user",
                    moduleClass=OscalImplementationCommonModule.class,
                    remarks="Permissible values to be determined closer to the application, such as by a receiving authority.",
                    valueConstraints=@AllowedValues(level=ERROR,target="prop[has-oscal-namespace(\'http://csrc.nist.gov/ns/oscal\')]/@name",values={@AllowedValue(value="type",description="The type of user, such as internal, external, or general-public."),@AllowedValue(value="privilege-level",description="The user\'s privilege level within the system, such as privileged, non-privileged, no-logical-access.")}) @AllowedValues(level=ERROR,target="prop[has-oscal-namespace(\'http://csrc.nist.gov/ns/oscal\') and @name=\'type\']/@value",values={@AllowedValue(value="internal",description="A user account for a person or entity that is part of the organization who owns or operates the system."),@AllowedValue(value="external",description="A user account for a person or entity that is not part of the organization who owns or operates the system."),@AllowedValue(value="general-public",description="A user of the system considered to be outside")}) @AllowedValues(level=ERROR,target="prop[has-oscal-namespace(\'http://csrc.nist.gov/ns/oscal\') and @name=\'privilege-level\']/@value",values={@AllowedValue(value="privileged",description="This role has elevated access to the system, such as a group or system administrator."),@AllowedValue(value="non-privileged",description="This role has typical user-level access to the system without elevated access."),@AllowedValue(value="no-logical-access",description="This role has no access to the system, such as a manager who approves access as part of a process.")}) @AllowedValues(level=ERROR,target="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.")}))
public class SystemUser
extends Object
implements gov.nist.secauto.metaschema.core.model.IBoundObject
A type of user that interacts with the system based on an associated role.
- 
Constructor Summary
Constructors - 
Method Summary
Modifier and TypeMethodDescriptionbooleanAdd a newAuthorizedPrivilegeitem to the underlying collection.booleanAdd a newLinkitem to the underlying collection.booleanAdd a newPropertyitem to the underlying collection.booleanAdd a newStringitem to the underlying collection.gov.nist.secauto.metaschema.core.datatype.markup.MarkupMultilinegetLinks()gov.nist.secauto.metaschema.core.model.IMetaschemaDatagetProps()gov.nist.secauto.metaschema.core.datatype.markup.MarkupMultilinegov.nist.secauto.metaschema.core.datatype.markup.MarkupLinegetTitle()getUuid()booleanRemove the first matchingAuthorizedPrivilegeitem from the underlying collection.booleanremoveLink(Link item) Remove the first matchingLinkitem from the underlying collection.booleanremoveProp(Property item) Remove the first matchingPropertyitem from the underlying collection.booleanremoveRoleId(String item) Remove the first matchingStringitem from the underlying collection.voidvoidsetDescription(gov.nist.secauto.metaschema.core.datatype.markup.MarkupMultiline value) voidvoidvoidsetRemarks(gov.nist.secauto.metaschema.core.datatype.markup.MarkupMultiline value) voidsetRoleIds(List<String> value) voidsetShortName(String value) voidsetTitle(gov.nist.secauto.metaschema.core.datatype.markup.MarkupLine value) voidtoString() 
- 
Constructor Details
- 
SystemUser
public SystemUser() - 
SystemUser
 
 - 
 - 
Method Details
- 
getMetaschemaData
- Specified by:
 getMetaschemaDatain interfacegov.nist.secauto.metaschema.core.model.IBoundObject
 - 
getUuid
 - 
setUuid
 - 
getTitle
 - 
setTitle
 - 
getShortName
 - 
setShortName
 - 
getDescription
 - 
setDescription
 - 
getProps
 - 
setProps
 - 
addProp
Add a newPropertyitem to the underlying collection.- Parameters:
 item- the item to add- Returns:
 true
 - 
removeProp
Remove the first matchingPropertyitem from the underlying collection.- Parameters:
 item- the item to remove- Returns:
 trueif the item was removed orfalseotherwise
 - 
getLinks
 - 
setLinks
 - 
addLink
Add a newLinkitem to the underlying collection.- Parameters:
 item- the item to add- Returns:
 true
 - 
removeLink
Remove the first matchingLinkitem from the underlying collection.- Parameters:
 item- the item to remove- Returns:
 trueif the item was removed orfalseotherwise
 - 
getRoleIds
 - 
setRoleIds
 - 
addRoleId
Add a newStringitem to the underlying collection.- Parameters:
 item- the item to add- Returns:
 true
 - 
removeRoleId
Remove the first matchingStringitem from the underlying collection.- Parameters:
 item- the item to remove- Returns:
 trueif the item was removed orfalseotherwise
 - 
getAuthorizedPrivileges
 - 
setAuthorizedPrivileges
 - 
addAuthorizedPrivilege
Add a newAuthorizedPrivilegeitem to the underlying collection.- Parameters:
 item- the item to add- Returns:
 true
 - 
removeAuthorizedPrivilege
Remove the first matchingAuthorizedPrivilegeitem from the underlying collection.- Parameters:
 item- the item to remove- Returns:
 trueif the item was removed orfalseotherwise
 - 
getRemarks
 - 
setRemarks
 - 
toString
 
 -