Skip navigation links

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

E12907-03


oracle.irm.engine.core.license
Interface LicenseCriteria


public interface LicenseCriteria

License criteria. The license criteria defines the what you can do, with what classifications and when criteria.

Creation

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

LicenseCriteria object = createLicenseCriteria(
    storage,
    use,
    features,
    timeSpans,
    refreshPeriod,
    classifications,
    destinations);
LicenseCriteria object = createLicenseCriteria(
    storage,
    delivery,
    use,
    features,
    timeSpans,
    refreshPeriod,
    classifications,
    destinations);

XML Serialization

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

<?xml version="1.0" encoding="UTF-8"?>
<core:LicenseCriteria xmlns:classifications="http://xmlns.oracle.com/irm/classifications" xmlns:core="http://xmlns.oracle.com/irm/core" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <storage>PERSISTENT</storage>
    <delivery>SYNCHRONIZATION</delivery>
    <use>PRIMARY</use>
    <features>
        <id>oracle.irm.generic.Open</id>
        <use>IMMEDIATE</use>
        <record>true</record>
    </features>
    <timeSpans xsi:type="core:AbsoluteTimeSpan">
        <referencePoint>CURRENT</referencePoint>
        <startTime>2007-08-10T12:00:00.000+01:00</startTime>
        <stopTime>2007-09-10T12:00:00.000+01:00</stopTime>
    </timeSpans>
    <refreshPeriod>
        <amount>120</amount>
        <units>SECONDS</units>
    </refreshPeriod>
    <classifications xsi:type="core:XPathClassificationFilter">
        <system>
            <uuid>588403f9-9cff-4cce-88e4-e030cc57282a</uuid>
        </system>
        <uri>http://irm.example.com/irm_desktop</uri>
        <expression>
            <namespaceContexts>classifications:classifications</namespaceContexts>
            <value>classifications:ContextCookie/[context[uuid='588403f9-9cff-4cce-88e4-e030cc57282a'] and itemCode='item1.sdoc']</value>
        </expression>
    </classifications>
    <destinations xsi:type="core:XPathClassificationFilter">
        <system>
            <uuid>588403f9-9cff-4cce-88e4-e030cc57282a</uuid>
        </system>
        <uri>http://irm.example.com/irm_desktop</uri>
        <expression>
            <namespaceContexts>classifications:classifications</namespaceContexts>
            <value>classifications:ContextCookie/context[uuid='9275e6e5-9550-4054-9a4e-618971d5aeda']</value>
        </expression>
    </destinations>
</core:LicenseCriteria>


Nested Class Summary
static class LicenseCriteria.Delivery
          How a license is delivered to the device.
static class LicenseCriteria.Storage
          How a license is stored on a device.
static class LicenseCriteria.Use
          The intended use of a license.

 

Method Summary
 ClassificationFilter getClassifications()
          Valid classifications.
 LicenseCriteria.Delivery getDelivery()
          Delivery specifier.
 ClassificationFilter getDestinations()
          Trusted classifications.
 Collection<Feature> getFeatures()
          The valid features.
 TimePeriod getRefreshPeriod()
          The refresh period.
 LicenseCriteria.Storage getStorage()
          Storage specifier.
 Collection<TimeSpan> getTimeSpans()
          Time constraints.
 LicenseCriteria.Use getUse()
          License use.

 

Method Detail

getStorage

LicenseCriteria.Storage getStorage()
Storage specifier. Whether this license should be stored in persistent storage or not.
Returns:
the value of the property. This method will never return null.

getDelivery

LicenseCriteria.Delivery getDelivery()
Delivery specifier. Specifies whether this license can be shipped using synchronization and/or shipped from an on-demand request. Care should be made to ensure that a license that is delivered on synchronization does not have conflicting criteria - such as a time constraint based on the license request time.
Returns:
the value of the property. This method will never return null.
See Also:
synchronize, request

getUse

LicenseCriteria.Use getUse()
License use. Whether this license is a primary or secondary license.
Returns:
the value of the property. This method will never return null.

getFeatures

Collection<Feature> getFeatures()
The valid features. The list of features this license allows.

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. This collection will always have at least one element.

getTimeSpans

Collection<TimeSpan> getTimeSpans()
Time constraints.

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.

getRefreshPeriod

TimePeriod getRefreshPeriod()
The refresh period. How long this license can be used before the license must be refreshed.
Returns:
the value of the property. This method can return null.

getClassifications

ClassificationFilter getClassifications()
Valid classifications. The classifications this license relates.
Returns:
the value of the property. This method will never return null.

getDestinations

ClassificationFilter getDestinations()
Trusted classifications. The classifications this license allows content to be copied or re-classified.
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.