Skip navigation links

oracle.irm.engine.core.desktop
Interface DesktopState

public interface DesktopState

Desktop state. When content is accessed from the desktop there may be a number of factors that prevent the content from being opened. For example, the user may not have the appropriate rights to view the content, or the desktop might not be able to contact a server to obtain rights. The desktop state captures the state of the desktop during such an event. This state can then be provided, for example, to a status page which can provide a personalize response based on this state. The desktop state contains information about the Desktop, the content being viewed (provided as a ContentDescription), and the Account (if authenticated).

Creation

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

DesktopState object = createDesktopState(
    desktop,
    contentDescription,
    contentURI,
    account);

XML Serialization

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

<?xml version="1.0" encoding="UTF-8"?>
<core:DesktopState xmlns:core="http://xmlns.oracle.com/irm/core">
<desktop>
<uuid>70678535-0a6f-4cf9-9411-2c05ed8d989</uuid>
<version>
<version>11.1.1</version>
</version>
<operatingSystem>Microsoft XP SP 2</operatingSystem>
<locale>en</locale>
<device>
<uuid>a7352732-dcd0-43af-93c5-0cbc7c1f203d</uuid>
<name>machine</name>
</device>
<application>
<name>desktop</name>
<container>browser</container>
</application>
</desktop>
<contentDescription>
<schema>
<schemaVersion>
<version>6.0</version>
</schemaVersion>
</schema>
<classification>
<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>
</classification>
<creationTime>2007-01-01T12:00:00.000+01:00</creationTime>
<editTime>2007-01-01T12:00:00.000+01:00</editTime>
<sealedMime>application/vnd.sealed.doc</sealedMime>
<unsealedSize>1234567</unsealedSize>
</contentDescription>
<contentUri>http://server/files/fish.sdoc</contentUri>
<account>
<uuid>17f45d8d-d5c9-4970-8808-daa0fc893c33</uuid>
<type>USER</type>
<name>John Smith</name>
</account>
</core:DesktopState>

Method Summary

Account	getAccount() Authenticated account.
ContentDescription	getContentDescription() Content details.
URI	getContentUri() Content URI.
Desktop	getDesktop() Desktop.

Method Detail

getDesktop

Desktop getDesktop()

Desktop. The desktop this state.

Returns:

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

getContentDescription

ContentDescription getContentDescription()

Content details. The content details (including the Classification as extracted from the sealed content public header.

Returns:

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

getContentUri

URI getContentUri()

Content URI. Where the content was obtained on the desktop.

Returns:

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

getAccount

Account getAccount()

Authenticated account. The authenticated account - if authentication has taken place.

Returns:

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

Skip navigation links