net.nicholaswilliams.java.licensing.licensor

Class LicenseCreator

java.lang.Object

net.nicholaswilliams.java.licensing.licensor.LicenseCreator

public final class LicenseCreator
extends Object

This class manages the creation of licenses in the master application. Use this class within your license generation software to sign and serialize license for distribution to the client. This class is not needed for the client application, and in fact you should not use this class in your client application. For this reason, it is in the package of classes (net.nicholaswilliams.java.licensing.licensor) that is packaged separately from the distributable client binary.

Before getting the creator instance for the first time, relevant properties should be set in LicenseCreatorProperties. The values in this class will be used to instantiate the license creator. After setting all the necessary properties there, one can retrieve an instance using getInstance(). Be sure to set all the properties first; once getInstance() is called for the first time, any changes to LicenseCreatorProperties will be ignored.

Since:

1.0.0

Version:

1.0.6

Author:

Nick Williams

Method Summary

Methods

Modifier and Type	Method and Description
static LicenseCreator	getInstance() Returns the license creator instance.
byte[]	signAndSerializeLicense(License license) Takes a license object and creates a secure and serialized version of it for delivery to the customer.
byte[]	signAndSerializeLicense(License license, char[] licensePassword) Takes a license object and creates a secure and serialized version of it for delivery to the customer.
SignedLicense	signLicense(License license) Takes a license object and creates a secure version of it for serialization and delivery to the customer.
SignedLicense	signLicense(License license, char[] licensePassword) Takes a license object and creates a secure version of it for serialization and delivery to the customer.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static LicenseCreator getInstance()

Returns the license creator instance. Before this method can be called the first time, all of the parameters must bet set in LicenseCreatorProperties. See the documentation for that class for more details.

Returns:

the license creator instance.

Throws:

IllegalArgumentException - if privateKeyDataProvider or privateKeyPasswordProvider are null

signLicense

public final SignedLicense signLicense(License license,
                        char[] licensePassword)
                                throws AlgorithmNotSupportedException,
                                       KeyNotFoundException,
                                       InappropriateKeySpecificationException,
                                       InappropriateKeyException

Takes a license object and creates a secure version of it for serialization and delivery to the customer.

Parameters:

license - The license object to be signed

licensePassword - The password to encrypt the license with

Returns:

the signed license object.

Throws:

AlgorithmNotSupportedException - if the encryption algorithm is not supported.

KeyNotFoundException - if the public key data could not be found.

InappropriateKeySpecificationException - if an inappropriate key specification is provided.

InappropriateKeyException - if the key type and cipher type do not match.

signLicense

public final SignedLicense signLicense(License license)
                                throws AlgorithmNotSupportedException,
                                       KeyNotFoundException,
                                       InappropriateKeySpecificationException,
                                       InappropriateKeyException

Takes a license object and creates a secure version of it for serialization and delivery to the customer.

Parameters:

license - The license object to be signed

Returns:

the signed license object.

Throws:

AlgorithmNotSupportedException - if the encryption algorithm is not supported.

KeyNotFoundException - if the public key data could not be found.

InappropriateKeySpecificationException - if an inappropriate key specification is provided.

InappropriateKeyException - if the key type and cipher type do not match.

signAndSerializeLicense

public final byte[] signAndSerializeLicense(License license,
                             char[] licensePassword)
                                     throws AlgorithmNotSupportedException,
                                            KeyNotFoundException,
                                            InappropriateKeySpecificationException,
                                            InappropriateKeyException,
                                            ObjectSerializationException

Takes a license object and creates a secure and serialized version of it for delivery to the customer.

Parameters:

license - The license object to be signed and serialized

licensePassword - The password to encrypt the license with

Returns:

the signed and serialized license object.

Throws:

AlgorithmNotSupportedException - if the encryption algorithm is not supported.

KeyNotFoundException - if the public key data could not be found.

InappropriateKeySpecificationException - if an inappropriate key specification is provided.

InappropriateKeyException - if the key type and cipher type do not match.

ObjectSerializationException - if an error is encountered while serializing the key.

signAndSerializeLicense

public final byte[] signAndSerializeLicense(License license)
                                     throws AlgorithmNotSupportedException,
                                            KeyNotFoundException,
                                            InappropriateKeySpecificationException,
                                            InappropriateKeyException,
                                            ObjectSerializationException

Takes a license object and creates a secure and serialized version of it for delivery to the customer.

Parameters:

license - The license object to be signed and serialized

Returns:

the signed and serialized license object.

Throws:

AlgorithmNotSupportedException - if the encryption algorithm is not supported.

KeyNotFoundException - if the public key data could not be found.

InappropriateKeySpecificationException - if an inappropriate key specification is provided.

InappropriateKeyException - if the key type and cipher type do not match.

ObjectSerializationException - if an error is encountered while serializing the key.