Click or drag to resize
CheckInstallationStatus Class
Implements the XmlActivationService web service's CheckInstallationStatus method to validate the status of an Installation ID.
Inheritance Hierarchy
SystemObject
  com.softwarekey.Client.WebServiceWebServiceCall
    com.softwarekey.Client.WebService.XmlActivationServiceCheckInstallationStatus

Namespace: com.softwarekey.Client.WebService.XmlActivationService
Assembly: PLUSManaged (in PLUSManaged.dll) Version: 5.17.4.0
Syntax
public class CheckInstallationStatus : WebServiceCall

The CheckInstallationStatus type exposes the following members.

Constructors
  NameDescription
Public methodCheckInstallationStatus(AuthorEncryptionKey)
Creates a new CheckInstallationStatus object.
Public methodCheckInstallationStatus(XmlActivationService, AuthorEncryptionKey)
Creates a new CheckInstallationStatus object.
Top
Properties
  NameDescription
Public propertyActivationData
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.
Public propertyClassName
Gets or sets the class name of the WebServiceClient object.
(Inherited from WebServiceCall.)
Public propertyEncryptionKey
Gets or sets the author encryption key data.
(Inherited from WebServiceCall.)
Public propertyErrorMessage
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.)
Public propertyExpirationDate
Gets the Installation/License's expiration date from SOLO Server.
Public propertyInstallationID
Gets or sets the Installation ID (required), which is a unique identifier for the given activation which was issued.
Public propertyLastError
Gets or sets the last error which occurred.
(Inherited from WebServiceCall.)
Public propertyLog
Gets or sets the optional XmlDocument containing metering usage log data. (This is for Instant Metering users.)
Public propertyMethodName
Gets or sets the name of the method which will be called from the WebServiceClient object.
(Inherited from WebServiceCall.)
Public propertyProductVersion
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.
Public propertyProductVersionNumber
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.
Public propertyRequireSsl
Gets or sets whether or not SSL certificate validation to check.
(Inherited from WebServiceCall.)
Public propertyResultCode
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.)
Public propertySessionCode
Gets or sets the randomized session code (used to deter replay attacks).
(Inherited from WebServiceCall.)
Public propertySessionCodeValidation
Gets or sets whether or not session code validation should be done automatically.
(Inherited from WebServiceCall.)
Public propertyUseDigitalSignature
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.)
Public propertyUseEncryption
Gets or sets whether or not encryption is to be used or is required for the web service call.
(Inherited from WebServiceCall.)
Public propertyWebServiceClient
Gets or sets the SoapHttpClientProtocol object used to perform the web service method call.
(Inherited from WebServiceCall.)
Public propertyWebServiceResponse
Gets or set the XmlNode object reference for the root XML node of the web service response.
(Inherited from WebServiceCall.)
Top
Methods
  NameDescription
Protected methodAppendSessionCode(String)
Appends the SessionCode value to an XML request string depending on the SessionCodeValidation setting, and returns the updated XML string
(Inherited from WebServiceCall.)
Protected methodAppendSessionCode(XmlDocument)
Appends the SessionCode value to an XmlDocument depending on the SessionCodeValidation setting, and returns the updated XML string
(Inherited from WebServiceCall.)
Public methodCallWebService
Calls the web service method.
(Inherited from WebServiceCall.)
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGenerateEncryptedRequest
Generates an encrypted web service call XML request string.
(Inherited from WebServiceCall.)
Public methodGeneratePlainTextRequest
Generates a plain-text XML request string for CheckInstallationStatus calls.
(Overrides WebServiceCallGeneratePlainTextRequest.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodProcessResponse(String)
Processes a web service response XML string.
(Inherited from WebServiceCall.)
Public methodProcessResponse(XmlNode)
Processes a web service response.
(Overrides WebServiceCallProcessResponse(XmlNode).)
Public methodResetSessionCode
Sets the SessionCode value to a new, randomized value.
(Inherited from WebServiceCall.)
Public methodToString (Inherited from Object.)
Top
Remarks

The XmlActivationService documentation should be referenced for the most current information.

Caution note Caution

If you wish to call these web services for PLUSManaged License implementations, we recommend you use the License.CheckInstallationStatus method, which implements this call for you.

Caution note Caution

Any Product Options in SOLO Server which you intend to use when issuing License IDs which will be validated with this method must have the "Issue Installation ID" option enabled, and must be activated with ActivateInstallation or ActivateInstallationLicenseFile. Please refer to the SOLO Server manual for details.

Examples
This example shows how to make a typical activation call for a PLUSManaged license:
public bool CheckInstallation(AuthorEncryptionKey encryptionKey,
    string installationId, ref LicenseError lastError)
{
    //make sure we have an Installation ID to use first
    if (string.IsNullOrEmpty(installationId))
    {
        lastError = new LicenseError(LicenseError.ERROR_INSTALLATIONID_REQUIRED);
        return false;
    }

    CheckInstallationStatus ws = new CheckInstallationStatus(encryptionKey);
    ws.InstallationID = installationId;
    ws.ProductVersionNumber = System.Reflection.Assembly.GetCallingAssembly().GetName().Version;

    XmlActivationService client = new XmlActivationService();
    // If you are using Instant 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())
    {
        //If you wish to revoke the local license when web-based validation fails, you can add code to do so here.
        lastError = ws.LastError;
        return false;
    }

    return true;
}
See Also