buri.ddmsence.ddms.security.ism

Class NoticeAttributes

Object

buri.ddmsence.AbstractAttributeGroup

buri.ddmsence.ddms.security.ism.NoticeAttributes

public final class NoticeAttributes
extends AbstractAttributeGroup

Attribute group for the ISM notice markings used on a Resource and Notice.

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

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

Nested Elements
Name Cardinality Availability None.

Attributes
Name Cardinality Availability ism:noticeType 0..1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 ism:noticeReason 0..1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 ism:noticeDate 0..1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 ism:unregisteredNoticeType 0..1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 ism:externalNotice 0..1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0

Validation Rules

Rule Type Applicability Attribute group 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 If set, ism:noticeType must be a valid token. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 If set, ism:noticeReason must be shorter than 2048 characters. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 If set, ism:unregisteredNoticeType must be shorter than 2048 characters. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 If set, ism:noticeDate must adhere to a valid date format. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 Does NOT do any validation on the constraints described in the DES ISM specification.

Since:

2.0.0

Author:

Brian Uri!

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NoticeAttributes.Builder Builder for these attributes.

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXTERNAL_NOTICE_NAME Attribute name
static int	MAX_LENGTH Maximum length of reason and unregistered notice type attributes.
static Set<String>	NON_EXTENSIBLE_NAMES A set of all SecurityAttribute names which should not be converted into ExtensibleAttributes
static String	NOTICE_DATE_NAME Attribute name
static String	NOTICE_REASON_NAME Attribute name
static String	NOTICE_TYPE_NAME Attribute name
static String	UNREGISTERED_NOTICE_TYPE_NAME Attribute name

Fields inherited from class buri.ddmsence.AbstractAttributeGroup

INCOMPATIBLE_VERSION_MESSAGE

Constructor Summary

Constructors

Constructor and Description
NoticeAttributes(nu.xom.Element element) Base constructor
NoticeAttributes(String noticeType, String noticeReason, String noticeDate, String unregisteredNoticeType) Deprecated. A new constructor was added for DDMS 4.1 to support ism:externalNotice. This constructor is preserved for backwards compatibility, but may disappear in the next major release.
NoticeAttributes(String noticeType, String noticeReason, String noticeDate, String unregisteredNoticeType, Boolean externalNotice) Constructor which builds from raw data.

Method Summary

Modifier and Type	Method and Description
void	addTo(nu.xom.Element element) Convenience method to add these attributes onto an existing XOM Element
boolean	equals(Object obj)
String	getHTMLTextOutput(OutputFormat format, String prefix) Outputs to HTML or Text with a prefix at the beginning of each meta tag or line.
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.
String	getName() Returns a name that describes this attribute group.
static NoticeAttributes	getNonNullInstance(NoticeAttributes noticeAttributes) Returns a non-null instance of notice attributes.
javax.xml.datatype.XMLGregorianCalendar	getNoticeDate() Accessor for the noticeDate attribute.
String	getNoticeReason() Accessor for the noticeReason attribute.
String	getNoticeType() Accessor for the noticeType attribute.
String	getUnregisteredNoticeType() Accessor for the unregisteredNoticeType attribute.
int	hashCode()
boolean	isEmpty() Checks if any attributes have been set.
Boolean	isExternalReference() Accessor for the externalNotice attribute.
protected void	validate(DDMSVersion version) Validates the attribute group.
protected void	validateCompatibleVersion(DDMSVersion newParentVersion) Compares the DDMS version of these attributes to another DDMS version

Methods inherited from class buri.ddmsence.AbstractAttributeGroup

addJson, addJson, getNamespace, getValidationWarnings, getWarnings, setNamespace

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

NOTICE_TYPE_NAME

public static final String NOTICE_TYPE_NAME

Attribute name

See Also:

Constant Field Values

NOTICE_REASON_NAME

public static final String NOTICE_REASON_NAME

Attribute name

See Also:

Constant Field Values

NOTICE_DATE_NAME

public static final String NOTICE_DATE_NAME

Attribute name

See Also:

Constant Field Values

UNREGISTERED_NOTICE_TYPE_NAME

public static final String UNREGISTERED_NOTICE_TYPE_NAME

Attribute name

See Also:

Constant Field Values

EXTERNAL_NOTICE_NAME

public static final String EXTERNAL_NOTICE_NAME

Attribute name

See Also:

Constant Field Values

MAX_LENGTH

public static final int MAX_LENGTH

Maximum length of reason and unregistered notice type attributes.

See Also:

Constant Field Values

NON_EXTENSIBLE_NAMES

public static final Set<String> NON_EXTENSIBLE_NAMES

A set of all SecurityAttribute names which should not be converted into ExtensibleAttributes

Constructor Detail

NoticeAttributes

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

Base constructor

Parameters:

element - the XOM element which is decorated with these attributes.

Throws:

InvalidDDMSException

NoticeAttributes

public NoticeAttributes(String noticeType,
                        String noticeReason,
                        String noticeDate,
                        String unregisteredNoticeType)
                 throws InvalidDDMSException

Deprecated. A new constructor was added for DDMS 4.1 to support ism:externalNotice. This constructor is preserved for backwards compatibility, but may disappear in the next major release.

Constructor which builds from raw data.

Parameters:

noticeType - the notice type (with a value from the CVE)

noticeReason - the reason associated with a notice

noticeDate - the date associated with a notice

unregisteredNoticeType - a notice type not in the CVE

Throws:

InvalidDDMSException - if any required information is missing or malformed

NoticeAttributes

public NoticeAttributes(String noticeType,
                        String noticeReason,
                        String noticeDate,
                        String unregisteredNoticeType,
                        Boolean externalNotice)
                 throws InvalidDDMSException

Constructor which builds from raw data.

Parameters:

noticeType - the notice type (with a value from the CVE)

noticeReason - the reason associated with a notice

noticeDate - the date associated with a notice

unregisteredNoticeType - a notice type not in the CVE

externalNotice - true if this notice is for an external resource

Throws:

InvalidDDMSException - if any required information is missing or malformed

Method Detail

getNonNullInstance

public static NoticeAttributes getNonNullInstance(NoticeAttributes noticeAttributes)
                                           throws InvalidDDMSException

Returns a non-null instance of notice attributes. If the instance passed in is not null, it will be returned.

Parameters:

noticeAttributes - the attributes to return by default

Returns:

a non-null attributes instance

Throws:

InvalidDDMSException - if there are problems creating the empty attributes instance

addTo

public void addTo(nu.xom.Element element)
           throws InvalidDDMSException

Convenience method to add these attributes onto an existing XOM Element

Parameters:

element - the element to decorate

Throws:

InvalidDDMSException

isEmpty

public boolean isEmpty()

Description copied from class: AbstractAttributeGroup

Checks if any attributes have been set.

Specified by:

isEmpty in class AbstractAttributeGroup

Returns:

true if no attributes have values, false otherwise

See Also:

AbstractAttributeGroup.isEmpty()

validateCompatibleVersion

protected void validateCompatibleVersion(DDMSVersion newParentVersion)
                                  throws InvalidDDMSException

Compares the DDMS version of these attributes to another DDMS version

Parameters:

newParentVersion - the version to test

Throws:

InvalidDDMSException - if the versions do not match

validate

protected void validate(DDMSVersion version)
                 throws InvalidDDMSException

Validates the attribute group. Where appropriate the ISMVocabulary enumerations are validated.

Overrides:

validate in class AbstractAttributeGroup

Parameters:

version - the DDMS version to validate against. This cannot be stored in the attribute group because some DDMSVersions have the same attribute XML namespace (e.g. XLink, ISM, NTK, GML after DDMS 2.0).

Throws:

InvalidDDMSException - if any required information is missing or malformed

getJSONObject

public com.google.gson.JsonObject getJSONObject()

Description copied from class: AbstractAttributeGroup

Renders this component as a JSON object, which can either be converted to a JSON string or inserted into the parent JSON object.

I consider this to be an internal method, that unfortunately must be marked as public to allow cross-package access when generating output. Use toJSON() as the formal, public method to generate output.

Specified by:

getJSONObject in class AbstractAttributeGroup

See Also:

AbstractAttributeGroup.getJSONObject()

getName

public String getName()

Description copied from class: AbstractAttributeGroup

Returns a name that describes this attribute group. The format of the name is the class name with a lower-case first letter. This method is used in JSON output.

Specified by:

getName in class AbstractAttributeGroup

See Also:

AbstractAttributeGroup.getName()

getHTMLTextOutput

public String getHTMLTextOutput(OutputFormat format,
                                String prefix)

Description copied from class: AbstractAttributeGroup

Outputs to HTML or Text with a prefix at the beginning of each meta tag or line.

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 AbstractAttributeGroup

Parameters:

format - the desired format of this output

prefix - the prefix to add

Returns:

the output

See Also:

AbstractAttributeGroup.getHTMLTextOutput(OutputFormat, String)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

Object.equals(Object)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

getNoticeType

public String getNoticeType()

Accessor for the noticeType attribute.

getNoticeReason

public String getNoticeReason()

Accessor for the noticeReason attribute.

getUnregisteredNoticeType

public String getUnregisteredNoticeType()

Accessor for the unregisteredNoticeType attribute.

isExternalReference

public Boolean isExternalReference()

Accessor for the externalNotice attribute. This may be null before DDMS 4.1.

getNoticeDate

public javax.xml.datatype.XMLGregorianCalendar getNoticeDate()

Accessor for the noticeDate attribute. Returns a copy. May return null if not set.