C# Class ImageProcessor.Umbraco.PackageActions.AddHttpModule

This package action will Add a new HTTP Module to the web.config file.
This package action has been adapted from the PackageActionsContrib Project. http://packageactioncontrib.codeplex.com
Inheritance: IPackageAction
显示文件 Open project: JimBobSquarePants/ImageProcessor.Umbraco

Public Methods

Method Description
Alias ( ) : string

This Alias must be unique and is used as an identifier that must match the alias in the package action XML.

Execute ( string packageName, XmlNode xmlData ) : bool

Append the xmlData node to the web.config file

SampleXml ( ) : XmlNode

Returns a Sample XML Node In this case the Sample HTTP Module TimingModule

Test ( ) : bool

Tests if the ImageProcessor HTTP module is added to web.config

Undo ( string packageName, XmlNode xmlData ) : bool

Removes the xmlData node from the web.config file

Private Methods

Method Description
getAttribute ( XmlNode xmlData, string attribute, string &value ) : bool

Get a named attribute from xmlData root node

getAttributeDefault ( XmlNode xmlData, string attribute, string defaultValue ) : string

Get an optional named attribute from xmlData root node when attribute is unavailable, return the default value

getUser ( ) : umbraco.BusinessLogic.User

Get the current user, or when unavailable admin user

Method Details

Alias() public method

This Alias must be unique and is used as an identifier that must match the alias in the package action XML.
public Alias ( ) : string
return string

Execute() public method

Append the xmlData node to the web.config file
public Execute ( string packageName, XmlNode xmlData ) : bool
packageName string Name of the package that we install
xmlData System.Xml.XmlNode The data that must be appended to the web.config file
return bool

SampleXml() public method

Returns a Sample XML Node In this case the Sample HTTP Module TimingModule
public SampleXml ( ) : XmlNode
return System.Xml.XmlNode

Test() public static method

Tests if the ImageProcessor HTTP module is added to web.config
public static Test ( ) : bool
return bool

Undo() public method

Removes the xmlData node from the web.config file
public Undo ( string packageName, XmlNode xmlData ) : bool
packageName string Name of the package that we install
xmlData System.Xml.XmlNode The data that must be appended to the web.config file
return bool