buri.ddmsence.ddms.security.ism

Class ISMVocabulary

Object

buri.ddmsence.ddms.security.ism.ISMVocabulary

public class ISMVocabulary
extends Object

Representation of the Controlled Vocabulary enumerations used by ISM attributes.

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

Token values are read from the CVEnumISM.xml files accompanying the "XML Data Encoding Specification for Information Security Marking Metadata". They can then be used to validate the contents of the attributes in a SecurityAttributes or NoticeAttributes instance.

• CVEnumISM25X.xml: tokens allowed in the "declassException" attribute
• CVEnumISMAtomicEnergyMarkings.xml: tokens allowed in the "atomicEnergyMarkings" attribute (starting in DDMS 3.1)
• CVEnumISMClassificationAll.xml: tokens allowed in the "classification" attribute
• CVEnumISMClassificationUS.xml: subset of the tokens allowed in the "classification" attribute
• CVEnumISMCompliesWith.xml: tokens allowed in the "compliesWith" attribute (starting in DDMS 3.1)
• CVEnumISMDissem.xml: tokens allowed in the "disseminationControls" attribute
• CVEnumISMFGIOpen.xml: tokens allowed in the "FGIsourceOpen" attribute
• CVEnumISMFGIProtected.xml: tokens allowed in the "FGIsourceProtected" attribute
• CVEnumISMNonIC.xml: tokens allowed in the "nonICmarkings" attribute
• CVEnumISMNonUSControls.xml: tokens allowed in the "nonUSControls" attribute (starting in DDMS 3.1)
• CVEnumISMNotice.xml: tokens allowed in the "noticeType" attribute (starting in DDMS 4.0.1)
• CVEnumISMOwnerProducer.xml: tokens allowed in the "ownerProducer" attribute
• CVEnumISMPocType.xml: tokens allowed in the "pocType" attribute
• CVEnumISMRelTo.xml: tokens allowed in the "displayOnlyTo" (starting in DDMS 3.1) and "releasableTo" attribute
• CVEnumISMSAR.xml: tokens allowed in the "SARIdentifier" attribute
• CVEnumISMSCIControls.xml: tokens allowed in the "SCIcontrols" attribute
• CVEnumISMSourceMarked.xml: tokens allowed in the "typeOfExemptedSource" attribute (DDMS 2.0 and DDMS 3.0 only)

Some of these vocabularies include regular expression patterns.

Since:

0.9.d

Author:

Brian Uri!

Field Summary

Fields

Modifier and Type	Field and Description
static String	CVE_ALL_CLASSIFICATIONS Filename for the enumerations allowed in a classification attribute
static String	CVE_ATOMIC_ENERGY_MARKINGS Filename for the enumerations allowed in an atomicEnergyMarkings attribute
static String	CVE_COMPLIES_WITH Filename for the enumerations allowed in a compliesWith attribute
static String	CVE_DECLASS_EXCEPTION Filename for the enumerations allowed in a declassException attribute
static String	CVE_DISPLAY_ONLY_TO Filename for the enumerations allowed in a displayOnlyTo attribute
static String	CVE_DISSEMINATION_CONTROLS Filename for the enumerations allowed in a disseminationControls attribute
static String	CVE_FGI_SOURCE_OPEN Filename for the enumerations allowed in a FGIsourceOpen attribute
static String	CVE_FGI_SOURCE_PROTECTED Filename for the enumerations allowed in a FGIsourceProtected attribute
static String	CVE_NON_IC_MARKINGS Filename for the enumerations allowed in a nonICmarkings attribute
static String	CVE_NON_US_CONTROLS Filename for the enumerations allowed in a nonUSControls attribute
static String	CVE_NOTICE_TYPE Filename for the enumerations allowed in a noticeType attribute
static String	CVE_OWNER_PRODUCERS Filename for the enumerations allowed in an ownerProducer attribute
static String	CVE_POC_TYPE Filename for the enumerations allowed in a pocType attribute
static String	CVE_RELEASABLE_TO Filename for the enumerations allowed in a releasableTo attribute
static String	CVE_SAR_IDENTIFIER Filename for the enumerations allowed in a SARIdentifier attribute
static String	CVE_SCI_CONTROLS Filename for the enumerations allowed in a SCIcontrols attribute
static String	CVE_TYPE_EXEMPTED_SOURCE Filename for the enumerations allowed in a typeOfExemptedSource attribute
static String	CVE_US_CLASSIFICATIONS Filename for the enumerations allowed in a classification attribute (US only)

Method Summary

Modifier and Type	Method and Description
protected static boolean	enumContains(DDMSVersion version, String enumerationKey, String value) Checks if a value exists in the controlled vocabulary identified by the key.
protected static Set<String>	getEnumerationPatterns(DDMSVersion version, String enumerationKey) Returns an unmodifiable set of controlled vocabulary regular expression patterns.
static Set<String>	getEnumerationTokens(DDMSVersion version, String enumerationKey) Returns an unmodifiable set of controlled vocabulary tokens.
static String	getInvalidMessage(String enumerationKey, String value) Generates a message for an invalid value.
static void	requireValidNetwork(String network) Validates the value of a network attribute from the IC-COMMON schema.
static boolean	usingOldClassification(String classification) Checks if one of the classifications that existed in DDMS 2.0 but was removed for DDMS 3.0 is being used.
static void	validateEnumeration(DDMSVersion version, String enumerationKey, String value) Helper method to validate a value from a controlled vocabulary.

Methods inherited from class Object

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

Field Detail

CVE_DECLASS_EXCEPTION

public static final String CVE_DECLASS_EXCEPTION

Filename for the enumerations allowed in a declassException attribute

See Also:

Constant Field Values

CVE_ATOMIC_ENERGY_MARKINGS

public static final String CVE_ATOMIC_ENERGY_MARKINGS

Filename for the enumerations allowed in an atomicEnergyMarkings attribute

See Also:

Constant Field Values

CVE_ALL_CLASSIFICATIONS

public static final String CVE_ALL_CLASSIFICATIONS

Filename for the enumerations allowed in a classification attribute

See Also:

Constant Field Values

CVE_US_CLASSIFICATIONS

public static final String CVE_US_CLASSIFICATIONS

Filename for the enumerations allowed in a classification attribute (US only)

See Also:

Constant Field Values

CVE_COMPLIES_WITH

public static final String CVE_COMPLIES_WITH

Filename for the enumerations allowed in a compliesWith attribute

See Also:

Constant Field Values

CVE_DISPLAY_ONLY_TO

public static final String CVE_DISPLAY_ONLY_TO

Filename for the enumerations allowed in a displayOnlyTo attribute

See Also:

Constant Field Values

CVE_DISSEMINATION_CONTROLS

public static final String CVE_DISSEMINATION_CONTROLS

Filename for the enumerations allowed in a disseminationControls attribute

See Also:

Constant Field Values

CVE_FGI_SOURCE_OPEN

public static final String CVE_FGI_SOURCE_OPEN

Filename for the enumerations allowed in a FGIsourceOpen attribute

See Also:

Constant Field Values

CVE_FGI_SOURCE_PROTECTED

public static final String CVE_FGI_SOURCE_PROTECTED

Filename for the enumerations allowed in a FGIsourceProtected attribute

See Also:

Constant Field Values

CVE_NON_IC_MARKINGS

public static final String CVE_NON_IC_MARKINGS

Filename for the enumerations allowed in a nonICmarkings attribute

See Also:

Constant Field Values

CVE_NON_US_CONTROLS

public static final String CVE_NON_US_CONTROLS

Filename for the enumerations allowed in a nonUSControls attribute

See Also:

Constant Field Values

CVE_NOTICE_TYPE

public static final String CVE_NOTICE_TYPE

Filename for the enumerations allowed in a noticeType attribute

See Also:

Constant Field Values

CVE_OWNER_PRODUCERS

public static final String CVE_OWNER_PRODUCERS

Filename for the enumerations allowed in an ownerProducer attribute

See Also:

Constant Field Values

CVE_POC_TYPE

public static final String CVE_POC_TYPE

Filename for the enumerations allowed in a pocType attribute

See Also:

Constant Field Values

CVE_RELEASABLE_TO

public static final String CVE_RELEASABLE_TO

Filename for the enumerations allowed in a releasableTo attribute

See Also:

Constant Field Values

CVE_SAR_IDENTIFIER

public static final String CVE_SAR_IDENTIFIER

Filename for the enumerations allowed in a SARIdentifier attribute

See Also:

Constant Field Values

CVE_SCI_CONTROLS

public static final String CVE_SCI_CONTROLS

Filename for the enumerations allowed in a SCIcontrols attribute

See Also:

Constant Field Values

CVE_TYPE_EXEMPTED_SOURCE

public static final String CVE_TYPE_EXEMPTED_SOURCE

Filename for the enumerations allowed in a typeOfExemptedSource attribute

See Also:

Constant Field Values

Method Detail

validateEnumeration

public static void validateEnumeration(DDMSVersion version,
                                       String enumerationKey,
                                       String value)
                                throws InvalidDDMSException

Helper method to validate a value from a controlled vocabulary.

Parameters:

version - the DDMS Version which maps to the version of ISM you wish to use

enumerationKey - the key of the enumeration

value - the test value

Throws:

InvalidDDMSException - if the value is not and validation should result in errors

getEnumerationTokens

public static Set<String> getEnumerationTokens(DDMSVersion version,
                                               String enumerationKey)

Returns an unmodifiable set of controlled vocabulary tokens. This method is publicly available so that these tokens can be used as reference data (for example, a select box on a web form).

If you wish to use these tokens in that way, you must explicitly call setDDMSVersion() in advance, to ensure that the appropriate set of CVE files is used to look up the tokens, OR you may use the configurable property, icism.cve.customEnumLocation, to force the use of a custom set of CVE files. If neither option is used, the default set of tokens returned will be based on the current value of DDMSVersion.getCurrentVersion().

Parameters:

version - the DDMS Version which maps to the version of ISM you wish to use

enumerationKey - the key of the enumeration

Returns:

an unmodifiable set of Strings

Throws:

IllegalArgumentException - if the key does not match a controlled vocabulary

enumContains

protected static boolean enumContains(DDMSVersion version,
                                      String enumerationKey,
                                      String value)

Checks if a value exists in the controlled vocabulary identified by the key. If the value does not match the tokens, but the CVE also contains patterns, the regular expression pattern is checked next. If neither tokens or patterns returns a match, return false.

Parameters:

version - the DDMS Version which maps to the version of ISM you wish to use

enumerationKey - the key of the enumeration

value - the test value

Returns:

true if the value exists in the enumeration, false otherwise

Throws:

IllegalArgumentException - on an invalid key

getEnumerationPatterns

protected static Set<String> getEnumerationPatterns(DDMSVersion version,
                                                    String enumerationKey)

Returns an unmodifiable set of controlled vocabulary regular expression patterns.

Parameters:

version - the DDMS Version which maps to the version of ISM you wish to use

enumerationKey - the key of the enumeration

Returns:

an unmodifiable set of Strings

usingOldClassification

public static boolean usingOldClassification(String classification)

Checks if one of the classifications that existed in DDMS 2.0 but was removed for DDMS 3.0 is being used.

Parameters:

classification - the classification to test

Returns:

true if it is one of the removed enums, false otherwise

getInvalidMessage

public static String getInvalidMessage(String enumerationKey,
                                       String value)

Generates a message for an invalid value.

Parameters:

enumerationKey - the key of the enumeration

value - the test value which was invalid

Returns:

a String

requireValidNetwork

public static void requireValidNetwork(String network)
                                throws InvalidDDMSException

Validates the value of a network attribute from the IC-COMMON schema. This check is only relevant in DDMS 4.1, which uses IC-COMMON to create a no-namespace "network" attribute. In DDMS 5.0, "network" is moved into the "virt" XML namespace, and validation of the token is implicit in the schema.

Parameters:

network - the network token to test

Throws:

InvalidDDMSException - if the network is not a valid token