• 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

Interface 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.

Namespace: Sp.Agent.Configuration
Assembly: Sp.Agent.dll
Remarks

Using the Sp.Agent.Configuration.Internal namespace opens access to low-level customization Apis. Typically one should be using an appropriate environment layer such as Sp.Agent.Crm.dll.

Examples
using Sp.Agent.Configuration;
using Sp.Agent.Configuration.Internal;

var context = AgentContext.For( "abc12" );
context.Configure( x=> x.Configure( x=>x.CompleteWithDefaults() ) );

Methods

DisableLocalBoundStorage()

Skips configuration of any license storage that binds licenses to the local execution environment. Used if all licenses will be sourced from HardwareBound, Removable or Distributed storage.

NB: Disabling local bound storage will disable Checkout functionality for Distributor.

Declaration
IAgentExternalStorageConfigurationPhase DisableLocalBoundStorage()
Returns
Type Description
IAgentExternalStorageConfigurationPhase

A reference to the next phase of the configuration pipeline.

Examples
            AgentContext.For( "abc12" )
                .Configure( agent => agent
                    .WithLocalBoundStorageDisabled()
                    .WithRemovableStorageDiscovery( () => SearchForRemovables() )
                    .WithDistributor( distributor => distributor
                        .WithDiscovery( () => baseUri )
                        .CompleteWithDefaults())
                    .CompleteWithDefaults() );
See Also
Configure(Func<IAgentCommenceConfigurationPhase, IAgentCompletedConfigurationPhase>)
IAgentCommenceConfigurationPhase

DisableLocalStore()

Skips configuration of any license storage that binds licenses to the local execution environment. Used if all licenses will be sourced from HardwareBound, Removable or Distributed storage.

NB: Disabling local bound storage will disable Checkout functionality for Distributor.

Declaration
IAgentHardwareBoundStorageConfigurationPhase DisableLocalStore()
Returns
Type Description
IAgentHardwareBoundStorageConfigurationPhase

A reference to the next phase of the configuration pipeline.

Examples
            AgentContext.For( "abc12" )
                .Configure( agent => agent
                    .WithLocalBoundStorageDisabled()
                    .WithHardwareBoundStorage(rootpath, dir => Initialize(dir))
                    .WithRemovableStorageDiscovery( () => SearchForRemovables() )
                    .WithDistributor( distributor => distributor
                        .WithDiscovery( () => baseUri )
                        .CompleteWithDefaults())
                    .CompleteWithDefaults() );
See Also
Configure(Func<IAgentCommenceConfigurationPhase, IAgentCompletedConfigurationPhase>)
IAgentCommenceConfigurationPhase

Extension Methods

CrmStartingConfigurationPhaseExtensions.WithCrmOnlineOrganizationStore(IAgentCommenceConfigurationPhase, Func<IServiceProvider>, String)
DistributorDisableStorageExtensions.DisableStorage(IAgentCommenceConfigurationPhase)
WebApplicationStoreConfigurationExtensions.WithFileStoreDirectoryInitializationAction(IAgentCommenceConfigurationPhase, Action<DirectoryInfo>)
WebApplicationStoreConfigurationExtensions.WithHttpApplicationIdStore(IAgentCommenceConfigurationPhase, String)
WebApplicationStoreConfigurationExtensions.WithHttpApplicationIdStore(IAgentCommenceConfigurationPhase, String, String)
LocalStoreConfigurationExtensions.WithLocalSharedStore(IAgentCommenceConfigurationPhase, String)
LocalStoreConfigurationExtensions.WithSingleUserStore(IAgentCommenceConfigurationPhase, String, String)
LocalStoreConfigurationExtensions.WithExternallyInitializedStore(IAgentCommenceConfigurationPhase, String)
LocalStoreConfigurationExtensions.WithApplicationInitializedStore(IAgentCommenceConfigurationPhase, String, Action<DirectoryInfo>)

See Also

IAgentCompletedConfigurationPhase
IAgentContext
AgentContext
Back to top Generated by DocFX