クラス GatewayProxySpec

java.lang.ObjectSE
org.springframework.integration.dsl.GatewayProxySpec
public class GatewayProxySpec extends ObjectSE
サービスインターフェースの MessagingGateway を宣言できない場合の GatewayProxyFactoryBean オプションのビルダー。
導入:
5.2
作成者:
Artem Bilan, Gary Russell

  • フィールドの詳細

  • コンストラクターの詳細

    • GatewayProxySpec

      protected GatewayProxySpec(ClassSE<?> serviceInterface)

  • 方法の詳細

    • beanName

      public GatewayProxySpec beanName(@Nullable StringSE beanName)
      ターゲット GatewayProxyFactoryBean の Bean 名を指定します。
      パラメーター:
      beanName - ゲートウェイプロキシに Bean を登録するために使用される Bean 名
      戻り値:
      現在の GatewayProxySpec。

    • replyChannel

      public GatewayProxySpec replyChannel(StringSE channelName)
      ゲートウェイプロキシがサブスクライブするデフォルトチャネルを識別し、応答 Message を受信します。そのペイロードは、メソッドシグネチャーの戻り値の型に変換されます。
      パラメーター:
      channelName - MessageChannel の Bean 名
      戻り値:
      現在の GatewayProxySpec。
      関連事項:

    • replyChannel

      public GatewayProxySpec replyChannel(MessageChannel replyChannel)
      ゲートウェイプロキシがサブスクライブするデフォルトチャネルを識別し、応答 Message を受信します。そのペイロードは、メソッドシグネチャーの戻り値の型に変換されます。
      パラメーター:
      replyChannel - 返信用の MessageChannel。
      戻り値:
      現在の GatewayProxySpec。
      関連事項:

    • errorChannel

      public GatewayProxySpec errorChannel(StringSE errorChannelName)
      ゲートウェイのプロキシ呼び出しで障害が発生した場合にエラーメッセージが送信されるチャネルを識別します。errorChannel 参照が提供されていない場合、ゲートウェイは Exception を呼び出し元に伝搬します。Exception を完全に抑制するには、ここで nullChannel への参照を提供します。
      パラメーター:
      errorChannelName - MessageChannel の Bean 名
      戻り値:
      現在の GatewayProxySpec。
      関連事項:

    • errorChannel

      public GatewayProxySpec errorChannel(MessageChannel errorChannel)
      ゲートウェイのプロキシ呼び出しで障害が発生した場合にエラーメッセージが送信されるチャネルを識別します。errorChannel 参照が提供されていない場合、ゲートウェイは Exception を呼び出し元に伝搬します。Exception を完全に抑制するには、ここで nullChannel への参照を提供します。
      パラメーター:
      errorChannel - 返信用の MessageChannel。
      戻り値:
      現在の GatewayProxySpec。
      関連事項:

    • requestTimeout

      public GatewayProxySpec requestTimeout(long requestTimeout)
      ディスパッチャーが Message の送信を待機する時間を提供します。このタイムアウトは、送信呼び出しでブロックされる可能性がある場合にのみ適用されます。たとえば、このゲートウェイが QueueChannel に接続されている場合です。値はミリ秒単位で指定されます。
      パラメーター:
      requestTimeout - リクエストのタイムアウト（ミリ秒単位）。
      戻り値:
      現在の GatewayProxySpec。
      関連事項:

    • replyTimeout

      public GatewayProxySpec replyTimeout(long replyTimeout)
      このゲートウェイが応答 Message を返すまで待機する時間を指定できます。デフォルトでは、30 秒待機します。ゲートウェイがタイムアウトすると、null が返されます。値はミリ秒単位で指定します。
      パラメーター:
      replyTimeout - ミリ秒単位の応答のタイムアウト。
      戻り値:
      現在の GatewayProxySpec。
      関連事項:

    • asyncExecutor

      public GatewayProxySpec asyncExecutor(@Nullable ExecutorSE executor)
      FutureSE 戻り値の型を持つ任意のインターフェースメソッドに使用する ExecutorSE の実装への参照を提供します。この Executor は、これらの非同期メソッドにのみ使用されます。同期メソッドは、呼び出し元のスレッドで呼び出されます。null を使用して、非同期エグゼキュータを指定しないでください。たとえば、ダウンストリームフローが FutureSE を返す場合などです。
      パラメーター:
      executor - 使用する ExecutorSE。
      戻り値:
      現在の GatewayProxySpec。
      関連事項:

    • payloadExpression

      public GatewayProxySpec payloadExpression(StringSE expression)
      メソッド宣言によって明示的にオーバーライドされない限り、サービスインターフェースのすべてのメソッドの payload を生成するために使用される式。評価コンテキストのルートオブジェクトは MethodArgsHolder です。
      パラメーター:
      expression - デフォルトのペイロードの SpEL 式。
      戻り値:
      現在の GatewayProxySpec。
      関連事項:

    • payloadFunction

      public GatewayProxySpec payloadFunction(FunctionSE<MethodArgsHolder, ?> defaultPayloadFunction)
      メソッド宣言によって明示的にオーバーライドされない限り、サービスインターフェースのすべてのメソッドの payload を生成するために使用される FunctionSE。
      パラメーター:
      defaultPayloadFunction - デフォルトのペイロードの FunctionSE。
      戻り値:
      現在の GatewayProxySpec。
      関連事項:

    • payloadExpression

      public GatewayProxySpec payloadExpression(Expression expression)
      メソッド宣言によって明示的にオーバーライドされない限り、サービスインターフェースのすべてのメソッドの payload を生成するために使用される式。評価コンテキストのルートオブジェクトは MethodArgsHolder です。Bean リゾルバーも利用可能で、@someBean(#args) のような式を有効にします。
      パラメーター:
      expression - デフォルトのペイロードの SpEL 式。
      戻り値:
      現在の GatewayProxySpec。
      関連事項:

    • header

      public GatewayProxySpec header(StringSE headerName, ObjectSE value)
      カスタムメッセージヘッダーを提供します。デフォルトのヘッダーは、サービスインターフェースのすべてのメソッドに対して作成されます（特定のメソッドによってオーバーライドされない限り）。
      パラメーター:
      headerName - ヘッダーの名前。
      value - ヘッダーの静的な値。
      戻り値:
      現在の GatewayProxySpec。
      関連事項:

    • header

      public GatewayProxySpec header(StringSE headerName, FunctionSE<MethodArgsHolder, ?> valueFunction)
      カスタムメッセージヘッダーを提供します。デフォルトのヘッダーは、サービスインターフェースのすべてのメソッドに対して作成されます（特定のメソッドによってオーバーライドされない限り）。
      パラメーター:
      headerName - ヘッダーの名前。
      valueFunction - ヘッダー値の FunctionSE。
      戻り値:
      現在の GatewayProxySpec。
      関連事項:

    • header

      public GatewayProxySpec header(StringSE headerName, Expression valueExpression)
      カスタムメッセージヘッダーを提供します。デフォルトのヘッダーは、サービスインターフェースのすべてのメソッドに対して作成されます（特定のメソッドによってオーバーライドされない限り）。この式ベースのヘッダーは、評価コンテキストのルートオブジェクトとして MethodArgsHolder にアクセスできます。
      パラメーター:
      headerName - ヘッダーの名前。
      valueExpression - ヘッダー値の SpEL 式。
      戻り値:
      現在の GatewayProxySpec。
      関連事項:

    • mapper

      public GatewayProxySpec mapper(MethodArgsMessageMapper mapper)
      メソッド引数を Message にマップするための MethodArgsMessageMapper。これが提供されている場合、payload-expression または header は許可されません。カスタムマッパーはメッセージの作成を担当します。
      パラメーター:
      mapper - 使用する MethodArgsMessageMapper。
      戻り値:
      現在の GatewayProxySpec。
      関連事項:

    • proxyDefaultMethods

      public GatewayProxySpec proxyDefaultMethods(boolean proxyDefaultMethods)
      インターフェースの default メソッドもプロキシする必要があるかどうかを示します。
      パラメーター:
      proxyDefaultMethods - デフォルトのメソッドをプロキシする、または MethodHandle を介して呼び出すブールフラグ。
      戻り値:
      現在の GatewayProxySpec。
      導入:
      5.3
      関連事項: