Class ModuleFinder

Discovers modules in a folder structure and registers them into the application

Inheritance

System.Object

ModuleFinder

Implements

IModuleFinder

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: EPiServer.Shell.Modules

Assembly: EPiServer.Shell.dll

Version: 8.11.0

Syntax

public class ModuleFinder : IModuleFinder

Remarks

This class is used internally by EPiServer and should not be instantiated.

Constructors

ModuleFinder(VirtualPathProvider, ITypeScannerLookup)

Initializes a new instance of the ModuleFinder class.

Declaration

public ModuleFinder(VirtualPathProvider virtualPathProvider, ITypeScannerLookup typeScannerLookup)

Parameters

Type	Name	Description
System.Web.Hosting.VirtualPathProvider	virtualPathProvider	The virtual path provider.
ITypeScannerLookup	typeScannerLookup	The type scanner lookup.

ModuleFinder(VirtualPathProvider, BinariesFinder, ITypeScannerLookup)

Initializes a new instance of the ModuleFinder class.

Declaration

public ModuleFinder(VirtualPathProvider virtualPathProvider, BinariesFinder binariesFinder, ITypeScannerLookup typeScannerLookup)

Parameters

Type	Name	Description
System.Web.Hosting.VirtualPathProvider	virtualPathProvider	The VPP.
BinariesFinder	binariesFinder	The BinariesFinder instance.
ITypeScannerLookup	typeScannerLookup	The type scanner lookup.

Fields

ProtectedModulesFolderName

By default a folder named "_Protected" is always ignored by the module finder

Declaration

public const string ProtectedModulesFolderName = "_Protected"

Field Value

Type	Description
System.String

Methods

GetModuleInDirectory(String, String, IEnumerable<String>, AutoDiscoveryLevel, String)

Extracts and loads a module in a directory

Declaration

public virtual ShellModule GetModuleInDirectory(string routeBasePath, string moduleResourcePath, IEnumerable<string> configuredAssemblyNames, AutoDiscoveryLevel discoveryMode, string configuredName)

Parameters

Type	Name	Description
System.String	routeBasePath	The base path for the routes.
System.String	moduleResourcePath	The virtual path to module resources
System.Collections.Generic.IEnumerable<System.String>	configuredAssemblyNames	Assemblies that are always loaded and associated with the module.
AutoDiscoveryLevel	discoveryMode	What level the auto discovery should be.
System.String	configuredName	Configured module name.

Returns

Type	Description
ShellModule	A shell module.

GetModulesInSubdirectories(String, AutoDiscoveryLevel)

Get modules from sub-directories of the supplied directory.

Declaration

public virtual IList<ShellModule> GetModulesInSubdirectories(string rootPath, AutoDiscoveryLevel discoveryMode)

Parameters

Type	Name	Description
System.String	rootPath	The root folder for modules to discover.
AutoDiscoveryLevel	discoveryMode	The level to use for the auto discovery.

Returns

Type	Description
System.Collections.Generic.IList<ShellModule>	A list of shell modules

ReadManifest(Stream)

Deserialize the manifest file stream

Declaration

protected virtual ShellModuleManifest ReadManifest(Stream manifestStream)

Parameters

Type	Name	Description
System.IO.Stream	manifestStream	The manifest file stream

Returns

Type	Description
ShellModuleManifest	Deserialize manifest file

Implements

IModuleFinder