Click or drag to resize
WebServiceCall Class

The base/abstract class from which all WebServiceCall implementations are derived. Key functions of this class include:

  • Signing and encrypting web service requests.
  • Decrypting and verifying web service responses.
  • Validation of session codes (to prevent replay attacks).
  • Providing a common means in which web service requests may be generated and responses may be processed, regardless of whether or not direct Internet connectivity is being used.

Web services presently implemented include:

NameDescription
XmlActivationServiceIncludes methods for Electronic License Activation, status checking, and deactivation.
XmlLicenseFileServiceUsed for retrieving and refreshing License Files electronically.
XmlLicenseServiceUsed for retrieving and sending license data (such as checks for product updates, customer registration, etc...).
XmlNetworkFloatingServiceUsed for SOLO Server-based Network Floating licensing implementations. This allows limiting the number of concurrent users/open sessions, status checking, closing sessions, and provides a means to "check-out" sessions for off-line use (when allowed) and to "check-in" any checked-out sessions when off-line use is no longer required.

Remarks
Note Note
By default, the .NET Framework sets the user-agent in the HTTP header to "Mozilla/4.0 (compatible; MSIE 6.0; MS Web Services Client Protocol x.x.x.x)" where x.x.x.x is the version of the common language runtime. It is possible to specify the user-agent value when using the web service references by modifying the HttpWebClientProtocol.UserAgent property .
Inheritance Hierarchy
SystemObject
  com.softwarekey.Client.WebServiceWebServiceCall
    More...

Namespace: com.softwarekey.Client.WebService
Assembly: PLUSManaged (in PLUSManaged.dll) Version: 5.23.4.0
Syntax
public abstract class WebServiceCall : IWebServiceCall

The WebServiceCall type exposes the following members.

Constructors
  NameDescription
Public methodWebServiceCall
Creates a new WebServiceCall object.
Top
Properties
  NameDescription
Public propertyClassName
Gets or sets the class name of the WebServiceClient object.
Public propertyEncryptionKey
Gets or sets the author encryption key data.
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.)
Public propertyLastError
Gets or sets the last error which occurred.
Public propertyMethodName
Gets or sets the name of the method which will be called from the WebServiceClient object.
Public propertyRequireSsl
Gets or sets whether or not SSL certificate validation to check.
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.)
Public propertySessionCode
Gets or sets the randomized session code (used to deter replay attacks).
Public propertySessionCodeValidation
Gets or sets whether or not session code validation should be done automatically.
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.)
Public propertyUseEncryption
Gets or sets whether or not encryption is to be used or is required for the web service call.
Public propertyWebServiceClient
Gets or sets the SoapHttpClientProtocol object (.NET Framework) or the XmlWebService object (.NET Standard 2.0) used to perform the web service method call.
Public propertyWebServiceResponse
Gets or set the XmlNode object reference for the root XML node of the web service response.
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
Protected methodAppendSessionCode(XmlDocument)
Appends the SessionCode value to an XmlDocument depending on the SessionCodeValidation setting, and returns the updated XML string
Public methodCallWebService
Calls the web service method.
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 methodGenerateEncryptedRequest
Generates an encrypted web service call XML request string.
Public methodGeneratePlainTextRequest
Generates a plain-text web service call XML request string.
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodStatic memberParseSOLOServerStatus
Parses a status string returned by SOLO Server web services.
Public methodProcessResponse(String)
Processes a web service response XML string.
Public methodProcessResponse(XmlNode)
Processes a web service response XML.
Public methodResetSessionCode
Sets the SessionCode value to a new, randomized value.
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Public methodValidateWebServiceResponseFormat
Verifies the format of the response received is such that expected and required content can be found and parsed.
Top
See Also
Inheritance Hierarchy
SystemObject
  com.softwarekey.Client.WebServiceWebServiceCall
    com.softwarekey.Client.WebService.XmlActivationServiceActivateInstallation
    com.softwarekey.Client.WebService.XmlActivationServiceActivateInstallationLicenseFile
    com.softwarekey.Client.WebService.XmlActivationServiceCheckInstallationStatus
    com.softwarekey.Client.WebService.XmlActivationServiceDeactivateInstallation
    com.softwarekey.Client.WebService.XmlActivationServiceDecrementLicenseCounter
    com.softwarekey.Client.WebService.XmlLicenseFileServiceGetLicenseFile
    com.softwarekey.Client.WebService.XmlLicenseServiceInfoCheck
    com.softwarekey.Client.WebService.XmlLicenseServiceRegister
    com.softwarekey.Client.WebService.XmlLicenseServiceUpdateCheck
    com.softwarekey.Client.WebService.XmlLicenseServiceValidateRegistration
    com.softwarekey.Client.WebService.XmlNetworkFloatingServiceNetworkFloatingServiceCall