Security (DDMSence 2.6.0 API)

Object
- buri.ddmsence.AbstractBaseComponent
- - buri.ddmsence.ddms.security.Security

All Implemented Interfaces:: IDDMSComponent

public final class Security
extends AbstractBaseComponent

An immutable implementation of ddms:security.

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

History
This class was removed in DDMS 5.0, as part of the migrartion to the IC Trusted Data Format.

Nested Elements

Name

Cardinality

Availability

ddms:noticeList

0..1

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ntk:Access

0..1

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

Attributes

Name

Cardinality

Availability

ism:excludeFromRollup

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ism:classification

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ism:ownerProducer

1..*

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ism:<securityAttributes>

0..*

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

Validation Rules

Rule

Type

Applicability

Component must not be used after the DDMS version in which it was removed.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

The qualified name of this element must be correct.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ism:excludeFromRollup must not be used before the DDMS version in which it was introduced.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ism:excludeFromRollup must exist and is set to "true".

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ism:classification must exist.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ism:ownerProducer must exist.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

Since:: 0.9.b
Author:: Brian Uri!

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Security.Builder
Builder for this DDMS component.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Security.Builder` Builder for this DDMS component.

Field Summary

Fields
Modifier and Type Field and Description

static String EXCLUDE_FROM_ROLLUP_NAME
Attribute name
- Fields inherited from class buri.ddmsence.AbstractBaseComponent
  OUTPUT_TEMPLATES

Fields
Modifier and Type	Field and Description
`static String`	`EXCLUDE_FROM_ROLLUP_NAME` Attribute name

Constructor Summary

Constructors
Constructor and Description
`Security(nu.xom.Element element)` Constructor for creating a component from a XOM Element
`Security(NoticeList noticeList, Access access, SecurityAttributes securityAttributes)` Constructor for creating a component from raw data

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)` Test for logical equality.
`Access`	`getAccess()` Accessor for the Access.
`Boolean`	`getExcludeFromRollup()` Accessor for the excludeFromRollup attribute.
`String`	`getHTMLTextOutput(OutputFormat format, String prefix, String suffix)` Renders this component as HTML or Text, with an optional prefix to nest it.
`com.google.gson.JsonObject`	`getJSONObject()` Renders this component as a JSON object, which can either be converted to a JSON string or inserted into the parent JSON object.
`static String`	`getName(DDMSVersion version)` Accessor for the element name of this component, based on the version of DDMS used
`protected List<IDDMSComponent>`	`getNestedComponents()` Accessor for a collection of nested components.
`NoticeList`	`getNoticeList()` Accessor for the NoticeList.
`SecurityAttributes`	`getSecurityAttributes()` Accessor for the Security Attributes.
`protected void`	`validate()` Base case for validation.

Methods inherited from class buri.ddmsence.AbstractBaseComponent
addDdms40Warning, addJson, addJson, addJson, addJson, addWarning, addWarnings, buildHTMLTextOutput, buildHTMLTextOutput, buildIndex, buildPrefix, getAttributeValue, getAttributeValue, getChild, getChildTextAsDouble, getDDMSVersion, getLocatorSuffix, getName, getNamespace, getPrefix, getQualifiedName, getValidationWarnings, getXOMElement, getXOMElementCopy, hashCode, requireAtLeastVersion, requireAtMostVersion, setXOMElement, toHTML, toJSON, toString, toText, toXML, validateWarnings

Methods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - EXCLUDE_FROM_ROLLUP_NAME
```
public static final String EXCLUDE_FROM_ROLLUP_NAME
```
    Attribute name
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Security
```
public Security(nu.xom.Element element)
         throws InvalidDDMSException
```
    Constructor for creating a component from a XOM Element
    
    Parameters:
    
    element - the XOM element representing this
    
    Throws:
    
    InvalidDDMSException - if any required information is missing or malformed
  - Security
```
public Security(NoticeList noticeList,
                Access access,
                SecurityAttributes securityAttributes)
         throws InvalidDDMSException
```
    Constructor for creating a component from raw data
    
    Parameters:
    
    noticeList - notice list
    
    access - NTK access information
    
    securityAttributes - any security attributes
    
    Throws:
    
    InvalidDDMSException - if any required information is missing or malformed
- Method Detail
  - validate
```
protected void validate()
                 throws InvalidDDMSException
```
    Description copied from class: AbstractBaseComponent
    
    Base case for validation. This method can be overridden for more in-depth validation. It is always assumed that the subcomponents of a component are already valid.
    
    Overrides:
    
    validate in class AbstractBaseComponent
    
    Throws:
    
    InvalidDDMSException
    
    See Also:
    
    AbstractBaseComponent.validate()
  - getJSONObject
```
public com.google.gson.JsonObject getJSONObject()
```
    Description copied from class: AbstractBaseComponent
    
    Renders this component as a JSON object, which can either be converted to a JSON string or inserted into the parent JSON object. Although this method is marked a public, it is only intended to be used internally, and is not part of the IDDMSComponent interface. Use the toJSON() method as the public way to get JSON output.
    
    Specified by:
    
    getJSONObject in class AbstractBaseComponent
    
    See Also:
    
    AbstractBaseComponent.getJSONObject()
  - getHTMLTextOutput
```
public String getHTMLTextOutput(OutputFormat format,
                                String prefix,
                                String suffix)
```
    Description copied from class: AbstractBaseComponent
    
    Renders this component as HTML or Text, with an optional prefix to nest it.
    I consider this to be an internal method, that unfortunately must be marked as public to allow cross-package access when generating output. Use toHTML() and toText() as the formal, public methods to generate output.
    
    Specified by:
    
    getHTMLTextOutput in class AbstractBaseComponent
    
    Parameters:
    
    format - the desired format of this output
    
    prefix - an optional prefix to put on each name.
    
    suffix - an optional suffix to append to each name, such as an index.
    
    Returns:
    
    the representation of this component in the specified format
    
    See Also:
    
    AbstractBaseComponent.getHTMLTextOutput(OutputFormat, String, String)
  - getNestedComponents
```
protected List<IDDMSComponent> getNestedComponents()
```
    Description copied from class: AbstractBaseComponent
    
    Accessor for a collection of nested components. A list such as this is useful for bulk actions, such as checking emptiness, equality, generating hash codes, or applying mass validation.
    
    Overrides:
    
    getNestedComponents in class AbstractBaseComponent
    
    See Also:
    
    AbstractBaseComponent.getNestedComponents()
  - equals
```
public boolean equals(Object obj)
```
    Description copied from class: AbstractBaseComponent
    
    Test for logical equality.
    The base case tests against the name value and namespaceURI, as well as any child components classified as "nested components" and any security attributes. Extending classes may require additional rules for equality. This case automatically includes any nested components or security attributes.
    
    Overrides:
    
    equals in class AbstractBaseComponent
    
    See Also:
    
    Object.equals(Object)
  - getName
```
public static String getName(DDMSVersion version)
```
    Accessor for the element name of this component, based on the version of DDMS used
    
    Parameters:
    
    version - the DDMSVersion
    
    Returns:
    
    an element name
  - getExcludeFromRollup
```
public Boolean getExcludeFromRollup()
```
    Accessor for the excludeFromRollup attribute. This may be null for DDMS 2.0 components.
  - getNoticeList
```
public NoticeList getNoticeList()
```
    Accessor for the NoticeList. May be null.
  - getAccess
```
public Access getAccess()
```
    Accessor for the Access. May be null.
  - getSecurityAttributes
```
public SecurityAttributes getSecurityAttributes()
```
    Accessor for the Security Attributes. Will always be non-null even if the attributes are not set.
    
    Specified by:
    
    getSecurityAttributes in interface IDDMSComponent
    
    Overrides:
    
    getSecurityAttributes in class AbstractBaseComponent

Class Security

Nested Class Summary

Field Summary

Fields inherited from class buri.ddmsence.AbstractBaseComponent

Constructor Summary

Method Summary

Methods inherited from class buri.ddmsence.AbstractBaseComponent

Methods inherited from class Object

Field Detail

EXCLUDE_FROM_ROLLUP_NAME

Constructor Detail

Security

Security

Method Detail

validate

getJSONObject

getHTMLTextOutput

getNestedComponents

equals

getName

getExcludeFromRollup

getNoticeList

getAccess

getSecurityAttributes