RelayConfigurationInstaller Class

Installs the Machine.config settings for the Windows Azure Service Bus relay.

Inheritance Hierarchy

System. . :: . .Object
  System. . :: . .MarshalByRefObject
    System.ComponentModel. . :: . .Component
      System.Configuration.Install. . :: . .Installer
        Microsoft.ServiceBus.Configuration..::..RelayConfigurationInstaller

Namespace:  Microsoft.ServiceBus.Configuration
Assembly:  Microsoft.ServiceBus (in Microsoft.ServiceBus.dll)

Syntax

'Declaration
Public Class RelayConfigurationInstaller _
    Inherits Installer
'Usage
Dim instance As RelayConfigurationInstaller

public class RelayConfigurationInstaller : Installer

public ref class RelayConfigurationInstaller : public Installer

type RelayConfigurationInstaller =  
    class
        inherit Installer
    end

public class RelayConfigurationInstaller extends Installer

The RelayConfigurationInstaller type exposes the following members.

Constructors

	Name	Description
	RelayConfigurationInstaller	Initializes a new instance of the RelayConfigurationInstaller class.

Top

Properties

	Name	Description
	CanRaiseEvents	(Inherited from Component.)
	Container	(Inherited from Component.)
	Context	(Inherited from Installer.)
	DesignMode	(Inherited from Component.)
	Events	(Inherited from Component.)
	HelpText	(Inherited from Installer.)
	Installers	(Inherited from Installer.)
	Parent	(Inherited from Installer.)
	Site	(Inherited from Component.)

Top

Methods

	Name	Description
	AddRelayConfiguration	Adds the entries of the current instance to the specified configuration.
	Commit	(Inherited from Installer.)
	CreateObjRef	Security Critical. (Inherited from MarshalByRefObject.)
	Dispose() () () ()	(Inherited from Component.)
	Dispose(Boolean)	(Inherited from Component.)
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Component.)
	GetHashCode	(Inherited from Object.)
	GetLifetimeService	Security Critical. (Inherited from MarshalByRefObject.)
	GetService	(Inherited from Component.)
	GetType	(Inherited from Object.)
	InitializeLifetimeService	Security Critical. (Inherited from MarshalByRefObject.)
	Install	Adds the entries to the Machine.config file to allow an application using that configuration to use ServiceBus elements in its config file. (Overrides Installer. . :: . .Install(IDictionary).)
	MemberwiseClone() () () ()	(Inherited from Object.)
	MemberwiseClone(Boolean)	(Inherited from MarshalByRefObject.)
	OnAfterInstall	(Inherited from Installer.)
	OnAfterRollback	(Inherited from Installer.)
	OnAfterUninstall	(Inherited from Installer.)
	OnBeforeInstall	(Inherited from Installer.)
	OnBeforeRollback	(Inherited from Installer.)
	OnBeforeUninstall	(Inherited from Installer.)
	OnCommitted	(Inherited from Installer.)
	OnCommitting	(Inherited from Installer.)
	RemoveRelayConfiguration	Removes the entries from the specified configuration that allow an application using that configuration to use ServiceBus elements in its config file.
	Rollback	(Inherited from Installer.)
	ToString	(Inherited from Component.)
	Uninstall	Removes the entries from the machine.config that allow an application using that configuration to use ServiceBus elements in its config file. (Overrides Installer. . :: . .Uninstall(IDictionary).)

Top

Events

	Name	Description
	AfterInstall	(Inherited from Installer.)
	AfterRollback	(Inherited from Installer.)
	AfterUninstall	(Inherited from Installer.)
	BeforeInstall	(Inherited from Installer.)
	BeforeRollback	(Inherited from Installer.)
	BeforeUninstall	(Inherited from Installer.)
	Committed	(Inherited from Installer.)
	Committing	(Inherited from Installer.)
	Disposed	(Inherited from Component.)

Top

Remarks

Windows Azure Service Bus supports only Full Trust code access security.

RelayConfigurationInstaller is a part of the Windows Azure Service Bus assembly, and allows users to easily add the Machine.config settings necessary for the Windows Azure Service Bus bindings to be supported in App.config. To use RelayConfigurationInstaller, either use Installutil.exe or write an application to call the methods needed. You can also use RelayConfigurationInstaller through the RelayConfigurationInstaller.exe tool, located in the <installdir>/Assemblies directory of the SDK.

The primary scenario for RelayConfigurationInstaller is to assist in installing the necessary Machine.config or App.config information necessary to run a Windows Azure Service Bus application on a computer that does not have Windows Azure Service Bus installed. However, in most scenarios, the application installer for the Windows Azure Service Bus application would automatically install the necessary configuration information. Therefore, this API would likely be used by developer who want additional control over the installation process.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.ServiceBus.Configuration Namespace