• 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

Namespace Sp.Agent.Configuration

Classes

AgentContext

Main entry point to the Software Potential Agent's Configuration and processing capabilities.

  • Configuration - Controls configuration of the Agent's Stores, Activation endpoints etc. in a manner appropriate to your application style/environment.
  • Agent Context, see IAgentContext - Provides licensing and configuration information not pertaining to a specific licensed product.
  • Product Context, see IProductContext - Provides information regarding a licensed product.

AgentContextDistributorsExtensions

Exposes a set of extension methods for IAgentContext related to Software Potential Distributor.

AgentDistributorsConfigurationExtensions

Enables the specification of the desired behavior with regard to discovering and managing connectivity to a Distributor Service.

Part of the Fluent Syntax chain used to fulfill the IAgentDistributorsConfigurationPhase of the AgentContext.Configure() Fluent Configuration Expression.

CloudStorageConfigurationExtensions

Provides extension methods for IAgentCloudStorageConfigurationPhase relevant to .

ConfigurationCompleteWithDefaultsExtensions

Exposes a set of extension methods that accept the defaults for any remaining configurable settings in a configuration call-chain.

CrmActivationEndpointsConfigurationPhaseExtensions

Provides extension methods for ICrmActivationEndpointsConfigurationPhase relevant to the Microsoft Dynamics CRM 2011 platform.

See WithCrmOnlineOrganizationStore(IAgentCommenceConfigurationPhase, Func<IServiceProvider>, String) for the preceding phase in the configuration sequence.

CrmAgentContextExtensions

Layers configuration extension methods onto IAgentContext appropriate to the Microsoft Dynamics CRM 2011 environment.

See EnsureConfigured(IAgentContext, Func<IAgentCommenceConfigurationPhase, IAgentCompletedConfigurationPhase>) for a usage example.

CrmStartingConfigurationPhaseExtensions

Provides extension methods for IAgentCommenceConfigurationPhase relevant to the Microsoft Dynamics CRM 2011 platform.

DistributorDisableStorageExtensions

Enables one to opt out of local or removable storage when using Sp.Agent.Distributor to consume Licenses (via WithDistributor(IAgentDistributorsConfigurationPhase, Func<IDistributorCommenceConfigurationPhase, IDistributorCompletedConfigurationPhase>)).

FileStoreInitialization

Provides helper facilities for initializing File-based License Stores.

HardwareStoreConfigurationExtensions

Provides extension methods for IAgentHardwareBoundStorageConfigurationPhase relevant to Hardware Locked licensed applications with licenses being stored on the associated machine.

HardwareStoreInitialization

Provides helper facilities for initializing File-based License Stores.

IStoreLicensesInitializationExtensions

Provides access to Store Initialization Apis. These become relevant when using a License Store that has an Initialization or Verification aspect. Examples of such Stores include the Local Store.

LocalStoreConfigurationExtensions

Provides extension methods for IAgentCommenceConfigurationPhase relevant to Machine Locked licensed applications with licenses being stored on the associated machine.

LocalStoreInitialization

Provides helper facilities for initializing File-based License Stores.

ProductContextDistributedExtensions

Exposes a set of extension methods for IProductContext related to Software Potential Distributor.

RemovableConfigurationExtensions

Provides methods to allow one to configure (or opt out of configuring) Removable Storage devices.

WebApplicationStoreConfigurationExtensions

Provides extension methods for IAgentCommenceConfigurationPhase relevant to ASP .NET applications.

Interfaces

IAgentChallengeConfigurationPhase

Part of the Software Potential Agent configuration pipeline.

Used to specify the challenge handling function to be used in conjunction with the removable device discovery function.

IAgentCloudStorageCommenceConfigurationPhase

The Commencement of the Cloud Storage configuration phases.

Allows one to select a cloud provider storage strategy. Currently only Azure Blob storage is supported.

IAgentCloudStorageCompleteConfigurationPhase

Completes the composition of the Fluent Configuration Expression.

IAgentCloudStorageConfigurationPhase

Allows one to control access to Cloud Licenses within a given AgentContext.

Extension methods provided by Sp.Agent.Cloud allow one to opt into relevant storage strategies.

IAgentCloudStorageConfigurationPhaseTail

IAgentCloudStorageCustomIdConfigurationPhase

IAgentCommenceConfigurationPhase

Commences the Software Potential Agent configuration pipeline.

Each specific application style/environment provides appropriate Extension Methods on this interface to provide an appropriate subset of customization options.

Following the fluent configuration sequence should yield a IAgentCompletedConfigurationPhase, which the IAgentContext .Configure( Func<IAgentCommenceConfigurationPhase, IAgentCompletedConfigurationPhase> ) or .EnsureConfigured( Func<IAgentCommenceConfigurationPhase, IAgentCompletedConfigurationPhase>) extension method expects.

NB IntelliSense will not offer any methods until you add a Reference to an appropriate environment layer such as Sp.Agent.Crm.dll.

IAgentCompletedConfigurationPhase

Terminates the Software Potential Agent configuration pipeline.

See IAgentCommenceConfigurationPhase for further information and examples pertaining to Configure() / EnsureConfigured() call sequences.

NB IntelliSense will not offer any methods until you add a Reference to an appropriate environment layer such as Sp.Agent.Crm.dll.

IAgentContext

Provides access to information and capabilities for a given Permuted Software Potential Agent.

See IAgentCommenceConfigurationPhase for examples and details of .Configure( ... ) or .EnsureConfigured( ... ) extension methods which can be layered onto this context.

See For(String) for examples and details of how to obtain an IAgentContext.

IAgentDistributorsConfigurationPhase

Allows one to control access to Distributed Licenses within a given AgentContext.

Extension methods provided by Sp.Agent.Distributor allow one to opt into relevant Discovery strategies.

IAgentEmbeddedLicensesConfigurationPhase

Allows one to control whether or not Licensed Code Execution should search for Embedded Licenses (for Execute only) that are embedded as part of the Code Protection process should no Stored License be available.

IAgentExternalStorageConfigurationPhase

Part of the Software Potential Agent configuration pipeline.

Each specific application style/environment provides appropriate Extension Methods on this interface to provide an appropriate subset of customization options.

NB IntelliSense will not offer any methods until you add a Reference to an appropriate storage extension such as Sp.Agent.Crm/Local/Iis/Removable.dll.

IAgentHardwareBoundStorageConfigurationPhase

IAgentUserBoundStorageConfigurationPhase

ICrmActivationEndpointsConfigurationPhase

Enables specification of an appropriate activation endpoint to be used when a ILicense is to be IActivateLicenses.

See WithCrmOnlineOrganizationStore(IAgentCommenceConfigurationPhase, Func<IServiceProvider>, String) for the preceding phase in the configuration sequence.

IDistributorCommenceConfigurationPhase

Part of Fluent Syntax flow used to build the composer argument of WithDistributor(IAgentDistributorsConfigurationPhase, Func<IDistributorCommenceConfigurationPhase, IDistributorCompletedConfigurationPhase>).

Enables the specification of the desired behavior with regard to discovering and managing connectivity to a Distributor Service.

IDistributorCompletedConfigurationPhase

Terminates a Fluent Syntax Composition expression starting from WithDistributor(IAgentDistributorsConfigurationPhase, Func<IDistributorCommenceConfigurationPhase, IDistributorCompletedConfigurationPhase>).

IDistributorConfigurationPhaseTail

Part of Fluent Syntax flow used to build the composer argument of WithDistributor(IAgentDistributorsConfigurationPhase, Func<IDistributorCommenceConfigurationPhase, IDistributorCompletedConfigurationPhase>).

Represents the last step in the customization chain starting from IDistributorCommenceConfigurationPhase.

IDistributorNamedUserConfigurationPhase

Part of Fluent Syntax flow used to build the composer argument of WithDistributor(IAgentDistributorsConfigurationPhase, Func<IDistributorCommenceConfigurationPhase, IDistributorCompletedConfigurationPhase>).

Enables the specification of the desired behavior with regard to the calculation of a Named User.

IInitializeStores

Provides access to Store Initialization facilities.

These Apis apply to Configured License Stores that have an Initialization or Verification aspect. Examples of such Stores include the Local Store (when configured using .WithApplicationInitializedStore()).

See the IStoreLicenses.Initialization() extension method in the Sp.Agent.Configuration namespace for the relevant navigation path.

Back to top Generated by DocFX