MessageQueueInstaller クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
アプリケーションを実行するために必要なキューをインストールして構成できます。 このクラスは、 MessageQueueをインストールするときに、InstallUtil.exeなどのインストール ユーティリティによって呼び出されます。
public ref class MessageQueueInstaller : System::Configuration::Install::ComponentInstallerpublic class MessageQueueInstaller : System.Configuration.Install.ComponentInstallertype MessageQueueInstaller = class
inherit ComponentInstallerPublic Class MessageQueueInstaller
Inherits ComponentInstaller- 継承
注釈
MessageQueueInstallerは、キューに関連付けられているレジストリ値を書き込むのにインストール ユーティリティによって使用されます。 インストール ユーティリティの詳細については、「 Installutil.exe (インストーラー ツール)」を参照してください。
キューをインストールするには、 Installerから継承するプロジェクト インストーラー クラスを作成し、クラスの RunInstallerAttribute を trueに設定します。 プロジェクト内で、インストール内の各キューの MessageQueueInstaller インスタンスを作成し、そのインスタンスをプロジェクト インストーラー クラスに追加します。
MessageQueueInstaller インスタンスを作成するときに、必要に応じて既存のMessageQueue (テスト サーバーなど) をMessageQueueInstallerコンストラクターに渡すことができます。 この方法では、渡されたキューの設定をミラーリングすることで、新しいキューの構成設定が自動的に提供されます。 または、 MessageQueueInstaller インスタンスのプロパティを必要な状態に手動で設定し、パラメーターなしのコンストラクターを呼び出すこともできます。
インストール ユーティリティが呼び出されると、 RunInstallerAttributeが検索されます。
trueされている場合、ユーティリティはプロジェクト インストーラーに関連付けられているInstallers コレクション内のすべてのキューをインストールします。
RunInstallerAttributeがfalseされている場合、ユーティリティはプロジェクト インストーラーを無視します。
プロジェクト インストーラーのMessageQueueInstaller コレクションにインスタンスを追加する前または後に、Installers インスタンスの他のプロパティを変更します。 たとえば、インストール ユーティリティを実行する前に、キューの Path を設定する必要があります。
通常、コード内から MessageQueueInstaller のメソッドは呼び出しません。通常、installutil.exe インストール ユーティリティによってのみ呼び出されます。 このユーティリティは、インストール プロセス中に Install メソッドを自動的に呼び出し、インストールで例外がスローされなかった場合は Commit を呼び出します。 必要に応じて、例外を生成したオブジェクトの Rollback を呼び出すことによって、エラーをバックアウトします。
アプリケーションのインストール ルーチンは、プロジェクト インストーラーの Installer.Context を使用して、既にインストールされているコンポーネントに関する情報を自動的に保持します。 この状態情報は、各 MessageQueueInstaller インスタンスがユーティリティによってインストールされるときに継続的に更新されます。 通常、コードで状態情報を明示的に変更する必要はありません。
コンストラクター
| 名前 | 説明 |
|---|---|
| MessageQueueInstaller() |
MessageQueueInstaller クラスの新しいインスタンスを初期化します。 インスタンス プロパティを設定しません。 |
| MessageQueueInstaller(MessageQueue) |
MessageQueueInstaller クラスの新しいインスタンスを初期化し、既存のMessageQueue インスタンスの設定にインストール設定を初期化します。 |
プロパティ
| 名前 | 説明 |
|---|---|
| Authenticate |
インストールするキューが認証済みメッセージのみを受け入れるかどうかを示す値を取得または設定します。 |
| BasePriority |
パブリック キューのメッセージをネットワーク経由でルーティングするために使用される基本優先度を取得または設定します。 |
| CanRaiseEvents |
コンポーネントがイベントを発生できるかどうかを示す値を取得します。 (継承元 Component) |
| Category |
実装固有のキューの種類を取得または設定します。 |
| Container |
IContainerを含むComponentを取得します。 (継承元 Component) |
| Context |
現在のインストールに関する情報を取得または設定します。 (継承元 Installer) |
| DesignMode |
Componentが現在デザイン モードであるかどうかを示す値を取得します。 (継承元 Component) |
| EncryptionRequired |
キューがプライベート メッセージまたは暗号化されたメッセージのみを受け入れるかどうかを示す値を取得または設定します。 |
| Events |
この Componentにアタッチされているイベント ハンドラーの一覧を取得します。 (継承元 Component) |
| HelpText |
インストーラー コレクション内のすべてのインストーラーのヘルプ テキストを取得します。 (継承元 Installer) |
| Installers |
このインストーラーに含まれるインストーラーのコレクションを取得します。 (継承元 Installer) |
| Label |
キューの説明を取得または設定します。 |
| MaximumJournalSize |
キューに関連付けられているジャーナルの最大サイズを取得または設定します。 |
| MaximumQueueSize |
キューの最大サイズを取得または設定します。 |
| MulticastAddress |
MSMQ 3.0 で導入されました。 キューに関連付けられているマルチキャスト アドレスを取得または設定します。 |
| Parent |
このインストーラーが属するコレクションを含むインストーラーを取得または設定します。 (継承元 Installer) |
| Path |
このオブジェクトによって参照されるキューの場所を取得または設定します。 |
| Permissions |
キューに関連付けられているアクセス許可を取得または設定します。 |
| Site | (継承元 Component) |
| Transactional |
キューがトランザクションの一部として送信されたメッセージのみを受け入れるかどうかを示す値を取得または設定します。 |
| UninstallAction |
インストーラーがアンインストール時にキューに対して実行する処理を示す値を取得または設定します。削除するか、インストール前の状態に復元するか、現在インストールされている状態のままにします。 |
| UseJournalQueue |
キューから取得したメッセージも、関連付けられているジャーナル キューにコピーするかどうかを示す値を取得または設定します。 |
メソッド
| 名前 | 説明 |
|---|---|
| Commit(IDictionary) |
MessageQueue メソッドがレジストリに書き込んだInstall(IDictionary)インストール情報をコミットして、インストール プロセスを完了します。 このメソッドは、適切なメソッドを自動的に呼び出すインストール ツールで使用するためのものです。 |
| CopyFromComponent(IComponent) |
メッセージ キューのインストール時に必要な MessageQueue コンポーネントのプロパティ値をコピーします。 |
| CreateObjRef(Type) |
リモート オブジェクトとの通信に使用されるプロキシの生成に必要なすべての関連情報を含むオブジェクトを作成します。 (継承元 MarshalByRefObject) |
| Dispose() |
Componentで使用されているすべてのリソースを解放します。 (継承元 Component) |
| Dispose(Boolean) |
Componentによって使用されるアンマネージ リソースを解放し、必要に応じてマネージド リソースを解放します。 (継承元 Component) |
| Equals(Object) |
指定したオブジェクトが現在のオブジェクトと等しいかどうかを判断します。 (継承元 Object) |
| GetHashCode() |
既定のハッシュ関数として機能します。 (継承元 Object) |
| GetLifetimeService() |
古い.
このインスタンスの有効期間ポリシーを制御する現在の有効期間サービス オブジェクトを取得します。 (継承元 MarshalByRefObject) |
| GetService(Type) |
ComponentまたはそのContainerによって提供されるサービスを表すオブジェクトを返します。 (継承元 Component) |
| GetType() |
現在のインスタンスの Type を取得します。 (継承元 Object) |
| InitializeLifetimeService() |
古い.
このインスタンスの有効期間ポリシーを制御する有効期間サービス オブジェクトを取得します。 (継承元 MarshalByRefObject) |
| Install(IDictionary) |
インストールを実行し、メッセージ キュー情報をレジストリに書き込みます。 このメソッドは、適切なメソッドを自動的に呼び出すインストール ツールで使用するためのものです。 |
| IsEquivalentInstaller(ComponentInstaller) |
指定したインストーラーがこのインストーラーと同じ種類のインストールを処理できるかどうかを判断します。 |
| MemberwiseClone() |
現在の Objectの簡易コピーを作成します。 (継承元 Object) |
| MemberwiseClone(Boolean) |
現在の MarshalByRefObject オブジェクトの簡易コピーを作成します。 (継承元 MarshalByRefObject) |
| OnAfterInstall(IDictionary) |
AfterInstall イベントを発生させます。 (継承元 Installer) |
| OnAfterRollback(IDictionary) |
AfterRollback イベントを発生させます。 (継承元 Installer) |
| OnAfterUninstall(IDictionary) |
AfterUninstall イベントを発生させます。 (継承元 Installer) |
| OnBeforeInstall(IDictionary) |
BeforeInstall イベントを発生させます。 (継承元 Installer) |
| OnBeforeRollback(IDictionary) |
BeforeRollback イベントを発生させます。 (継承元 Installer) |
| OnBeforeUninstall(IDictionary) |
BeforeUninstall イベントを発生させます。 (継承元 Installer) |
| OnCommitted(IDictionary) |
Committed イベントを発生させます。 (継承元 Installer) |
| OnCommitting(IDictionary) |
Committing イベントを発生させます。 (継承元 Installer) |
| Rollback(IDictionary) |
インストール手順でレジストリに書き込まれたキュー情報をロールバックして、コンピューターをインストール前の状態に復元します。 このメソッドは、適切なメソッドを自動的に呼び出すインストール ツールで使用するためのものです。 |
| ToString() |
Stringの名前 (存在する場合) を含むComponentを返します。 このメソッドはオーバーライドしないでください。 (継承元 Component) |
| Uninstall(IDictionary) |
レジストリからキュー情報を削除して、インストールを削除します。 このメソッドは、適切なメソッドを自動的に呼び出すアンインストール ツールで使用するためのものです。 |
イベント
| 名前 | 説明 |
|---|---|
| AfterInstall |
Install(IDictionary) プロパティ内のすべてのインストーラーのInstallers メソッドが実行された後に発生します。 (継承元 Installer) |
| AfterRollback |
Installers プロパティ内のすべてのインストーラーのインストールがロールバックされた後に発生します。 (継承元 Installer) |
| AfterUninstall |
Installers プロパティ内のすべてのインストーラーがアンインストール操作を実行した後に発生します。 (継承元 Installer) |
| BeforeInstall |
インストーラー コレクション内の各インストーラーの Install(IDictionary) メソッドが実行される前に発生します。 (継承元 Installer) |
| BeforeRollback |
Installers プロパティのインストーラーがロールバックされる前に発生します。 (継承元 Installer) |
| BeforeUninstall |
Installers プロパティのインストーラーがアンインストール操作を実行する前に発生します。 (継承元 Installer) |
| Committed |
Installers プロパティ内のすべてのインストーラーがインストールをコミットした後に発生します。 (継承元 Installer) |
| Committing |
Installers プロパティのインストーラーがインストールをコミットする前に発生します。 (継承元 Installer) |
| Disposed |
コンポーネントが Dispose() メソッドの呼び出しによって破棄されるときに発生します。 (継承元 Component) |
