Class WebApplicationStoreConfigurationExtensions

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

Namespace: Sp.Agent.Configuration

Assembly: Sp.Agent.Iis.dll

Methods

WithFileStoreDirectoryInitializationAction(IAgentCommenceConfigurationPhase, Action<DirectoryInfo>)

Registers an Action for the Software Potential Agent to invoke when initializing a Web Application Store license directory.

Declaration

public static IAgentCommenceConfigurationPhase WithFileStoreDirectoryInitializationAction(this IAgentCommenceConfigurationPhase that, Action<DirectoryInfo> initialize)

Parameters

Type	Name	Description
IAgentCommenceConfigurationPhase	that	Starting point of Sp.Agent configuration pipeline.
System.Action<System.IO.DirectoryInfo>	initialize	Action that initializes a License Store directory for a given combination of Product / Version / Hosting context.

Returns

Type	Description
IAgentCommenceConfigurationPhase	A reference to the same phase. Typically this is followed by a call to .WithHttpApplicationStore().

WithHttpApplicationIdStore(IAgentCommenceConfigurationPhase, String)

Configures the Software Potential Agent to maintain its licenses in the file system, locked to the currently running IIS 6 or later Web Application.

Declaration

public static IAgentHardwareBoundStorageConfigurationPhase WithHttpApplicationIdStore(this IAgentCommenceConfigurationPhase that, string licenseStoreRootPath)

Parameters

Type	Name	Description
IAgentCommenceConfigurationPhase	that	Starting point of Sp.Agent configuration pipeline.
System.String	licenseStoreRootPath	License store root directory.

Returns

Type	Description
IAgentHardwareBoundStorageConfigurationPhase	A reference to the next phase of the configuration pipeline.

Remarks

Every combination of IIS Application name/Software potential product sharing a given licenseStoreRootPath will have an isolated store subdirectory within which that set of licenses are maintained.

Note: If one intends to Initialize a store via IInitializeStores.Initialize(), it is mandatory to first supply a directory initialization Action first via WithFileStoreDirectoryInitializationAction().

WithHttpApplicationIdStore(IAgentCommenceConfigurationPhase, String, String)

Configures the Software Potential Agent to maintain its licenses in the file system, tied to a nominated Web application hosted in IIS.

Declaration

public static IAgentHardwareBoundStorageConfigurationPhase WithHttpApplicationIdStore(this IAgentCommenceConfigurationPhase that, string licenseStoreRootPath, string webApplicationIdOverride)

Parameters

Type	Name	Description
IAgentCommenceConfigurationPhase	that	Starting point of Sp.Agent configuration pipeline.
System.String	licenseStoreRootPath	License store root directory.
System.String	webApplicationIdOverride	IIS Web Application Id in IIS metabase format (i.e., /LM/W3SVC/<SiteId>/ROOT/<WebApplicationName> see http://technet.microsoft.com/en-us/library/cc784572%28v=ws.10%29.aspx). Note that specifying this override only applies to IInitializeStores and IActivateLicenses.

Returns

Type	Description
IAgentHardwareBoundStorageConfigurationPhase	A reference to the next phase of the configuration pipeline.

Remarks

Every combination of webApplicationIdOverride/Software potential product sharing a given licenseStoreRootPath will have an isolated store subdirectory within which that set of licenses are maintained.

Note: If one intends to Initialize a store via IInitializeStores.Initialize(), it is mandatory to first supply a directory initialization Action first via WithFileStoreDirectoryInitializationAction().