Skip navigation links

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

E12907-03


oracle.irm.engine.types.core.license
Class LicenseCriteria

java.lang.Object
  extended by oracle.irm.engine.types.core.license.LicenseCriteria

All Implemented Interfaces:
Serializable

public class LicenseCriteria
extends Object
implements Serializable

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

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>

See Also:
Serialized Form

Nested Class Summary
static class LicenseCriteria.Delivery
          Delivery enumeration.
static class LicenseCriteria.Storage
          Storage enumeration.
static class LicenseCriteria.Use
          Use enumeration.

 

Constructor Summary
LicenseCriteria()
          No argument constructor.
LicenseCriteria(LicenseCriteria.Storage storage, LicenseCriteria.Delivery delivery, LicenseCriteria.Use use, Feature[] features, TimeSpan[] timeSpans, TimePeriod refreshPeriod, ClassificationFilter classifications, ClassificationFilter destinations)
          Constructor.

 

Method Summary
 ClassificationFilter getClassifications()
          Valid classifications.
 LicenseCriteria.Delivery getDelivery()
          Delivery specifier.
 ClassificationFilter getDestinations()
          Trusted classifications.
 Feature[] getFeatures()
          The valid features.
 TimePeriod getRefreshPeriod()
          The refresh period.
 LicenseCriteria.Storage getStorage()
          Storage specifier.
 TimeSpan[] getTimeSpans()
          Time constraints.
 LicenseCriteria.Use getUse()
          License use.
 void setClassifications(ClassificationFilter value)
          Valid classifications.
 void setDelivery(LicenseCriteria.Delivery value)
          Delivery specifier.
 void setDestinations(ClassificationFilter value)
          Trusted classifications.
 void setFeatures(Feature[] value)
          The valid features.
 void setRefreshPeriod(TimePeriod value)
          The refresh period.
 void setStorage(LicenseCriteria.Storage value)
          Storage specifier.
 void setTimeSpans(TimeSpan[] value)
          Time constraints.
 void setUse(LicenseCriteria.Use value)
          License use.

 

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

 

Constructor Detail

LicenseCriteria

public LicenseCriteria()
No argument constructor.

LicenseCriteria

public LicenseCriteria(LicenseCriteria.Storage storage,
                       LicenseCriteria.Delivery delivery,
                       LicenseCriteria.Use use,
                       Feature[] features,
                       TimeSpan[] timeSpans,
                       TimePeriod refreshPeriod,
                       ClassificationFilter classifications,
                       ClassificationFilter destinations)
Constructor.

Method Detail

getStorage

public LicenseCriteria.Storage getStorage()
Storage specifier. Whether this license should be stored in persistent storage or not.
Returns:
the value of the property.

setStorage

public void setStorage(LicenseCriteria.Storage value)
Storage specifier. Whether this license should be stored in persistent storage or not.
Parameters:
value - the new value for the property.

getDelivery

public 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.
See Also:
synchronize, request

setDelivery

public void setDelivery(LicenseCriteria.Delivery value)
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.
Parameters:
value - the new value for the property.
See Also:
synchronize, request

getUse

public LicenseCriteria.Use getUse()
License use. Whether this license is a primary or secondary license.
Returns:
the value of the property.

setUse

public void setUse(LicenseCriteria.Use value)
License use. Whether this license is a primary or secondary license.
Parameters:
value - the new value for the property.

getFeatures

public Feature[] getFeatures()
The valid features. The list of features this license allows.
Returns:
the value of the property.

setFeatures

public void setFeatures(Feature[] value)
The valid features. The list of features this license allows.
Parameters:
value - the new value for the property.

getTimeSpans

public TimeSpan[] getTimeSpans()
Time constraints.
Returns:
the value of the property.

setTimeSpans

public void setTimeSpans(TimeSpan[] value)
Time constraints.
Parameters:
value - the new value for the property.

getRefreshPeriod

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

setRefreshPeriod

public void setRefreshPeriod(TimePeriod value)
The refresh period. How long this license can be used before the license must be refreshed.
Parameters:
value - the new value for the property.

getClassifications

public ClassificationFilter getClassifications()
Valid classifications. The classifications this license relates.
Returns:
the value of the property.

setClassifications

public void setClassifications(ClassificationFilter value)
Valid classifications. The classifications this license relates.
Parameters:
value - the new value for the property.

getDestinations

public ClassificationFilter getDestinations()
Trusted classifications. The classifications this license allows content to be copied or re-classified.
Returns:
the value of the property.

setDestinations

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