buri.ddmsence

Class AbstractAccessEntity

Object

buri.ddmsence.AbstractBaseComponent

buri.ddmsence.AbstractAccessEntity

All Implemented Interfaces:

IDDMSComponent

Direct Known Subclasses:

Group, Individual, Profile

public abstract class AbstractAccessEntity
extends AbstractBaseComponent

Base class for NTK elements which describe system access rules for an Individual, Group, or Profile.

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

Extensions of this class are generally expected to be immutable, and the underlying XOM element MUST be set before the component is used.

History
This abstract class was introduced to support NTK Access components in DDMS 4.1. Those components are no longer a part of DDMS 5.0.

Nested Elements
Name Cardinality Availability ntk:AccessSystemName 1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0

Attributes
Name Cardinality Availability ism:classification 1 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 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 ntk:AccessSystemName must exist. 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:

2.0.0

Author:

Brian Uri!

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractAccessEntity.Builder Builder for this DDMS component.

Field Summary

Fields inherited from class buri.ddmsence.AbstractBaseComponent

OUTPUT_TEMPLATES

Constructor Summary

Constructors

Constructor and Description
AbstractAccessEntity(nu.xom.Element element) Constructor for creating a component from a XOM Element.
AbstractAccessEntity(String name, SystemName systemName, SecurityAttributes securityAttributes) Constructor for creating a component from raw data.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Test for logical equality.
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.
protected List<IDDMSComponent>	getNestedComponents() Accessor for a collection of nested components.
protected abstract String	getOutputName() Allows inheriting classes to provide a name for HTML/Text/JSON output.
protected abstract List<?>	getOutputValues() Allows inheriting classes to provide the access values for HTML/Text/JSON output.
SecurityAttributes	getSecurityAttributes() Accessor for the Security Attributes.
SystemName	getSystemName() Accessor for the system name
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

Constructor Detail

AbstractAccessEntity

public AbstractAccessEntity(nu.xom.Element element)
                     throws InvalidDDMSException

Constructor for creating a component from a XOM Element. Does not validate.

Parameters:

element - the XOM element representing this

Throws:

InvalidDDMSException - if any required information is missing or malformed

AbstractAccessEntity

public AbstractAccessEntity(String name,
                            SystemName systemName,
                            SecurityAttributes securityAttributes)
                     throws InvalidDDMSException

Constructor for creating a component from raw data. Does not validate.

Parameters:

systemName - the system name

securityAttributes - 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)

getOutputName

protected abstract String getOutputName()

Allows inheriting classes to provide a name for HTML/Text/JSON output.

getOutputValues

protected abstract List<?> getOutputValues()

Allows inheriting classes to provide the access values for HTML/Text/JSON output.

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)

getSystemName

public SystemName getSystemName()

Accessor for the system name

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