com.intertrust.wasabi.licensestore

Class LicenseStore

java.lang.Object

com.intertrust.wasabi.licensestore.LicenseStore

public class LicenseStore
extends java.lang.Object

A LicenseStore object is used to access the Wasabi License Store database in which licenses may be stored. Its methods can be called to store licenses, to obtain licenses that are stored, and to remove licenses from the License Store.

Field Summary

Fields

Modifier and Type	Field and Description
static int	WSB_LS_FLAG_LICENSE_DATA License data
static int	WSB_LS_FLAG_LICENSE_EXPIRE_DATE License expiration date
static int	WSB_LS_FLAG_LICENSE_INSERT_DATE License insertion date
static int	WSB_LS_FLAG_LICENSE_TAG License tag

Constructor Summary

Constructors

Constructor and Description
LicenseStore() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
int	addLicense(java.lang.String data, java.lang.String tag) Adds a license into the License Store.
void	close() Closes the License Store.
java.lang.String[]	enumerateContentIds() Obtains from the License Store all content IDs governed by the licenses in the License Store.
License[]	enumerateLicenses(int flags) Obtains from the License Store all licenses.
void	expungeExpiredLicenses() Expunges from the License Store all the expired licenses and vacuums the database.
java.lang.String[]	findContentIdsByLicense(int lid) Finds in the License Store the content ID(s) governed by the license with the specified license ID.
License[]	findLicensesByContentIds(java.lang.String[] contentIds) Finds in the License Store the license(s) with specified content ID(s).
License	getLicenseById(int lid) Obtains from the License Store the license with a specified license ID.
void	removeLicense(int lid) Removes from the License Store the license with a specified license ID.

Methods inherited from class java.lang.Object

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

Field Detail

WSB_LS_FLAG_LICENSE_DATA

public static final int WSB_LS_FLAG_LICENSE_DATA

License data

See Also:

Constant Field Values

WSB_LS_FLAG_LICENSE_EXPIRE_DATE

public static final int WSB_LS_FLAG_LICENSE_EXPIRE_DATE

License expiration date

See Also:

Constant Field Values

WSB_LS_FLAG_LICENSE_INSERT_DATE

public static final int WSB_LS_FLAG_LICENSE_INSERT_DATE

License insertion date

See Also:

Constant Field Values

WSB_LS_FLAG_LICENSE_TAG

public static final int WSB_LS_FLAG_LICENSE_TAG

License tag

See Also:

Constant Field Values

Constructor Detail

LicenseStore

public LicenseStore()
             throws ErrorCodeException

Constructor. Opens the license store

Throws:

ErrorCodeException

Method Detail

addLicense

public int addLicense(java.lang.String data,
             java.lang.String tag)
               throws ErrorCodeException,
                      java.lang.NullPointerException

Adds a license into the License Store. If the specified license already exists in the License Store, this method throws an exception with result code WSB_ERROR_LS_DUPLICATE_LICENSE.

Parameters:

data - A String representing the license.

tag - a String to support tagging. For example, the tag could be something like "myAppA inserted this license", where "myAppA" would actually be the name of the application that inserted the license.

Returns:

the license id

Throws:

ErrorCodeException

java.lang.NullPointerException - if the data or tag parameter is null

findLicensesByContentIds

public License[] findLicensesByContentIds(java.lang.String[] contentIds)
                                   throws ErrorCodeException,
                                          java.lang.NullPointerException

Finds in the License Store the license(s) with specified content ID(s).

Parameters:

contentIds - An array of one String, each specifying a content ID. If a request is made with an empty content ID list, all licenses in the License Store will be returned, although the preferred method of obtaining all licenses in the License Store is to call enumerateLicenses.

Returns:

an Array of License

Throws:

ErrorCodeException

java.lang.NullPointerException - if contentIds parameter is null

findContentIdsByLicense

public java.lang.String[] findContentIdsByLicense(int lid)
                                           throws ErrorCodeException

Finds in the License Store the content ID(s) governed by the license with the specified license ID.

Parameters:

lid - The license ID of the license that governs the content ID(s) to be obtained.

Returns:

an Array of content ids

Throws:

ErrorCodeException

getLicenseById

public License getLicenseById(int lid)
                       throws ErrorCodeException

Obtains from the License Store the license with a specified license ID.

Parameters:

lid - The license ID for the license to be obtained.

Returns:

a License object

Throws:

ErrorCodeException

enumerateLicenses

public License[] enumerateLicenses(int flags)
                            throws ErrorCodeException

Obtains from the License Store all licenses. The flags parameter allows the caller to select the license-related data (license data, expiration date, insertion date, tag) to be included in each WSB_License object. If some of this data is not specified for inclusion, a potentially large amount of memory resources may be saved, if there are a large number of licenses in the License Store.

Parameters:

flags - Flags selecting license-related data to include.

Returns:

an Array of License

Throws:

ErrorCodeException

enumerateContentIds

public java.lang.String[] enumerateContentIds()
                                       throws ErrorCodeException

Obtains from the License Store all content IDs governed by the licenses in the License Store.

Returns:

an Array of content ids

Throws:

ErrorCodeException

expungeExpiredLicenses

public void expungeExpiredLicenses()
                            throws ErrorCodeException

Expunges from the License Store all the expired licenses and vacuums the database. Vacuum is resource-intensive and takes some time to run. It is best to call this function during idle times.

Throws:

ErrorCodeException

Since:

1.10

removeLicense

public void removeLicense(int lid)
                   throws ErrorCodeException

Removes from the License Store the license with a specified license ID.

Parameters:

lid - The license ID for the license to be removed.

Throws:

ErrorCodeException

close

public void close()
           throws ErrorCodeException

Closes the License Store.

Throws:

ErrorCodeException