Click or drag to resize
License Class
The base License class, from which all PLUSManaged application license implementations are derived.
Inheritance Hierarchy

Namespace: com.softwarekey.Client.Licensing
Assembly: PLUSManaged (in PLUSManaged.dll) Version: 5.23.4.0
Syntax
public class License

The License type exposes the following members.

Constructors
  NameDescription
Public methodLicense
Creates a new License object with the cryptographic keys already set in an AuthorEncryptionKey object
Top
Properties
  NameDescription
Public propertyActivationPassword
Gets the activation password, which is usually randomly generated by SOLO Server.
Public propertyAuthor
Gets the Author that issued this License.
Public propertyAuthorizedIdentifiers
Gets a generic list of authorized/activated system identifiers.
Public propertyCurrentIdentifiers
Gets a generic list of the current system's identifiers.
Public propertyCurrentSessionCode
Gets or sets the current session code, which prevents replay attacks in manual request processing.
Public propertyCurrentVersion
Gets the current version of the product available.
Public propertyCustomer
Gets the Customer to which this License was issued.
Public propertyDistributor
Gets the Distributor with which this License is associated.
Public propertyEffectiveEndDate
Gets the date in which the license expires.
Public propertyEffectiveStartDate
Gets the date in which the license becomes effective.
Public propertyEncryptionKeyID
Gets or sets the Encryption Key identifier.
Public propertyExternalReference1
Gets the External Reference 1 value, which is a unique identifier generated by a third-party system or service.
Public propertyExternalReference1Source
Gets the source of the ExternalReference1 value.
Public propertyExternalReference2
Gets the External Reference 2 value, which is a unique identifier generated by a third-party system or service.
Public propertyExternalReference2Source
Gets the source of the ExternalReference2 value.
Public propertyFormatVersion
Gets the format version of the license file.
Public propertyInstallationID
Gets the Installation ID which uniquely identifies the activation of the current system
Public propertyInstallationName
Gets or sets the name of the installation.
Public propertyIsTestLicense
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!
Public propertyLastError
Gets or sets the last error encountered
Public propertyLatestVersion
Gets the latest version of the product available.
Public propertyLicenseCounter
Gets the License Counter value.
Public propertyLicenseCustomData
Gets the License Custom Data, which contains custom XML or alphanumeric data.
Public propertyLicenseeEmail
Gets the licensee's email address.
Public propertyLicenseeName
Gets the licensee's name.
Public propertyLicenseGroup
Gets the License Group to which the License was assigned.
Public propertyLicenseID
Gets the License ID of the license purchased and activated.
Public propertyLicenseUpdate
Gets the License Update data.
Public propertyLicenseValidationOptions
Gets the License Validation Options.
Public propertyNumberOfMatchingIdentifiers
Gets the the number of authorized system identifiers with matching current system identifiers.
Public propertyProduct
Gets the Product for which the License was issued.
Public propertyProductOption
Gets the Product Option for which the License was issued.
Public propertyProductVersion
Gets or sets the version of this product.
Public propertyQuantityOrdered
Gets the quantity of licenses ordered.
Public propertySerialNumber
Gets the Serial Number value
Public propertySignatureDate
Gets the date in which the license file itself was created and signed.
Public propertyThisProductID
Gets or sets the Product ID (usually generated by SOLO Server) of this product/application.
Public propertyTriggerCode
Gets the Trigger Code number issued by SOLO Server.
Public propertyTriggerCodeFixedValue
Gets the Trigger Code Fixed Value issued by SOLO Server.
Public propertyUserDefinedDate1
Gets the User Defined Date-Time Field 1 value.
Public propertyUserDefinedDate2
Gets the User Defined Date-Time Field 2 value.
Public propertyUserDefinedDate3
Gets the User Defined Date-Time Field 3 value.
Public propertyUserDefinedDate4
Gets the User Defined Date-Time Field 4 value.
Public propertyUserDefinedDate5
Gets the User Defined Date-Time Field 5 value.
Public propertyUserDefinedFloat1
Gets the User Defined Float Field 1 value.
Public propertyUserDefinedFloat2
Gets the User Defined Float Field 2 value.
Public propertyUserDefinedFloat3
Gets the User Defined Float Field 3 value.
Public propertyUserDefinedFloat4
Gets the User Defined Float Field 4 value.
Public propertyUserDefinedFloat5
Gets the User Defined Float Field 5 value.
Public propertyUserDefinedNumber1
Gets the User Defined Number Field 1 value.
Public propertyUserDefinedNumber2
Gets the User Defined Number Field 2 value.
Public propertyUserDefinedNumber3
Gets the User Defined Number Field 3 value.
Public propertyUserDefinedNumber4
Gets the User Defined Number Field 4 value.
Public propertyUserDefinedNumber5
Gets the User Defined Number Field 5 value.
Public propertyUserDefinedString1
Gets the User Defined String Field 1 value.
Public propertyUserDefinedString10
Gets the User Defined String Field 10 value.
Public propertyUserDefinedString2
Gets the User Defined String Field 2 value.
Public propertyUserDefinedString3
Gets the User Defined String Field 3 value.
Public propertyUserDefinedString4
Gets the User Defined String Field 4 value.
Public propertyUserDefinedString5
Gets the User Defined String Field 5 value.
Public propertyUserDefinedString6
Gets the User Defined String Field 6 value.
Public propertyUserDefinedString7
Gets the User Defined String Field 7 value.
Public propertyUserDefinedString8
Gets the User Defined String Field 8 value.
Public propertyUserDefinedString9
Gets the User Defined String Field 9 value.
Top
Methods
  NameDescription
Public methodActivateInstallationLicenseFile(Int32, String, String)
Activates online using a specified License ID, and customer password or activation password
Public methodActivateInstallationLicenseFile(String, XmlActivationService, String)
Activates online using a specified License ID, customer password or activation password, and endpoint URL
Public methodActivateInstallationLicenseFile(String, String, String)
Activates online using the license's current License ID, the specified customer password or activation password, and endpoint URL
Public methodActivateInstallationLicenseFile(Int32, String, XmlActivationService, String)
Activates online using a specified License ID, customer password or activation password, and endpoint URL
Public methodActivateInstallationLicenseFile(Int32, String, String, String)
Activates online using the license's current License ID, the specified customer password or activation password, and endpoint URL
Public methodActivateOnline(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
Public methodActivateOnline(String, String)
Activates online using the license's current License ID, the specified customer password or activation password, and endpoint URL
Public methodActivateOnline(Int32, String, XmlActivationService)
Activates online using the specified License ID, customer password or activation password, and SoapHttpClientProtocol object.
Public methodActivateOnline(Int32, String, String)
Activates online using the specified License ID, customer password or activation password, and endpoint URL.
Public methodAddIdentifierAlgorithm
Adds a SystemIdentifierAlgorithm implementation to use for system identification and verification.
Public methodAddTimeServerCheck(String)
Add an SNTP server to the list of servers to check
Public methodAddTimeServerCheck(String, Int32)
Add an SNTP server to the list of servers to check
Public methodAddTimeServerCheck(String, Int32, Int32, Int32)
Add an SNTP server to the list of servers to check
Public methodCheckInstallationStatus
Checks the installation status for the given Installation ID against SOLO Server using the current value in the InstallationID property.
Public methodCheckInstallationStatus(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.
Public methodCheckInstallationStatus(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.
Public methodCheckTimeAgainstServers
Checks the system time against multiple time servers/sntp requests, allowing up to a 5 minute difference.
Public methodCheckTimeAgainstServers(Double)
Checks the system time against multiple time servers/sntp requests
Public methodDeactivateInstallation
Deactivates the license with SOLO Server using the InstallationID property.
Public methodDeactivateInstallation(String)
Deactivates the license with SOLO Server using the InstallationID property and the specified endpoint.
Public methodDeactivateInstallation(XmlActivationService)
Deactivates the license with SOLO Server using the InstallationID property and the specified endpoint.
Public methodDecrementLicenseCounter(Int32)
Decrements the License Counter value for the given Installation ID against SOLO Server using the current value in the InstallationID property.
Public methodDecrementLicenseCounter(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.
Public methodDecrementLicenseCounter(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.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetActivationInstallationLicenseFileRequest
Builds a manual activation XML request string
Public methodGetActivationRequest
Builds a manual activation XML request string
Public methodGetCheckInstallationStatusRequest
Builds a manual status check XML request string using the current value in the InstallationID property
Public methodGetDeactivateInstallationRequest
Builds a manual status check XML request string using the current value in the InstallationID property
Public methodGetDecrementLicenseCounterRequest
Builds a manual status check XML request string using the current value in the InstallationID property
Protected methodGetEncryptionKey
Gets the AuthorEncryptionKey object used for cryptographic routines.
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetLicenseRefreshRequest
Builds a manual license refresh XML request string using the current value in the InstallationID property
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInitializeCurrentIdentifiers
Initializes the CurrentIdentifiers property using the algorithms added using the AddIdentifierAlgorithm(SystemIdentifierAlgorithm) method.
Protected methodinitializeFromXml
Initializes properties from a plain-text XML license document.
Public methodLoad
Loads a License File from a String in memory.
Public methodLoadFile
Loads a License File from the file system and returns true if successful
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodProcessActivateInstallationLicenseFileResponse(String, String)
Processes an activation XML response string
Public methodProcessActivateInstallationLicenseFileResponse(XmlNode, String)
Processes an activation XML response
Public methodProcessActivationResponse(String)
Processes an activation XML response string
Public methodProcessActivationResponse(XmlNode)
Processes an activation XML response.
Public methodProcessCheckInstallationStatusResponse(String)
Processes a CheckInstallationStatus XML response string
Public methodProcessCheckInstallationStatusResponse(XmlNode)
Processes a CheckInstallationStatus XML response string
Public methodProcessDeactivateInstallationResponse(String)
Processes a DeactivateInstallation XML response string
Public methodProcessDeactivateInstallationResponse(XmlNode)
Processes a DeactivateInstallation XML response string
Public methodProcessDecrementLicenseCounterResponse(String)
Processes a DecrementLicenseCounter XML response string
Public methodProcessDecrementLicenseCounterResponse(XmlNode)
Processes a DecrementLicenseCounter XML response string
Public methodProcessLicenseRefreshResponse(String, String)
Processes an activation XML response string
Public methodProcessLicenseRefreshResponse(XmlNode, String)
Processes an License Refresh XML response
Public methodRefreshLicense(String)
Returns the current license file contents from SOLO Server using the current value in the InstallationID property.
Public methodRefreshLicense(String, String)
Returns the current license file contents from SOLO Server using the current value in the InstallationID property.
Public methodRefreshLicense(XmlLicenseFileService, String)
Returns the current license file contents from SOLO Server using the current value in the InstallationID property.
Public methodResetSessionCode
Creates a new session code in the CurrentSessionCode property
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Public methodWriteLicenseFile
Writes a License File to the file system.
Top
Remarks
Note 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