net.java.truelicense.core

Interface LicenseConsumerManager

All Superinterfaces:

ContextProvider<LicenseConsumerContext>, LicenseParametersProvider, LicenseSubjectProvider

public interface LicenseConsumerManager
extends ContextProvider<LicenseConsumerContext>, LicenseParametersProvider, LicenseSubjectProvider

Defines the life cycle management operations for license keys in consumer applications.

How to Preview License Keys?

This interface lacks a method to preview the license bean which is encoded in a license key. However, you can work around this constraint by using a license consumer context to configure a license consumer manager which uses a transient MemoryStore instead of a persistent store - see LicenseConsumerContext.ManagerBuilder.storeIn(net.java.truelicense.core.io.Store). Once configured, you can install the license key to the transient memory store and view its encoded license bean.

Author:

Christian Schlichtherle

Method Summary

Modifier and Type	Method and Description
License	install(Source source) Installs the license key from the given source and returns an unvalidated duplicate of its encoded license bean.
void	uninstall() Uninstalls the installed license key.
void	verify() Verifies the license bean which is encoded in the installed license key.
License	view() Returns an unvalidated duplicate of the license bean which is encoded in the installed license key.

Methods inherited from interface net.java.truelicense.core.util.ContextProvider

context

Methods inherited from interface net.java.truelicense.core.LicenseParametersProvider

parameters

Methods inherited from interface net.java.truelicense.core.LicenseSubjectProvider

subject

Method Detail

install

License install(Source source)
         throws LicenseManagementException

Installs the license key from the given source and returns an unvalidated duplicate of its encoded license bean. Unlike verify(), this operation does not validate the license bean. This enables the caller to obtain a duplicate of the license bean even if its validation would fail, e.g. if the license has expired. Note that this is a change of the behavior from versions prior to TrueLicense 2.4 where license validation was mandatory.

Calling this operation performs an initial authorization check.

Parameters:

source - the source for loading the license key.

Returns:

An unvalidated duplicate of the license bean which is encoded in the license key.

Throws:

LicenseManagementException

uninstall

void uninstall()
        throws LicenseManagementException

Uninstalls the installed license key.

Calling this operation performs an initial authorization check.

Throws:

LicenseManagementException

verify

void verify()
     throws LicenseManagementException

Verifies the license bean which is encoded in the installed license key. You should call this method whenever you want to verify access to a feature of your software product. Execution needs to be fast in order to support frequent calling.

Calling this operation performs an initial authorization check.

Throws:

LicenseValidationException - if validating the license bean fails, e.g. if the license has expired.

LicenseManagementException

view

License view()
      throws LicenseManagementException

Returns an unvalidated duplicate of the license bean which is encoded in the installed license key. You should call this method whenever you want to display the properties of the installed license. Unlike verify(), this operation does not validate the license bean. This enables the caller to obtain a duplicate of the license bean even if its validation would fail, e.g. if the license has expired.

Calling this operation performs an initial authorization check.

Returns:

An unvalidated duplicate of the license bean which is encoded in the installed license key.

Throws:

LicenseManagementException