A C D E G I L M N O P R S T U V

A

AbstractLicenseAware - Class in org.craftercms.commons.entitlements.manager

AbstractLicenseAware() - Constructor for class org.craftercms.commons.entitlements.manager.AbstractLicenseAware

AbstractLicenseLoader - Class in org.craftercms.commons.entitlements.manager

Provides basic operations to read license files.

AbstractLicenseLoader() - Constructor for class org.craftercms.commons.entitlements.manager.AbstractLicenseLoader

appContext - Variable in class org.craftercms.commons.entitlements.manager.impl.DefaultLicenseManagerImpl

C

checkLicenseFile(boolean) - Method in class org.craftercms.commons.entitlements.manager.impl.DefaultLicenseManagerImpl

clientId - Variable in class org.craftercms.commons.entitlements.model.License

Id of the client.

clientName - Variable in class org.craftercms.commons.entitlements.model.License

Name of the client.

contractEndDate - Variable in class org.craftercms.commons.entitlements.model.License

End date of the license.

contractStartDate - Variable in class org.craftercms.commons.entitlements.model.License

Start date of the license.

createdBy - Variable in class org.craftercms.commons.entitlements.model.License

The username of the user that created the license.

createdDate - Variable in class org.craftercms.commons.entitlements.model.License

The date when the license was created.

CURRENT_VERSION - Static variable in class org.craftercms.commons.entitlements.model.License

Current version used for the license file.

currentValue - Variable in exception org.craftercms.commons.entitlements.exception.EntitlementExceededException

The actual value provided by the module.

D

decryptLicense() - Method in class org.craftercms.commons.entitlements.manager.AbstractLicenseLoader

Reads the license file and decrypts the content.

DefaultEntitlementValidatorImpl - Class in org.craftercms.commons.entitlements.validator.impl

Implementation of EntitlementValidator for Crafter Enterprise Edition.

DefaultEntitlementValidatorImpl() - Constructor for class org.craftercms.commons.entitlements.validator.impl.DefaultEntitlementValidatorImpl

DefaultLicenseManagerImpl - Class in org.craftercms.commons.entitlements.manager.impl

Default implementation of LicenseManager.

DefaultLicenseManagerImpl() - Constructor for class org.craftercms.commons.entitlements.manager.impl.DefaultLicenseManagerImpl

E

Entitlement - Class in org.craftercms.commons.entitlements.model

Holds the value for a given entitlement type.

Entitlement() - Constructor for class org.craftercms.commons.entitlements.model.Entitlement

EntitlementExceededException - Exception in org.craftercms.commons.entitlements.exception

Exception thrown when the validation of an entitlement fails.

EntitlementExceededException(Module, EntitlementType, Number, Number) - Constructor for exception org.craftercms.commons.entitlements.exception.EntitlementExceededException

EntitlementException - Exception in org.craftercms.commons.entitlements.exception

Base class for all entitlement related errors.

EntitlementException() - Constructor for exception org.craftercms.commons.entitlements.exception.EntitlementException

EntitlementException(String) - Constructor for exception org.craftercms.commons.entitlements.exception.EntitlementException

EntitlementException(String, Throwable) - Constructor for exception org.craftercms.commons.entitlements.exception.EntitlementException

EntitlementException(Throwable) - Constructor for exception org.craftercms.commons.entitlements.exception.EntitlementException

entitlements - Variable in class org.craftercms.commons.entitlements.model.License

Map of entitlements for each module.

entitlementType - Variable in exception org.craftercms.commons.entitlements.exception.EntitlementExceededException

The entitlement that was being validated.

entitlementType - Variable in exception org.craftercms.commons.entitlements.exception.UnsupportedEntitlementException

The requested entitlement.

EntitlementType - Enum in org.craftercms.commons.entitlements.model

Holds the available entitlements when requesting an entitlement validation.

EntitlementValidator - Interface in org.craftercms.commons.entitlements.validator

Defines the operations to perform entitlement validations.

entitlementValue - Variable in exception org.craftercms.commons.entitlements.exception.EntitlementExceededException

The entitlement value found in the license file.

Environment - Enum in org.craftercms.commons.entitlements.model

Holds the possible values for environments.

environment - Variable in class org.craftercms.commons.entitlements.model.License

Environment for the license.

expireDate - Variable in exception org.craftercms.commons.entitlements.exception.ExpiredLicenseException

The date when the license expired.

ExpiredLicenseException - Exception in org.craftercms.commons.entitlements.exception

Exception thrown when the license is of type STANDARD and the end date has been reached.

ExpiredLicenseException(Date) - Constructor for exception org.craftercms.commons.entitlements.exception.ExpiredLicenseException

G

getClientId() - Method in class org.craftercms.commons.entitlements.model.License

getClientId() - Method in interface org.craftercms.commons.entitlements.validator.EntitlementValidator

Provides the client id of the current validator.

getClientId() - Method in class org.craftercms.commons.entitlements.validator.impl.DefaultEntitlementValidatorImpl

Provides the client id of the current validator.

getClientName() - Method in class org.craftercms.commons.entitlements.model.License

getContractEndDate() - Method in class org.craftercms.commons.entitlements.model.License

getContractStartDate() - Method in class org.craftercms.commons.entitlements.model.License

getCreatedBy() - Method in class org.craftercms.commons.entitlements.model.License

getCreatedDate() - Method in class org.craftercms.commons.entitlements.model.License

getCurrentValue() - Method in exception org.craftercms.commons.entitlements.exception.EntitlementExceededException

getDescription() - Method in interface org.craftercms.commons.entitlements.validator.EntitlementValidator

Provides a general description of the current validator.

getDescription() - Method in class org.craftercms.commons.entitlements.validator.impl.DefaultEntitlementValidatorImpl

Provides a general description of the current validator.

getEntitlements() - Method in class org.craftercms.commons.entitlements.model.License

getEntitlementType() - Method in exception org.craftercms.commons.entitlements.exception.EntitlementExceededException

getEntitlementType() - Method in exception org.craftercms.commons.entitlements.exception.UnsupportedEntitlementException

getEntitlementValue() - Method in exception org.craftercms.commons.entitlements.exception.EntitlementExceededException

getEnvironment() - Method in class org.craftercms.commons.entitlements.model.License

getExpireDate() - Method in exception org.craftercms.commons.entitlements.exception.ExpiredLicenseException

getId() - Method in class org.craftercms.commons.entitlements.model.License

getId() - Method in interface org.craftercms.commons.entitlements.validator.EntitlementValidator

Provides the id of the current validator.

getId() - Method in class org.craftercms.commons.entitlements.validator.impl.DefaultEntitlementValidatorImpl

Provides the id of the current validator.

getLabel() - Method in class org.craftercms.commons.entitlements.model.License

getLicenseType() - Method in class org.craftercms.commons.entitlements.model.License

getModule() - Method in exception org.craftercms.commons.entitlements.exception.EntitlementExceededException

getModule() - Method in exception org.craftercms.commons.entitlements.exception.UnsupportedEntitlementException

getNotes() - Method in class org.craftercms.commons.entitlements.model.License

getOrderFormId() - Method in class org.craftercms.commons.entitlements.model.License

getPackageBuild() - Method in interface org.craftercms.commons.entitlements.validator.EntitlementValidator

Provides the build of the containing JAR file.

getPackageBuild() - Method in class org.craftercms.commons.entitlements.validator.impl.DefaultEntitlementValidatorImpl

Provides the build of the containing JAR file.

getPackageVersion() - Method in interface org.craftercms.commons.entitlements.validator.EntitlementValidator

Provides the version of the containing JAR file.

getPackageVersion() - Method in class org.craftercms.commons.entitlements.validator.impl.DefaultEntitlementValidatorImpl

Provides the version of the containing JAR file.

getType() - Method in class org.craftercms.commons.entitlements.model.Entitlement

getValue() - Method in class org.craftercms.commons.entitlements.model.Entitlement

getVersion() - Method in class org.craftercms.commons.entitlements.model.License

getVersion() - Method in interface org.craftercms.commons.entitlements.validator.EntitlementValidator

Provides the version of the current validator.

getVersion() - Method in class org.craftercms.commons.entitlements.validator.impl.DefaultEntitlementValidatorImpl

Provides the version of the current validator.

I

id - Variable in class org.craftercms.commons.entitlements.model.License

Id of the license.

init() - Method in class org.craftercms.commons.entitlements.manager.impl.DefaultLicenseManagerImpl

init() - Method in class org.craftercms.commons.entitlements.validator.impl.DefaultEntitlementValidatorImpl

Performs an early validation of the license file.

InvalidLicenseException - Exception in org.craftercms.commons.entitlements.exception

Exception thrown when the license file is corrupted or can't be decrypted.

InvalidLicenseException(String) - Constructor for exception org.craftercms.commons.entitlements.exception.InvalidLicenseException

InvalidLicenseException(String, Throwable) - Constructor for exception org.craftercms.commons.entitlements.exception.InvalidLicenseException

isReadOnlyEnabled() - Method in class org.craftercms.commons.entitlements.model.License

L

label - Variable in class org.craftercms.commons.entitlements.model.License

General label to describe the license.

lastModified - Variable in class org.craftercms.commons.entitlements.manager.impl.DefaultLicenseManagerImpl

The last modified time of the license file.

License - Class in org.craftercms.commons.entitlements.model

Holds the information read from the license file.

License() - Constructor for class org.craftercms.commons.entitlements.model.License

license - Variable in class org.craftercms.commons.entitlements.validator.impl.DefaultEntitlementValidatorImpl

Object loaded from the license file.

LicenseAware - Interface in org.craftercms.commons.entitlements.manager

Defines the basic operations that all license related classes should provide.

licenseFile - Variable in class org.craftercms.commons.entitlements.manager.AbstractLicenseLoader

The location of the license file to check.

LicenseManager - Interface in org.craftercms.commons.entitlements.manager

Defines general license file validations and notifies listeners.

licenseName - Variable in class org.craftercms.commons.entitlements.manager.AbstractLicenseLoader

Name of the license file.

LicenseNotFoundException - Exception in org.craftercms.commons.entitlements.exception

Exception thrown when the license file is not present or can't be read.

LicenseNotFoundException() - Constructor for exception org.craftercms.commons.entitlements.exception.LicenseNotFoundException

LicenseNotFoundException(String) - Constructor for exception org.craftercms.commons.entitlements.exception.LicenseNotFoundException

LicenseNotFoundException(String, Throwable) - Constructor for exception org.craftercms.commons.entitlements.exception.LicenseNotFoundException

LicenseNotFoundException(Throwable) - Constructor for exception org.craftercms.commons.entitlements.exception.LicenseNotFoundException

licenseType - Variable in class org.craftercms.commons.entitlements.model.License

Type of the license.

LicenseType - Enum in org.craftercms.commons.entitlements.model

Holds the different license types.

LicenseUpdatedEvent - Class in org.craftercms.commons.entitlements.manager

Event to describe an update of the license file.

LicenseUpdatedEvent(Object) - Constructor for class org.craftercms.commons.entitlements.manager.LicenseUpdatedEvent

LIMIT - Static variable in interface org.craftercms.commons.entitlements.manager.LicenseManager

loadLicense() - Method in class org.craftercms.commons.entitlements.manager.impl.DefaultLicenseManagerImpl

Checks if the license file has changes and is valid.

loadLicense() - Method in interface org.craftercms.commons.entitlements.manager.LicenseAware

Reads the license file and extracts the relevant data.

loadLicense() - Method in interface org.craftercms.commons.entitlements.manager.LicenseManager

Checks if the license file has changes and is valid.

loadLicense() - Method in class org.craftercms.commons.entitlements.validator.impl.DefaultEntitlementValidatorImpl

LOG_PREFIX - Static variable in interface org.craftercms.commons.entitlements.manager.LicenseManager

logger - Static variable in interface org.craftercms.commons.entitlements.manager.LicenseAware

LOGGER - Static variable in interface org.craftercms.commons.entitlements.manager.LicenseManager

M

module - Variable in exception org.craftercms.commons.entitlements.exception.EntitlementExceededException

The module that requested the validation.

module - Variable in exception org.craftercms.commons.entitlements.exception.UnsupportedEntitlementException

The requested module.

Module - Enum in org.craftercms.commons.entitlements.model

Holds the available modules when requesting an entitlement validation.

N

notes - Variable in class org.craftercms.commons.entitlements.model.License

General notes to describe the license.

O

objectMapper - Variable in class org.craftercms.commons.entitlements.manager.AbstractLicenseLoader

Jackson ObjectMapper used to read from the license file.

onApplicationEvent(LicenseUpdatedEvent) - Method in class org.craftercms.commons.entitlements.manager.AbstractLicenseAware

onApplicationEvent(LicenseUpdatedEvent) - Method in interface org.craftercms.commons.entitlements.manager.LicenseAware

Handles the license update event

onApplicationEvent(LicenseUpdatedEvent) - Method in class org.craftercms.commons.entitlements.validator.impl.DefaultEntitlementValidatorImpl

Handles the license update event

orderFormId - Variable in class org.craftercms.commons.entitlements.model.License

Order Form Id of the license.

org.craftercms.commons.entitlements.exception - package org.craftercms.commons.entitlements.exception

org.craftercms.commons.entitlements.manager - package org.craftercms.commons.entitlements.manager

org.craftercms.commons.entitlements.manager.impl - package org.craftercms.commons.entitlements.manager.impl

org.craftercms.commons.entitlements.model - package org.craftercms.commons.entitlements.model

org.craftercms.commons.entitlements.validator - package org.craftercms.commons.entitlements.validator

org.craftercms.commons.entitlements.validator.impl - package org.craftercms.commons.entitlements.validator.impl

P

privateKeyName - Variable in class org.craftercms.commons.entitlements.manager.AbstractLicenseLoader

Name of the private publicKeyContent file.

privateKeyPassword - Variable in class org.craftercms.commons.entitlements.manager.AbstractLicenseLoader

Passphrase for the PGP Private Key.

publicKeyName - Variable in class org.craftercms.commons.entitlements.manager.AbstractLicenseLoader

Name of the public publicKeyContent file.

R

readOnlyEnabled - Variable in class org.craftercms.commons.entitlements.model.License

Indicates if the system should be read-only when the license expires.

readPublicKey() - Method in class org.craftercms.commons.entitlements.manager.AbstractLicenseLoader

Reads the license file and returns the content of the public key.

reloadLicense() - Method in class org.craftercms.commons.entitlements.manager.AbstractLicenseAware

reloadLicense() - Method in interface org.craftercms.commons.entitlements.manager.LicenseAware

Performs all actions required when the license is updated.

reloadLicense() - Method in class org.craftercms.commons.entitlements.validator.impl.DefaultEntitlementValidatorImpl

Performs all actions required when the license is updated.

S

setApplicationContext(ApplicationContext) - Method in class org.craftercms.commons.entitlements.manager.impl.DefaultLicenseManagerImpl

setClientId(long) - Method in class org.craftercms.commons.entitlements.model.License

setClientName(String) - Method in class org.craftercms.commons.entitlements.model.License

setContractEndDate(Date) - Method in class org.craftercms.commons.entitlements.model.License

setContractStartDate(Date) - Method in class org.craftercms.commons.entitlements.model.License

setCreatedBy(String) - Method in class org.craftercms.commons.entitlements.model.License

setCreatedDate(Date) - Method in class org.craftercms.commons.entitlements.model.License

setEntitlements(Map<Module, List<Entitlement>>) - Method in class org.craftercms.commons.entitlements.model.License

setEntitlementType(EntitlementType) - Method in exception org.craftercms.commons.entitlements.exception.UnsupportedEntitlementException

setEnvironment(Environment) - Method in class org.craftercms.commons.entitlements.model.License

setId(long) - Method in class org.craftercms.commons.entitlements.model.License

setLabel(String) - Method in class org.craftercms.commons.entitlements.model.License

setLicenseFile(Resource) - Method in class org.craftercms.commons.entitlements.manager.AbstractLicenseLoader

setLicenseName(String) - Method in class org.craftercms.commons.entitlements.manager.AbstractLicenseLoader

setLicenseType(LicenseType) - Method in class org.craftercms.commons.entitlements.model.License

setModule(Module) - Method in exception org.craftercms.commons.entitlements.exception.UnsupportedEntitlementException

setNotes(String) - Method in class org.craftercms.commons.entitlements.model.License

setOrderFormId(String) - Method in class org.craftercms.commons.entitlements.model.License

setPrivateKeyName(String) - Method in class org.craftercms.commons.entitlements.manager.AbstractLicenseLoader

setPrivateKeyPassword(char[]) - Method in class org.craftercms.commons.entitlements.manager.AbstractLicenseLoader

setPublicKeyName(String) - Method in class org.craftercms.commons.entitlements.manager.AbstractLicenseLoader

setReadOnlyEnabled(boolean) - Method in class org.craftercms.commons.entitlements.model.License

setType(EntitlementType) - Method in class org.craftercms.commons.entitlements.model.Entitlement

setValue(int) - Method in class org.craftercms.commons.entitlements.model.Entitlement

setVersion(String) - Method in class org.craftercms.commons.entitlements.model.License

T

toString() - Method in class org.craftercms.commons.entitlements.model.Entitlement

type - Variable in class org.craftercms.commons.entitlements.model.Entitlement

U

UnsupportedEntitlementException - Exception in org.craftercms.commons.entitlements.exception

Exception thrown when an invalid module or entitlement is requested during a validation.

UnsupportedEntitlementException(Module, EntitlementType) - Constructor for exception org.craftercms.commons.entitlements.exception.UnsupportedEntitlementException

V

validateEntitlement(Module, EntitlementType, int, int) - Method in interface org.craftercms.commons.entitlements.validator.EntitlementValidator

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

validateEntitlement(Module, EntitlementType, int, int) - Method in class org.craftercms.commons.entitlements.validator.impl.DefaultEntitlementValidatorImpl

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

validateLicense() - Method in class org.craftercms.commons.entitlements.validator.impl.DefaultEntitlementValidatorImpl

Performs general validations on the license object.

value - Variable in class org.craftercms.commons.entitlements.model.Entitlement

valueOf(String) - Static method in enum org.craftercms.commons.entitlements.model.EntitlementType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.craftercms.commons.entitlements.model.Environment

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.craftercms.commons.entitlements.model.LicenseType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.craftercms.commons.entitlements.model.Module

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.craftercms.commons.entitlements.model.EntitlementType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.craftercms.commons.entitlements.model.Environment

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.craftercms.commons.entitlements.model.LicenseType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.craftercms.commons.entitlements.model.Module

Returns an array containing the constants of this enum type, in the order they are declared.

version - Variable in class org.craftercms.commons.entitlements.model.License

Version of the license file.

A C D E G I L M N O P R S T U V