Skip navigation links

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

java.lang.Object
oracle.irm.engine.types.core.license.License

All Implemented Interfaces:

Serializable

public class License

extends Object

implements Serializable

License type. A license defines the what you can do, with what classifications and when criteria. The criteria of a license are stored in the Criteria property. This property contains all the data that defines the what you can do, with what classifications and when. When licenses are requested by the desktop (for example, when content is opened) additional properties on the license are altered to reflect where the license is delivered. This process is called serving a license and is processed by the serveLicenses operation. The serving process sets additional properties on the license such as the RequestTime, RefreshTime and attached Device. If the license can be refreshed from the server these properties are also recorded in persistent storage. If the same license is requested, these properties are restored and checked, to ensure the license is not already in use.

XML Serialization

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

<?xml version="1.0" encoding="UTF-8"?>
<core:License 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">
<uuid>7fabc0b0-6ece-495b-96e3-661b655b1759</uuid>
<criteria>
<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>
</criteria>
<keys>
<uuid>213f8f65-c5d1-4868-9fff-ad156daa2dd6</uuid>
</keys>
<licenseTime>2007-01-01T12:00:00.000+01:00</licenseTime>
<requestTime>2008-01-01T12:00:00.000+01:00</requestTime>
<serveUuid>9c31d850-4470-4ba4-8dac-16324156e54f</serveUuid>
<refreshTime>2009-01-01T12:00:00.000+01:00</refreshTime>
</core:License>

See Also:

Serialized Form

Nested Class Summary

static class	License.Availability Availability enumeration.
static class	License.ExpiryType Expiry Type enumeration.

Constructor Summary

License()
No argument constructor.

License(UUID uuid, LicenseCriteria criteria, KeySetRef[] keys, Date licenseTime, Date requestTime, UUID serveUuid, Date refreshTime)
Constructor.

Method Summary

LicenseCriteria	getCriteria() The license criteria.
KeySetRef[]	getKeys() The related key sets.
Date	getLicenseTime() License time.
Date	getRefreshTime() Refresh time.
Date	getRequestTime() Request time.
UUID	getServeUuid() Serve UUID.
UUID	getUuid() An unique identity for a license.
void	setCriteria(LicenseCriteria value) The license criteria.
void	setKeys(KeySetRef[] value) The related key sets.
void	setLicenseTime(Date value) License time.
void	setRefreshTime(Date value) Refresh time.
void	setRequestTime(Date value) Request time.
void	setServeUuid(UUID value) Serve UUID.
void	setUuid(UUID value) An unique identity for a license.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

License

public License()

No argument constructor.

License

public License(UUID uuid,
               LicenseCriteria criteria,
               KeySetRef[] keys,
               Date licenseTime,
               Date requestTime,
               UUID serveUuid,
               Date refreshTime)

Constructor.

Method Detail

getUuid

public UUID getUuid()

An unique identity for a license. A globally unique identity for a license. The license UUID logically identifies a license. The UUID is used during the serveLicenses to record where the license was delivered. Maintaining the same UUID for logically equivalent licenses is important when tracking of a license's use is important.

It is valid for the Criteria to change over time for the same UUID.

Returns:

the value of the property.

setUuid

public void setUuid(UUID value)

An unique identity for a license. A globally unique identity for a license. The license UUID logically identifies a license. The UUID is used during the serveLicenses to record where the license was delivered. Maintaining the same UUID for logically equivalent licenses is important when tracking of a license's use is important.

It is valid for the Criteria to change over time for the same UUID.

Parameters:

value - the new value for the property.

getCriteria

public LicenseCriteria getCriteria()

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

Returns:

the value of the property.

setCriteria

public void setCriteria(LicenseCriteria value)

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

Parameters:

value - the new value for the property.

getKeys

public KeySetRef[] getKeys()

The related key sets. The key sets that relate to this license. As this license may be applicable to multiple classifications, it may also be applicable to multiple key sets. This relationship is used to ensure that key sets are discarded when a license is no longer valid.

Returns:

the value of the property.

setKeys

public void setKeys(KeySetRef[] value)

The related key sets. The key sets that relate to this license. As this license may be applicable to multiple classifications, it may also be applicable to multiple key sets. This relationship is used to ensure that key sets are discarded when a license is no longer valid.

Parameters:

value - the new value for the property.

getLicenseTime

public Date getLicenseTime()

License time. The time the license was created, issued, bought or assigned.

Returns:

the value of the property.

setLicenseTime

public void setLicenseTime(Date value)

License time. The time the license was created, issued, bought or assigned.

Parameters:

value - the new value for the property.

getRequestTime

public Date getRequestTime()

Request time. The time the license was served to a device. If the license has not been served this property will have a null value.

Returns:

the value of the property.

setRequestTime

public void setRequestTime(Date value)

Request time. The time the license was served to a device. If the license has not been served this property will have a null value.

Parameters:

value - the new value for the property.

getServeUuid

public UUID getServeUuid()

Serve UUID. When a set of licenses are served to a device a unique UUID will be set on the license. This value can be used to identify the set of licenses served at the same time. This value can also be used with the check in operation to filter the check in based on the serve UUID value. If the license has not been served this property will have a null value.

Returns:

the value of the property.

setServeUuid

public void setServeUuid(UUID value)

Serve UUID. When a set of licenses are served to a device a unique UUID will be set on the license. This value can be used to identify the set of licenses served at the same time. This value can also be used with the check in operation to filter the check in based on the serve UUID value. If the license has not been served this property will have a null value.

Parameters:

value - the new value for the property.

getRefreshTime

public Date getRefreshTime()

Refresh time. The time at which the license must be refreshed. If the license has not been served this property will have a null value.

Returns:

the value of the property.

setRefreshTime

public void setRefreshTime(Date value)

Refresh time. The time at which the license must be refreshed. If the license has not been served this property will have a null value.

Parameters:

value - the new value for the property.

Skip navigation links