C# Class Subtext.Extensibility.Providers.Installation

Provider for classes that implement installation procedures. This allows new data providers to implement their own installation code.

Inheritance: System.Configuration.Provider.ProviderBase

Mostrar archivo Open project: ayende/Subtext

Public Methods

Method	Description
GatherInstallationInformation ( ) : Control	This method is called by the installation engine in order to ask the provider what pieces of information it needs from the user in order to proceed with the installation. This method returns a Control used to gather the required installation information. This will be returned back to the provider after the user provides the information.
GetCurrentInstallationVersion ( ) : System.Version	Gets the Version of the current Subtext installation.
GetInstallationStatus ( System.Version currentAssemblyVersion ) : InstallationState	Gets the installation status.
Install ( System.Version assemblyVersion ) : void	Installs this instance.
IsInstallationException ( Exception exception ) : bool	Determines whether the specified exception is due to a problem with the installation.
IsPermissionDeniedException ( Exception exception ) : bool	Determines whether the specified exception is due to a permission denied error.
ProvideInstallationInformation ( Control populatedControl ) : void	Provides the installation information as provided by the user back into the provider. The control passed in should be the same as that provided in GatherInstallationInformation, but with user values supplied within it.
Repair ( ) : bool	Attempts to repair this instance. Returns true if it was successful.
UpdateInstallationVersionNumber ( System.Version newVersion, SqlTransaction transaction ) : void	Updates the current installed version.
Upgrade ( ) : void	Upgrades this instance. Returns true if it was successful.
ValidateInstallationInformation ( Control control ) : string	Validates the installation information provided by the user. Returns a string with an explanation of why it is incorrect.

Method Details

GatherInstallationInformation() public abstract method

This method is called by the installation engine in order to ask the provider what pieces of information it needs from the user in order to proceed with the installation.

This method returns a Control used to gather the required installation information. This will be returned back to the provider after the user provides the information.

public abstract GatherInstallationInformation ( ) : Control
return	System.Web.UI.Control

GetCurrentInstallationVersion() public abstract method

Gets the Version of the current Subtext installation.

public abstract GetCurrentInstallationVersion ( ) : System.Version
return	System.Version

GetInstallationStatus() public abstract method

Gets the installation status.

public abstract GetInstallationStatus ( System.Version currentAssemblyVersion ) : InstallationState
currentAssemblyVersion	System.Version	The version of the assembly that represents this installation.
return	InstallationState

Install() public abstract method

Installs this instance.

public abstract Install ( System.Version assemblyVersion ) : void
assemblyVersion	System.Version	The current assembly version being installed.
return	void

IsInstallationException() public abstract method

Determines whether the specified exception is due to a problem with the installation.

public abstract IsInstallationException ( Exception exception ) : bool
exception	System.Exception	exception.
return	bool

IsPermissionDeniedException() public abstract method

Determines whether the specified exception is due to a permission denied error.

public abstract IsPermissionDeniedException ( Exception exception ) : bool
exception	System.Exception
return	bool

ProvideInstallationInformation() public abstract method

Provides the installation information as provided by the user back into the provider. The control passed in should be the same as that provided in GatherInstallationInformation, but with user values supplied within it.

public abstract ProvideInstallationInformation ( Control populatedControl ) : void
populatedControl	System.Web.UI.Control	Populated control.
return	void

Repair() public abstract method

Attempts to repair this instance. Returns true if it was successful.

public abstract Repair ( ) : bool
return	bool

UpdateInstallationVersionNumber() public abstract method

Updates the current installed version.

public abstract UpdateInstallationVersionNumber ( System.Version newVersion, SqlTransaction transaction ) : void
newVersion	System.Version	The new version that is now current.
transaction	System.Data.SqlClient.SqlTransaction	The transaction to perform this upgrade within.
return	void

Upgrade() public abstract method

Upgrades this instance. Returns true if it was successful.

public abstract Upgrade ( ) : void
return	void

ValidateInstallationInformation() public abstract method

Validates the installation information provided by the user. Returns a string with an explanation of why it is incorrect.

public abstract ValidateInstallationInformation ( Control control ) : string
control	System.Web.UI.Control	control used to provide information.
return	string