パッケージ org.springframework.integration.annotation

アノテーションインターフェース Filter

@TargetSE({METHODSE,ANNOTATION_TYPESE}) @RetentionSE(RUNTIMESE) @DocumentedSE @RepeatableSE(Filters.class) public @interface Filter
メソッドがメッセージフィルターのロールを果たすことができることを示します。

@Filter アノテーションが付けられたメソッドは、型 Message または予期されるメッセージペイロードの型のパラメーターを受け入れる場合があります。デフォルトでサポートされている型変換、または "integrationConversionService" Bean に登録されているコンバーターは、必要に応じてメッセージペイロードに適用されます。ヘッダー値は、@Header パラメーターアノテーションを使用してメッセージパラメーターとして渡すこともできます。

アノテーション付きメソッドの戻り値の型はブール値（またはブール値）である必要があります。

導入:
2.0
作成者:
Mark Fisher, Gary Russell, Artem Bilan, Chris Bono

  • 要素の詳細

    • inputChannel

      StringSE inputChannel
      このフィルターがメッセージを消費するチャネルを指定します。チャネルが存在しない場合、この名前の DirectChannel がアプリケーションコンテキストに登録されます。
      戻り値:
      チャンネル名。
      デフォルト:
      ""

    • outputChannel

      StringSE outputChannel
      このフィルターがセレクターを通過するメッセージを送信するチャネルを指定します。
      戻り値:
      チャンネル名。
      デフォルト:
      ""

    • discardChannel

      StringSE discardChannel
      このフィルターがセレクターを通過しないメッセージを送信するチャネルを指定します。
      戻り値:
      チャンネル名。
      デフォルト:
      ""

    • throwExceptionOnRejection

      StringSE throwExceptionOnRejection
      フィルターがメッセージを拒否した場合は、例外をスローします。デフォルトは false です。「プロパティプレースホルダー」として指定できます。例: ${spring.integration.throwExceptionOnRejection}。
      戻り値:
      拒否フラグで例外をスローします。
      デフォルト:
      ""

    • adviceChain

      StringSE[] adviceChain
      メッセージハンドラーを「ラップ」する Advice Bean の「チェーン」を指定します。ダウンストリームフローではなく、ハンドラーのみが通知されます。
      戻り値:
      アドバイスチェーン。
      デフォルト:
      {}

    • discardWithinAdvice

      StringSE discardWithinAdvice
      true （デフォルト）の場合、破棄アクション（およびスローされた例外）は、チェーンのアドバイスクラスのスコープ内で発生します。それ以外の場合、これらのアクションが発生します。after the アドバイスチェーンが戻ります。「プロパティプレースホルダー」として指定できます。例: ${spring.integration.discardWithinAdvice}。
      戻り値:
      アドバイスフラグ内の破棄。
      デフォルト:
      ""

    • sendTimeout

      StringSE sendTimeout
      応答 Message を outputChannel() に送信するときに待機する最大時間をミリ秒単位で指定します。デフォルトは 30 秒です。これは、出力チャンネルに何らかの「送信」制限がある場合にのみ適用されます。「容量」が固定された QueueChannel。この場合、MessageDeliveryException がスローされます。AbstractSubscribableChannel 実装の場合、"sendTimeout" は無視されます。「プロパティプレースホルダ」として指定できます。${spring.integration.sendTimeout}。
      戻り値:
      結果を応答ターゲットに送信するためのタイムアウト (ミリ秒単位)
      デフォルト:
      ""

    • autoStartup

      StringSE autoStartup
      SmartLifecycle autoStartup オプション。「プロパティプレースホルダー」として指定できます。例: ${foo.autoStartup}。デフォルトは true です。
      戻り値:
      自動起動 boolean フラグ。
      デフォルト:
      ""

    • phase

      StringSE phase
      SmartLifecycle phase オプションを指定します。デフォルトは、PollingConsumer の場合は Integer.MAX_VALUE / 2、EventDrivenConsumer の場合は Integer.MIN_VALUE です。「プロパティプレースホルダー」として指定できます。例: ${foo.phase}。
      戻り値:
      SmartLifecycle フェーズ。
      デフォルト:
      ""

    • poller

      Poller poller
      戻り値:
      ポーリングされたエンドポイント ( PollerMetadata ) の Poller オプション。reactive() とは相互に排他的です。
      デフォルト:
      @org.springframework.integration.annotation.Poller("\n\t\t\n\t\t\n\ue000\ue001\ue002\n\t\t\t\t\n")

    • reactive

      Reactive reactive
      戻り値:
      コンシューマーエンドポイントの Reactive マーカー。poller() と相互に排他的です。
      導入:
      5.5
      デフォルト:
      @org.springframework.integration.annotation.Reactive（"\n \ t \ t \n \ t \ t \n \ ue000 \ ue001 \ ue002 \n \ t \ t \ t \ t \n"）