Class CleanupInstaller

The CleanupInstaller cleans up (removes) files from previous versions.

Inheritance
System.Object
ComponentInstallerBase
FileInstaller
CleanupInstaller
Inherited Members
Namespace: DotNetNuke.Services.Installer.Installers
Assembly: DotNetNuke.dll
Syntax
public class CleanupInstaller : FileInstaller

Constructors

| Improve this Doc View Source

CleanupInstaller()

Initializes a new instance of the CleanupInstaller class.

Declaration
public CleanupInstaller()

Properties

| Improve this Doc View Source

AllowableFiles

Gets a list of allowable file extensions (in addition to the Host's List).

Declaration
public override string AllowableFiles { get; }
Property Value
Type Description
System.String
Overrides
| Improve this Doc View Source

Folders

Gets the list of folders to clean up.

Declaration
protected IList<string> Folders { get; }
Property Value
Type Description
IList<System.String>

Methods

| Improve this Doc View Source

CleanupFile(InstallFile)

The CleanupFile method cleans up a single file.

Declaration
protected bool CleanupFile(InstallFile insFile)
Parameters
Type Name Description
InstallFile insFile

The InstallFile to clean up.
Returns
Type Description
System.Boolean

true if the file was deleted, otherwise false.
| Improve this Doc View Source

CleanupFolder(String)

Deletes all empty folders beneath a given root folder and the root folder itself as well if empty.

Declaration
protected virtual void CleanupFolder(string path)
Parameters
Type Name Description
System.String path

The root folder path.
| Improve this Doc View Source

Commit()

The Commit method finalizes the Install and commits any pending changes.

Declaration
public override void Commit()
Overrides
Remarks

In the case of Clenup this is not neccessary.

| Improve this Doc View Source

Install()

The Install method installs the file component.

Declaration
public override void Install()
Overrides
Remarks

The Install method cleans up the files.

| Improve this Doc View Source

ProcessFile(InstallFile, XPathNavigator)

The ProcessFile method determines what to do with parsed "file" node.

Declaration
protected override void ProcessFile(InstallFile file, XPathNavigator nav)
Parameters
Type Name Description
InstallFile file

The file represented by the node.
XPathNavigator nav

The XPathNavigator representing the node.
Overrides
| Improve this Doc View Source

ProcessFolder(XPathNavigator)

Determines what to do with the parsed "folder" node.

Declaration
protected virtual void ProcessFolder(XPathNavigator nav)
Parameters
Type Name Description
XPathNavigator nav

The XPathNavigator representing the node.
| Improve this Doc View Source

ReadManifest(XPathNavigator)

The ReadManifest method reads the manifest file for the file component.

Declaration
public override void ReadManifest(XPathNavigator manifestNav)
Parameters
Type Name Description
XPathNavigator manifestNav
Overrides
| Improve this Doc View Source

ReadManifestItem(XPathNavigator, Boolean)

The ReadManifestItem method reads a single node.

Declaration
protected override InstallFile ReadManifestItem(XPathNavigator nav, bool checkFileExists)
Parameters
Type Name Description
XPathNavigator nav

The XPathNavigator representing the node.
System.Boolean checkFileExists

Flag that determines whether a check should be made.
Returns
Type Description
InstallFile

A new InstallFile instance.
Overrides
| Improve this Doc View Source

RollbackFile(InstallFile)

The RollbackFile method rolls back the install of a single file.

Declaration
protected override void RollbackFile(InstallFile installFile)
Parameters
Type Name Description
InstallFile installFile

The InstallFile to commit.
Overrides
Remarks

For new installs this removes the added file. For upgrades it restores the backup file created during install.

| Improve this Doc View Source

UnInstall()

The UnInstall method uninstalls the file component.

Declaration
public override void UnInstall()
Overrides
Remarks

There is no uninstall for this component.

Extension Methods