StompBrokerRelayRegistration (Spring Framework 5.1.1.RELEASE API)

java.lang.Object
- org.springframework.messaging.simp.config.AbstractBrokerRegistration
- - org.springframework.messaging.simp.config.StompBrokerRelayRegistration

```
public class StompBrokerRelayRegistration
extends AbstractBrokerRegistration
```
StompBrokerRelayMessageHandler を構成するための登録クラス。
導入:
4.0
作成者:
Rossen Stoyanchev

コンストラクター概要

コンストラクター
コンストラクターと説明
`StompBrokerRelayRegistration(SubscribableChannel clientInboundChannel, MessageChannel clientOutboundChannel, java.lang.String[] destinationPrefixes)`

方法の概要

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`protected StompBrokerRelayMessageHandler`	`getMessageHandler(SubscribableChannel brokerChannel)`
`protected java.lang.String`	`getUserDestinationBroadcast()`
`protected java.lang.String`	`getUserRegistryBroadcast()`
`StompBrokerRelayRegistration`	`setAutoStartup(boolean autoStartup)` Spring ApplicationContext がリフレッシュされたときに `StompBrokerRelayMessageHandler` が自動的に起動するかどうかを構成します。
`StompBrokerRelayRegistration`	`setClientLogin(java.lang.String login)` 接続されたクライアントに代わって STOMP ブローカーへの接続を作成するときに使用するログインを設定します。
`StompBrokerRelayRegistration`	`setClientPasscode(java.lang.String passcode)` 接続されたクライアントに代わって STOMP ブローカーへの接続を作成するときに使用するパスコードを設定します。
`StompBrokerRelayRegistration`	`setRelayHost(java.lang.String relayHost)` STOMP メッセージブローカーホストを設定します。
`StompBrokerRelayRegistration`	`setRelayPort(int relayPort)` STOMP メッセージブローカーポートを設定します。
`StompBrokerRelayRegistration`	`setSystemHeartbeatReceiveInterval(long heartbeatReceiveInterval)` 他のデータがない場合に「システム」リレーセッションが STOMP ブローカーからハートビートを受信することを期待する最大間隔をミリ秒単位で設定します。
`StompBrokerRelayRegistration`	`setSystemHeartbeatSendInterval(long systemHeartbeatSendInterval)` 他のデータが送信されていない場合に「システム」リレーセッションがハートビートを STOMP ブローカーに送信する間隔をミリ秒単位で設定します。
`StompBrokerRelayRegistration`	`setSystemLogin(java.lang.String login)` アプリケーション内から STOMP ブローカーにメッセージを送信するために使用される共有「システム」接続のログインを設定します。
`StompBrokerRelayRegistration`	`setSystemPasscode(java.lang.String passcode)` アプリケーション内から STOMP ブローカーにメッセージを送信するために使用される共有「システム」接続のパスコードを設定します。
`void`	`setTcpClient(TcpOperations<byte[]> tcpClient)` STOMP ブローカーへの TCP 接続を管理するための TCP クライアントを構成します。
`StompBrokerRelayRegistration`	`setUserDestinationBroadcast(java.lang.String destination)` ユーザーが接続していないように見えるために未解決のままになっているユーザーの宛先にメッセージをブロードキャストする宛先を設定します。
`StompBrokerRelayRegistration`	`setUserRegistryBroadcast(java.lang.String destination)` ローカルユーザーレジストリのコンテンツをブロードキャストし、他のサーバーからのブロードキャストをリッスンする宛先を設定します。
`StompBrokerRelayRegistration`	`setVirtualHost(java.lang.String virtualHost)` STOMP CONNECT フレームで使用する「ホスト」ヘッダーの値を設定します。

クラス org.springframework.messaging.simp.config.AbstractBrokerRegistration から継承されたメソッド
getClientInboundChannel, getClientOutboundChannel, getDestinationPrefixes

クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクターの詳細
  - StompBrokerRelayRegistration
```
public StompBrokerRelayRegistration(SubscribableChannel clientInboundChannel,
                                    MessageChannel clientOutboundChannel,
                                    java.lang.String[] destinationPrefixes)
```
- メソッドの詳細
  - setRelayHost
```
public StompBrokerRelayRegistration setRelayHost(java.lang.String relayHost)
```
    STOMP メッセージブローカーホストを設定します。
  - setRelayPort
```
public StompBrokerRelayRegistration setRelayPort(int relayPort)
```
    STOMP メッセージブローカーポートを設定します。
  - setClientLogin
```
public StompBrokerRelayRegistration setClientLogin(java.lang.String login)
```
    接続されたクライアントに代わって STOMP ブローカーへの接続を作成するときに使用するログインを設定します。
    デフォルトでは「ゲスト」に設定されています。
  - setClientPasscode
```
public StompBrokerRelayRegistration setClientPasscode(java.lang.String passcode)
```
    接続されたクライアントに代わって STOMP ブローカーへの接続を作成するときに使用するパスコードを設定します。
    デフォルトでは「ゲスト」に設定されています。
  - setSystemLogin
```
public StompBrokerRelayRegistration setSystemLogin(java.lang.String login)
```
    アプリケーション内から STOMP ブローカーにメッセージを送信するために使用される共有「システム」接続のログインを設定します。つまり、特定のクライアントセッションに関連付けられていないメッセージ（REST/HTTP リクエスト処理メソッドなど）です。
    デフォルトでは「ゲスト」に設定されています。
  - setSystemPasscode
```
public StompBrokerRelayRegistration setSystemPasscode(java.lang.String passcode)
```
    アプリケーション内から STOMP ブローカーにメッセージを送信するために使用される共有「システム」接続のパスコードを設定します。つまり、特定のクライアントセッションに関連付けられていないメッセージ（REST/HTTP リクエスト処理メソッドなど）です。
    デフォルトでは「ゲスト」に設定されています。
  - setSystemHeartbeatSendInterval
```
public StompBrokerRelayRegistration setSystemHeartbeatSendInterval(long systemHeartbeatSendInterval)
```
    他のデータが送信されていない場合に「システム」リレーセッションがハートビートを STOMP ブローカーに送信する間隔をミリ秒単位で設定します。値をゼロにすると、ハートビートがブローカーに送信されなくなります。
    デフォルト値は 10000 です。
  - setSystemHeartbeatReceiveInterval
```
public StompBrokerRelayRegistration setSystemHeartbeatReceiveInterval(long heartbeatReceiveInterval)
```
    他のデータがない場合に「システム」リレーセッションが STOMP ブローカーからハートビートを受信することを期待する最大間隔をミリ秒単位で設定します。ゼロの値は、ブローカーからハートビートを受信しないことを期待するようにリレーセッションを構成します。
    デフォルト値は 10000 です。
  - setVirtualHost
```
public StompBrokerRelayRegistration setVirtualHost(java.lang.String virtualHost)
```
    STOMP CONNECT フレームで使用する「ホスト」ヘッダーの値を設定します。このプロパティを設定すると、STOMP ブローカーに送信されるすべての STOMP フレームに「ホスト」ヘッダーが追加されます。これは、たとえば、TCP 接続が確立される実際のホストがクラウドベースの STOMP サービスを提供するホストと異なるクラウド環境で役立つ場合があります。
    デフォルトでは、このプロパティは設定されていません。
  - setTcpClient
```
public void setTcpClient(TcpOperations<byte[]> tcpClient)
```
    STOMP ブローカーへの TCP 接続を管理するための TCP クライアントを構成します。
    デフォルトでは ReactorNettyTcpClient が使用されます。
    注意 : このプロパティを使用すると、指定された host または port は事実上無視されます。
    導入:
    4.3.15
  - setAutoStartup
```
public StompBrokerRelayRegistration setAutoStartup(boolean autoStartup)
```
    Spring ApplicationContext がリフレッシュされたときに StompBrokerRelayMessageHandler が自動的に起動するかどうかを構成します。
    デフォルト設定は true です。
  - setUserDestinationBroadcast
```
public StompBrokerRelayRegistration setUserDestinationBroadcast(java.lang.String destination)
```
    ユーザーが接続していないように見えるために未解決のままになっているユーザーの宛先にメッセージをブロードキャストする宛先を設定します。マルチアプリケーションサーバーのシナリオでは、これにより他のアプリケーションサーバーが試す機会が与えられます。
    デフォルトでは、これは設定されていません。
    パラメーター:
    destination - 未解決のメッセージをブロードキャストする宛先。"/topic/unresolved-user-destination"
  - getUserDestinationBroadcast
```
@Nullable
protected java.lang.String getUserDestinationBroadcast()
```
  - setUserRegistryBroadcast
```
public StompBrokerRelayRegistration setUserRegistryBroadcast(java.lang.String destination)
```
    ローカルユーザーレジストリのコンテンツをブロードキャストし、他のサーバーからのブロードキャストをリッスンする宛先を設定します。マルチアプリケーションサーバーのシナリオでは、これにより、各サーバーのユーザーレジストリが他のサーバーに接続しているユーザーを認識することができます。
    デフォルトでは、これは設定されていません。
    パラメーター:
    destination - ユーザーレジストリの詳細をブロードキャストする宛先。"/topic/simp-user-registry"。
  - getUserRegistryBroadcast
```
@Nullable
protected java.lang.String getUserRegistryBroadcast()
```
  - getMessageHandler
```
protected StompBrokerRelayMessageHandler getMessageHandler(SubscribableChannel brokerChannel)
```
    次で指定:
    クラス AbstractBrokerRegistration の getMessageHandler

クラス StompBrokerRelayRegistration

コンストラクター概要

方法の概要

クラス org.springframework.messaging.simp.config.AbstractBrokerRegistration から継承されたメソッド

クラス java.lang.Object から継承されたメソッド

コンストラクターの詳細

StompBrokerRelayRegistration

メソッドの詳細

setRelayHost

setRelayPort

setClientLogin

setClientPasscode

setSystemLogin

setSystemPasscode

setSystemHeartbeatSendInterval

setSystemHeartbeatReceiveInterval

setVirtualHost

setTcpClient

setAutoStartup

setUserDestinationBroadcast

getUserDestinationBroadcast

setUserRegistryBroadcast

getUserRegistryBroadcast

getMessageHandler