AbstractMessageChannel (Spring Integration API)

java.lang.ObjectSE
- org.springframework.integration.context.IntegrationObjectSupport
- - org.springframework.integration.channel.AbstractMessageChannel

実装されたすべてのインターフェース:
Aware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, ExpressionCapable, IntegrationPattern, NamedComponent, IntegrationManagement, TrackableComponent, MessageChannel, InterceptableChannel
既知の直属サブクラス
AbstractAmqpChannel, AbstractJmsChannel, AbstractKafkaChannel, AbstractPollableChannel, AbstractSubscribableChannel, FluxMessageChannel, SubscribableRedisChannel, ZeroMqChannel
```
@IntegrationManagedResource
public abstract class AbstractMessageChannel
extends IntegrationObjectSupport
implements MessageChannel, TrackableComponent, InterceptableChannel, IntegrationManagement, IntegrationPattern
```
チャネル名などの一般的なプロパティを提供する MessageChannel 実装の基本クラス。また、ChannelInterceptors の呼び出しを含む、Messages を送受信するための共通機能も提供します。
作成者:
Mark Fisher, Oleg Zhurakousky, Gary Russell, Artem Bilan

ネストされたクラスのサマリー

ネストされたクラス
修飾子と型	クラスと説明
`protected static class`	`AbstractMessageChannel.ChannelInterceptorList` ChannelInterceptors のリストの便利なラッパークラス。

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

フィールドのサマリー
フィールド
修飾子と型フィールドと説明
protected AbstractMessageChannel.ChannelInterceptorList interceptors
protected SetSE<MeterFacade> meters
- クラス org.springframework.integration.context.IntegrationObjectSupport から継承されたフィールド
  EXPRESSION_PARSER, logger
- インターフェース org.springframework.messaging.MessageChannel から継承されたフィールド
  INDEFINITE_TIMEOUT
- インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたフィールド
  METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME

フィールド
修飾子と型	フィールドと説明
`protected AbstractMessageChannel.ChannelInterceptorList`	`interceptors`
`protected SetSE<MeterFacade>`	`meters`

コンストラクターの概要
コンストラクター
コンストラクターと説明
AbstractMessageChannel()

コンストラクター
コンストラクターと説明
`AbstractMessageChannel()`

メソッドのサマリー

すべてのメソッドインスタンスメソッド抽象メソッド具象メソッド
修飾子と型	メソッドと説明
`void`	`addInterceptor(ChannelInterceptor interceptor)` リストの最後にチャネルインターセプターを追加します。
`void`	`addInterceptor(int index, ChannelInterceptor interceptor)` リストの指定されたインデックスにチャネルインターセプターを追加します。
`void`	`destroy()`
`protected abstract boolean`	`doSend(Message<?> message, long timeout)` サブクラスはこのメソッドを実装する必要があります。
`StringSE`	`getComponentType()` サブクラスはこのメソッドを実装して、コンポーネント型情報を提供できます。
`StringSE`	`getFullChannelName()` 可能な場合は、アプリケーションコンテキスト ID を含む完全修飾チャネル名を返します。
`protected AbstractMessageChannel.ChannelInterceptorList`	`getIChannelInterceptorList()` サブクラスのインターセプターリストインスタンスを公開します。
`IntegrationPatternType`	`getIntegrationPatternType()` このコンポーネントが実装するパターン型を返します。
`ListSE<ChannelInterceptor>`	`getInterceptors()` 構成されたインターセプターの読み取り専用リストを返します。
`protected MetricsCaptor`	`getMetricsCaptor()`
`IntegrationManagement.ManagementOverrides`	`getOverrides()` オーバーライドを返します。
`boolean`	`isLoggingEnabled()` ロギングが有効かどうかを返します。
`protected void`	`onInit()` サブクラスは、初期化ロジック用にこれを実装できます。
`void`	`registerMetricsCaptor(MetricsCaptor metricsCaptorToRegister)` `MetricsCaptor` を注入する
`boolean`	`removeInterceptor(ChannelInterceptor interceptor)`
`ChannelInterceptor`	`removeInterceptor(int index)`
`boolean`	`send(Message<?> message)` このチャネルでメッセージを送信します。
`boolean`	`send(Message<?> messageArg, long timeout)` このチャネルでメッセージを送信します。
`void`	`setDatatypes(ClassSE<?>... datatypes)` このチャネルでサポートされているメッセージペイロードデータ型を指定します。
`void`	`setInterceptors(ListSE<ChannelInterceptor> interceptors)` チャネルインターセプターのリストを設定します。
`void`	`setLoggingEnabled(boolean loggingEnabled)` ロギングを有効にするかどうか。
`void`	`setMessageConverter(MessageConverter messageConverter)` ペイロードがまだ一致していないメッセージに対して、このチャネルでサポートされているデータ型の 1 つに（順番に）変換しようとするときに使用する `MessageConverter` を指定します。
`void`	`setShouldTrack(boolean shouldTrack)`

クラス org.springframework.integration.context.IntegrationObjectSupport から継承されたメソッド
afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getComponentName, 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.integration.support.management.IntegrationManagement から継承されたメソッド
getManagedName, getManagedType, getThisAs, setManagedName, setManagedType

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

- フィールドの詳細
  - interceptors
```
protected final AbstractMessageChannel.ChannelInterceptorList interceptors
```
  - meters
```
protected final SetSE<MeterFacade> meters
```
- コンストラクターの詳細
  - AbstractMessageChannel
```
public AbstractMessageChannel()
```
- メソッドの詳細
  - getComponentType
```
public StringSE getComponentType()
```
    クラスからコピーされた説明: IntegrationObjectSupport
    サブクラスはこのメソッドを実装して、コンポーネント型情報を提供できます。
    次で指定:
    インターフェース NamedComponent の getComponentType
    オーバーライド:
    クラス IntegrationObjectSupport の getComponentType
  - getIntegrationPatternType
```
public IntegrationPatternType getIntegrationPatternType()
```
    インターフェースからコピーされた説明: IntegrationPattern
    このコンポーネントが実装するパターン型を返します。
    次で指定:
    インターフェース IntegrationPattern の getIntegrationPatternType
    戻り値:
    このコンポーネントが実装する IntegrationPatternType
  - setShouldTrack
```
public void setShouldTrack(boolean shouldTrack)
```
    次で指定:
    インターフェース TrackableComponent の setShouldTrack
  - registerMetricsCaptor
```
public void registerMetricsCaptor(MetricsCaptor metricsCaptorToRegister)
```
    インターフェースからコピーされた説明: IntegrationManagement
    MetricsCaptor を注入する
    次で指定:
    インターフェース IntegrationManagement の registerMetricsCaptor
    パラメーター:
    metricsCaptorToRegister - キャプター。
  - getMetricsCaptor
```
@Nullable
protected MetricsCaptor getMetricsCaptor()
```
  - isLoggingEnabled
```
public boolean isLoggingEnabled()
```
    インターフェースからコピーされた説明: IntegrationManagement
    ロギングが有効かどうかを返します。
    次で指定:
    インターフェース IntegrationManagement の isLoggingEnabled
    戻り値:
    有効な場合は true。
  - setLoggingEnabled
```
public void setLoggingEnabled(boolean loggingEnabled)
```
    インターフェースからコピーされた説明: IntegrationManagement
    ロギングを有効にするかどうか。
    次で指定:
    インターフェース IntegrationManagement の setLoggingEnabled
    パラメーター:
    loggingEnabled - 無効にする dalse。
  - setDatatypes
```
public void setDatatypes(ClassSE<?>... datatypes)
```
    このチャネルでサポートされているメッセージペイロードデータ型を指定します。ペイロード型が直接一致しないが、"conversionService" が使用可能な場合は、この配列で提供される要素の順序で型変換が試行されます。
    このプロパティが明示的に設定されていない場合、すべてのメッセージペイロード型が受け入れられます。
    パラメーター:
    datatypes - サポートされているデータ型。
    関連事項:
    setMessageConverter(MessageConverter)
  - setInterceptors
```
public void setInterceptors(ListSE<ChannelInterceptor> interceptors)
```
    チャネルインターセプターのリストを設定します。これにより、既存のインターセプターがすべてクリアされます。
    次で指定:
    インターフェース InterceptableChannel の setInterceptors
    パラメーター:
    interceptors - インターセプターのリスト。
  - addInterceptor
```
public void addInterceptor(ChannelInterceptor interceptor)
```
    リストの最後にチャネルインターセプターを追加します。
    次で指定:
    インターフェース InterceptableChannel の addInterceptor
    パラメーター:
    interceptor - インターセプター。
  - addInterceptor
```
public void addInterceptor(int index,
                           ChannelInterceptor interceptor)
```
    リストの指定されたインデックスにチャネルインターセプターを追加します。
    次で指定:
    インターフェース InterceptableChannel の addInterceptor
    パラメーター:
    index - インターセプターを追加するためのインデックス。
    interceptor - インターセプター。
  - setMessageConverter
```
public void setMessageConverter(MessageConverter messageConverter)
```
    ペイロードがまだ一致していないメッセージに対して、このチャネルでサポートされているデータ型の 1 つに（順番に）変換しようとするときに使用する MessageConverter を指定します。
    注意 : MessageConverter.fromMessage(Message, Class) メソッドのみが使用されます。返されたオブジェクトが Message でない場合、受信ヘッダーがコピーされます。返されたオブジェクトが Message の場合、コンバーターはヘッダーに完全に入力されていると予想されます。チャネルはそれ以上のアクションを実行しません。null が返されると、次のデータ型（存在する場合）への変換が試行されます。デフォルトは DefaultDatatypeChannelMessageConverter です。
    パラメーター:
    messageConverter - メッセージコンバーター。
  - getInterceptors
```
public ListSE<ChannelInterceptor> getInterceptors()
```
    構成されたインターセプターの読み取り専用リストを返します。
    次で指定:
    インターフェース InterceptableChannel の getInterceptors
  - removeInterceptor
```
public boolean removeInterceptor(ChannelInterceptor interceptor)
```
    次で指定:
    インターフェース InterceptableChannel の removeInterceptor
  - removeInterceptor
```
@Nullable
public ChannelInterceptor removeInterceptor(int index)
```
    次で指定:
    インターフェース InterceptableChannel の removeInterceptor
  - getIChannelInterceptorList
```
protected AbstractMessageChannel.ChannelInterceptorList getIChannelInterceptorList()
```
    サブクラスのインターセプターリストインスタンスを公開します。
    戻り値:
    チャネルインターセプターリスト。
  - getOverrides
```
public IntegrationManagement.ManagementOverrides getOverrides()
```
    インターフェースからコピーされた説明: IntegrationManagement
    オーバーライドを返します。
    次で指定:
    インターフェース IntegrationManagement の getOverrides
    戻り値:
    オーバーライド。
  - onInit
```
protected void onInit()
```
    クラスからコピーされた説明: IntegrationObjectSupport
    サブクラスは、初期化ロジック用にこれを実装できます。
    オーバーライド:
    クラス IntegrationObjectSupport の onInit
  - getFullChannelName
```
public StringSE getFullChannelName()
```
    可能な場合は、アプリケーションコンテキスト ID を含む完全修飾チャネル名を返します。
    戻り値:
    名前。
  - send
```
public boolean send(Message<?> message)
```
    このチャネルでメッセージを送信します。チャネルが容量に達した場合、このメソッドは、スペースが使用可能になるか、送信スレッドが中断されるまでブロックします。
    次で指定:
    インターフェース MessageChannel の send
    パラメーター:
    message - 送信するメッセージ
    戻り値:
    メッセージが正常に送信された場合は true、送信スレッドが中断された場合は false。
  - send
```
public boolean send(Message<?> messageArg,
                    long timeout)
```
    このチャネルでメッセージを送信します。チャネルが容量に達している場合、このメソッドは、タイムアウトが発生するか、送信スレッドが中断されるまでブロックします。指定されたタイムアウトが 0 の場合、メソッドはすぐに戻ります。ゼロ未満の場合、無期限にブロックされます（send(Message) を参照）。
    次で指定:
    インターフェース MessageChannel の send
    パラメーター:
    messageArg - 送信するメッセージ
    timeout - ミリ秒単位のタイムアウト
    戻り値:
    メッセージが正常に送信された場合は true、割り当てられた時間内にメッセージを送信できない場合、または送信スレッドが中断された場合は false。
  - doSend
```
protected abstract boolean doSend(Message<?> message,
                                  long timeout)
```
    サブクラスはこのメソッドを実装する必要があります。負でないタイムアウトは、チャネルが容量に達した場合に待機する時間を示します（値が 0 の場合、成功の有無にかかわらずすぐに戻る必要があります）。負のタイムアウト値は、メッセージが受け入れられるか、ブロッキングスレッドが中断されるまでメソッドがブロックされることを示します。
    パラメーター:
    message - メッセージ。
    timeout - タイムアウト。
    戻り値:
    送信が成功した場合は true。
  - destroy
```
public void destroy()
```
    次で指定:
    インターフェース DisposableBean の destroy
    次で指定:
    インターフェース IntegrationManagement の destroy

クラス AbstractMessageChannel

ネストされたクラスのサマリー

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

フィールドのサマリー

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

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

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

コンストラクターの概要

メソッドのサマリー

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

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

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

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

フィールドの詳細

interceptors

meters

コンストラクターの詳細

AbstractMessageChannel

メソッドの詳細

getComponentType

getIntegrationPatternType

setShouldTrack

registerMetricsCaptor

getMetricsCaptor

isLoggingEnabled

setLoggingEnabled

setDatatypes

setInterceptors

addInterceptor

addInterceptor

setMessageConverter

getInterceptors

removeInterceptor

removeInterceptor

getIChannelInterceptorList

getOverrides

onInit

getFullChannelName

send

send

doSend

destroy