Skip navigation links

oracle.irm.engine.core.classification
Interface Classification

public interface Classification

Classification. A classification is the set of meta-data sealed into content during the sealing process. This information includes the classification Cookie which is an opaque blob of data, the Uri which is used to determine which server to contact for licenses and key sets, and the ClassificationTime which is used in license algorithms when determining whether content can be accessed. The format of the data in the cookie is defined by the classification System.

For example, the context classification system provides a ContextCookie for the classification meta-data. A context cookie associates sealed content with a Context and an ItemCode. License rules are then based on matching the context and/or item code.

Creation

Instances of Classification objects can be created using the following factory style method(s).

Classification object = createClassification(
    classification,
    cookie);

Classification object = createClassification(
    id,
    system,
    keySet,
    uri,
    classificationTime,
    labels,
    cookie);

Collections

Collections for Classification objects can be created using the following factory method. This method creates the most appropriate collection implementation class for storing Classification elements.

 Collection<Classification> object = createClassifications();

Consult the Id property for more information on how this property can relate to Classification collections.

XML Serialization

Classification instances can be serialized as an XML document. This XML document can also be used to recreate a Classification object. The following XML document shows an example Classification in XML form.

<?xml version="1.0" encoding="UTF-8"?>
<core:Classification xmlns:core="http://xmlns.oracle.com/irm/core">
<id>7ec1c191-0531-4876-813e-c554676df09b</id>
<system>
<uuid>588403f9-9cff-4cce-88e4-e030cc57282a</uuid>
</system>
<keySet>
<uuid>213f8f65-c5d1-4868-9fff-ad156daa2dd6</uuid>
</keySet>
<uri>http://irm.example.com/irm_desktop</uri>
<classifications:ContextCookie xmlns:classifications="http://xmlns.oracle.com/irm/classifications">
<context>
<uuid>588403f9-9cff-4cce-88e4-e030cc57282a</uuid>
</context>
<itemCode>
<value>sample.sdoc</value>
</itemCode>
</classifications:ContextCookie>
<classificationTime>2008-02-01T13:00:00.000+01:00</classificationTime>
<labels>
<locale>en</locale>
<name>Top Secret</name>
</labels>
</core:Classification>

Method Summary

Date	getClassificationTime() Classification Time.
Object	getCookie() Classification cookie.
String	getId() The classification Id.
KeySet	getKeySet() The key set used to encrypt/de-crypt content sealed with this classification.
Collection<Label>	getLabels() Labels for the classification.
ClassificationSystem	getSystem() The classification system.
URI	getUri() Desktop URI.

Method Detail

getId

String getId()

The classification Id. The classification Id is used to lookup classification details during the sealing processes. When content is sealed, if the caller has not provided any classification labels, the classification Id is used to look up the corresponding classification details from a master list (returned from a synchronize or request call). The labels from the classification are then filled in automatically before the content is sealed.

The classification Id can also be used as a key to identify a classification in a list of classifications.

The context classification system uses the context Uuid value as a classification Id.

Collections

This property value can be used to retrieve the object from a collection using getClassificationById.

Returns:

the value of the property. This method will never return null.

getSystem

ClassificationSystem getSystem()

The classification system. The ClassificationSystem defines how the classification is structured and what data it contains. It also defines how licenses and key sets relate to the classification.

Returns:

the value of the property. This method will never return null.

getKeySet

KeySet getKeySet()

The key set used to encrypt/de-crypt content sealed with this classification. If the key set is not known (when sealing content) this property can be set to null.

Returns:

the value of the property. This method can return null.

getUri

URI getUri()

Desktop URI. The URI used by the desktop to contact a server for licenses, keys, classification details and status pages.

The desktop URI is sealed in with the content and must therefore be valid in perpetuity or at least as long as the sealed content is in circulation.

Returns:

the value of the property. This method will never return null.

getClassificationTime

Date getClassificationTime()

Classification Time. The classification time signifies when content was classified. This is usually set to the time content is sealed, but does not have to be. It can represent when content is logically classified, for example, when a publication is released, rather than when it physically created.

State

The date returned by this method can be safely altered without affecting the internal state of the object.

Returns:

the value of the property. This method can return null.

getLabels

Collection<Label> getLabels()

Labels for the classification. A set localized names that help identify the classification. When content is sealed these labels will appear in the content public header. This information can then be extracted and displayed without having to unseal the content. As this information is sealed into content be aware of the size implications - provide succinct names and descriptions. If the classification name is sensitive labels do not need to be provided.

State

The collection returned by this method is an unmodifiable view on the internal collection state of the object.

Returns:

the value of the property. If this collection is empty this method returns an empty collection rather than returning null.

getCookie

Object getCookie()

Classification cookie. This property represents the opaque part of a classification and would be filled with data specific to the classification system. When content is sealed, this cookie is sealed into the content. When content is opened, and licenses required for the content, this cookie (plus the rest of the classification) are sent to the server.

The value of this property can either by an object that can be transformed into XML using JAXB, or a Element containing the require XML data.

Returns:

the value of the property. This method will never return null.

See Also:

ContextCookie

Skip navigation links