com.lf.commons.crypto

Class License

java.lang.Object

com.lf.commons.web.msg.XMLMessage

com.lf.commons.crypto.License

All Implemented Interfaces:

AbstractMessage

public class License
extends XMLMessage

Represents a license message in XML format based on 'license.dtd'.

Can be used to generate license keys of any kind for Leisenfels applications.

Since:

1.6

Version:

$Revision: 1.18 $, $Date: 2012/12/28 11:44:24 $

Author:

Axel Schwolow

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	LICENSE_DOCNAME The name of the root element.
static java.lang.String	LICENSE_DTD The underlying DTD.

Fields inherited from class com.lf.commons.web.msg.XMLMessage

docname, document, dtd, encoding, format

Constructor Summary

Constructors

Constructor and Description
License() Constructs an instance based on a given DTD.
License(java.lang.String version, java.util.Properties props, Agreement[] agreements, java.lang.String agreementid) Constructs a message instance.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	calculateSignature(boolean update) Generates the signature for this license.
protected void	finalize() Clean-up method to help the gc.
Agreement[]	getAgreements() Provides the license agreements in various localizations.
Configuration	getConfiguration() Provides the application configuration included in the license document.
java.util.Properties	getProperties() Provides the license data as Properties.
java.lang.String	getSignature() Provides the signature for this license.
void	setAgreements(Agreement[] agreements, java.lang.String id) Sets the given license agreements in various locales.
void	setSignature(java.lang.String signature) Sets the signature for this license.

Methods inherited from class com.lf.commons.web.msg.XMLMessage

canProcess, getAttribute, getAttributeValue, getContents, getDocument, getDTD, getElement, getElements, getElementValue, getEncoding, getIntFunctionResult, isArmed, isValid, printDocument, read, read, setEncoding, setFormat, write, write

Methods inherited from class java.lang.Object

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

Field Detail

LICENSE_DTD

public static final java.lang.String LICENSE_DTD

The underlying DTD.

See Also:

Constant Field Values

LICENSE_DOCNAME

public static final java.lang.String LICENSE_DOCNAME

The name of the root element.

See Also:

Constant Field Values

Constructor Detail

License

public License()

Constructs an instance based on a given DTD.

License

public License(java.lang.String version,
       java.util.Properties props,
       Agreement[] agreements,
       java.lang.String agreementid)

Constructs a message instance.

The supported properties follow the underlying DTD and use a prefix according to the data block. For instance the childs are specified product_id, product_type, product_orderid, and product_npgrade since several child tags can be used for multiple blocks.

Parameters:

version - Currently only "1.0", required

props - Container with license data, must not be null

agreements - Array with license agreements

agreementid - The agreement identifier

Throws:

java.lang.NullPointerException - If parameters are null

java.lang.IllegalArgumentException - If at least one of the parameters is invalid

Method Detail

finalize

protected void finalize()
                 throws java.lang.Throwable

Clean-up method to help the gc.

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable - Error indication

Since:

1.5

getProperties

public java.util.Properties getProperties()

Provides the license data as Properties.

The supported properties follow the underlying DTD and use a prefix according to the data block. For instance the childs are specified product_id, product_type, product_orderid, and product_npgrade since several child tags can be used for multiple blocks.

The configuration variables are not included here. Call getConfiguration() to obtain the configuration variables.

Returns:

License properties, may be null or empty

See Also:

getConfiguration()

getAgreements

public Agreement[] getAgreements()

Provides the license agreements in various localizations.

Returns:

Array with license agreements, may be null or empty

setAgreements

public void setAgreements(Agreement[] agreements,
                 java.lang.String id)

Sets the given license agreements in various locales.

If this method is called, make sure that no agreements so already exist!

Parameters:

agreements - The license agreements

id - The agreement identifier (e.g. date)

Throws:

java.lang.NullPointerException - If parameters are null

java.lang.IllegalArgumentException - If at least one of the parameters is invalid

getConfiguration

public Configuration getConfiguration()

Provides the application configuration included in the license document.

The configuration section can be used to grant access to plugin modules, ask the user to agree to the license agreement etc.

Returns:

The variables, may be empty

Since:

1.6

getSignature

public java.lang.String getSignature()

Provides the signature for this license.

Returns:

The signature, null indicates error

Since:

1.6

setSignature

public void setSignature(java.lang.String signature)

Sets the signature for this license.

Parameters:

signature - The signature

Since:

1.6

calculateSignature

public java.lang.String calculateSignature(boolean update)

Generates the signature for this license.

Parameters:

update - Update license signature with the calculated value?

Returns:

The signature, null indicates error

Since:

1.6