BaseSiteManager Class

Summary

Base class for managing IIS sites
Assembly
Cake.IIS.dll
Namespace
Cake.IIS
Base Types
Derived Types
graph BT Type-->Base0["BaseManager"] click Base0 "/api/Cake.IIS/BaseManager" Base0-->Base1["Object"] Type["BaseSiteManager"] class Type type-node Derived0["FtpsiteManager"]-->Type click Derived0 "/api/Cake.IIS/FtpsiteManager" Derived1["WebsiteManager"]-->Type click Derived1 "/api/Cake.IIS/WebsiteManager"

Syntax

public abstract class BaseSiteManager : BaseManager

Constructors

Name Summary
BaseSiteManager(ICakeEnvironment, ICakeLog) Initializes a new instance of the BaseSiteManager class.

Fields

Name Constant Value Summary
_Environment
Cake environment
Inherited from BaseManager
_Log
Cake log
Inherited from BaseManager
_Server
IIS server manager
Inherited from BaseManager

Methods

Name Value Summary
AddApplication(ApplicationSettings) bool
Adds a virtual application to a IIS site
AddBinding(string, BindingSettings) bool
Adds a binding to a IIS site
AddVirtualDirectory(VirtualDirectorySettings) bool
Adds a virtual directory to a IIS site
ApplicationExists(ApplicationSettings) bool
Checks if a virtual application exists in a IIS site
Connect(string) ServerManager
Creates a IIS ServerManager
Inherited from BaseManager
static
CreateSite(SiteSettings, bool) Site
Creates a IIS site
Delete(string) bool
Delets a site from IIS
Exists(string) bool
Checks if a site exists in IIS
GetPhysicalDirectory(IDirectorySettings) string
Gets the physical directory from the working directory
Inherited from BaseManager
RemoveApplication(ApplicationSettings) bool
Removes a virtual application to a IIS site
RemoveBinding(string, BindingSettings) bool
Removes a binding to a IIS site
RemoveVirtualDirectory(VirtualDirectorySettings) bool
Removes a virtual directory from a IIS site
SetServer() void
Set the IIS ServerManager
Inherited from BaseManager
SetServer(ServerManager) void
Set the IIS ServerManager
Inherited from BaseManager
SetServer(string) void
Set the IIS ServerManager
Inherited from BaseManager
SetWebConfiguration(string, string, Action<Configuration>) void
Updates the web.config of the given host/site/application.
Start(string) bool
Starts a IIS site
Stop(string) bool
Stops a IIS site
VirtualDirectoryExists(VirtualDirectorySettings) bool
Checks if a virtual directory exists in a IIS site

Extension Methods

Name Value Summary
Dump<BaseSiteManager>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<BaseSiteManager>(BaseSiteManager[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<BaseSiteManager>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<BaseSiteManager>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<BaseSiteManager>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<BaseSiteManager>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin