UserDestinationMessageHandler (Spring Framework API)

java.lang.ObjectSE
- org.springframework.messaging.simp.user.UserDestinationMessageHandler

実装されたすべてのインターフェース:
Lifecycle, Phased, SmartLifecycle, MessageHandler
```
public class UserDestinationMessageHandler
extends ObjectSE
implements MessageHandler, SmartLifecycle
```
「ユーザー」宛先をサポートする MessageHandler。
「ユーザー」宛先のメッセージをリッスンし、その宛先をユーザーのアクティブセッションに固有の実際のターゲット宛先に変換し、解決されたメッセージをブローカーチャネルに送信して配信します。
導入:
4.0
作成者:
Rossen Stoyanchev

フィールドサマリー
- インターフェース org.springframework.context.SmartLifecycle から継承されたフィールド
  DEFAULT_PHASE

コンストラクターのサマリー

コンストラクター
コンストラクターと説明
`UserDestinationMessageHandler(SubscribableChannel clientInboundChannel, SubscribableChannel brokerChannel, UserDestinationResolver resolver)` 指定されたクライアントとブローカーチャネルをサブスクライブしてインスタンスを作成し、それぞれからのメッセージを処理して、解決されたメッセージをブローカーチャネルに送信します。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`StringSE`	`getBroadcastDestination()` 未解決のメッセージの構成済み宛先を返します。
`MessageSendingOperations<StringSE>`	`getBrokerMessagingTemplate()` 解決されたメッセージをブローカーチャネルに送信するために使用されるメッセージングテンプレートを返します。
`MessageHeaderInitializer`	`getHeaderInitializer()` 設定済みのヘッダー初期化子を返します。
`UserDestinationResolver`	`getUserDestinationResolver()` 設定された `UserDestinationResolver` を返します。
`void`	`handleMessage(Message<?> message)` 指定されたメッセージを処理します。
`boolean`	`isRunning()` このコンポーネントが現在実行されているかどうかを確認します。
`void`	`setBroadcastDestination(StringSE destination)` ユーザーが接続されていないため未解決のままになるメッセージをブロードキャストする宛先を設定します。
`void`	`setHeaderInitializer(MessageHeaderInitializer headerInitializer)` カスタム `MessageHeaderInitializer` を構成して、解決されたターゲットメッセージのヘッダーを初期化します。
`void`	`start()` このコンポーネントを起動します。
`void`	`stop()` このメソッドを返すとコンポーネントが完全に停止するように、通常は同期的にこのコンポーネントを停止します。
`void`	`stop(RunnableSE callback)` Lifecycle コンポーネントが現在実行中の場合、停止する必要があることを示します。
`StringSE`	`toString()`

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, waitSE, waitSE, waitSE

インターフェース org.springframework.context.SmartLifecycle から継承されたメソッド
getPhase, isAutoStartup

- コンストラクターの詳細
  - UserDestinationMessageHandler
```
public UserDestinationMessageHandler(SubscribableChannel clientInboundChannel,
                                     SubscribableChannel brokerChannel,
                                     UserDestinationResolver resolver)
```
    指定されたクライアントとブローカーチャネルをサブスクライブしてインスタンスを作成し、それぞれからのメッセージを処理して、解決されたメッセージをブローカーチャネルに送信します。
    パラメーター:
    clientInboundChannel - クライアントから受信したメッセージ。
    brokerChannel - ブローカーに送信されたメッセージ。
    resolver - 「ユーザー」宛先のリゾルバー。
- メソッドの詳細
  - getUserDestinationResolver
```
public UserDestinationResolver getUserDestinationResolver()
```
    設定された UserDestinationResolver を返します。
  - setBroadcastDestination
```
public void setBroadcastDestination(@Nullable
                                    StringSE destination)
```
    ユーザーが接続されていないため未解決のままになるメッセージをブロードキャストする宛先を設定します。マルチアプリケーションサーバーのシナリオでは、これにより他のアプリケーションサーバーが試す機会が与えられます。
    デフォルトでは、これは設定されていません。
    パラメーター:
    destination - ターゲット宛先。
  - getBroadcastDestination
```
@Nullable
public StringSE getBroadcastDestination()
```
    未解決のメッセージの構成済み宛先を返します。
  - getBrokerMessagingTemplate
```
public MessageSendingOperations<StringSE> getBrokerMessagingTemplate()
```
    解決されたメッセージをブローカーチャネルに送信するために使用されるメッセージングテンプレートを返します。
  - setHeaderInitializer
```
public void setHeaderInitializer(@Nullable
                                 MessageHeaderInitializer headerInitializer)
```
    カスタム MessageHeaderInitializer を構成して、解決されたターゲットメッセージのヘッダーを初期化します。
    デフォルトでは、これは設定されていません。
  - getHeaderInitializer
```
@Nullable
public MessageHeaderInitializer getHeaderInitializer()
```
    設定済みのヘッダー初期化子を返します。
  - start
```
public final void start()
```
    インターフェースからコピーされた説明: Lifecycle
    このコンポーネントを起動します。
    コンポーネントがすでに実行されている場合は、例外をスローしないでください。
    コンテナーの場合、これは適用されるすべてのコンポーネントに開始信号を伝播します。
    次で指定:
    インターフェース Lifecycle の start
    関連事項:
    SmartLifecycle.isAutoStartup()
  - stop
```
public final void stop()
```
    インターフェースからコピーされた説明: Lifecycle
    このメソッドを返すとコンポーネントが完全に停止するように、通常は同期的にこのコンポーネントを停止します。非同期停止動作が必要な場合は、SmartLifecycle とその stop(Runnable) バリアントの実装を検討してください。
    この停止通知は破棄前に送信されるとは限らないことに注意してください。通常のシャットダウンでは、一般的な破棄コールバックが伝播される前に、Lifecycle Bean は最初に停止通知を受信します。ただし、コンテキストの存続期間中のホットリフレッシュまたは中断されたリフレッシュ試行では、特定の Bean の destroy メソッドが、停止信号を事前に考慮することなく呼び出されます。
    コンポーネントが実行されていない（まだ開始されていない）場合は、例外をスローしないでください。
    コンテナーの場合、これは停止信号を適用するすべてのコンポーネントに伝播します。
    次で指定:
    インターフェース Lifecycle の stop
    関連事項:
    SmartLifecycle.stop(Runnable), DisposableBean.destroy()
  - stop
```
public final void stop(RunnableSE callback)
```
    インターフェースからコピーされた説明: SmartLifecycle
    Lifecycle コンポーネントが現在実行中の場合、停止する必要があることを示します。
    提供されたコールバックは、LifecycleProcessor によって使用され、共通のシャットダウン順序値を持つすべてのコンポーネントの順序付けられた、潜在的に同時のシャットダウンをサポートします。コールバックは、SmartLifecycle コンポーネントが実際に停止した後に実行する必要があります。
    LifecycleProcessor は、stop メソッドのこのバリアントのみを呼び出します。つまり、SmartLifecycle 実装では、このメソッドの実装内に明示的に委譲されない限り、Lifecycle.stop() は呼び出されません。
    デフォルトの実装は Lifecycle.stop() に委譲し、呼び出しスレッドで指定されたコールバックをすぐにトリガーします。2 つの間に同期がないことに注意してください。カスタム実装では、少なくとも共通のライフサイクルモニター（存在する場合）内に同じ手順を入れたい場合があります。
    次で指定:
    インターフェース SmartLifecycle の stop
    関連事項:
    Lifecycle.stop(), SmartLifecycle.getPhase()
  - isRunning
```
public final boolean isRunning()
```
    インターフェースからコピーされた説明: Lifecycle
    このコンポーネントが現在実行されているかどうかを確認します。
    コンテナーの場合、これは、適用されるすべてのコンポーネントが現在実行されている場合にのみ、true を返します。
    次で指定:
    インターフェース Lifecycle の isRunning
    戻り値:
    コンポーネントが現在実行中かどうか
  - handleMessage
```
public void handleMessage(Message<?> message)
                   throws MessagingException
```
    インターフェースからコピーされた説明: MessageHandler
    指定されたメッセージを処理します。
    次で指定:
    インターフェース MessageHandler の handleMessage
    パラメーター:
    message - 処理するメッセージ
    例外:
    MessagingException - ハンドラーがメッセージの処理に失敗した場合
  - toString
```
public StringSE toString()
```
    オーバーライド:
    クラス ObjectSE の toStringSE

クラス UserDestinationMessageHandler

フィールドサマリー

インターフェース org.springframework.context.SmartLifecycle から継承されたフィールド

コンストラクターのサマリー

メソッドのサマリー

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

インターフェース org.springframework.context.SmartLifecycle から継承されたメソッド

コンストラクターの詳細

UserDestinationMessageHandler

メソッドの詳細

getUserDestinationResolver

setBroadcastDestination

getBroadcastDestination

getBrokerMessagingTemplate

setHeaderInitializer

getHeaderInitializer

start

stop

stop

isRunning

handleMessage

toString