| License Class |
The base License class, from which all PLUSManaged application license implementations are derived.
Inheritance HierarchySystemObject
com.softwarekey.Client.LicensingLicense
com.softwarekey.Client.LicensingWritableLicense
com.softwarekey.Client.LicensingLicense
com.softwarekey.Client.LicensingWritableLicense
Namespace: com.softwarekey.Client.Licensing
Assembly: PLUSManaged (in PLUSManaged.dll) Version: 5.23.4.0
SyntaxThe License type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | License | Creates a new License object with the cryptographic keys already set in an AuthorEncryptionKey object |
Properties| Name | Description | |
|---|---|---|
 | ActivationPassword | Gets the activation password, which is usually randomly generated by SOLO Server. |
| Author | Gets the Author that issued this License. |
| AuthorizedIdentifiers | Gets a generic list of authorized/activated system identifiers. |
| CurrentIdentifiers | Gets a generic list of the current system's identifiers. |
| CurrentSessionCode | Gets or sets the current session code, which prevents replay attacks in manual request processing. |
| CurrentVersion | Gets the current version of the product available. |
| Customer | Gets the Customer to which this License was issued. |
| Distributor | Gets the Distributor with which this License is associated. |
| EffectiveEndDate | Gets the date in which the license expires. |
| EffectiveStartDate | Gets the date in which the license becomes effective. |
| EncryptionKeyID | Gets or sets the Encryption Key identifier. |
| ExternalReference1 | Gets the External Reference 1 value, which is a unique identifier generated by a third-party system or service. |
| ExternalReference1Source | Gets the source of the ExternalReference1 value. |
| ExternalReference2 | Gets the External Reference 2 value, which is a unique identifier generated by a third-party system or service. |
| ExternalReference2Source | Gets the source of the ExternalReference2 value. |
| FormatVersion | Gets the format version of the license file. |
| InstallationID | Gets the Installation ID which uniquely identifies the activation of the current system |
| InstallationName | Gets or sets the name of the installation. |
| IsTestLicense | Gets whether or not the license file was generated from a test license. IMPORTANT: Test licenses may eventually be deleted from SOLO Server's database! |
| LastError | Gets or sets the last error encountered |
| LatestVersion | Gets the latest version of the product available. |
| LicenseCounter | Gets the License Counter value. |
| LicenseCustomData | Gets the License Custom Data, which contains custom XML or alphanumeric data. |
| LicenseeEmail | Gets the licensee's email address. |
| LicenseeName | Gets the licensee's name. |
| LicenseGroup | Gets the License Group to which the License was assigned. |
| LicenseID | Gets the License ID of the license purchased and activated. |
| LicenseUpdate | Gets the License Update data. |
| LicenseValidationOptions | Gets the License Validation Options. |
| NumberOfMatchingIdentifiers | Gets the the number of authorized system identifiers with matching current system identifiers. |
| Product | Gets the Product for which the License was issued. |
| ProductOption | Gets the Product Option for which the License was issued. |
| ProductVersion | Gets or sets the version of this product. |
| QuantityOrdered | Gets the quantity of licenses ordered. |
| SerialNumber | Gets the Serial Number value |
| SignatureDate | Gets the date in which the license file itself was created and signed. |
| ThisProductID | Gets or sets the Product ID (usually generated by SOLO Server) of this product/application. |
| TriggerCode | Gets the Trigger Code number issued by SOLO Server. |
| TriggerCodeFixedValue | Gets the Trigger Code Fixed Value issued by SOLO Server. |
| UserDefinedDate1 | Gets the User Defined Date-Time Field 1 value. |
| UserDefinedDate2 | Gets the User Defined Date-Time Field 2 value. |
| UserDefinedDate3 | Gets the User Defined Date-Time Field 3 value. |
| UserDefinedDate4 | Gets the User Defined Date-Time Field 4 value. |
| UserDefinedDate5 | Gets the User Defined Date-Time Field 5 value. |
| UserDefinedFloat1 | Gets the User Defined Float Field 1 value. |
| UserDefinedFloat2 | Gets the User Defined Float Field 2 value. |
| UserDefinedFloat3 | Gets the User Defined Float Field 3 value. |
| UserDefinedFloat4 | Gets the User Defined Float Field 4 value. |
| UserDefinedFloat5 | Gets the User Defined Float Field 5 value. |
| UserDefinedNumber1 | Gets the User Defined Number Field 1 value. |
| UserDefinedNumber2 | Gets the User Defined Number Field 2 value. |
| UserDefinedNumber3 | Gets the User Defined Number Field 3 value. |
| UserDefinedNumber4 | Gets the User Defined Number Field 4 value. |
| UserDefinedNumber5 | Gets the User Defined Number Field 5 value. |
| UserDefinedString1 | Gets the User Defined String Field 1 value. |
| UserDefinedString10 | Gets the User Defined String Field 10 value. |
| UserDefinedString2 | Gets the User Defined String Field 2 value. |
| UserDefinedString3 | Gets the User Defined String Field 3 value. |
| UserDefinedString4 | Gets the User Defined String Field 4 value. |
| UserDefinedString5 | Gets the User Defined String Field 5 value. |
| UserDefinedString6 | Gets the User Defined String Field 6 value. |
| UserDefinedString7 | Gets the User Defined String Field 7 value. |
| UserDefinedString8 | Gets the User Defined String Field 8 value. |
| UserDefinedString9 | Gets the User Defined String Field 9 value. |
Methods| Name | Description | |
|---|---|---|
| ActivateInstallationLicenseFile(Int32, String, String) | Activates online using a specified License ID, and customer password or activation password |
| ActivateInstallationLicenseFile(String, XmlActivationService, String) | Activates online using a specified License ID, customer password or activation password, and endpoint URL |
| ActivateInstallationLicenseFile(String, String, String) | Activates online using the license's current License ID, the specified customer password or activation password, and endpoint URL |
| ActivateInstallationLicenseFile(Int32, String, XmlActivationService, String) | Activates online using a specified License ID, customer password or activation password, and endpoint URL |
| ActivateInstallationLicenseFile(Int32, String, String, String) | Activates online using the license's current License ID, the specified customer password or activation password, and endpoint URL |
| ActivateOnline(String, XmlActivationService) | Activates online using the license's current License ID, the specified customer password or activation password, and SoapHttpClientProtocol (.NET Framework) or the XmlWebService (.NET Standard) object |
| ActivateOnline(String, String) | Activates online using the license's current License ID, the specified customer password or activation password, and endpoint URL |
| ActivateOnline(Int32, String, XmlActivationService) | Activates online using the specified License ID, customer password or activation password, and SoapHttpClientProtocol object. |
| ActivateOnline(Int32, String, String) | Activates online using the specified License ID, customer password or activation password, and endpoint URL. |
| AddIdentifierAlgorithm | Adds a SystemIdentifierAlgorithm implementation to use for system identification and verification. |
| AddTimeServerCheck(String) | Add an SNTP server to the list of servers to check |
| AddTimeServerCheck(String, Int32) | Add an SNTP server to the list of servers to check |
| AddTimeServerCheck(String, Int32, Int32, Int32) | Add an SNTP server to the list of servers to check |
| CheckInstallationStatus | Checks the installation status for the given Installation ID against SOLO Server using the current value in the InstallationID property. |
| CheckInstallationStatus(String) | Checks the installation status for the given Installation ID against SOLO Server using the current value in the InstallationID property and a specified endpoint. |
| CheckInstallationStatus(XmlActivationService) | Checks the installation status for the given Installation ID against SOLO Server using the current value in the InstallationID property and a specified endpoint. |
| CheckTimeAgainstServers | Checks the system time against multiple time servers/sntp requests, allowing up to a 5 minute difference. |
| CheckTimeAgainstServers(Double) | Checks the system time against multiple time servers/sntp requests |
| DeactivateInstallation | Deactivates the license with SOLO Server using the InstallationID property. |
| DeactivateInstallation(String) | Deactivates the license with SOLO Server using the InstallationID property and the specified endpoint. |
| DeactivateInstallation(XmlActivationService) | Deactivates the license with SOLO Server using the InstallationID property and the specified endpoint. |
| DecrementLicenseCounter(Int32) | Decrements the License Counter value for the given Installation ID against SOLO Server using the current value in the InstallationID property. |
| DecrementLicenseCounter(String, Int32) | Decrements the License Counter value for the given Installation ID against SOLO Server using the current value in the InstallationID property and a specified endpoint. |
| DecrementLicenseCounter(XmlActivationService, Int32) | Decrements the License Counter value for the given Installation ID against SOLO Server using the current value in the InstallationID property and a specified endpoint. |
| Equals | (Inherited from Object.) |
 | Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
| GetActivationInstallationLicenseFileRequest | Builds a manual activation XML request string |
| GetActivationRequest | Builds a manual activation XML request string |
| GetCheckInstallationStatusRequest | Builds a manual status check XML request string using the current value in the InstallationID property |
| GetDeactivateInstallationRequest | Builds a manual status check XML request string using the current value in the InstallationID property |
| GetDecrementLicenseCounterRequest | Builds a manual status check XML request string using the current value in the InstallationID property |
| GetEncryptionKey | Gets the AuthorEncryptionKey object used for cryptographic routines. |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetLicenseRefreshRequest | Builds a manual license refresh XML request string using the current value in the InstallationID property |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| InitializeCurrentIdentifiers | Initializes the CurrentIdentifiers property using the algorithms added using the AddIdentifierAlgorithm(SystemIdentifierAlgorithm) method. |
| initializeFromXml | Initializes properties from a plain-text XML license document. |
| Load | Loads a License File from a String in memory. |
| LoadFile | Loads a License File from the file system and returns true if successful |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ProcessActivateInstallationLicenseFileResponse(String, String) | Processes an activation XML response string |
| ProcessActivateInstallationLicenseFileResponse(XmlNode, String) | Processes an activation XML response |
| ProcessActivationResponse(String) | Processes an activation XML response string |
| ProcessActivationResponse(XmlNode) | Processes an activation XML response. |
| ProcessCheckInstallationStatusResponse(String) | Processes a CheckInstallationStatus XML response string |
| ProcessCheckInstallationStatusResponse(XmlNode) | Processes a CheckInstallationStatus XML response string |
| ProcessDeactivateInstallationResponse(String) | Processes a DeactivateInstallation XML response string |
| ProcessDeactivateInstallationResponse(XmlNode) | Processes a DeactivateInstallation XML response string |
| ProcessDecrementLicenseCounterResponse(String) | Processes a DecrementLicenseCounter XML response string |
| ProcessDecrementLicenseCounterResponse(XmlNode) | Processes a DecrementLicenseCounter XML response string |
| ProcessLicenseRefreshResponse(String, String) | Processes an activation XML response string |
| ProcessLicenseRefreshResponse(XmlNode, String) | Processes an License Refresh XML response |
| RefreshLicense(String) | Returns the current license file contents from SOLO Server using the current value in the InstallationID property. |
| RefreshLicense(String, String) | Returns the current license file contents from SOLO Server using the current value in the InstallationID property. |
| RefreshLicense(XmlLicenseFileService, String) | Returns the current license file contents from SOLO Server using the current value in the InstallationID property. |
| ResetSessionCode | Creates a new session code in the CurrentSessionCode property |
| ToString | (Inherited from Object.) |
| WriteLicenseFile | Writes a License File to the file system. |
Remarks Note |
|---|
This is the base class from which all PLUSManaged application licensing implementations are derived. Inheriting from this class directly is ideal for using read-only License Files which are signed by SOLO Server. If you wish to use a License File that is writable and does not require SOLO Server, your implementation should inherit from the WritableLicense class instead |
See Also