Skip navigation links

oracle.irm.engine.rights.journal
Interface ContextJournalEntry

public interface ContextJournalEntry

Context journal entry. A context journal entry contains a record of an action performed on sealed content of the context classification system. The context journal entry contains the Time the action that was performed, whether the action was successful or unsuccessful, which Account performed the action, what Feature was performed on the content, the ContextInstance of the content, the ItemCode of the content, the Uri source of the content and the Device the action was performed.

Creation

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

ContextJournalEntry object = createContextJournalEntry(
    time,
    status,
    account,
    feature,
    contextInstance,
    itemCode,
    uri,
    device);

ContextJournalEntry object = createContextJournalEntry(
    uuid,
    time,
    status,
    account,
    feature,
    contextInstance,
    itemCode,
    uri,
    device);

ContextJournalEntry object = createContextJournalEntry(
    uuid,
    journalEntry);

ContextJournalEntry object = createContextJournalEntry(journalEntry);

Collections

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

 Collection<ContextJournalEntry> object = createContextJournalEntries();

Consult the Uuid property for more information on how this property can relate to ContextJournalEntry collections.

XML Serialization

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

<?xml version="1.0" encoding="UTF-8"?>
<rights:ContextJournalEntry xmlns:rights="http://xmlns.oracle.com/irm/rights" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../../schema/irm_rights_journal_types.xsd">
<uuid>7fabc0b0-6ece-495b-96e3-661b655b1759</uuid>
<time>2008-02-01T12:00:00.000+01:00</time>
<status>SUCCESS</status>
<account>
<uuid>17f45d8d-d5c9-4970-8808-daa0fc893c33</uuid>
<name>John Smith</name>
<type>USER</type>
</account>
<feature>
<id>oracle.irm.generic.Open</id>
<use>IMMEDIATE</use>
<record>true</record>
</feature>
<contextInstance>
<uuid>7fabc0b0-6ece-495b-96e3-661b655b1759</uuid>
</contextInstance>
<itemCode>
<value>sample.sdoc</value>
</itemCode>
<uri>http://irm.example.com/sample.sdoc</uri>
<device>
<uuid>7fabc0b0-6ece-495b-96e3-661b655b1759</uuid>
<name>machine</name>
</device>
</rights:ContextJournalEntry>

Nested Class Summary

static class

ContextJournalEntry.Status Content action status.

Method Summary

Account	getAccount() The account performing the action.
ContextInstance	getContextInstance() The context of the content.
Device	getDevice() The device the action was performed.
Feature	getFeature() The application feature being performed.
ItemCode	getItemCode() The item code of the content.
ContextJournalEntry.Status	getStatus() The status of the action.
Date	getTime() The time of the action.
URI	getUri() The source of the content.
UUID	getUuid() The context journal entry UUID.

Method Detail

getUuid

UUID getUuid()

The context journal entry UUID. A unique identifier for a context journal entry.

Collections

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

Returns:

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

getTime

Date getTime()

The time of the action. The context journal entry time records the time the action was performed, rather than the time the context journal entry was 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 will never return null.

getStatus

ContextJournalEntry.Status getStatus()

The status of the action. Whether the context journal entry indicates a successful action on content of an unsuccessful action.

Returns:

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

getAccount

Account getAccount()

The account performing the action. The authenticated account.

Returns:

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

getFeature

Feature getFeature()

The application feature being performed. The feature describes the application feature being used, e.g. opening content or printing content.

Returns:

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

See Also:

Record

getContextInstance

ContextInstance getContextInstance()

The context of the content. The context of the content that this context journal entry relates to.

Returns:

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

getItemCode

ItemCode getItemCode()

The item code of the content. The ItemCode that identifies the content that this context journal entry relates to.

Returns:

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

getUri

URI getUri()

The source of the content. The source indicates where desktop application obtained the content. This is typically the file system, but also could be a HTTP or HTTPS location. The source of the content may not always be available, for example, if the action was performed on a server.

Returns:

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

getDevice

Device getDevice()

The device the action was performed. The device gives an indication of the physical location where the action was performed.

Returns:

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

Skip navigation links