org.craftercms.commons.entitlements.validator.impl

Class DefaultEntitlementValidatorImpl

java.lang.Object

org.craftercms.commons.entitlements.manager.AbstractLicenseLoader

org.craftercms.commons.entitlements.validator.impl.DefaultEntitlementValidatorImpl

All Implemented Interfaces:

EventListener, LicenseAware, EntitlementValidator, org.springframework.context.ApplicationListener<LicenseUpdatedEvent>

public class DefaultEntitlementValidatorImpl
extends AbstractLicenseLoader
implements EntitlementValidator, LicenseAware

Implementation of EntitlementValidator for Crafter Enterprise Edition.

Author:

joseross

Field Summary

Fields

Modifier and Type	Field and Description
protected License	license Object loaded from the license file.

Fields inherited from class org.craftercms.commons.entitlements.manager.AbstractLicenseLoader

licenseFile, licenseName, objectMapper, privateKeyName, privateKeyPassword, publicKeyName

Constructor Summary

Constructors

Constructor and Description
DefaultEntitlementValidatorImpl()

Method Summary

Modifier and Type	Method and Description
long	getClientId() Provides the client id of the current validator.
String	getDescription() Provides a general description of the current validator.
long	getId() Provides the id of the current validator.
String	getPackageBuild() Provides the build of the containing JAR file.
String	getPackageVersion() Provides the version of the containing JAR file.
String	getVersion() Provides the version of the current validator.
void	init() Performs an early validation of the license file.
void	loadLicense() Reads the license file and extracts the relevant data.
void	onApplicationEvent(LicenseUpdatedEvent event) Handles the license update event
void	reloadLicense() Performs all actions required when the license is updated.
void	validateEntitlement(Module module, EntitlementType entitlementType, int currentValue, int newAmount) Checks that an entitlement is below the value indicated in the configuration file.
void	validateLicense() Performs general validations on the license object.

Methods inherited from class org.craftercms.commons.entitlements.manager.AbstractLicenseLoader

decryptLicense, readPublicKey, setLicenseFile, setLicenseName, setPrivateKeyName, setPrivateKeyPassword, setPublicKeyName

Methods inherited from class java.lang.Object

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

Field Detail

license

protected License license

Object loaded from the license file.

Constructor Detail

DefaultEntitlementValidatorImpl

public DefaultEntitlementValidatorImpl()

Method Detail

init

public void init()
          throws EntitlementException

Performs an early validation of the license file.

Throws:

EntitlementException - if the license file is not found or can't be read.

loadLicense

public void loadLicense()
                 throws EntitlementException

Description copied from interface: LicenseAware

Reads the license file and extracts the relevant data.

Specified by:

loadLicense in interface LicenseAware

Throws:

EntitlementException - if there is any error reading the license file

validateLicense

public void validateLicense()

Performs general validations on the license object.

validateEntitlement

public void validateEntitlement(Module module,
                                EntitlementType entitlementType,
                                int currentValue,
                                int newAmount)

Checks that an entitlement is below the value indicated in the configuration file.

Specified by:

validateEntitlement in interface EntitlementValidator

Parameters:

module - module requesting the validation

entitlementType - entitlement to be validated

currentValue - current value provided by the module

newAmount - amount of items to be created

getId

public long getId()

Provides the id of the current validator.

Specified by:

getId in interface EntitlementValidator

Returns:

id of the validator

getClientId

public long getClientId()

Provides the client id of the current validator.

Specified by:

getClientId in interface EntitlementValidator

Returns:

if of the client

getVersion

public String getVersion()

Provides the version of the current validator.

Specified by:

getVersion in interface EntitlementValidator

Returns:

the version

getDescription

public String getDescription()

Provides a general description of the current validator.

Specified by:

getDescription in interface EntitlementValidator

Returns:

validator description

getPackageVersion

public String getPackageVersion()

Provides the version of the containing JAR file.

Specified by:

getPackageVersion in interface EntitlementValidator

Returns:

the version

getPackageBuild

public String getPackageBuild()

Provides the build of the containing JAR file.

Specified by:

getPackageBuild in interface EntitlementValidator

Returns:

the build

reloadLicense

public void reloadLicense()

Performs all actions required when the license is updated.

Specified by:

reloadLicense in interface LicenseAware

onApplicationEvent

public void onApplicationEvent(LicenseUpdatedEvent event)

Handles the license update event

Specified by:

onApplicationEvent in interface LicenseAware

Specified by:

onApplicationEvent in interface org.springframework.context.ApplicationListener<LicenseUpdatedEvent>

Parameters:

event - the event