• Webservices API
  • Agent Runtime API
  • Support
  • Samples
  • Software Potential Home
Show / Hide Table of Contents
  • Sp.Agent
    • ActivateLicensesExtensions
    • IProductContext
    • ProductActivationConfigurationCompleteWithDefaultsExtensions
    • ProductActivationConfigurationDefaultExtensions
  • Sp.Agent.Activation
    • ActivationServerException
    • ActivationTransmissionException
    • DeviceChangedActivationServerException
    • DistributorLicenseActivationServerException
    • IActivateLicenses
    • IActivateLicensesAdvanced
    • InvalidLicenseKeyException
    • InvalidVersionActivationServerException
    • LicenseDisabledActivationServerException
    • LicenseExpiredActivationServerException
    • LinkedLicenseAmbiguousStorageActivationServerException
    • LinkedLicenseNoStorageActivationServerException
    • NumberOfActivationsExceededActivationServerException
    • ProductIdMismatchActivationServerException
    • RenewalNotAuthorizedActivationServerException
    • TagsChangedActivationServerException
  • Sp.Agent.Configuration
    • AgentContext
    • AgentContextDistributorsExtensions
    • AgentDistributorsConfigurationExtensions
    • CloudStorageConfigurationExtensions
    • ConfigurationCompleteWithDefaultsExtensions
    • CrmActivationEndpointsConfigurationPhaseExtensions
    • CrmAgentContextExtensions
    • CrmStartingConfigurationPhaseExtensions
    • DistributorDisableStorageExtensions
    • FileStoreInitialization
    • HardwareStoreConfigurationExtensions
    • HardwareStoreInitialization
    • IAgentChallengeConfigurationPhase
    • IAgentCloudStorageCommenceConfigurationPhase
    • IAgentCloudStorageCompleteConfigurationPhase
    • IAgentCloudStorageConfigurationPhase
    • IAgentCloudStorageConfigurationPhaseTail
    • IAgentCloudStorageCustomIdConfigurationPhase
    • IAgentCommenceConfigurationPhase
    • IAgentCompletedConfigurationPhase
    • IAgentContext
    • IAgentDistributorsConfigurationPhase
    • IAgentEmbeddedLicensesConfigurationPhase
    • IAgentExternalStorageConfigurationPhase
    • IAgentHardwareBoundStorageConfigurationPhase
    • IAgentUserBoundStorageConfigurationPhase
    • ICrmActivationEndpointsConfigurationPhase
    • IDistributorCommenceConfigurationPhase
    • IDistributorCompletedConfigurationPhase
    • IDistributorConfigurationPhaseTail
    • IDistributorNamedUserConfigurationPhase
    • IInitializeStores
    • IStoreLicensesInitializationExtensions
    • LocalStoreConfigurationExtensions
    • LocalStoreInitialization
    • ProductContextDistributedExtensions
    • RemovableConfigurationExtensions
    • WebApplicationStoreConfigurationExtensions
  • Sp.Agent.Configuration.Product
    • IProductCommenceConfigurationPhase
    • IProductCompletedConfigurationPhase
    • IProductConfigurationPhaseTail
  • Sp.Agent.Configuration.Product.Activation
    • IActivationAttemptContext
    • IActivationDeviceLabelContext
    • IActivationTaggingContext
    • IProductActivationCommenceConfigurationPhase
    • IProductActivationCompletedConfigurationPhase
    • IProductActivationConfigurationPhase
    • IProductActivationConfigurationPhaseTail
    • IProductActivationDeviceLabelConfigurationPhase
    • IProductActivationDeviceLabelTailConfigurationPhase
    • IProductActivationTransmissionCommenceConfigurationPhase
    • IProductActivationTransmissionCompletedConfigurationPhase
    • IProductActivationTransmissionConfigurationPhase
    • IProductActivationTransmissionConfigurationPhaseTail
    • IProductActivationTransmissionEndpointConfigurationPhase
    • IProductActivationTransmissionHooksConfigurationPhase
    • IProductActivationTransmissionProxyConfigurationPhase
    • ProductActivationConfigurationException
  • Sp.Agent.Distributor
    • CheckedOutNotLicensedException
    • CheckoutRequiresStorageException
    • CheckoutStorageAccessException
    • DistributorIntegrityException
    • DistributorIntegrityNotLicensedException
    • DistributorNotLicensedException
    • DistributorRequestException
    • IAvailableCheckout
    • ICheckout
    • ICheckoutContext
    • IDistributedContext
    • IDistributorsContext
    • NoDistributorException
    • NoLongerAvailableException
    • NotLicnesedInvalidNamedUserException
  • Sp.Agent.Execution
    • NotLicensedException
  • Sp.Agent.Licensing
    • IFeature
    • ILicense
    • ILicenseAdvanced
    • ILicensePeriod
    • ILicenseRenewal
    • IQueryFeatures
    • IQueryLicenses
    • IQueryLocalFeatures
    • IQueryUserTokens
    • IUserToken
    • LicenseRevisionException
  • Sp.Agent.Storage
    • DistributorLicenseOnClientException
    • InvalidStorageAccessException
    • InvalidStorageException
    • IStore
    • IStoreLicenses
    • IStoreUserTokens
    • LicenseNotFoundException
    • LicenseTargetEnvironmentMismatchException
    • NonmatchingProductIdException
    • ReadingStorageInaccessibleException
    • ServerOSNotAllowedException
    • StorageInaccessibleException
    • StoreNotEmptyException
    • UserTokenNotFoundException
    • VirtualMachineNotAllowedException
    • WritingStorageInaccessibleException

Class ProductActivationConfigurationDefaultExtensions

Defines standard behaviors for IActivateLicenses Activation time behavior. Used in conjunction with IProductActivationCommenceConfigurationPhase.

Namespace: Sp.Agent
Assembly: Sp.Agent.dll

Methods

Default(IProductActivationConfigurationPhase)

Accepts the defaults for all IProductActivationConfigurationPhase configuration aspects. See Customize(Func<IProductActivationCommenceConfigurationPhase, IProductActivationCompletedConfigurationPhase>).

Declaration
public static IProductConfigurationPhaseTail Default(this IProductActivationConfigurationPhase that)
Parameters
Type Name Description
IProductActivationConfigurationPhase that
Returns
Type Description
IProductConfigurationPhaseTail
Remarks

Equivalent to selecting all defaults :-

.Customize( activationConfig => activationConfig
.WithTaggingDefault()
.WithTransmissionDefault()
.BeforeEachAttempt( _ => { } )
.WithProxyConfigurationDefault()
.CompleteWithDefaults() )

WithDeviceLabelPolicyDefault(IProductActivationDeviceLabelConfigurationPhase)

Accepts the default rules and behaviors for the transmission of Activation Requests.

Declaration
public static IProductActivationDeviceLabelTailConfigurationPhase WithDeviceLabelPolicyDefault(this IProductActivationDeviceLabelConfigurationPhase that)
Parameters
Type Name Description
IProductActivationDeviceLabelConfigurationPhase that
Returns
Type Description
IProductActivationDeviceLabelTailConfigurationPhase
See Also
Default(IProductActivationConfigurationPhase)
Customize(Func<IProductActivationCommenceConfigurationPhase, IProductActivationCompletedConfigurationPhase>)

WithEndpointSelectionPolicyDefault(IProductActivationTransmissionEndpointConfigurationPhase)

Accepts the default behavior for the selection of which endpoint to use when communicating with an Activation Server.

Declaration
public static IProductActivationTransmissionHooksConfigurationPhase WithEndpointSelectionPolicyDefault(this IProductActivationTransmissionEndpointConfigurationPhase that)
Parameters
Type Name Description
IProductActivationTransmissionEndpointConfigurationPhase that
Returns
Type Description
IProductActivationTransmissionHooksConfigurationPhase
Remarks

Presently, the default policy is to default to using https, but try the http endpoint for every third Activation attempt. The main aim of this strategy is to maximize the likelihood of being able to traverse any proxies between the end-user machine and the Software Potential Activation servers.

See Also
Default(IProductActivationConfigurationPhase)
Customize(Func<IProductActivationCommenceConfigurationPhase, IProductActivationCompletedConfigurationPhase>)
WithRetryPolicyDefault(IProductActivationTransmissionCommenceConfigurationPhase)
WithEndpointSelectionPolicyHttpsOnly(IProductActivationTransmissionEndpointConfigurationPhase)

WithEndpointSelectionPolicyHttpsOnly(IProductActivationTransmissionEndpointConfigurationPhase)

Constrains the endpoint selection algorithm to only use https:// endpoints when communicating with an Activation Server.

Declaration
public static IProductActivationTransmissionHooksConfigurationPhase WithEndpointSelectionPolicyHttpsOnly(this IProductActivationTransmissionEndpointConfigurationPhase that)
Parameters
Type Name Description
IProductActivationTransmissionEndpointConfigurationPhase that
Returns
Type Description
IProductActivationTransmissionHooksConfigurationPhase
Remarks

A key impact of selecting this policy (when compared to WithEndpointSelectionPolicyDefault(IProductActivationTransmissionEndpointConfigurationPhase)) is that there is a higher likelihood of a proxy being configured in such a manner that it will not allow the Activation attempt to be transmitted as an Online Activation Request, leading to the need to use CreateDeferredRequest(String, Object) and/or CreateManualActivationRequest(String, Object).

See Also
Default(IProductActivationConfigurationPhase)
Customize(Func<IProductActivationCommenceConfigurationPhase, IProductActivationCompletedConfigurationPhase>)
WithRetryPolicyDefault(IProductActivationTransmissionCommenceConfigurationPhase)
WithEndpointSelectionPolicyDefault(IProductActivationTransmissionEndpointConfigurationPhase)

WithRetryPolicyDefault(IProductActivationTransmissionCommenceConfigurationPhase)

Accepts the default behavior for retrying the transmission of Activation Requests should a failure occur.

Declaration
public static IProductActivationTransmissionEndpointConfigurationPhase WithRetryPolicyDefault(this IProductActivationTransmissionCommenceConfigurationPhase that)
Parameters
Type Name Description
IProductActivationTransmissionCommenceConfigurationPhase that
Returns
Type Description
IProductActivationTransmissionEndpointConfigurationPhase
Remarks

Presently, the default policy is to make a maximum of 3 attempts.

See Also
Default(IProductActivationConfigurationPhase)
Customize(Func<IProductActivationCommenceConfigurationPhase, IProductActivationCompletedConfigurationPhase>)

WithTaggingDefault(IProductActivationCommenceConfigurationPhase)

Accepts the default processing rules for the inclusion of Tags at IActivateLicenses time.

If a state argument implementing IEnumerable<KeyValuePair<string, string>> is supplied to the Activation methods (e.g. such as Dictionary), it will be treated as a set of tags, each of which will be submitted to the Activation Server for inclusion in the License.

If a state argument not matching the above is supplied, a ProductActivationConfigurationException is thrown.

Declaration
public static IProductActivationTransmissionConfigurationPhase WithTaggingDefault(this IProductActivationCommenceConfigurationPhase that)
Parameters
Type Name Description
IProductActivationCommenceConfigurationPhase that
Returns
Type Description
IProductActivationTransmissionConfigurationPhase
Remarks

Equivalent to:

.WithTagging( context =>
{
foreach ( var kv in (IEnumerable<KeyValuePair<string, string>>)context.State )
        context.AddTag( kv.Key, kv.Value );
} )
Exceptions
Type Condition
ProductActivationConfigurationException

Thrown in response to Activate method invocation if the state argument is not null but does not implement IEnumerable<KeyValuePair<string, string>>.

See Also
Default(IProductActivationConfigurationPhase)
Customize(Func<IProductActivationCommenceConfigurationPhase, IProductActivationCompletedConfigurationPhase>)

WithTransmissionDefault(IProductActivationTransmissionConfigurationPhase)

Accepts the default rules and behaviors for the transmission of Activation Requests.

Declaration
public static IProductActivationDeviceLabelConfigurationPhase WithTransmissionDefault(this IProductActivationTransmissionConfigurationPhase that)
Parameters
Type Name Description
IProductActivationTransmissionConfigurationPhase that
Returns
Type Description
IProductActivationDeviceLabelConfigurationPhase
Remarks

Equivalent to:

.WithTransmission( activationTransmission => activationTransmission
.WithRetryPolicyDefault()
.WithEndpointSelectionPolicyDefault()
.CompleteWithDefaults() )
See Also
Default(IProductActivationConfigurationPhase)
Customize(Func<IProductActivationCommenceConfigurationPhase, IProductActivationCompletedConfigurationPhase>)
Back to top Generated by DocFX