net.nicholaswilliams.java.licensing

Class LicenseManagerProperties

java.lang.Object

net.nicholaswilliams.java.licensing.LicenseManagerProperties

public final class LicenseManagerProperties
extends Object

This class is used to set properties that will be used to instantiate the LicenseManager. Read the documentation for each property below.

Since:

1.0.0

Version:

1.0.0

Author:

Nick Williams

Method Summary

Methods

Modifier and Type	Method and Description
static void	setCacheTimeInMinutes(int cacheTimeInMinutes) Sets the length of time in minutes to cache license information (for performance reasons, anything less than 1 minute results in a 10-second cache life; the cache cannot be disabled completely).
static void	setLicensePasswordProvider(PasswordProvider licensePasswordProvider) Sets the provider of the password for the persisted license data.
static void	setLicenseProvider(LicenseProvider licenseProvider) Sets the provider of the persisted license data.
static void	setLicenseValidator(LicenseValidator licenseValidator) Sets the validator implementation that validates all licenses; if null, licenses are assumed to always be valid.
static void	setPublicKeyDataProvider(PublicKeyDataProvider publicKeyDataProvider) Sets the provider of the data for the public key companion to the private key used to sign the license object.
static void	setPublicKeyPasswordProvider(PasswordProvider publicKeyPasswordProvider) Sets the provider of the password for decrypting the public key.

Methods inherited from class java.lang.Object

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

Method Detail

setPublicKeyDataProvider

public static void setPublicKeyDataProvider(PublicKeyDataProvider publicKeyDataProvider)

Sets the provider of the data for the public key companion to the private key used to sign the license object.

This field is required.

Parameters:

publicKeyDataProvider - The provider of the data for the public key companion to the private key used to sign the license object

setPublicKeyPasswordProvider

public static void setPublicKeyPasswordProvider(PasswordProvider publicKeyPasswordProvider)

Sets the provider of the password for decrypting the public key.

This field is required.

Parameters:

publicKeyPasswordProvider - The provider of the password for decrypting the public key

setLicenseProvider

public static void setLicenseProvider(LicenseProvider licenseProvider)

Sets the provider of the persisted license data.

This field is required.

Parameters:

licenseProvider - The provider of the persisted license data

setLicensePasswordProvider

public static void setLicensePasswordProvider(PasswordProvider licensePasswordProvider)

Sets the provider of the password for the persisted license data.

This field is optional. If not provided, the publicKeyPasswordProvider will be used to decrypt licenses.

Parameters:

licensePasswordProvider - The provider of the password for decrypting license data

setLicenseValidator

public static void setLicenseValidator(LicenseValidator licenseValidator)

Sets the validator implementation that validates all licenses; if null, licenses are assumed to always be valid. If you do not want to validate licenses automatically, you do not need to provide a validator, or you may set it to null.

This field is optional and defaults to no validation.

Parameters:

licenseValidator - The validator implementation that validates all licenses; if null, licenses are assumed to always be valid

setCacheTimeInMinutes

public static void setCacheTimeInMinutes(int cacheTimeInMinutes)

Sets the length of time in minutes to cache license information (for performance reasons, anything less than 1 minute results in a 10-second cache life; the cache cannot be disabled completely).

This field is optional and defaults to 10 seconds.

Parameters:

cacheTimeInMinutes - The length of time in minutes to cache license information