MessageQueueInstaller Class
TOC
Collapse the table of content
Expand the table of content

MessageQueueInstaller Class

 

Allows you to install and configure a queue that your application needs in order to run. This class is called by the installation utility, for example, InstallUtil.exe, when installing a MessageQueue.

Namespace:   System.Messaging
Assembly:  System.Messaging (in System.Messaging.dll)

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      System.Configuration.Install.Installer
        System.Configuration.Install.ComponentInstaller
          System.Messaging.MessageQueueInstaller

type MessageQueueInstaller = 
    class
        inherit ComponentInstaller
    end

NameDescription
System_CAPS_pubmethodMessageQueueInstaller()

Initializes a new instance of the MessageQueueInstaller class. Does not set any instance properties.

System_CAPS_pubmethodMessageQueueInstaller(MessageQueue)

Initializes a new instance of the MessageQueueInstaller class, initializing the installation settings to those of an existing MessageQueue instance.

NameDescription
System_CAPS_pubpropertyAuthenticate

Gets or sets a value that indicates whether the queue to be installed accepts only authenticated messages.

System_CAPS_pubpropertyBasePriority

Gets or sets the base priority that is used to route a public queue's messages over the network.

System_CAPS_protpropertyCanRaiseEvents

Gets a value indicating whether the component can raise an event.(Inherited from Component.)

System_CAPS_pubpropertyCategory

Gets or sets an implementation-specific queue type.

System_CAPS_pubpropertyContainer

Gets the IContainer that contains the Component.(Inherited from Component.)

System_CAPS_pubpropertyContext

Gets or sets information about the current installation.(Inherited from Installer.)

System_CAPS_protpropertyDesignMode

Gets a value that indicates whether the Component is currently in design mode.(Inherited from Component.)

System_CAPS_pubpropertyEncryptionRequired

Gets or sets a value that indicates whether the queue accepts only private, or encrypted, messages.

System_CAPS_protpropertyEvents

Gets the list of event handlers that are attached to this Component.(Inherited from Component.)

System_CAPS_pubpropertyHelpText

Gets the help text for all the installers in the installer collection.(Inherited from Installer.)

System_CAPS_pubpropertyInstallers

Gets the collection of installers that this installer contains.(Inherited from Installer.)

System_CAPS_pubpropertyLabel

Gets or sets a description of the queue.

System_CAPS_pubpropertyMaximumJournalSize

Gets or sets the maximum size of the journal that is associated with the queue.

System_CAPS_pubpropertyMaximumQueueSize

Gets or sets the maximum size of the queue.

System_CAPS_pubpropertyMulticastAddress

Introduced in MSMQ 3.0. Gets or sets the multicast address associated with the queue.

System_CAPS_pubpropertyParent

Gets or sets the installer containing the collection that this installer belongs to.(Inherited from Installer.)

System_CAPS_pubpropertyPath

Gets or sets the location of the queue that is referenced by this object.

System_CAPS_pubpropertyPermissions

Gets or sets permissions associated with the queue.

System_CAPS_pubpropertySite

Gets or sets the ISite of the Component.(Inherited from Component.)

System_CAPS_pubpropertyTransactional

Gets or sets a value that indicates whether the queue accepts only messages sent as part of a transaction.

System_CAPS_pubpropertyUninstallAction

Gets or sets a value that indicates what the installer does with the queue at uninstall time: remove it, restore it to its pre-installation state, or leave it in its current installed state.

System_CAPS_pubpropertyUseJournalQueue

Gets or sets a value that indicates whether messages that are retrieved from the queue are also copied to the associated journal queue.

NameDescription
System_CAPS_pubmethodCommit(IDictionary)

Completes the installation process by committing the MessageQueue installation information that the Install method wrote to the registry. This method is meant to be used by installation tools, which automatically call the appropriate methods.(Overrides Installer.Commit(IDictionary).)

System_CAPS_pubmethodCopyFromComponent(IComponent)

Copies the property values of a MessageQueue component that are required at install time for a message queue.(Overrides ComponentInstaller.CopyFromComponent(IComponent).)

System_CAPS_pubmethodCreateObjRef(Type)

Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodDispose()

Releases all resources used by the Component.(Inherited from Component.)

System_CAPS_protmethodDispose(Boolean)

Releases the unmanaged resources used by the Component and optionally releases the managed resources.(Inherited from Component.)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection.(Inherited from Component.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetLifetimeService()

Retrieves the current lifetime service object that controls the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_protmethodGetService(Type)

Returns an object that represents a service provided by the Component or by its Container.(Inherited from Component.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodInitializeLifetimeService()

Obtains a lifetime service object to control the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodInstall(IDictionary)

Performs the installation and writes message queue information to the registry. This method is meant to be used by installation tools, which automatically call the appropriate methods.(Overrides Installer.Install(IDictionary).)

System_CAPS_pubmethodIsEquivalentInstaller(ComponentInstaller)

Determines whether the specified installer can handle the same kind of installation as this installer.(Overrides ComponentInstaller.IsEquivalentInstaller(ComponentInstaller).)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone(Boolean)

Creates a shallow copy of the current MarshalByRefObject object.(Inherited from MarshalByRefObject.)

System_CAPS_protmethodOnAfterInstall(IDictionary)

Raises the AfterInstall event.(Inherited from Installer.)

System_CAPS_protmethodOnAfterRollback(IDictionary)

Raises the AfterRollback event.(Inherited from Installer.)

System_CAPS_protmethodOnAfterUninstall(IDictionary)

Raises the AfterUninstall event.(Inherited from Installer.)

System_CAPS_protmethodOnBeforeInstall(IDictionary)

Raises the BeforeInstall event.(Inherited from Installer.)

System_CAPS_protmethodOnBeforeRollback(IDictionary)

Raises the BeforeRollback event.(Inherited from Installer.)

System_CAPS_protmethodOnBeforeUninstall(IDictionary)

Raises the BeforeUninstall event.(Inherited from Installer.)

System_CAPS_protmethodOnCommitted(IDictionary)

Raises the Committed event.(Inherited from Installer.)

System_CAPS_protmethodOnCommitting(IDictionary)

Raises the Committing event.(Inherited from Installer.)

System_CAPS_pubmethodRollback(IDictionary)

Restores the computer to the state it was in before the installation, by rolling back the queue information that the installation procedure wrote to the registry. This method is meant to be used by installation tools, which automatically call the appropriate methods.(Overrides Installer.Rollback(IDictionary).)

System_CAPS_pubmethodToString()

Returns a String containing the name of the Component, if any. This method should not be overridden.(Inherited from Component.)

System_CAPS_pubmethodUninstall(IDictionary)

Removes an installation by removing queue information from the registry. This method is meant to be used by uninstallation tools, which automatically call the appropriate methods.(Overrides Installer.Uninstall(IDictionary).)

NameDescription
System_CAPS_pubeventAfterInstall

Occurs after the Install methods of all the installers in the Installers property have run.(Inherited from Installer.)

System_CAPS_pubeventAfterRollback

Occurs after the installations of all the installers in the Installers property are rolled back.(Inherited from Installer.)

System_CAPS_pubeventAfterUninstall

Occurs after all the installers in the Installers property perform their uninstallation operations.(Inherited from Installer.)

System_CAPS_pubeventBeforeInstall

Occurs before the Install method of each installer in the installer collection has run.(Inherited from Installer.)

System_CAPS_pubeventBeforeRollback

Occurs before the installers in the Installers property are rolled back.(Inherited from Installer.)

System_CAPS_pubeventBeforeUninstall

Occurs before the installers in the Installers property perform their uninstall operations.(Inherited from Installer.)

System_CAPS_pubeventCommitted

Occurs after all the installers in the Installers property have committed their installations.(Inherited from Installer.)

System_CAPS_pubeventCommitting

Occurs before the installers in the Installers property committ their installations.(Inherited from Installer.)

System_CAPS_pubeventDisposed

Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)

The MessageQueueInstaller is used by the installation utility to write registry values that are associated with the queue. For more information about installation utilities, see Installutil.exe (Installer Tool).

To install a queue, create a project installer class that inherits from the Installer, and set the RunInstallerAttribute for the class to true. Within your project, create a MessageQueueInstaller instance for each queue in the installation and add the instance to your project installer class.

When creating a MessageQueueInstaller instance, you can optionally pass an existing MessageQueue (for example, from a test server) to the MessageQueueInstaller constructor. This approach automatically provides the configuration settings for the new queue by mirroring the settings of the queue passed in. Alternatively, you can manually set the properties in the MessageQueueInstaller instance to the states you want and call the default constructor.

When the install utility is called, it looks for the RunInstallerAttribute. If it is true, the utility installs all the queues in the Installers collection associated with your project installer. If RunInstallerAttribute is false, the utility ignores the project installer.

You modify other properties of a MessageQueueInstaller instance either before or after adding the instance to the Installers collection of your project installer. For example, a queue's Path must be set before the install utility executes.

Typically, you do not call the methods of the MessageQueueInstaller from within your code; they are generally called only by the installutil.exe installation utility. The utility automatically calls the Install method during the installation process and calls Commit if the installation did not throw an exception. It backs out failures, if necessary, by calling Rollback for the object that generated the exception.

An application's install routine uses the project installer's Installer.Context to automatically maintain information about the components that have already been installed. This state information is continuously updated as each MessageQueueInstaller instance is installed by the utility. It is not usually necessary for your code to explicitly modify the state information.

.NET Framework
Available since 1.1

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

Return to top
Show:
© 2016 Microsoft