GatewayProxyFactoryBean (Spring Integration API)

java.lang.ObjectSE
- org.springframework.integration.context.IntegrationObjectSupport
- - org.springframework.integration.endpoint.AbstractEndpoint
  - - org.springframework.integration.gateway.GatewayProxyFactoryBean

実装されているすべてのインターフェース:
Advice, Interceptor, MethodInterceptor, Aware, BeanClassLoaderAware, BeanFactoryAware, BeanNameAware, DisposableBean, FactoryBean<ObjectSE>, InitializingBean, ApplicationContextAware, Lifecycle, Phased, SmartLifecycle, ExpressionCapable, NamedComponent, IntegrationManagement, ManageableLifecycle, ManageableSmartLifecycle, TrackableComponent
既知の直属サブクラス
AnnotationGatewayProxyFactoryBean
```
public class GatewayProxyFactoryBean
extends AbstractEndpoint
implements TrackableComponent, FactoryBean<ObjectSE>, MethodInterceptor, BeanClassLoaderAware, IntegrationManagement
```
提供されたサービスインターフェースのプロキシを生成し、アプリケーションコードが認識せずにメッセージングコンポーネントとの対話を可能にして、POJO スタイルの対話を可能にします。このコンポーネントは、必要に応じて型変換を実行するために、IntegrationUtils.INTEGRATION_CONVERSION_SERVICE_BEAN_NAME という名前で外側の BeanFactory に設定された ConversionService も認識しています（INT-1230 での Jon Schneider の貢献と提案のおかげです）。
作成者:
Mark Fisher, Oleg Zhurakousky, Gary Russell, Artem Bilan

ネストされたクラスの要約
- インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたネストクラス / インターフェース
  IntegrationManagement.ManagementOverrides

フィールドのサマリー
- クラス org.springframework.integration.endpoint.AbstractEndpoint から継承されたフィールド
  lifecycleCondition, lifecycleLock
- クラス org.springframework.integration.context.IntegrationObjectSupport から継承されたフィールド
  EXPRESSION_PARSER, logger
- インターフェース org.springframework.beans.factory.FactoryBean から継承されたフィールド
  OBJECT_TYPE_ATTRIBUTE
- インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたフィールド
  METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME
- インターフェース org.springframework.context.SmartLifecycle から継承されたフィールド
  DEFAULT_PHASE

コンストラクターの概要

コンストラクター
コンストラクターと説明
`GatewayProxyFactoryBean()` setter インジェクションによってサービスインターフェース型を構成できるファクトリを作成します。
`GatewayProxyFactoryBean(ClassSE<?> serviceInterface)`

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`void`	`destroy()`
`protected ObjectSE`	`doInvoke(MethodInvocation invocation, boolean runningOnCallerThread)`
`protected void`	`doStart()` サブクラスは、開始動作でこのメソッドを実装する必要があります。
`protected void`	`doStop()` サブクラスは、停止動作でこのメソッドを実装する必要があります。
`protected AsyncTaskExecutor`	`getAsyncExecutor()`
`protected MessageChannel`	`getDefaultReplyChannel()`
`protected StringSE`	`getDefaultReplyChannelName()`
`protected Expression`	`getDefaultReplyTimeout()`
`protected MessageChannel`	`getDefaultRequestChannel()`
`protected StringSE`	`getDefaultRequestChannelName()`
`protected Expression`	`getDefaultRequestTimeout()`
`protected MessageChannel`	`getErrorChannel()`
`protected StringSE`	`getErrorChannelName()`
`MapSE<MethodSE, MessagingGatewaySupport>`	`getGateways()` このファクトリ Bean によって生成された `Method`SE のマップを `MessagingGatewaySupport` に戻します。
`protected GatewayMethodMetadata`	`getGlobalMethodMetadata()`
`protected MethodArgsMessageMapper`	`getMapper()`
`ObjectSE`	`getObject()`
`ClassSE<?>`	`getObjectType()`
`ObjectSE`	`invoke(MethodInvocation invocation)`
`protected boolean`	`isAsyncExecutorExplicitlySet()`
`protected void`	`onInit()` サブクラスは、初期化ロジック用にこれを実装できます。
`void`	`registerMetricsCaptor(MetricsCaptor metricsCaptorToRegister)` `MetricsCaptor` を注入する
`void`	`setAsyncExecutor(ExecutorSE executor)` ゲートウェイメソッドが `Future`SE または `ListenableFuture` を返すときに使用する executor を設定します。
`void`	`setBeanClassLoader(ClassLoaderSE beanClassLoader)`
`void`	`setDefaultReplyChannel(MessageChannel defaultReplyChannel)` デフォルトの応答チャネルを設定します。
`void`	`setDefaultReplyChannelName(StringSE defaultReplyChannelName)` デフォルトの応答チャネル Bean 名を設定します。
`void`	`setDefaultReplyTimeout(LongSE defaultReplyTimeout)` 応答メッセージを受信するためのデフォルトのタイムアウト値を設定します。
`void`	`setDefaultReplyTimeoutExpression(Expression defaultReplyTimeout)` 評価する式を設定して、応答メッセージを受信するためのデフォルトのタイムアウト値を決定します。
`void`	`setDefaultReplyTimeoutExpressionString(StringSE defaultReplyTimeout)` 評価する式を設定して、応答メッセージを受信するためのデフォルトのタイムアウト値を決定します。
`void`	`setDefaultRequestChannel(MessageChannel defaultRequestChannel)` デフォルトのリクエストチャネルを設定します。
`void`	`setDefaultRequestChannelName(StringSE defaultRequestChannelName)` デフォルトのリクエストチャネル Bean 名を設定します。
`void`	`setDefaultRequestTimeout(LongSE defaultRequestTimeout)` リクエストメッセージを送信するためのデフォルトのタイムアウト値を設定します。
`void`	`setDefaultRequestTimeoutExpression(Expression defaultRequestTimeout)` 評価する式を設定して、リクエストメッセージを送信するためのデフォルトのタイムアウト値を決定します。
`void`	`setDefaultRequestTimeoutExpressionString(StringSE defaultRequestTimeout)` 評価する式を設定して、リクエストメッセージを送信するためのデフォルトのタイムアウト値を決定します。
`void`	`setErrorChannel(MessageChannel errorChannel)` エラーチャンネルを設定します。
`void`	`setErrorChannelName(StringSE errorChannelName)` エラーチャネル名を設定します。
`void`	`setGlobalMethodMetadata(GatewayMethodMetadata globalMethodMetadata)`
`void`	`setMapper(MethodArgsMessageMapper mapper)` `MethodArgsHolder` から `Message` にマップするカスタム `MethodArgsMessageMapper` を提供します。
`void`	`setMethodMetadataMap(MapSE<StringSE, GatewayMethodMetadata> methodMetadataMap)`
`void`	`setProxyDefaultMethods(boolean proxyDefaultMethods)` インターフェースの `default` メソッドもプロキシする必要があるかどうかを示します。
`void`	`setShouldTrack(boolean shouldTrack)`
`void`	`setTypeConverter(TypeConverter typeConverter)`

クラス org.springframework.integration.endpoint.AbstractEndpoint から継承されたメソッド
doStop, getPhase, getRole, isAutoStartup, isRunning, setAutoStartup, setPhase, setRole, start, stop, stop

クラス org.springframework.integration.context.IntegrationObjectSupport から継承されたメソッド
afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getComponentName, getComponentType, getConversionService, getExpression, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentName, setConversionService, setMessageBuilderFactory, setPrimaryExpression, setTaskScheduler, toString

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, waitSE, waitSE, waitSE

インターフェース org.springframework.beans.factory.FactoryBean から継承されたメソッド
isSingleton

インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたメソッド
getManagedName, getManagedType, getOverrides, getThisAs, isLoggingEnabled, setLoggingEnabled, setManagedName, setManagedType

インターフェース org.springframework.integration.support.context.NamedComponent から継承されたメソッド
getBeanName, getComponentName, getComponentType

- コンストラクターの詳細
  - GatewayProxyFactoryBean
```
public GatewayProxyFactoryBean()
```
    setter インジェクションによってサービスインターフェース型を構成できるファクトリを作成します。何も設定されていない場合、初期化時にデフォルトのサービスインターフェース型 RequestReplyExchanger にフォールバックします。
  - GatewayProxyFactoryBean
```
public GatewayProxyFactoryBean(ClassSE<?> serviceInterface)
```
- メソッドの詳細
  - setDefaultRequestChannel
```
public void setDefaultRequestChannel(MessageChannel defaultRequestChannel)
```
    デフォルトのリクエストチャネルを設定します。
    パラメーター:
    defaultRequestChannel - アノテーションを使用してリクエストチャネルが構成されていない場合にリクエストメッセージが送信されるチャネル。
  - setDefaultRequestChannelName
```
public void setDefaultRequestChannelName(StringSE defaultRequestChannelName)
```
    デフォルトのリクエストチャネル Bean 名を設定します。
    パラメーター:
    defaultRequestChannelName - リクエストチャネルがアノテーションで構成されていない場合にリクエストメッセージが送信されるチャネル名。
    導入:
    4.2.9
  - getDefaultRequestChannel
```
@Nullable
protected MessageChannel getDefaultRequestChannel()
```
  - getDefaultRequestChannelName
```
@Nullable
protected StringSE getDefaultRequestChannelName()
```
  - setDefaultReplyChannel
```
public void setDefaultReplyChannel(MessageChannel defaultReplyChannel)
```
    デフォルトの応答チャネルを設定します。デフォルトの応答チャネルが提供されておらず、アノテーションで応答チャネルが構成されていない場合、匿名の一時チャネルが応答の処理に使用されます。
    パラメーター:
    defaultReplyChannel - アノテーション付きの応答チャネルが構成されていない場合に応答メッセージを受信するチャネル
  - setDefaultReplyChannelName
```
public void setDefaultReplyChannelName(StringSE defaultReplyChannelName)
```
    デフォルトの応答チャネル Bean 名を設定します。デフォルトの応答チャネルが提供されておらず、アノテーションで応答チャネルが構成されていない場合、匿名の一時チャネルが応答の処理に使用されます。
    パラメーター:
    defaultReplyChannelName - アノテーション付きの応答チャネルが構成されていない場合に応答メッセージを受信するチャネル名
    導入:
    4.2.9
  - getDefaultReplyChannel
```
@Nullable
protected MessageChannel getDefaultReplyChannel()
```
  - getDefaultReplyChannelName
```
@Nullable
protected StringSE getDefaultReplyChannelName()
```
  - setErrorChannel
```
public void setErrorChannel(MessageChannel errorChannel)
```
    エラーチャネルを設定します。エラーチャネルが指定されていない場合、このゲートウェイは呼び出し元に例外を伝播します。例外を完全に抑制するには、ここで "nullChannel" への参照を指定します。
    パラメーター:
    errorChannel - エラーチャネル。
  - setErrorChannelName
```
public void setErrorChannelName(StringSE errorChannelName)
```
    エラーチャネル名を設定します。エラーチャネルが指定されていない場合、このゲートウェイは呼び出し元に例外を伝播します。例外を完全に抑制するには、ここで "nullChannel" への参照を指定します。
    パラメーター:
    errorChannelName - エラーチャネル Bean 名。
    導入:
    4.2.9
  - getErrorChannel
```
@Nullable
protected MessageChannel getErrorChannel()
```
  - getErrorChannelName
```
@Nullable
protected StringSE getErrorChannelName()
```
  - setDefaultRequestTimeout
```
public void setDefaultRequestTimeout(LongSE defaultRequestTimeout)
```
    リクエストメッセージを送信するためのデフォルトのタイムアウト値を設定します。アノテーションまたはメソッド要素で明示的に構成されていない場合、この値が使用されます。
    パラメーター:
    defaultRequestTimeout - ミリ秒単位のタイムアウト値
  - setDefaultRequestTimeoutExpression
```
public void setDefaultRequestTimeoutExpression(Expression defaultRequestTimeout)
```
    評価する式を設定して、リクエストメッセージを送信するためのデフォルトのタイムアウト値を決定します。アノテーションまたはメソッド要素で明示的に構成されていない場合、この値が使用されます。
    パラメーター:
    defaultRequestTimeout - ミリ秒単位のタイムアウト値
    導入:
    5.0
  - setDefaultRequestTimeoutExpressionString
```
public void setDefaultRequestTimeoutExpressionString(StringSE defaultRequestTimeout)
```
    評価する式を設定して、リクエストメッセージを送信するためのデフォルトのタイムアウト値を決定します。アノテーションまたはメソッド要素で明示的に構成されていない場合、この値が使用されます。
    パラメーター:
    defaultRequestTimeout - ミリ秒単位のタイムアウト値
    導入:
    5.0
  - getDefaultRequestTimeout
```
@Nullable
protected Expression getDefaultRequestTimeout()
```
  - setDefaultReplyTimeout
```
public void setDefaultReplyTimeout(LongSE defaultReplyTimeout)
```
    応答メッセージを受信するためのデフォルトのタイムアウト値を設定します。アノテーションまたはメソッド要素で明示的に構成されていない場合、この値が使用されます。
    パラメーター:
    defaultReplyTimeout - ミリ秒単位のタイムアウト値
  - setDefaultReplyTimeoutExpression
```
public void setDefaultReplyTimeoutExpression(Expression defaultReplyTimeout)
```
    評価する式を設定して、応答メッセージを受信するためのデフォルトのタイムアウト値を決定します。アノテーションまたはメソッド要素で明示的に構成されていない場合、この値が使用されます。
    パラメーター:
    defaultReplyTimeout - ミリ秒単位のタイムアウト値
    導入:
    5.0
  - setDefaultReplyTimeoutExpressionString
```
public void setDefaultReplyTimeoutExpressionString(StringSE defaultReplyTimeout)
```
    評価する式を設定して、応答メッセージを受信するためのデフォルトのタイムアウト値を決定します。アノテーションまたはメソッド要素で明示的に構成されていない場合、この値が使用されます。
    パラメーター:
    defaultReplyTimeout - ミリ秒単位のタイムアウト値
    導入:
    5.0
  - getDefaultReplyTimeout
```
@Nullable
protected Expression getDefaultReplyTimeout()
```
  - setShouldTrack
```
public void setShouldTrack(boolean shouldTrack)
```
    次で指定:
    インターフェース TrackableComponent の setShouldTrack
  - setAsyncExecutor
```
public void setAsyncExecutor(@Nullable
                             ExecutorSE executor)
```
    ゲートウェイメソッドが FutureSE または ListenableFuture を返すときに使用する executor を設定します。これを null に設定して非同期処理を無効にします。FutureSE 戻り値の型はすべてダウンストリームフローによって返される必要があります。
    パラメーター:
    executor - エグゼキューター。
  - setTypeConverter
```
public void setTypeConverter(TypeConverter typeConverter)
```
  - setMethodMetadataMap
```
public void setMethodMetadataMap(MapSE<StringSE,GatewayMethodMetadata> methodMetadataMap)
```
  - setGlobalMethodMetadata
```
public void setGlobalMethodMetadata(GatewayMethodMetadata globalMethodMetadata)
```
  - getGlobalMethodMetadata
```
@Nullable
protected GatewayMethodMetadata getGlobalMethodMetadata()
```
  - setBeanClassLoader
```
public void setBeanClassLoader(ClassLoaderSE beanClassLoader)
```
    次で指定:
    インターフェース BeanClassLoaderAware の setBeanClassLoader
  - setMapper
```
public final void setMapper(MethodArgsMessageMapper mapper)
```
    MethodArgsHolder から Message にマップするカスタム MethodArgsMessageMapper を提供します。
    パラメーター:
    mapper - マッパー。
  - getMapper
```
@Nullable
protected MethodArgsMessageMapper getMapper()
```
  - setProxyDefaultMethods
```
public void setProxyDefaultMethods(boolean proxyDefaultMethods)
```
    インターフェースの default メソッドもプロキシする必要があるかどうかを示します。明示的な Gateway アノテーションがメソッドに存在する場合、このオプションとは無関係にプロキシされます。注: JDK クラスのデフォルトメソッド（Function など）はプロキシできますが、MethodHandle.Lookup の内部 Java セキュリティ制限によって MethodHandle を介して呼び出すことはできません。
    パラメーター:
    proxyDefaultMethods - デフォルトのメソッドをプロキシする、または MethodHandle を介して呼び出すブールフラグ。
    導入:
    5.3
  - getAsyncExecutor
```
@Nullable
protected AsyncTaskExecutor getAsyncExecutor()
```
  - isAsyncExecutorExplicitlySet
```
protected boolean isAsyncExecutorExplicitlySet()
```
  - getGateways
```
public MapSE<MethodSE,MessagingGatewaySupport> getGateways()
```
    このファクトリ Bean によって生成された MethodSE のマップを MessagingGatewaySupport に戻します。
    戻り値:
    地図。
    導入:
    4.3
  - registerMetricsCaptor
```
public void registerMetricsCaptor(MetricsCaptor metricsCaptorToRegister)
```
    インターフェースからコピーされた説明: IntegrationManagement
    MetricsCaptor を注入する
    次で指定:
    インターフェース IntegrationManagement の registerMetricsCaptor
    パラメーター:
    metricsCaptorToRegister - キャプター。
  - onInit
```
protected void onInit()
```
    クラスからコピーされた説明: IntegrationObjectSupport
    サブクラスは、初期化ロジック用にこれを実装できます。
    オーバーライド:
    クラス AbstractEndpoint の onInit
  - getObjectType
```
public ClassSE<?> getObjectType()
```
    次で指定:
    インターフェース FactoryBean<ObjectSE> の getObjectType
  - getObject
```
public ObjectSE getObject()
```
    次で指定:
    インターフェース FactoryBean<ObjectSE> の getObject
  - invoke
```
@Nullable
public ObjectSE invoke(MethodInvocation invocation)
                        throws ThrowableSE
```
    次で指定:
    インターフェース MethodInterceptor の invoke
    例外:
    ThrowableSE
  - doInvoke
```
@Nullable
protected ObjectSE doInvoke(MethodInvocation invocation,
                                    boolean runningOnCallerThread)
                             throws ThrowableSE
```
    例外:
    ThrowableSE
  - 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

クラス GatewayProxyFactoryBean

ネストされたクラスの要約

インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたネストクラス / インターフェース

フィールドのサマリー

クラス org.springframework.integration.endpoint.AbstractEndpoint から継承されたフィールド

クラス org.springframework.integration.context.IntegrationObjectSupport から継承されたフィールド

インターフェース org.springframework.beans.factory.FactoryBean から継承されたフィールド

インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたフィールド

インターフェース org.springframework.context.SmartLifecycle から継承されたフィールド

コンストラクターの概要

メソッドのサマリー

クラス org.springframework.integration.endpoint.AbstractEndpoint から継承されたメソッド

クラス org.springframework.integration.context.IntegrationObjectSupport から継承されたメソッド

クラス java.lang.ObjectSE から継承されたメソッド

インターフェース org.springframework.beans.factory.FactoryBean から継承されたメソッド

インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたメソッド

インターフェース org.springframework.integration.support.context.NamedComponent から継承されたメソッド

コンストラクターの詳細

GatewayProxyFactoryBean

GatewayProxyFactoryBean

メソッドの詳細

setDefaultRequestChannel

setDefaultRequestChannelName

getDefaultRequestChannel

getDefaultRequestChannelName

setDefaultReplyChannel

setDefaultReplyChannelName

getDefaultReplyChannel

getDefaultReplyChannelName

setErrorChannel

setErrorChannelName

getErrorChannel

getErrorChannelName

setDefaultRequestTimeout

setDefaultRequestTimeoutExpression

setDefaultRequestTimeoutExpressionString

getDefaultRequestTimeout

setDefaultReplyTimeout

setDefaultReplyTimeoutExpression

setDefaultReplyTimeoutExpressionString

getDefaultReplyTimeout

setShouldTrack

setAsyncExecutor

setTypeConverter

setMethodMetadataMap

setGlobalMethodMetadata

getGlobalMethodMetadata

setBeanClassLoader

setMapper

getMapper

setProxyDefaultMethods

getAsyncExecutor

isAsyncExecutorExplicitlySet

getGateways

registerMetricsCaptor

onInit

getObjectType

getObject

invoke

doInvoke

doStart

doStop

destroy