フィールドの詳細

• logger

  protected final Log logger

コンストラクターの詳細

• AbstractBrokerMessageHandler

  public AbstractBrokerMessageHandler(SubscribableChannel inboundChannel,
                                      MessageChannel outboundChannel,
                                      SubscribableChannel brokerChannel)

  宛先プレフィックスのないコンストラクター（すべての宛先に一致）。

  パラメーター:

  inboundChannel - クライアントからメッセージを受信するためのチャネル (たとえば WebSocket クライアント)

  outboundChannel - クライアントにメッセージを送信するためのチャネル (たとえば WebSocket クライアント)

  brokerChannel - アプリケーションがブローカーにメッセージを送信するためのチャネル

• AbstractBrokerMessageHandler

  public AbstractBrokerMessageHandler(SubscribableChannel inboundChannel,
                                      MessageChannel outboundChannel,
                                      SubscribableChannel brokerChannel,
                                      @Nullable
                                      CollectionSE<StringSE> destinationPrefixes)

  メッセージの宛先に一致する宛先プレフィックスを持つコンストラクター。

  パラメーター:

  inboundChannel - クライアントからメッセージを受信するためのチャネル (たとえば WebSocket クライアント)

  outboundChannel - クライアントにメッセージを送信するためのチャネル (たとえば WebSocket クライアント)

  brokerChannel - アプリケーションがブローカーにメッセージを送信するためのチャネル

  destinationPrefixes - メッセージを除外するために使用するプレフィックス

メソッドの詳細

• getClientInboundChannel

  public SubscribableChannel getClientInboundChannel()

• getClientOutboundChannel

  public MessageChannel getClientOutboundChannel()

• getBrokerChannel

  public SubscribableChannel getBrokerChannel()

• getDestinationPrefixes

  public CollectionSE<StringSE> getDestinationPrefixes()

• setApplicationEventPublisher

  public void setApplicationEventPublisher(@Nullable
                                           ApplicationEventPublisher publisher)

  インターフェースからコピーされた説明: ApplicationEventPublisherAware
  このオブジェクトが実行される ApplicationEventPublisher を設定します。

  通常の Bean プロパティの設定後、InitializingBean の afterPropertiesSet などの init コールバックやカスタム init メソッドの前に呼び出されます。ApplicationContextAware の setApplicationContext の前に呼び出されます。

  次で指定:

  インターフェース ApplicationEventPublisherAware の setApplicationEventPublisher 

  パラメーター:

  publisher - このオブジェクトによって使用されるイベント発行元

• getApplicationEventPublisher

  @Nullable
  public ApplicationEventPublisher getApplicationEventPublisher()

• setAutoStartup

  public void setAutoStartup(boolean autoStartup)

• isAutoStartup

  public boolean isAutoStartup()

  インターフェースからコピーされた説明: SmartLifecycle
  true が含まれる ApplicationContext がリフレッシュされるときに、この Lifecycle コンポーネントがコンテナーによって自動的に開始される場合、true を返します。

  false の値は、プレーン Lifecycle 実装に類似した、明示的な Lifecycle.start() 呼び出しを介してコンポーネントが開始されることを意図していることを示します。

  次で指定:

  インターフェース SmartLifecycle の isAutoStartup 

  関連事項:

  Lifecycle.start(), Phased.getPhase(), LifecycleProcessor.onRefresh(), ConfigurableApplicationContext.refresh()

• getPhase

  public int getPhase()

  インターフェースからコピーされた説明: Phased
  このオブジェクトのフェーズ値を返します。

  次で指定:

  インターフェース Phased の getPhase 

• start

  public void start()

  インターフェースからコピーされた説明: Lifecycle
  このコンポーネントを起動します。

  コンポーネントがすでに実行されている場合は、例外をスローしないでください。

  コンテナーの場合、これは適用されるすべてのコンポーネントに開始シグナルを伝播します。

  次で指定:

  インターフェース Lifecycle の start 

  関連事項:

  SmartLifecycle.isAutoStartup()

• startInternal

  protected void startInternal()

• stop

  public void stop()

  インターフェースからコピーされた説明: Lifecycle
  このメソッドを返すとコンポーネントが完全に停止するように、通常は同期的にこのコンポーネントを停止します。非同期停止動作が必要な場合は、SmartLifecycle とその stop(Runnable) バリアントの実装を検討してください。

  この停止通知が破棄の前に来るとは限らないことに注意してください。通常のシャットダウンでは、Lifecycle Bean は一般的な破棄コールバックが伝達される前に、まず停止通知を受け取ります。ただし、コンテキストの有効期間中のホットリフレッシュ時、またはリフレッシュ試行が中止されたときは、destroy メソッドのみが呼び出されます。

  コンポーネントがまだ開始されていない場合は、例外をスローしないでください。

  コンテナーの場合、これは停止シグナルを適用するすべてのコンポーネントに伝播します。

  次で指定:

  インターフェース Lifecycle の stop 

  関連事項:

  SmartLifecycle.stop(Runnable), DisposableBean.destroy()

• stopInternal

  protected void stopInternal()

• stop

  public final void stop(RunnableSE callback)

  インターフェースからコピーされた説明: SmartLifecycle
  Lifecycle コンポーネントが現在実行中の場合、停止する必要があることを示します。

  提供されたコールバックは、LifecycleProcessor によって使用され、共通のシャットダウン順序値を持つすべてのコンポーネントの順序付けられた、潜在的に同時のシャットダウンをサポートします。コールバック は、SmartLifecycle コンポーネントが実際に停止した後に実行する必要があります。

  LifecycleProcessor は、stop メソッドのこのバリアントのみを呼び出します。つまり、SmartLifecycle 実装では、このメソッドの実装内に明示的に委譲されない限り、Lifecycle.stop() は呼び出されません。

  次で指定:

  インターフェース SmartLifecycle の stop 

  関連事項:

  Lifecycle.stop(), Phased.getPhase()

• isRunning

  public final boolean isRunning()

  このメッセージハンドラーが現在実行されているかどうかを確認します。

  このメッセージハンドラーが実行されている場合でも、isBrokerAvailable() フラグは、具象サブクラスの実装によっては、オンとオフを交互に切り替える場合があります。

  次で指定:

  インターフェース Lifecycle の isRunning 

  戻り値:

  コンポーネントが現在実行中かどうか

• isBrokerAvailable

  public boolean isBrokerAvailable()

  メッセージブローカーが現在利用可能で、メッセージを処理できるかどうか。

  これは、このメッセージハンドラーが実行されているかどうかを示す isRunning() フラグに追加されることに注意してください。つまり、メッセージハンドラーを最初に実行しておく必要があります。その後、具象サブクラスの実装に応じて、#isBrokerAvailable() フラグをオンとオフの間で個別に切り替えることができます。

  アプリケーションコンポーネントは、org.springframework.context.ApplicationListener<BrokerAvailabilityEvent> を実装して、ブローカーが使用可能および使用不可になったときに通知を受け取ることができます。

• handleMessage

  public void handleMessage(Message<?> message)

  インターフェースからコピーされた説明: MessageHandler
  指定されたメッセージを処理します。

  次で指定:

  インターフェース MessageHandler の handleMessage 

  パラメーター:

  message - 処理するメッセージ

• handleMessageInternal

  protected abstract void handleMessageInternal(Message<?> message)

• checkDestinationPrefix

  protected boolean checkDestinationPrefix(@Nullable
                                           StringSE destination)

• publishBrokerAvailableEvent

  protected void publishBrokerAvailableEvent()

• publishBrokerUnavailableEvent

  protected void publishBrokerUnavailableEvent()