ActivateInstallation Class |
Namespace: com.softwarekey.Client.WebService.XmlActivationService
The ActivateInstallation type exposes the following members.
Name | Description | |
---|---|---|
![]() | ActivateInstallation(AuthorEncryptionKey) | Creates a new ActivateInstallation object. |
![]() | ActivateInstallation(XmlActivationService, AuthorEncryptionKey) | Creates a new ActivateInstallation object. |
Name | Description | |
---|---|---|
![]() | ActivationData | Gets or sets the Activation Data document, which contains the SystemIdentifier information. This field is optional, but recommended. This document may be generated using the SystemIdentifier.GenerateActivationDataXml method. |
![]() | ClassName | Gets or sets the class name of the WebServiceClient object. (Inherited from WebServiceCall.) |
![]() | EncryptionKey | Gets or sets the author encryption key data. (Inherited from WebServiceCall.) |
![]() | ErrorMessage | Gets or sets the error message returned by the web service method call. (See http://www.softwarekey.com/go/?ID=20 for a list of possible values.) (Inherited from WebServiceCall.) |
![]() | InstallationID | Gets or sets the Installation ID, which is a unique identifier for the given activation which was issued. If you specify the Installation ID of a prior activation, SOLO Server will show that the specified Installation ID is related to the new Installation ID (if issued). |
![]() | InstallationName | Gets or sets the Installation Name, which may be a name of your choice or the user's choice. You may opt to use things like a username or computer name here, or you may also allow the user to specify a friendly name. |
![]() | LastError | Gets or sets the last error which occurred. (Inherited from WebServiceCall.) |
![]() | LicenseID | Gets or sets the License ID, which is required for License ID and Password validation. |
![]() | MethodName | Gets or sets the name of the method which will be called from the WebServiceClient object. (Inherited from WebServiceCall.) |
![]() | Password | Gets or sets password, which is required for License ID and Password validation. |
![]() | ProdOptionID | Gets or sets the Product Option ID. When the value is non-zero, the Product Option ID in SOLO Server will be validated against the product for which the License ID was issued. |
![]() | ProductID | Gets or sets the Product ID. When the value is non-zero, the Product ID in SOLO Server will be validated against the product for which the License ID was issued. This is only required when using serial number and Product ID validation. |
![]() | ProductVersion | Gets or sets the product version number, which is optional. When set, this must be formatted like NNNNN.NNNNN.NNNNN.NNNNN format, where N represents a digit. |
![]() | ProductVersionNumber | Gets or sets the product version number, which is optional. This corresponds with the ProductVersion property, but uses the System.Version class to create the ProductVersion string. |
![]() | RegistrationKey1 | Gets or sets Activation Code 1. This is also known as "RegKey1" in Protection PLUS 4, and will be populated with a Protection PLUS 4 compatible activation code (or "Trigger Code") after processing the response successfully. |
![]() | RegistrationKey2 | Gets or sets Activation Code 2. This is also known as "RegKey2" in Protection PLUS 4, and may be populated with a Protection PLUS 4 compatible activation code (or "Trigger Code") after processing the response successfully. |
![]() | RequireRegistration | Gets or sets whether or not customer registration is required for activation. Customer registration is where the customer enters information (such as name, email, address, etc...) about himself or herself with SOLO Server. |
![]() | RequireSsl | Gets or sets whether or not SSL certificate validation to check. (Inherited from WebServiceCall.) |
![]() | ResultCode | Gets or sets the result code returned by the web service method call. (See http://www.softwarekey.com/go/?ID=20 for a list of possible values.) (Inherited from WebServiceCall.) |
![]() | SerialNumber | Gets or sets the serial number. This is only required when using serial number and Product ID validation. |
![]() | SessionCode | Gets or sets the randomized session code (used to deter replay attacks). (Inherited from WebServiceCall.) |
![]() | SessionCodeValidation | Gets or sets whether or not session code validation should be done automatically. (Inherited from WebServiceCall.) |
![]() | UseDigitalSignature | Gets or sets whether or not a digital signature is to be used or is required for the web service call. (This can only be set to false if UseEncryption is already set to false.) (Inherited from WebServiceCall.) |
![]() | UseEncryption | Gets or sets whether or not encryption is to be used or is required for the web service call. (Inherited from WebServiceCall.) |
![]() | UserCode1 | Gets or sets User Code 1. Although the web service requires a non-zero value in this field, this property is only relevant if you are using Protection PLUS 4 (where it is also referred to as the "Session Code") "Trigger Code" compatibility features. (The default value will suffice if you are not using these features.) |
![]() | UserCode2 | Gets or sets User Code 2. Although the web service requires a non-zero value in this field, this property is only relevant if you are using Protection PLUS 4 (where it is also referred to as the "Computer ID") "Trigger Code" compatibility features. (The default value will suffice if you are not using these features.) |
![]() | WebServiceClient | Gets or sets the SoapHttpClientProtocol object (.NET Framework) or the XmlWebService object (.NET Standard 2.0) used to perform the web service method call. (Inherited from WebServiceCall.) |
![]() | WebServiceResponse | Gets or set the XmlNode object reference for the root XML node of the web service response. (Inherited from WebServiceCall.) |
Name | Description | |
---|---|---|
![]() | AppendSessionCode(String) | Appends the SessionCode value to an XML request string depending on the SessionCodeValidation setting, and returns the updated XML string (Inherited from WebServiceCall.) |
![]() | AppendSessionCode(XmlDocument) | Appends the SessionCode value to an XmlDocument depending on the SessionCodeValidation setting, and returns the updated XML string (Inherited from WebServiceCall.) |
![]() | CallWebService | Calls the web service method. (Inherited from WebServiceCall.) |
![]() | 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.) |
![]() | GenerateEncryptedRequest | Generates an encrypted web service call XML request string. (Inherited from WebServiceCall.) |
![]() | GeneratePlainTextRequest | Generates a plain-text XML request string for ActivateInstallation calls. (Overrides WebServiceCallGeneratePlainTextRequest.) |
![]() | GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | ProcessResponse(String) | Processes a web service response XML string. (Inherited from WebServiceCall.) |
![]() | ProcessResponse(XmlNode) | Processes a web service response. (Overrides WebServiceCallProcessResponse(XmlNode).) |
![]() | ResetSessionCode | Sets the SessionCode value to a new, randomized value. (Inherited from WebServiceCall.) |
![]() | ToString | (Inherited from Object.) |
![]() | ValidateWebServiceResponseFormat | Verifies the format of the response received is such that expected and required content can be found and parsed. (Inherited from WebServiceCall.) |
The XmlActivationService documentation should be referenced for the most current information.
![]() |
---|
If you wish to call these web services for PLUSManaged License implementations, we recommend you use the License.ActivateOnline method, which implements this call for you. |
![]() |
---|
Any Product Options in SOLO Server which you intend to use when issuing License IDs which will be activated with this method must have the "Issue Installation ID" option enabled. Please refer to the SOLO Server manual for details. |
![]() |
---|
Before calling the CallWebService method, some properties must be set:
|
![]() |
---|
Properties strongly recommended to have set before calling the CallWebService method include:
|
public bool Activate(AuthorEncryptionKey encryptionKey, Int32 licenseId, string password, Int32 productID, string installationName, List<SystemIdentifier> currentIdentifiers, ref LicenseError lastError) { ActivateInstallation ws = new ActivateInstallation(encryptionKey); ws.LicenseID = licenseId; ws.Password = password; ws.ProductID = productID; ws.ProductVersionNumber = System.Reflection.Assembly.GetCallingAssembly().GetName().Version; ws.InstallationName = installationName; if (currentIdentifiers.Count > 0) ws.ActivationData = SystemIdentifier.GenerateActivationDataXml(currentIdentifiers); XmlActivationService client = new XmlActivationService(); // If you are using SOLO Server Dedicated URL or a self-hosted instance of SOLO Server, // set the client.Url property here. You may also configure proxy settings on this object here, if necessary. ws.WebServiceClient = client; if (!ws.CallWebService()) { lastError = ws.LastError; return false; } //TODO: Store the new Installation ID from the value in the ws.InstallationID property return true; }