Skip navigation links

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

E12907-03


oracle.irm.engine.types.core.status
Class StatusPageResponse

java.lang.Object
  extended by oracle.irm.engine.types.core.status.StatusPageResponse

All Implemented Interfaces:
Serializable

public class StatusPageResponse
extends Object
implements Serializable

Status Page Response type. The status page response contains all the information that is typically displayed on a status page.

XML Serialization

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

<?xml version="1.0" encoding="UTF-8"?>
<core:StatusPageResponse xmlns:core="http://xmlns.oracle.com/irm/core">
    <status>
        <locale>en</locale>
        <name>Access Denied</name>
        <description>You are not authorized to access this content.</description>
    </status>
    <state>
        <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>unit</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>
    </state>
    <content>
        <extensions>html</extensions>
        <extensions>htm</extensions>
        <sealedExtension>stml</sealedExtension>
        <mimeTypes>text/html</mimeTypes>
        <sealedMimeType>application/vnd.sealedmedia.softseal.html</sealedMimeType>
    </content>
    <information>
        <system>
            <locale>en</locale>
            <name>Oracle</name>
        </system>
        <classification>
            <locale>en</locale>
            <name>Top Secret</name>
            <description>This is a top secret classification.</description>
        </classification>
        <content>
            <locale>en</locale>
            <name>Top Secret.sdoc</name>
        </content>
        <links>
            <label>
                <locale>en</locale>
                <name>John Smith</name>
            </label>
            <uri>mailto:john.smith@example.com</uri>
        </links>
    </information>
</core:StatusPageResponse>

See Also:
Serialized Form

Constructor Summary
StatusPageResponse()
          No argument constructor.
StatusPageResponse(Label status, DesktopState state, ContentType content, StatusPageInformation information)
          Constructor.

 

Method Summary
 ContentType getContent()
          Content type.
 StatusPageInformation getInformation()
          Status page information.
 DesktopState getState()
          The desktop state.
 Label getStatus()
          The status.
 void setContent(ContentType value)
          Content type.
 void setInformation(StatusPageInformation value)
          Status page information.
 void setState(DesktopState value)
          The desktop state.
 void setStatus(Label value)
          The status.

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Constructor Detail

StatusPageResponse

public StatusPageResponse()
No argument constructor.

StatusPageResponse

public StatusPageResponse(Label status,
                          DesktopState state,
                          ContentType content,
                          StatusPageInformation information)
Constructor.

Method Detail

getStatus

public Label getStatus()
The status. The human readable, localized, name of the status page.
Returns:
the value of the property.

setStatus

public void setStatus(Label value)
The status. The human readable, localized, name of the status page.
Parameters:
value - the new value for the property.

getState

public DesktopState getState()
The desktop state. As provided by the desktop.
Returns:
the value of the property.

setState

public void setState(DesktopState value)
The desktop state. As provided by the desktop.
Parameters:
value - the new value for the property.

getContent

public ContentType getContent()
Content type. The sealed content type that matches the SealedMime information provided by the desktop.
Returns:
the value of the property.

setContent

public void setContent(ContentType value)
Content type. The sealed content type that matches the SealedMime information provided by the desktop.
Parameters:
value - the new value for the property.

getInformation

public StatusPageInformation getInformation()
Status page information. Additional information retrieved from the server relating to the DesktopState provided by the desktop.
Returns:
the value of the property.

setInformation

public void setInformation(StatusPageInformation value)
Status page information. Additional information retrieved from the server relating to the DesktopState provided by the desktop.
Parameters:
value - the new value for the property.

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.