Interface IActivateLicensesAdvanced

Provides advanced facilities for management of the Activation process such as:

1. Manual Activation - creation of a textual activation request which an end-user can transmit to the Vendor's systems via mechanisms such as email.
2. Disconnected Activation - creation of a Deferred Activation request on the machine that is to have the license installed which can then be submitted to the Software Potential Activation service at a later point in time - e.g., on another machine that doesn't have firewall restrictions imposed on it.
3. Installation of licenses resulting from Manual or Disconnected activation.

Namespace: Sp.Agent.Activation

Assembly: Sp.Agent.dll

Properties

ActivationUrl

Returns the configured Software Potential activation service endpoint.

Declaration

[Obsolete("Now parameterized by number previousAttempts, please use GenerateActivationAddress() instead")]
Uri ActivationUrl { get; }

Property Value

Type	Description
System.Uri	Activation endpoint URL.

Examples

"http://srv.softwarepotential.com/SLMServerWS/ActivationWS.svc";

Methods

CreateDeferredRequest(String, Object)

Generates a request blob which can then be transmitted to the Software Potential service in order to generate a ILicense that is appropriate for the configured licensing context.

See AgentContext for details of configuring stores.

Declaration

byte[] CreateDeferredRequest(string activationKey, object state)

Parameters

Type	Name	Description
System.String	activationKey	The activation key for the License entity in the Software Potential service.
System.Object	state	propagated to Activation Customizations such as the Action supplied to WithTagging(Action<IActivationTaggingContext>).

Returns

Type	Description
System.Byte[]	An activation request blob that can be submitted to the Software Potential service at a later point viaSendDeferredRequestAsync().

Exceptions

Type	Condition
System.ArgumentOutOfRangeException	thrown if activationKey does not represent a well-formed key, as defined by IsWellFormedKey().

CreateManualActivationRequest(String, Object)

Generates a textual representation of the request blob which can be used to download a binary license file from the Software Potential service.

Textual requests can be submitted e.g., via email where an Online Activation would not be appropriate, e.g., due to lack of network connectivity.

See AgentContext for details of configuring stores.

Declaration

string CreateManualActivationRequest(string activationKey, object state)

Parameters

Type	Name	Description
System.String	activationKey	The activation key for the license entity in the Software Potential service.
System.Object	state	propagated to Activation Customizations such as the Action supplied to WithTagging(Action<IActivationTaggingContext>).

Returns

Type	Description
System.String	Manual Activation request string ready for submission to the Software Potential service (in return for a .BIN license file)

Remarks

Submission of the textual request to the Software Potential service yields a .BIN License File. Such a license can be installed at a later point in time via Install(Byte[])

Exceptions

Type	Condition
System.ArgumentOutOfRangeException	thrown if activationKey does not represent a well-formed key, as defined by IsWellFormedKey().

See Also

Install(Byte[])

GenerateActivationAddress(Int32)

Returns the Software Potential activation service endpoint that is appropriate for use after previous attempts.

Declaration

Uri GenerateActivationAddress(int previousAttempts)

Parameters

Type	Name	Description
System.Int32	previousAttempts

Returns

Type	Description
System.Uri	Activation endpoint URL.

Examples

"http://srv.softwarepotential.com/SLMServerWS/ActivationWS.svc";

SendDeferredRequestAsync(Byte[])

Transmits a request blob generated by CreateDeferredRequest() to the Software Potential service in order to retrieve a license blob which is appropriate for the configured licensing context.

Such a license can be installed at a later point in time via Install(Byte[]).

Declaration

Task<byte[]> SendDeferredRequestAsync(byte[] requestBlob)

Parameters

Type	Name	Description
System.Byte[]	requestBlob	The license activation request blob to be transmitted to the Software Potential service (previously obtained from CreateRequest()).

Returns

Type	Description
System.Threading.Tasks.Task<System.Byte[]>

Exceptions

Type	Condition
System.ArgumentNullException	thrown if requestBlob is null.
System.AggregateException	Transmission may (internally) be automatically retried as dictated by IProductActivationTransmissionCommenceConfigurationPhase. As a result, an System.AggregateException reflecting the outcomes of multiple activation attempts may be thrown.
ActivationServerException	Thrown if the Software Potential service refuses the Activation Request. For some causes, there are specific derived Types reflecting the indicated reason.
ActivationTransmissionException	Thrown if it was not possible to communicate with the Software Potential Activation service.