クラス MessagingGatewaySupport

方法の詳細

• setErrorOnTimeout

  public void setErrorOnTimeout(boolean errorOnTimeout)

  errorOnTimeout が true の場合、応答が期待されても何も受信されない場合に、MessageTimeoutException ペイロードを含む ErrorMessage をエラーチャネルに送信するインスタンスを作成します。エラーチャネルが設定されていない場合、MessageTimeoutException がスローされます。

  パラメーター:

  errorOnTimeout - true の場合、応答タイムアウト時にエラーメッセージを作成します。

  導入:

  5.2.2

• setRequestChannel

  public void setRequestChannel(MessageChannel requestChannel)

  リクエストチャネルを設定します。

  パラメーター:

  requestChannel - リクエストメッセージの送信先のチャネル

• setRequestChannelName

  public void setRequestChannelName(StringSE requestChannelName)

  リクエストチャンネル名を設定します。

  パラメーター:

  requestChannelName - リクエストメッセージの送信先となるチャネル Bean 名

  導入:

  4.1

• getRequestChannelName

  public @Nullable StringSE getRequestChannelName()

  このゲートウェイのリクエストチャネル名を返します。

  戻り値:

  チャンネル名。指定しない場合は null。

  導入:

  6.5.10

• setReplyChannel

  public void setReplyChannel(MessageChannel replyChannel)

  返信チャンネルを設定します。応答チャネルが提供されていない場合、このゲートウェイは常に匿名の一時チャネルを使用して応答を処理します。

  パラメーター:

  replyChannel - 返信メッセージの受信元のチャネル

• setReplyChannelName

  public void setReplyChannelName(StringSE replyChannelName)

  返信チャンネル名を設定します。応答チャネルが提供されていない場合、このゲートウェイは常に匿名の一時チャネルを使用して応答を処理します。

  パラメーター:

  replyChannelName - 応答メッセージの受信元となるチャネル Bean 名

  導入:

  4.1

• setErrorChannel

  public void setErrorChannel(MessageChannel errorChannel)

  エラーチャネルを設定します。エラーチャネルが指定されていない場合、このゲートウェイは呼び出し元に例外を伝播します。例外を完全に抑制するには、ここで "nullChannel" への参照を指定します。

  パラメーター:

  errorChannel - エラーチャネル。

• setErrorChannelName

  public void setErrorChannelName(StringSE errorChannelName)

  エラーチャネル名を設定します。エラーチャネルが指定されていない場合、このゲートウェイは呼び出し元に例外を伝播します。例外を完全に抑制するには、ここで "nullChannel" への参照を指定します。

  パラメーター:

  errorChannelName - エラーチャネル Bean 名。

  導入:

  4.1

• setRequestTimeout

  public void setRequestTimeout(long requestTimeout)

  リクエストメッセージを送信するためのタイムアウト値を設定します。明示的に設定されていない場合、デフォルトは 1 秒です。

  パラメーター:

  requestTimeout - ミリ秒単位のタイムアウト値

• setReplyTimeout

  public void setReplyTimeout(long replyTimeout)

  応答メッセージを受信するためのタイムアウト値を設定します。明示的に設定されていない場合、デフォルトは 1 秒です。

  パラメーター:

  replyTimeout - ミリ秒単位のタイムアウト値

• setRequestMapper

  public void setRequestMapper(@Nullable InboundMessageMapper<?> requestMapper)

  send または sendAndReceive 操作で渡された任意のオブジェクトからリクエストメッセージを作成するための InboundMessageMapper を提供します。

  パラメーター:

  requestMapper - リクエストマッパー。

• setReplyMapper

  public void setReplyMapper(OutboundMessageMapper<?> replyMapper)

  受信または sendAndReceive 操作で受信した応答メッセージからオブジェクトにマッピングするための OutboundMessageMapper を提供します。

  パラメーター:

  replyMapper - 返信マッパー。

• setShouldTrack

  public void setShouldTrack(boolean shouldTrack)

  このゲートウェイを、送信または sendAndReceive 操作から生成されたメッセージのメッセージ履歴で追跡するかどうかを指定します。

  次で指定:

  インターフェース TrackableComponent 内の setShouldTrack 

• getComponentType

  public StringSE getComponentType()

  次で指定:

  インターフェース NamedComponent 内の getComponentType 

• setLoggingEnabled

  public void setLoggingEnabled(boolean enabled)

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

  ロギングを有効にするかどうか。

  次で指定:

  インターフェース IntegrationManagement 内の setLoggingEnabled 

  パラメーター:

  enabled - 無効にする場合は false。

• isLoggingEnabled

  public boolean isLoggingEnabled()

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

  ロギングが有効かどうかを返します。

  次で指定:

  インターフェース IntegrationManagement 内の isLoggingEnabled 

  戻り値:

  有効な場合は true。

• setErrorMessageStrategy

  public final void setErrorMessageStrategy(ErrorMessageStrategy errorMessageStrategy)

  例外が発生したときにエラーメッセージを作成するために使用する ErrorMessageStrategy を設定します。デフォルトは DefaultErrorMessageStrategy です。

  パラメーター:

  errorMessageStrategy - ErrorMessageStrategy

  導入:

  4.3.10

• getErrorMessageStrategy

  protected ErrorMessageStrategy getErrorMessageStrategy()

  例外が発生したときにエラーメッセージを作成するために使用する ErrorMessageStrategy を取得します。デフォルトは DefaultErrorMessageStrategy です。

  戻り値:

  errorMessageStrategy。

  導入:

  6.0

• getOverrides

  public IntegrationManagement.ManagementOverrides getOverrides()

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

  オーバーライドを返します。

  次で指定:

  インターフェース IntegrationManagement 内の getOverrides 

  戻り値:

  オーバーライド。

• setManagedType

  public void setManagedType(StringSE managedType)

  次で指定:

  インターフェース IntegrationManagement 内の setManagedType 

• getManagedType

  public @Nullable StringSE getManagedType()

  次で指定:

  インターフェース IntegrationManagement 内の getManagedType 

• setManagedName

  public void setManagedName(StringSE managedName)

  次で指定:

  インターフェース IntegrationManagement 内の setManagedName 

• getManagedName

  public @Nullable StringSE getManagedName()

  次で指定:

  インターフェース IntegrationManagement 内の getManagedName 

• getIntegrationPatternType

  public IntegrationPatternType getIntegrationPatternType()

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

  このコンポーネントが実装するパターン型を返します。

  次で指定:

  インターフェース IntegrationPattern 内の getIntegrationPatternType 

  戻り値:

  このコンポーネントが実装する IntegrationPatternType

• registerMetricsCaptor

  public void registerMetricsCaptor(MetricsCaptor metricsCaptorToRegister)

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

  MetricsCaptor を注入します。ObservationRegistry が指定されている場合は無視されます。

  次で指定:

  インターフェース IntegrationManagement 内の registerMetricsCaptor 

  パラメーター:

  metricsCaptorToRegister - キャプター。

  関連事項:

  • IntegrationManagement.registerObservationRegistry(ObservationRegistry)

• registerObservationRegistry

  public void registerObservationRegistry(io.micrometer.observation.ObservationRegistry observationRegistry)

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

  ObservationRegistry を注入します。指定された場合、MetricsCaptor は無視されます。メーターのキャプチャーは、提供された ObservationRegistry で ObservationHandler として構成する必要があります。

  次で指定:

  インターフェース IntegrationManagement 内の registerObservationRegistry 

  パラメーター:

  observationRegistry - コンポーネントからの観測結果を公開する ObservationRegistry。

  関連事項:

  • IntegrationManagement.registerMetricsCaptor(MetricsCaptor)

• isObserved

  public boolean isObserved()

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

  この実装が ObservationRegistry.NOOP インスタンス以外のレジストリを処理する場合は true。

  次で指定:

  インターフェース IntegrationManagement 内の isObserved 

  戻り値:

  この実装が ObservationRegistry.NOOP インスタンス以外のレジストリを処理する場合は true。

• setObservationConvention

  public void setObservationConvention(@Nullable MessageRequestReplyReceiverObservationConvention observationConvention)

• setReceiverObservationConvention

  public void setReceiverObservationConvention(@Nullable MessageReceiverObservationConvention receiverObservationConvention)

• onInit

  protected void onInit()

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

  サブクラスは、初期化ロジック用にこれを実装できます。

  オーバーライド:

  クラス AbstractEndpoint の onInit 

• getRequestChannel

  public @Nullable MessageChannel getRequestChannel()

  このゲートウェイのリクエストチャネルを返します。

  戻り値:

  チャンネル。

  導入:

  4.2

• getReplyChannel

  public @Nullable MessageChannel getReplyChannel()

  このゲートウェイの応答チャネルがある場合はそれを返します。

  戻り値:

  応答チャネルインスタンス

  導入:

  5.1

• getErrorChannel

  public @Nullable MessageChannel getErrorChannel()

  エラーメッセージがルーティングされるエラーチャネル（提供されている場合）を返します。

  戻り値:

  チャネルまたは null。

  導入:

  4.3

• send

  protected void send(ObjectSE object)

• receive

  protected @Nullable ObjectSE receive()

• receiveMessage

  protected @Nullable Message<?> receiveMessage()

• receive

  protected @Nullable ObjectSE receive(long timeout)

• receiveMessage

  protected @Nullable Message<?> receiveMessage(long timeout)

• sendAndReceive

  protected @Nullable ObjectSE sendAndReceive(ObjectSE object)

• sendAndReceiveMessage

  protected @Nullable Message<?> sendAndReceiveMessage(ObjectSE object)

• sendAndReceiveMessageReactive

  protected reactor.core.publisher.Mono<Message<?>> sendAndReceiveMessageReactive(ObjectSE object)

• sendTimer

  protected TimerFacade sendTimer()

• buildSendTimer

  protected TimerFacade buildSendTimer(boolean success, StringSE exception)

• buildErrorMessage

  protected final ErrorMessage buildErrorMessage(@Nullable Message<?> requestMessage, ThrowableSE throwable)

  メッセージのエラーメッセージを作成し、構成済みの ErrorMessageStrategy を使用してスロー可能にします。

  パラメーター:

  requestMessage - requestMessage。

  throwable - スローアブル。

  戻り値:

  エラーメッセージ。

  導入:

  4.3.10

• getErrorMessageAttributes

  protected AttributeAccessor getErrorMessageAttributes(@Nullable Message<?> message)

  errorMessageStrategy でエラーメッセージを作成するときに使用する AttributeAccessor を設定します。

  パラメーター:

  message - メッセージ。

  戻り値:

  属性。

  導入:

  4.3.10

• registerReplyMessageCorrelatorIfNecessary

  protected void registerReplyMessageCorrelatorIfNecessary()

• doStart

  protected void doStart()

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

  サブクラスは、開始動作でこのメソッドを実装する必要があります。このメソッドは、AbstractEndpoint.lifecycleLock を保持しているときに呼び出されます。

  次で指定:

  クラス AbstractEndpoint の doStart 

• doStop

  protected void doStop()

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

  サブクラスは、停止動作でこのメソッドを実装する必要があります。このメソッドは、AbstractEndpoint.lifecycleLock を保持しているときに呼び出されます。

  次で指定:

  クラス AbstractEndpoint の doStop 

• destroy

  public void destroy()

  次で指定:

  インターフェース DisposableBean 内の destroy 

  次で指定:

  インターフェース IntegrationManagement 内の destroy 

  オーバーライド:

  クラス AbstractEndpoint の destroy