iText Licensing Library 4.1.3 API
iText.Licensing.Base.Exceptions.LicenseKeyExceptionMessageConstant Class Reference

Class containing all the messages used in licensing module. More...

Static Public Attributes

const String  ATTEMPT_TO_LOAD_AN_OLDER_LICENSE
  Message notifies that license cannot be overloaded with the older one. More...
 
const String  CAN_NOT_FIND_LIMIT_FOR_PRODUCT = "Can not find limit for product \"{0}\"."
 
const String  CERTIFICATE_NOT_FOUND = "Certificate not found."
 
const String  COMMONS_VERSION_DOES_NOT_MATCH = "Version \"{0}\" of commons module of iText does not match minimal expected version \"{1}.{2}.{3}\"."
 
const String  CORE_LICENSE_IS_NOT_LOADED
 
const String  CORRUPTED_LICENSE_FILE = "License file was corrupted."
 
const String  CORRUPTED_SIGNATURE = "Signature was corrupted."
 
const String  EVENTS_CAN_NOT_BE_NULL = "Events can not be null."
 
const String  EVENT_IS_FORBIDDEN = "Event with type \"{0}\" for product \"{1}\" is forbidden."
 
const String  EVENT_TIME_CAN_NOT_BE_NULL = "Event time can not be null."
 
const String  GRACE_EXPIRATION_STRATEGY_INVALID_ARGUMENTS = "Grace period should not be null to create grace expiration strategy."
 
const String  HEALTH_CHECK_WRITING_FAILED = "Health check writing failed. Exception message: \"{0}\"."
 
const String  INTERNAL_USAGE_UTIL_EVENT = "This is util event for internal usage."
 
const String  INVALID_EVENT_VERSION = "Invalid event version."
 
const String  INVALID_EXPIRATION_STRATEGY = "Invalid license file expiration strategy."
 
const String  INVALID_GRACE_PERIOD_FORMAT = "Unable to parse grace period \"{0}\"."
 
const String  INVALID_LICENSE_FILE_EXPIRE_DATE = "Invalid expire date for license file which corresponds to \"{0}\" product."
 
const String  INVALID_LOCAL_FILE_ROOT_DIRECTORY = "Specified local file reporting root directory is invalid."
 
const String  INVALID_PUBLIC_KEY = "Invalid public key."
 
const String  INVALID_REPORTING_EXCEEDED_STRATEGY = "Invalid reporting exceeded strategy."
 
const String  INVALID_REPORTING_TYPE = "Invalid reporting type."
 
const String  INVALID_REPORTING_UNAVAILABILITY_STRATEGY = "Invalid reporting unavailability strategy."
 
const String  LEFT_LIMITS_CAN_NOT_BE_NULL = "Left limits can not be null."
 
const String  LICENSING_BASE_MODULE_SHOULD_BE_UPDATED
 
const String  LICENSE_DOES_NOT_ALLOW_REPORTING_TYPE = "Your current license does not allow reporting type {0}."
 
const String  LICENSING_REMOTE_VERSION_DOES_NOT_MATCH
 
const String  LICENSE_IS_INCOMPATIBLE
  Message notifies that license was not loaded as it is incompatible with the rest licenses. More...
 
const String  LICENSE_FILE_CAN_NOT_BE_NULL = "License file can not be null."
 
const String  LICENSE_FILE_HAS_BEEN_RELOADED = "License file for \"{0}\" product has been reloaded."
 
const String  LICENSE_FILE_HAS_EXPIRED = "A license file which corresponds to \"{0}\" product has expired."
 
const String  LICENSE_FILE_KEY_CAN_NOT_BE_NULL = "License file key can not be null."
 
const String  LICENSE_FILE_NOT_LOADED = "License file not loaded."
 
const String  LIMITS_CAN_NOT_BE_NULL = "Limits can not be null."
 
const String  LIMIT_HAS_EXCEEDED = "Limit \"{0}\" for product \"{1}\" has been exceeded."
 
const String  MAJOR_VERSION_DOES_NOT_MATCH = "Major version \"{0}\" of product \"{1}\" doesn't match to supported version \"{2}\" from license file."
 
const String  MINOR_VERSION_DOES_NOT_MATCH = "Minor version \"{0}\" of product \"{1}\" doesn't match to supported version \"{2}\" from license file."
 
const String  MISSING_LOCAL_FILE_ROOT_DIRECTORY = "Using local file reporting without specified reports root directory is forbidden."
 
const String  NEW_LICENSE_IS_INCOMPATIBLE_WITH_EXISTING
  Message notifies that new license was not loaded for the product as it is incompatible with the previous one. More...
 
const String  NO_AVAILABLE_REPORTING_TYPES_SPECIFIED = "Available reporting types collection is empty."
 
const String  OLD_LICENSE_FORMAT
 
const String  PRODUCT_NAME_CAN_NOT_BE_NULL = "Product name can not be null."
 
const String  REMOTE_REPORTING_HEALTH_CHECK_FAILED = "Cannot send data to remote reporting server"
 
const String  REMOTE_REPORTING_MISSING_REMOTE_MODULE
 
const String  STATISTICS_CANNOT_BE_ENABLED_FOR_LICENSEKEY
 
const String  UNABLE_TO_CONNECT_SERVER_DURING_LIMIT_UPDATING
 
const String  UNABLE_TO_CONNECT_SERVER_DURING_REPORTING
 
const String  UNABLE_TO_DESERIALIZE_DATA_LINE = "Unable to deserialize report file data line."
 
const String  UNABLE_TO_DESERIALIZE_METADATA = "Unable to deserialize metadata from report file."
 
const String  UNABLE_TO_EXTRACT_REMAINING_EVENTS = "Unable to extract remaining events for \"{0}\" type of event \"{1}\" product."
 
const String  UNABLE_TO_GET_LICENSE_LIMITS = "Unable to get license file limits."
 
const String  UNABLE_TO_PARSE_EMPTY_REPORT_FILE = "Unable to parse empty report file."
 
const String  UNEXPECTED_LICENSE_TYPE = "Unexpected license type \"{0}\"."
 
const String  UNEXPECTED_LIMIT_TYPE = "Unexpected limit type \"{0}\"."
 
const String  WRONG_LICENSE_FILE_VERSION = "This version {0} of license file is not supported. Try to update your license-key library."
  Message notifies that the version of license file is not compatible with the license-key library. More...
 
const String  WRONG_PLATFORM = "The license file is not compatible with your current platform."
 

Detailed Description

Class containing all the messages used in licensing module.

Member Data Documentation

◆ ATTEMPT_TO_LOAD_AN_OLDER_LICENSE

const String iText.Licensing.Base.Exceptions.LicenseKeyExceptionMessageConstant.ATTEMPT_TO_LOAD_AN_OLDER_LICENSE
static
Initial value:
= "Already set license for the product \"{0}\" was created later then the license you tried to load. "
+ "Typically iText uses the latest license for its work." + " If required, please unload the existing license and then load a new one."

Message notifies that license cannot be overloaded with the older one.

Message notifies that license cannot be overloaded with the older one. List of params:

  • 0th is a name of the product;

◆ CORE_LICENSE_IS_NOT_LOADED

const String iText.Licensing.Base.Exceptions.LicenseKeyExceptionMessageConstant.CORE_LICENSE_IS_NOT_LOADED
static
Initial value:
= "License for iText Core has not been loaded. Please make "
+ "sure to load iText Core license before loading license files for add-ons."

◆ LICENSE_IS_INCOMPATIBLE

const String iText.Licensing.Base.Exceptions.LicenseKeyExceptionMessageConstant.LICENSE_IS_INCOMPATIBLE
static
Initial value:
= "A license for the product \"{0}\" was not loaded as your "
+ "license is not compatible with the already loaded license for the product \"{1}\". Compatible licenses "
+ "should have same licensee info, the same deployment type and same event reporting set up."

Message notifies that license was not loaded as it is incompatible with the rest licenses.

Message notifies that license was not loaded as it is incompatible with the rest licenses. List of params:

  • 0th is a name of the product;
  • 1th is a name of the product which license is not compatible with the current one;

◆ LICENSING_BASE_MODULE_SHOULD_BE_UPDATED

const String iText.Licensing.Base.Exceptions.LicenseKeyExceptionMessageConstant.LICENSING_BASE_MODULE_SHOULD_BE_UPDATED
static
Initial value:
= "Your current licensing base module version "
+ "\"{0}\" does not corresponds minimal compatible version \"{1}\" for your product"

◆ LICENSING_REMOTE_VERSION_DOES_NOT_MATCH

const String iText.Licensing.Base.Exceptions.LicenseKeyExceptionMessageConstant.LICENSING_REMOTE_VERSION_DOES_NOT_MATCH
static
Initial value:
= "Version \"{0}\" of licensing remote module "
+ "of iText does not match version \"{1}\" of licensing base module."

◆ NEW_LICENSE_IS_INCOMPATIBLE_WITH_EXISTING

const String iText.Licensing.Base.Exceptions.LicenseKeyExceptionMessageConstant.NEW_LICENSE_IS_INCOMPATIBLE_WITH_EXISTING
static
Initial value:
= "A license for the product \"{0}\" was not loaded as your license is not compatible with the already"
+ " loaded license for this product. Compatible licenses should have same licensee info, " + "the same deployment type and same event reporting set up."

Message notifies that new license was not loaded for the product as it is incompatible with the previous one.

Message notifies that new license was not loaded for the product as it is incompatible with the previous one. List of params:

  • 0th is a name of the product which license is not compatible with the current one;

◆ OLD_LICENSE_FORMAT

const String iText.Licensing.Base.Exceptions.LicenseKeyExceptionMessageConstant.OLD_LICENSE_FORMAT
static
Initial value:
= "Looks like you are trying to load the old xml-based license. " +
"The new iText modules require updated license in json format. If you have any further questions, " +
"please contact our support team: https://itextpdf.com/support"

◆ REMOTE_REPORTING_MISSING_REMOTE_MODULE

const String iText.Licensing.Base.Exceptions.LicenseKeyExceptionMessageConstant.REMOTE_REPORTING_MISSING_REMOTE_MODULE
static
Initial value:
= "The 'licensing-remote' module which is required for sending events to AWS server may be missing or outdated. "
+ "Please ensure that you have added the appropriate version of this module and that all its transitive dependencies are also available. "
+ "If you continue to get this exception, please contact our support at 'https://itextpdf.com/support'."

◆ STATISTICS_CANNOT_BE_ENABLED_FOR_LICENSEKEY

const String iText.Licensing.Base.Exceptions.LicenseKeyExceptionMessageConstant.STATISTICS_CANNOT_BE_ENABLED_FOR_LICENSEKEY
static
Initial value:
= "Statistics cannot be enabled or disabled for licensekey module itself."
+ " Licensekey statistics is considered enabled if statistics is enabled for at least one module for which license file is loaded."
+ " Otherwise it is considered disabled."

◆ UNABLE_TO_CONNECT_SERVER_DURING_LIMIT_UPDATING

const String iText.Licensing.Base.Exceptions.LicenseKeyExceptionMessageConstant.UNABLE_TO_CONNECT_SERVER_DURING_LIMIT_UPDATING
static
Initial value:
= "Unable to connect to server during the limit updating. "
+ "A \"{0}\" limit for \"{1}\" product was not updated."

◆ UNABLE_TO_CONNECT_SERVER_DURING_REPORTING

const String iText.Licensing.Base.Exceptions.LicenseKeyExceptionMessageConstant.UNABLE_TO_CONNECT_SERVER_DURING_REPORTING
static
Initial value:
= "Unable to connect to server during the event reporting."
+ " A \"{0}\" event for \"{1}\" product was not reported."

◆ WRONG_LICENSE_FILE_VERSION

const String iText.Licensing.Base.Exceptions.LicenseKeyExceptionMessageConstant.WRONG_LICENSE_FILE_VERSION = "This version {0} of license file is not supported. Try to update your license-key library."
static

Message notifies that the version of license file is not compatible with the license-key library.

Message notifies that the version of license file is not compatible with the license-key library. List of params:

  • 0th is a version of the license file;