クラス BrokerRunningSupport
- java.lang.ObjectSE
-
- org.springframework.amqp.rabbit.junit.BrokerRunningSupport
public final class BrokerRunningSupport extends ObjectSE
Rabbit ブローカーアプリケーションが実行されていないかアクセスできない場合に統合テストが失敗するのを防ぐために使用できるクラス。Rabbit ブローカーがバックグラウンドで実行されていない場合、ここでのすべてのテストは、前提条件に違反しているため (デフォルトで) 単純にスキップされます (成功として表示されます)。CI サーバーなどでブローカーを強制的に使用可能にしたい場合は、環境変数 "RABBITMQ_SERVER_REQUIRED" を
trueに設定すると、テストはすぐに失敗します。- 導入:
- 2.2
- 作成者:
- Dave Syer, Gary Russell
ネストされたクラスの概要
ネストされたクラス 修飾子と型 クラス 説明 static classBrokerRunningSupport.BrokerNotAliveException指定されたホストポートでブローカーが使用できない場合にスローされるRuntimeExceptionSE。
フィールド概要
フィールド 修飾子と型 フィールド 説明 static StringSEBROKER_ADMIN_PWstatic StringSEBROKER_ADMIN_URIstatic StringSEBROKER_ADMIN_USERstatic StringSEBROKER_HOSTNAMEstatic StringSEBROKER_PORTstatic StringSEBROKER_PWstatic StringSEBROKER_REQUIREDstatic StringSEBROKER_USERstatic StringSEDEFAULT_QUEUE_NAME
方法の概要
すべてのメソッド 静的メソッド インスタンスメソッド 具象メソッド 修飾子と型 メソッド 説明 static voidclearEnvironmentVariableOverrides()setEnvironmentVariableOverrides(Map)で設定された環境変数オーバーライドをすべてクリアします。voiddeleteExchanges(StringSE... exchanges)ブローカーから任意の取引所を削除します。voiddeleteQueues(StringSE... queuesToDelete)ブローカーから任意のキューを削除します。static booleanfatal()StringSEgenerateId()ルールの接続ファクトリで使用される接続の接続 ID を生成します。StringSEgetAdminPassword()管理者パスワードを返します。StringSEgetAdminUri()管理 uri を返します。StringSEgetAdminUser()管理者ユーザーを返します。com.rabbitmq.client.ConnectionFactorygetConnectionFactory()このルールで使用される接続ファクトリを取得します。StringSEgetHostName()ポートを返します。StringSEgetPassword()パスワードを返します。intgetPort()ポートを返します。StringSEgetUser()ユーザーを返します。static BrokerRunningSupportisBrokerAndManagementRunning()static BrokerRunningSupportisBrokerAndManagementRunningWithEmptyQueues(StringSE... queues)static BrokerRunningSupportisNotRunning()booleanisPurgeAfterEach()static BrokerRunningSupportisRunning()static BrokerRunningSupportisRunningWithEmptyQueues(StringSE... names)ブローカーが実行中であり、デフォルト交換に指定された名前の空のキューがあることを確認してください。voidpurgeTestQueues()構成されたすべてのキューを削除して再宣言します。voidremoveExchanges(StringSE... exchanges)ブローカーから取引所を削除します。voidremoveTestQueues(StringSE... additionalQueues)isRunningWithEmptyQueues(String...)メソッドによって作成されたテストキューをすべて削除します。voidsetAdminPassword(StringSE password)管理 REST API 接続のデフォルトの「ゲスト」のパスワードを設定します。voidsetAdminUri(StringSE adminUri)REST API の uri を設定します。voidsetAdminUser(StringSE user)管理 REST API 接続のデフォルトの「ゲスト」のユーザーを設定します。static voidsetEnvironmentVariableOverrides(MapSE<StringSE,StringSE> environmentVariables)ホスト、ポートなどの環境変数のオーバーライドを設定します。voidsetHostName(StringSE hostName)voidsetPassword(StringSE password)amqp 接続のデフォルト "guest" のパスワードを設定します。voidsetPort(int port)voidsetPurgeAfterEach(boolean purgeAfterEach)各テストの後にテストキューをパージします (JUnit 5)。voidsetUser(StringSE user)amqp 接続のデフォルト「ゲスト」のユーザーを設定します。voidtest()ブローカーへの接続を確認し、キューを作成します。
フィールドの詳細
DEFAULT_QUEUE_NAME
public static final StringSE DEFAULT_QUEUE_NAME
メソッドの詳細
setEnvironmentVariableOverrides
public static void setEnvironmentVariableOverrides(MapSE<StringSE,StringSE> environmentVariables)
ホスト、ポートなどの環境変数のオーバーライドを設定します。存在する場合、実際の環境変数をオーバーライドします。変数は、このメソッドが呼び出された後に作成されたルールインスタンスにのみ適用されます。オーバーライド
- パラメーター:
environmentVariables- 変数。
clearEnvironmentVariableOverrides
public static void clearEnvironmentVariableOverrides()
setEnvironmentVariableOverrides(Map)で設定された環境変数オーバーライドをすべてクリアします。
isRunningWithEmptyQueues
public static BrokerRunningSupport isRunningWithEmptyQueues(StringSE... names)
ブローカーが実行中であり、デフォルト交換に指定された名前の空のキューがあることを確認してください。- パラメーター:
names- テストのために宣言するキュー。- 戻り値:
- 既存の実行中のブローカーを想定する新しいルール
isRunning
public static BrokerRunningSupport isRunning()
- 戻り値:
- 既存の実行中のブローカーを想定する新しいルール
isNotRunning
public static BrokerRunningSupport isNotRunning()
- 戻り値:
- 既存のブローカーが存在しないことを前提とする新しいルール
isBrokerAndManagementRunning
public static BrokerRunningSupport isBrokerAndManagementRunning()
- 戻り値:
- 管理プラグインを備えた既存のブローカーを想定する新しいルール
isBrokerAndManagementRunningWithEmptyQueues
public static BrokerRunningSupport isBrokerAndManagementRunningWithEmptyQueues(StringSE... queues)
- パラメーター:
queues- キュー。- 戻り値:
- 提供されたキューが宣言された (必要に応じて空にされた) 管理プラグインを備えた既存のブローカーを想定する新しいルール。
setPort
public void setPort(int port)
- パラメーター:
port- 設定するポート
setHostName
public void setHostName(StringSE hostName)
- パラメーター:
hostName- 設定する hostName
setUser
public void setUser(StringSE user)
amqp 接続のデフォルト「ゲスト」のユーザーを設定します。- パラメーター:
user- ユーザー。
setPassword
public void setPassword(StringSE password)
amqp 接続のデフォルト "guest" のパスワードを設定します。- パラメーター:
password- パスワード。
setAdminUri
public void setAdminUri(StringSE adminUri)
REST API の uri を設定します。- パラメーター:
adminUri- uri。
setAdminUser
public void setAdminUser(StringSE user)
管理 REST API 接続のデフォルトの「ゲスト」のユーザーを設定します。- パラメーター:
user- ユーザー。
setAdminPassword
public void setAdminPassword(StringSE password)
管理 REST API 接続のデフォルトの「ゲスト」のパスワードを設定します。- パラメーター:
password- パスワード。
getPort
public int getPort()
ポートを返します。- 戻り値:
- ポート。
getHostName
public StringSE getHostName()
ポートを返します。- 戻り値:
- ポート。
getUser
public StringSE getUser()
ユーザーを返します。- 戻り値:
- ユーザー。
getPassword
public StringSE getPassword()
パスワードを返します。- 戻り値:
- パスワード。
getAdminUser
public StringSE getAdminUser()
管理者ユーザーを返します。- 戻り値:
- ユーザー。
getAdminPassword
public StringSE getAdminPassword()
管理者パスワードを返します。- 戻り値:
- パスワード。
isPurgeAfterEach
public boolean isPurgeAfterEach()
setPurgeAfterEach
public void setPurgeAfterEach(boolean purgeAfterEach)
各テストの後にテストキューをパージします (JUnit 5)。- パラメーター:
purgeAfterEach- パージする場合は true。
test
public void test() throws BrokerRunningSupport.BrokerNotAliveExceptionブローカーへの接続を確認し、キューを作成します。- 例外:
BrokerRunningSupport.BrokerNotAliveException- ブローカーが利用できない場合。
fatal
public static boolean fatal()
generateId
public StringSE generateId()
ルールの接続ファクトリで使用される接続の接続 ID を生成します。- 戻り値:
- ID。
removeTestQueues
public void removeTestQueues(StringSE... additionalQueues)
isRunningWithEmptyQueues(String...)メソッドによって作成されたテストキューをすべて削除します。- パラメーター:
additionalQueues- テストによって作成された可能性のある削除する追加のキュー。
removeExchanges
public void removeExchanges(StringSE... exchanges)
ブローカーから取引所を削除します。- パラメーター:
exchanges- 取引所。- 導入:
- 2.3
purgeTestQueues
public void purgeTestQueues()
構成されたすべてのキューを削除して再宣言します。テストが古いデータを残す可能性があり、複数のテストが同じキューを使用する場合に、テスト間で使用できます。
deleteQueues
public void deleteQueues(StringSE... queuesToDelete)
ブローカーから任意のキューを削除します。- パラメーター:
queuesToDelete- 削除するキュー。
deleteExchanges
public void deleteExchanges(StringSE... exchanges)
ブローカーから任意の取引所を削除します。- パラメーター:
exchanges- 削除する取引所。
getConnectionFactory
public com.rabbitmq.client.ConnectionFactory getConnectionFactory()
このルールで使用される接続ファクトリを取得します。- 戻り値:
- 接続ファクトリ。
getAdminUri
public StringSE getAdminUri()
管理 uri を返します。- 戻り値:
- uri。