de.ipcon.db.feature

Class AbstractLicense

java.lang.Object

de.ipcon.db.feature.AbstractLicense

All Implemented Interfaces:

LicenseI, java.lang.Comparable

Direct Known Subclasses:

License

public abstract class AbstractLicense
extends java.lang.Object
implements java.lang.Comparable, LicenseI

Abstract base class for implementations for licenses for features. May be overwritten by project specific subclasses to introduce additional checks by overwriting matchesAdditionalCriteria() and possibly handleAdditionalKey() and clearCachedVars().

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DATEFORMAT_PATTERN_FULL
static java.lang.String	DATEFORMAT_PATTERN_SHORT
static java.lang.String	ENCODING
static java.lang.String	ENCODING_FOR_BASE64
static java.lang.String	LICENSE_END
static java.lang.String	LICENSE_START
static org.apache.log4j.Logger	log
static java.lang.String	LSK_FEATURE
static java.lang.String	LSK_FOR_GROUPS
static java.lang.String	LSK_FOR_INSTANCE
static java.lang.String	LSK_FOR_NODEID
static java.lang.String	LSK_FOR_PROJECT
static java.lang.String	LSK_FOR_USERS
static java.lang.String	LSK_FOR_VALIDFROM
static java.lang.String	LSK_FOR_VALIDTO
static java.lang.String	LSK_FROM_CREA
static java.lang.String	LSK_FROM_CREAID
static java.lang.String	LSK_FROM_CREATOR
static java.lang.String	LSK_FROM_HOSTADDR
static java.lang.String	LSK_FROM_HOSTNAME
static java.lang.String	LSK_FROM_OSINFO
static java.lang.String	LSK_TOUCH
static java.lang.String	LSK_VAR_PREFIX
static java.lang.String	LSK_VERSION
static java.lang.String	NOT_CHAR
static java.util.regex.Pattern	patternFull
static java.util.regex.Pattern	patternPair
static java.lang.String	SEP_CHAR
static java.lang.String	version

Method Summary

Modifier and Type	Method and Description
int	compareTo(java.lang.Object _obj) The natural ordering for AbstractLicenses, which is the one defined by MostPowerfulLicenseComparator.
static java.lang.String	decryptLicense(java.lang.String _strEnc, FeatureManagerI _fm)
static boolean	equals(AbstractLicense _license1, AbstractLicense _license2)
boolean	equals(java.lang.Object _obj)
void	fromLicenseString(java.lang.String _str) Sets the data of this License from the values parsed from the given compact license string.
java.lang.String[]	getBenutzer()
java.lang.String[]	getBenutzer(boolean _doRefresh)
java.lang.String	getBeschreibung()
java.lang.String	getBeschreibung(boolean _fallbackToKey)
java.lang.String	getCustomValue(java.lang.String _key) Some licenses may need/carry additional data, e.g. the maximum number of allowed clients for FK_MAXCLIENTS.
java.lang.String	getCustomValue(java.lang.String _key, boolean _doRefresh)
java.util.SortedMap	getCustomValues()
java.util.SortedMap	getCustomValues(boolean _doRefresh)
java.lang.String	getFeature() Returns (the name of) the feature this LicenseI is meant for.
java.lang.String	getFeature(boolean _doRefresh)
FeatureManagerI	getFm()
java.lang.String[]	getGruppen()
java.lang.String[]	getGruppen(boolean _doRefresh)
java.util.Date	getGueltigBis() Ending time up to which (inclusive) this LicenseI stays active.
java.util.Date	getGueltigBis(boolean _doRefresh)
java.util.Date	getGueltigVon() Starting time from when (inclusive) this LicenseI becomes active.
java.util.Date	getGueltigVon(boolean _doRefresh)
java.lang.String	getInstanz()
java.lang.String	getInstanz(boolean _doRefresh)
java.lang.String	getLizenz()
java.lang.String	getName() FIXME!
java.lang.Long	getNodeID()
java.lang.Long	getNodeID(boolean _doRefresh)
java.lang.String	getProjekt()
java.lang.String	getProjekt(boolean _doRefresh)
boolean	handleAdditionalKey(java.lang.String _key) Supposed to be overwritten by subclasses for easy introduction of additional keys.
int	hashCode()
boolean	isActive(FeatureManagerI _fm) For compatibility with LicenseI.
boolean	isAvailable(FeatureManagerI _fm)
boolean	matchesAdditionalCriteria() Supposed to be overwritten by subclasses for easy checking of additional criteria.
boolean	matchesInstallation(java.lang.String _projekt, java.lang.String _instanz, java.lang.Long _nodeID) Internal separate method for code clarity.
static boolean	matchesInstallation(java.lang.String _projekt, java.lang.String _projektWant, java.lang.String _instanz, java.lang.String _instanzWant, java.lang.Long _nodeID, java.lang.Long _nodeIDWant)
void	refreshFromLicense() (Re)sets the cached properties from the encrypted data in the Lizenz.
void	refreshFromLicense(FeatureManagerI _fm)
void	setBenutzer(java.lang.String[] _users)
void	setCustomValue(java.lang.String _key, java.lang.String _value)
void	setFeature(java.lang.String _str)
void	setFm(FeatureManagerI $8)
void	setGruppen(java.lang.String[] _groups)
void	setGueltigBis(java.util.Date _date)
void	setGueltigVon(java.util.Date _date)
void	setInstanz(java.lang.String _str)
void	setLizenz(java.lang.String _strEnc)
void	setNodeID(java.lang.Long _nodeid)
void	setProjekt(java.lang.String _str)
static boolean	stringsEqual(java.lang.String[] _strs1, java.lang.String[] _strs2)
java.lang.String	toString()
java.lang.String	toString(boolean _debug)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

log

public static final org.apache.log4j.Logger log

version

public static final java.lang.String version

See Also:

Constant Field Values

DATEFORMAT_PATTERN_SHORT

public static final java.lang.String DATEFORMAT_PATTERN_SHORT

See Also:

Constant Field Values

DATEFORMAT_PATTERN_FULL

public static final java.lang.String DATEFORMAT_PATTERN_FULL

See Also:

Constant Field Values

ENCODING

public static final java.lang.String ENCODING

ENCODING_FOR_BASE64

public static final java.lang.String ENCODING_FOR_BASE64

NOT_CHAR

public static final java.lang.String NOT_CHAR

See Also:

Constant Field Values

SEP_CHAR

public static final java.lang.String SEP_CHAR

See Also:

Constant Field Values

LICENSE_START

public static final java.lang.String LICENSE_START

See Also:

Constant Field Values

LICENSE_END

public static final java.lang.String LICENSE_END

See Also:

Constant Field Values

patternFull

public static final java.util.regex.Pattern patternFull

patternPair

public static final java.util.regex.Pattern patternPair

LSK_VAR_PREFIX

public static final java.lang.String LSK_VAR_PREFIX

See Also:

Constant Field Values

LSK_VERSION

public static final java.lang.String LSK_VERSION

See Also:

Constant Field Values

LSK_FEATURE

public static final java.lang.String LSK_FEATURE

See Also:

Constant Field Values

LSK_TOUCH

public static final java.lang.String LSK_TOUCH

See Also:

Constant Field Values

LSK_FOR_PROJECT

public static final java.lang.String LSK_FOR_PROJECT

See Also:

Constant Field Values

LSK_FOR_INSTANCE

public static final java.lang.String LSK_FOR_INSTANCE

See Also:

Constant Field Values

LSK_FOR_VALIDFROM

public static final java.lang.String LSK_FOR_VALIDFROM

See Also:

Constant Field Values

LSK_FOR_VALIDTO

public static final java.lang.String LSK_FOR_VALIDTO

See Also:

Constant Field Values

LSK_FOR_NODEID

public static final java.lang.String LSK_FOR_NODEID

See Also:

Constant Field Values

LSK_FOR_USERS

public static final java.lang.String LSK_FOR_USERS

See Also:

Constant Field Values

LSK_FOR_GROUPS

public static final java.lang.String LSK_FOR_GROUPS

See Also:

Constant Field Values

LSK_FROM_CREATOR

public static final java.lang.String LSK_FROM_CREATOR

See Also:

Constant Field Values

LSK_FROM_OSINFO

public static final java.lang.String LSK_FROM_OSINFO

See Also:

Constant Field Values

LSK_FROM_CREA

public static final java.lang.String LSK_FROM_CREA

See Also:

Constant Field Values

LSK_FROM_HOSTNAME

public static final java.lang.String LSK_FROM_HOSTNAME

See Also:

Constant Field Values

LSK_FROM_HOSTADDR

public static final java.lang.String LSK_FROM_HOSTADDR

See Also:

Constant Field Values

LSK_FROM_CREAID

public static final java.lang.String LSK_FROM_CREAID

See Also:

Constant Field Values

Method Detail

getName

public java.lang.String getName()

FIXME! this not yet used... some issues are still to be adressed. To provide a different implementation of LicenseI use (in project's build.xml) something like: <jar jarfile="${build.lib}/MyProject.jar" ...> ... <service type="de.ipcon.db.feature.LicenseI" provider="top.projectpackage.feature.CustomLicenseClass"/> ... </jar>

getBeschreibung

public java.lang.String getBeschreibung()

getBeschreibung

public java.lang.String getBeschreibung(boolean _fallbackToKey)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toString

public java.lang.String toString(boolean _debug)

compareTo

public int compareTo(java.lang.Object _obj)

The natural ordering for AbstractLicenses, which is the one defined by MostPowerfulLicenseComparator.

Specified by:

compareTo in interface java.lang.Comparable

Throws:

java.lang.IllegalArgumentException - if licenses' features do not match and not at least one of them is an _ALL_ license.

equals

public boolean equals(java.lang.Object _obj)

Specified by:

equals in interface LicenseI

Overrides:

equals in class java.lang.Object

equals

public static boolean equals(AbstractLicense _license1,
                             AbstractLicense _license2)

stringsEqual

public static boolean stringsEqual(java.lang.String[] _strs1,
                                   java.lang.String[] _strs2)

hashCode

public int hashCode()

Specified by:

hashCode in interface LicenseI

Overrides:

hashCode in class java.lang.Object

setFeature

public void setFeature(java.lang.String _str)

getFeature

public java.lang.String getFeature()

Description copied from interface: LicenseI

Returns (the name of) the feature this LicenseI is meant for. Should be one of the FK-constants from FeatureManagerI (but theoretically could be something else if the license is broken or a feature was removed). You can use AbstractFeatureManager.getFeatureDefinition( getFeature() ) to retrieve more info about the feature.

Specified by:

getFeature in interface LicenseI

getFeature

public java.lang.String getFeature(boolean _doRefresh)

setProjekt

public void setProjekt(java.lang.String _str)

getProjekt

public java.lang.String getProjekt()

getProjekt

public java.lang.String getProjekt(boolean _doRefresh)

setInstanz

public void setInstanz(java.lang.String _str)

getInstanz

public java.lang.String getInstanz()

getInstanz

public java.lang.String getInstanz(boolean _doRefresh)

setGueltigVon

public void setGueltigVon(java.util.Date _date)

getGueltigVon

public java.util.Date getGueltigVon()

Description copied from interface: LicenseI

Starting time from when (inclusive) this LicenseI becomes active.

Specified by:

getGueltigVon in interface LicenseI

getGueltigVon

public java.util.Date getGueltigVon(boolean _doRefresh)

setGueltigBis

public void setGueltigBis(java.util.Date _date)

getGueltigBis

public java.util.Date getGueltigBis()

Description copied from interface: LicenseI

Ending time up to which (inclusive) this LicenseI stays active.

Specified by:

getGueltigBis in interface LicenseI

getGueltigBis

public java.util.Date getGueltigBis(boolean _doRefresh)

setNodeID

public void setNodeID(java.lang.Long _nodeid)

getNodeID

public java.lang.Long getNodeID()

getNodeID

public java.lang.Long getNodeID(boolean _doRefresh)

setBenutzer

public void setBenutzer(java.lang.String[] _users)

getBenutzer

public java.lang.String[] getBenutzer()

getBenutzer

public java.lang.String[] getBenutzer(boolean _doRefresh)

setGruppen

public void setGruppen(java.lang.String[] _groups)

getGruppen

public java.lang.String[] getGruppen()

getGruppen

public java.lang.String[] getGruppen(boolean _doRefresh)

setCustomValue

public void setCustomValue(java.lang.String _key,
                           java.lang.String _value)

getCustomValue

public java.lang.String getCustomValue(java.lang.String _key)

Description copied from interface: LicenseI

Some licenses may need/carry additional data, e.g. the maximum number of allowed clients for FK_MAXCLIENTS.

Specified by:

getCustomValue in interface LicenseI

getCustomValue

public java.lang.String getCustomValue(java.lang.String _key,
                                       boolean _doRefresh)

getCustomValues

public java.util.SortedMap getCustomValues()

getCustomValues

public java.util.SortedMap getCustomValues(boolean _doRefresh)

setLizenz

public void setLizenz(java.lang.String _strEnc)

refreshFromLicense

public void refreshFromLicense()
                        throws LicenseException

(Re)sets the cached properties from the encrypted data in the Lizenz.

Throws:

LicenseException

refreshFromLicense

public void refreshFromLicense(FeatureManagerI _fm)
                        throws LicenseException

Throws:

LicenseException

decryptLicense

public static java.lang.String decryptLicense(java.lang.String _strEnc,
                                              FeatureManagerI _fm)

Parameters:

_strEnc - the encrypted license string in Base64 format FIXME! shouldn't/couldn't we actually not pass _strEnc but directly only read bytes from file or BO and only pass these?

fromLicenseString

public void fromLicenseString(java.lang.String _str)
                       throws LicenseException

Sets the data of this License from the values parsed from the given compact license string.

Throws:

LicenseException

handleAdditionalKey

public boolean handleAdditionalKey(java.lang.String _key)

Supposed to be overwritten by subclasses for easy introduction of additional keys.

Returns:

true if _key was a valid one, false if not.

isActive

public boolean isActive(FeatureManagerI _fm)
                 throws LicenseException

For compatibility with LicenseI.

Specified by:

isActive in interface LicenseI

Throws:

LicenseException

isAvailable

public boolean isAvailable(FeatureManagerI _fm)
                    throws LicenseException

Throws:

LicenseException

matchesInstallation

public boolean matchesInstallation(java.lang.String _projekt,
                                   java.lang.String _instanz,
                                   java.lang.Long _nodeID)

Internal separate method for code clarity.

matchesInstallation

public static boolean matchesInstallation(java.lang.String _projekt,
                                          java.lang.String _projektWant,
                                          java.lang.String _instanz,
                                          java.lang.String _instanzWant,
                                          java.lang.Long _nodeID,
                                          java.lang.Long _nodeIDWant)

matchesAdditionalCriteria

public boolean matchesAdditionalCriteria()

Supposed to be overwritten by subclasses for easy checking of additional criteria.

getLizenz

public java.lang.String getLizenz()

getFm

public FeatureManagerI getFm()

setFm

public void setFm(FeatureManagerI $8)