クラス SimpAnnotationMethodMessageHandler

メソッドの詳細

• setDestinationPrefixes

  public void setDestinationPrefixes(@Nullable CollectionSE<StringSE> prefixes)

  このプロパティが設定されている場合、設定された接頭辞のいずれかに一致する宛先へのメッセージのみが処理に適しています。一致する場合、プレフィックスが削除され、宛先の残りの部分のみがメソッドマッピングの目的で使用されます。

  デフォルトでは、プレフィックスは設定されていません。この場合、すべてのメッセージが処理に適格です。

  宛先の接頭辞はスラッシュで区切られた文字列であることが期待されているため、適切な接頭辞ベースの一致（つまり、完全なセグメントの一致）を確実にするために、欠落している場所にスラッシュが自動的に追加されます。

  ただし、プレフィックスの後の宛先の残りの部分では、構成された PathMatcher に応じて異なる区切り文字 (たとえば、メッセージングでは一般に "." ) が使用される場合があることに注意してください。

  オーバーライド:

  クラス AbstractMethodMessageHandler<SimpMessageMappingInfo> の setDestinationPrefixes 

• setMessageConverter

  public void setMessageConverter(MessageConverter converter)

  メッセージのペイロードを特定の MIME 型の直列化された形式からターゲットメソッドパラメーターに一致するオブジェクトに変換するために使用する MessageConverter を構成します。コンバーターは、メッセージブローカーにメッセージを送信するときにも使用されます。

  関連事項:

  • CompositeMessageConverter

• getMessageConverter

  public MessageConverter getMessageConverter()

  設定された MessageConverter を返します。

• setConversionService

  public void setConversionService(ConversionService conversionService)

  メッセージヘッダー値などのメソッド引数を解決するときに使用する ConversionService を構成します。

  デフォルトでは、DefaultFormattingConversionService が使用されます。

• getConversionService

  public ConversionService getConversionService()

  設定された ConversionService を返します。

• setPathMatcher

  public void setPathMatcher(PathMatcher pathMatcher)

  PathMatcher 実装を設定して、設定された宛先パターンに対して宛先を照合するために使用します。

  デフォルトでは、AntPathMatcher が使用されます。

• getPathMatcher

  public PathMatcher getPathMatcher()

  一致する宛先に使用する PathMatcher 実装を返します。

• getValidator

  @Nullable public Validator getValidator()

  設定された Validator インスタンスを返します。

• setValidator

  public void setValidator(@Nullable Validator validator)

  @Payload 引数の検証に使用される Validator インスタンスを設定します。

  関連事項:

  • Validated
  • PayloadMethodArgumentResolver

• setEmbeddedValueResolver

  public void setEmbeddedValueResolver(StringValueResolver resolver)

  インターフェースからコピーされた説明: EmbeddedValueResolverAware

  StringValueResolver を設定して、埋め込まれた定義値の解決に使用します。

  次で指定:

  インターフェース EmbeddedValueResolverAware の setEmbeddedValueResolver 

• setHeaderInitializer

  public void setHeaderInitializer(@Nullable MessageHeaderInitializer headerInitializer)

  コントローラーの戻り値からメッセージを送信する HandlerMethodReturnValueHandlers に渡すように MessageHeaderInitializer を構成します。

  デフォルトでは、このプロパティは設定されていません。

• getHeaderInitializer

  @Nullable public MessageHeaderInitializer getHeaderInitializer()

  設定済みのヘッダー初期化子を返します。

• setPhase

  public void setPhase(int phase)

  このハンドラーが実行されるフェーズを設定します。

  デフォルトでは SmartLifecycle.DEFAULT_PHASE ですが、@EnableWebSocketMessageBroker 構成では 0 に設定されます。

  導入:

  6.1.4

• getPhase

  public int getPhase()

  インターフェースからコピーされた説明: SmartLifecycle

  このライフサイクルオブジェクトが実行されるはずのフェーズを返します。

  デフォルトの実装は、通常の Lifecycle 実装の前に stop() コールバックを実行できるようにするために SmartLifecycle.DEFAULT_PHASE を返します。

  次で指定:

  インターフェース Phased の getPhase 

  次で指定:

  インターフェース SmartLifecycle の getPhase 

  関連事項:

  • SmartLifecycle.isAutoStartup()
  • Lifecycle.start()
  • SmartLifecycle.stop(Runnable)
  • DefaultLifecycleProcessor.getPhase(Lifecycle)

• 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 

  戻り値:

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

• initArgumentResolvers

  protected ListSE<HandlerMethodArgumentResolver> initArgumentResolvers()

  クラスからコピーされた説明: AbstractMethodMessageHandler

  使用する引数リゾルバーのリストを返します。AbstractMethodMessageHandler.setArgumentResolvers(java.util.List<org.springframework.messaging.handler.invocation.HandlerMethodArgumentResolver>) を介してリゾルバーがまだ設定されていない場合にのみ呼び出されます。

  サブクラスでは、AbstractMethodMessageHandler.setCustomArgumentResolvers(java.util.List<org.springframework.messaging.handler.invocation.HandlerMethodArgumentResolver>) を介して構成されたカスタム引数型も考慮する必要があります。

  次で指定:

  クラス AbstractMethodMessageHandler<SimpMessageMappingInfo> の initArgumentResolvers 

• initReturnValueHandlers

  protected ListSE<? extends HandlerMethodReturnValueHandler> initReturnValueHandlers()

  クラスからコピーされた説明: AbstractMethodMessageHandler

  使用する戻り値ハンドラーのリストを返します。戻り値ハンドラーが AbstractMethodMessageHandler.setReturnValueHandlers(java.util.List<org.springframework.messaging.handler.invocation.HandlerMethodReturnValueHandler>) を介してまだ設定されていない場合にのみ呼び出されます。

  サブクラスは、AbstractMethodMessageHandler.setCustomReturnValueHandlers(java.util.List<org.springframework.messaging.handler.invocation.HandlerMethodReturnValueHandler>) を介して構成されたカスタム戻り値型も考慮する必要があります。

  次で指定:

  クラス AbstractMethodMessageHandler<SimpMessageMappingInfo> の initReturnValueHandlers 

• getReturnValueHandlerLogger

  protected Log getReturnValueHandlerLogger()

  クラスからコピーされた説明: AbstractMethodMessageHandler

  HandlerMethodReturnValueHandlerComposite に設定するロガーを返します。

  オーバーライド:

  クラス AbstractMethodMessageHandler<SimpMessageMappingInfo> の getReturnValueHandlerLogger 

• getHandlerMethodLogger

  protected Log getHandlerMethodLogger()

  クラスからコピーされた説明: AbstractMethodMessageHandler

  InvocableHandlerMethod に設定するロガーを返します。

  オーバーライド:

  クラス AbstractMethodMessageHandler<SimpMessageMappingInfo> の getHandlerMethodLogger 

• isHandler

  protected boolean isHandler(ClassSE<?> beanType)

  クラスからコピーされた説明: AbstractMethodMessageHandler

  指定された Bean 型をメッセージング処理メソッドに対してイントロスペクトする必要があるかどうか。

  次で指定:

  クラス AbstractMethodMessageHandler<SimpMessageMappingInfo> の isHandler 

• getMappingForMethod

  @Nullable protected SimpMessageMappingInfo getMappingForMethod(MethodSE method, ClassSE<?> handlerType)

  クラスからコピーされた説明: AbstractMethodMessageHandler

  ハンドラーメソッドのマッピングを提供します。

  次で指定:

  クラス AbstractMethodMessageHandler<SimpMessageMappingInfo> の getMappingForMethod 

  パラメーター:

  method - マッピングを提供する方法

  handlerType - ハンドラー型、場合によってはメソッドの宣言クラスのサブ型

  戻り値:

  マッピング、またはメソッドがマッピングされていない場合は null 

• resolveEmbeddedValuesInDestinations

  protected StringSE[] resolveEmbeddedValuesInDestinations(StringSE[] destinations)

  指定された宛先配列のプレースホルダー値を解決します。

  戻り値:

  更新された宛先を持つ新しい配列

  導入:

  4.2

• getDirectLookupDestinations

  protected SetSE<StringSE> getDirectLookupDestinations(SimpMessageMappingInfo mapping)

  クラスからコピーされた説明: AbstractMethodMessageHandler

  マッピングに含まれ、パターンではないため、直接ルックアップに適した戻り先。

  次で指定:

  クラス AbstractMethodMessageHandler<SimpMessageMappingInfo> の getDirectLookupDestinations 

• getDestination

  @Nullable protected StringSE getDestination(Message<?> message)

  次で指定:

  クラス AbstractMethodMessageHandler<SimpMessageMappingInfo> の getDestination 

• getLookupDestination

  @Nullable protected StringSE getLookupDestination(@Nullable StringSE destination)

  クラスからコピーされた説明: AbstractMethodMessageHandler

  （受信メッセージの）指定された宛先が構成済み宛先プレフィックスの 1 つと一致するかどうかを確認し、一致する場合は、一致したプレフィックスの後に宛先の残りの部分を返します。

  一致するプレフィックスがない場合は、null を返します。

  宛先プレフィックスがない場合は、宛先をそのまま返します。

  オーバーライド:

  クラス AbstractMethodMessageHandler<SimpMessageMappingInfo> の getLookupDestination 

• getMatchingMapping

  @Nullable protected SimpMessageMappingInfo getMatchingMapping(SimpMessageMappingInfo mapping, Message<?> message)

  クラスからコピーされた説明: AbstractMethodMessageHandler

  マッピングが現在のメッセージと一致するかどうかを確認し、現在のリクエストに関連する条件を含む新しいマッピングを返す可能性があります。

  次で指定:

  クラス AbstractMethodMessageHandler<SimpMessageMappingInfo> の getMatchingMapping 

  パラメーター:

  mapping - 一致を取得するマッピング

  message - 処理されているメッセージ

  戻り値:

  一致、または一致がない場合は null 

• getMappingComparator

  protected ComparatorSE<SimpMessageMappingInfo> getMappingComparator(Message<?> message)

  クラスからコピーされた説明: AbstractMethodMessageHandler

  一致するマッピングをソートするためのコンパレータを返します。返されたコンパレータは、「より良い」一致をより高い順に並べ替えます。

  次で指定:

  クラス AbstractMethodMessageHandler<SimpMessageMappingInfo> の getMappingComparator 

  パラメーター:

  message - 現在のメッセージ

  戻り値:

  コンパレータ、決して null

• handleMatch

  protected void handleMatch(SimpMessageMappingInfo mapping, HandlerMethod handlerMethod, StringSE lookupDestination, Message<?> message)

  オーバーライド:

  クラス AbstractMethodMessageHandler<SimpMessageMappingInfo> の handleMatch 

• createExceptionHandlerMethodResolverFor

  protected AbstractExceptionHandlerMethodResolver createExceptionHandlerMethodResolverFor(ClassSE<?> beanType)

  次で指定:

  クラス AbstractMethodMessageHandler<SimpMessageMappingInfo> の createExceptionHandlerMethodResolverFor