Skip navigation links

Oracle® Information Rights Management Server Java API Reference
11g Release 1 (11.1.1)

E12907-03


oracle.irm.engine.core.desktop
Interface Desktop


public interface Desktop

Information about the client desktop. A desktop object contains all the information relating to the desktop. This information is passed to server side operations during license requests or synchronizations.

Creation

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

Desktop object = createDesktop(
    uuid,
    version,
    operatingSystem,
    locale,
    device,
    application,
    timeStamp);

XML Serialization

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

<?xml version="1.0" encoding="UTF-8"?>
<core:Desktop xmlns:core="http://xmlns.oracle.com/irm/core">
    <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>
    <timeStamp>2007-01-01T12:00:00.000+01:00</timeStamp>
</core:Desktop>


Method Summary
 DesktopApplication getApplication()
          The application that is in-use.
 Device getDevice()
          The device associated with the desktop.
 Locale getLocale()
          The desktop locale.
 String getOperatingSystem()
          The desktop operating system.
 Date getTimeStamp()
          The desktop time stamp.
 UUID getUuid()
          The globally unique desktop UUID.
 ProductVersion getVersion()
          The desktop product version.

 

Method Detail

getUuid

UUID getUuid()
The globally unique desktop UUID. The desktop UUID is used to identify a particular desktop independently of the product version number. There may or may not be a one to one mapping between version numbers and the UUID. The UUID can be used to identify a particular desktop version or variant.
Returns:
the value of the property. This method will never return null.

getVersion

ProductVersion getVersion()
The desktop product version. Useful to monitor what versions of desktop are being used.
Returns:
the value of the property. This method will never return null.

getOperatingSystem

String getOperatingSystem()
The desktop operating system. Useful to monitor where the desktop is being used.
Returns:
the value of the property. This method will never return null.

getLocale

Locale getLocale()
The desktop locale. Used to provide localized responses in desktop bundles.
Returns:
the value of the property. This method will never return null.

getDevice

Device getDevice()
The device associated with the desktop. The device is a unique way of identifying where licenses can be stored or sent.
Returns:
the value of the property. This method will never return null.

getApplication

DesktopApplication getApplication()
The application that is in-use. The desktop covers potentially many applications, this information gives details to which application was being used on the desktop.
Returns:
the value of the property. This method can return null.

getTimeStamp

Date getTimeStamp()
The desktop time stamp.

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.

Skip navigation links

Oracle® Information Rights Management Server Java API Reference
11g Release 1 (11.1.1)

E12907-03


Copyright © 2011, Oracle. All rights reserved.