TcpInboundGateway (Spring Integration API)

java.lang.ObjectSE
- org.springframework.integration.context.IntegrationObjectSupport
- - org.springframework.integration.endpoint.AbstractEndpoint
  - - org.springframework.integration.gateway.MessagingGatewaySupport
    - - org.springframework.integration.ip.tcp.TcpInboundGateway

実装されているすべてのインターフェース:
Aware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, Lifecycle, Phased, SmartLifecycle, ExpressionCapable, OrderlyShutdownCapable, IntegrationPattern, ClientModeCapable, TcpListener, TcpSender, NamedComponent, IntegrationInboundManagement, IntegrationManagement, ManageableLifecycle, ManageableSmartLifecycle, TrackableComponent
```
public class TcpInboundGateway
extends MessagingGatewaySupport
implements TcpListener, TcpSender, ClientModeCapable, OrderlyShutdownCapable
```
サーバー接続ファクトリを使用する受信ゲートウェイ - スレッドはファクトリによって制御されます。java.net 接続の場合、各ソケットは一度に 1 つのメッセージしか処理できません。java.nio 接続の場合、メッセージは多重化される可能性がありますが、クライアントは相関ロジックを提供する必要があります。クライアントが TcpOutboundGateway の場合、多重化は使用されませんが、接続ファクトリがシングルユース接続を使用する場合は、複数の同時接続を使用できます。真の非同期双方向通信には、受信 / 送信チャネルアダプターのペアを使用する必要があります。
導入:
2.0
作成者:
Gary Russell, Artem Bilan

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

フィールドのサマリー
フィールド
修飾子と型フィールドと説明
static long DEFAULT_RETRY_INTERVAL
ミリ秒単位のデフォルトの再試行間隔 -60000L。
- クラス org.springframework.integration.gateway.MessagingGatewaySupport から継承されたフィールド
  messagingTemplate
- クラス org.springframework.integration.endpoint.AbstractEndpoint から継承されたフィールド
  lifecycleCondition, lifecycleLock
- クラス org.springframework.integration.context.IntegrationObjectSupport から継承されたフィールド
  EXPRESSION_PARSER, logger
- インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたフィールド
  METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME
- インターフェース org.springframework.context.SmartLifecycle から継承されたフィールド
  DEFAULT_PHASE

フィールド
修飾子と型	フィールドと説明
`static long`	`DEFAULT_RETRY_INTERVAL` ミリ秒単位のデフォルトの再試行間隔 -60000L。

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

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

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`void`	`addNewConnection(TcpConnection connection)` `TcpListener` が所有するソケットを使用している場合、このメソッドは新しい接続が確立されるたびに呼び出されます。
`int`	`afterShutdown()` スケジューラー、エグゼキューターなどの通常のシャットダウンの後、シャットダウン遅延が経過した後、残りのアクティブなスケジューラー / エグゼキュータースレッドの強制シャットダウンの前に呼び出されます。オプションで、まだ処理中のアクティブなメッセージの数を返すことができます。
`int`	`beforeShutdown()` シャットダウンが始まる前に呼び出されます。
`protected void`	`doStart()` サブクラスは、開始動作でこのメソッドを実装する必要があります。
`protected void`	`doStop()` サブクラスは、停止動作でこのメソッドを実装する必要があります。
`StringSE`	`getComponentType()` サブクラスはこのメソッドを実装して、コンポーネント型情報を提供できます。
`long`	`getRetryInterval()`
`boolean`	`isClientMode()`
`boolean`	`isClientModeConnected()`
`boolean`	`isListening()`
`protected void`	`onInit()` サブクラスは、初期化ロジック用にこれを実装できます。
`boolean`	`onMessage(Message<?> message)` 新しいメッセージが到着したときに TCPConnection によって呼び出されます。
`void`	`removeDeadConnection(TcpConnection connection)` `TcpListener` が所有するソケットを使用している場合、このメソッドは接続が閉じられるたびに呼び出されます。
`void`	`retryConnection()` すぐに接続の確立を試みてください。
`void`	`setClientMode(boolean isClientMode)`
`void`	`setConnectionFactory(AbstractConnectionFactory connectionFactory)` `AbstractClientConnectionFactory` または `AbstractServerConnectionFactory` である必要があります。
`void`	`setRetryInterval(long retryInterval)` 再試行間隔を構成します。

クラス 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, 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 から継承されたメソッド
getThisAs

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

- フィールドの詳細
  - DEFAULT_RETRY_INTERVAL
```
public static final long DEFAULT_RETRY_INTERVAL
```
    ミリ秒単位のデフォルトの再試行間隔 -60000L。
    関連事項:
    定数フィールド値
- コンストラクターの詳細
  - TcpInboundGateway
```
public TcpInboundGateway()
```
- メソッドの詳細
  - onMessage
```
public boolean onMessage(Message<?> message)
```
    インターフェースからコピーされた説明: TcpListener
    新しいメッセージが到着したときに TCPConnection によって呼び出されます。
    次で指定:
    インターフェース TcpListener の onMessage
    パラメーター:
    message - メッセージ。
    戻り値:
    メッセージがインターセプトされた場合は true
  - isListening
```
public boolean isListening()
```
    戻り値:
    関連する接続ファクトリがリッスンしている場合は true。
  - setConnectionFactory
```
public void setConnectionFactory(AbstractConnectionFactory connectionFactory)
```
    AbstractClientConnectionFactory または AbstractServerConnectionFactory である必要があります。
    パラメーター:
    connectionFactory - 接続ファクトリ
  - addNewConnection
```
public void addNewConnection(TcpConnection connection)
```
    インターフェースからコピーされた説明: TcpSender
    TcpListener が所有するソケットを使用している場合、このメソッドは新しい接続が確立されるたびに呼び出されます。
    次で指定:
    インターフェース TcpSender の addNewConnection
    パラメーター:
    connection - 接続。
  - removeDeadConnection
```
public void removeDeadConnection(TcpConnection connection)
```
    インターフェースからコピーされた説明: TcpSender
    TcpListener が所有するソケットを使用している場合、このメソッドは接続が閉じられるたびに呼び出されます。
    次で指定:
    インターフェース TcpSender の removeDeadConnection
    パラメーター:
    connection - 接続。
  - getComponentType
```
public StringSE getComponentType()
```
    クラスからコピーされた説明: IntegrationObjectSupport
    サブクラスはこのメソッドを実装して、コンポーネント型情報を提供できます。
    次で指定:
    インターフェース NamedComponent の getComponentType
    オーバーライド:
    クラス MessagingGatewaySupport の getComponentType
  - onInit
```
protected void onInit()
```
    クラスからコピーされた説明: IntegrationObjectSupport
    サブクラスは、初期化ロジック用にこれを実装できます。
    オーバーライド:
    クラス MessagingGatewaySupport の onInit
  - doStart
```
protected void doStart()
```
    クラスからコピーされた説明: AbstractEndpoint
    サブクラスは、開始動作でこのメソッドを実装する必要があります。このメソッドは、AbstractEndpoint.lifecycleLock を保持しているときに呼び出されます。
    オーバーライド:
    クラス MessagingGatewaySupport の doStart
  - doStop
```
protected void doStop()
```
    クラスからコピーされた説明: AbstractEndpoint
    サブクラスは、停止動作でこのメソッドを実装する必要があります。このメソッドは、AbstractEndpoint.lifecycleLock を保持しているときに呼び出されます。
    オーバーライド:
    クラス MessagingGatewaySupport の doStop
  - isClientMode
```
public boolean isClientMode()
```
    次で指定:
    インターフェース ClientModeCapable の isClientMode
    戻り値:
    isClientMode
  - setClientMode
```
public void setClientMode(boolean isClientMode)
```
    パラメーター:
    isClientMode - 設定する isClientMode
  - getRetryInterval
```
public long getRetryInterval()
```
    戻り値:
    retryInterval
  - setRetryInterval
```
public void setRetryInterval(long retryInterval)
```
    再試行間隔を構成します。デフォルトは DEFAULT_RETRY_INTERVAL です。
    パラメーター:
    retryInterval - 設定する retryInterval
  - isClientModeConnected
```
public boolean isClientModeConnected()
```
    次で指定:
    インターフェース ClientModeCapable の isClientModeConnected
    戻り値:
    エンドポイントがクライアントモードで実行されている場合は true。
  - retryConnection
```
public void retryConnection()
```
    インターフェースからコピーされた説明: ClientModeCapable
    すぐに接続の確立を試みてください。
    次で指定:
    インターフェース ClientModeCapable の retryConnection
  - beforeShutdown
```
public int beforeShutdown()
```
    インターフェースからコピーされた説明: OrderlyShutdownCapable
    シャットダウンが始まる前に呼び出されます。実装は、新しいメッセージの受け入れを停止する必要があります。オプションで、処理中のアクティブなメッセージの数を返すことができます。
    次で指定:
    インターフェース OrderlyShutdownCapable の beforeShutdown
    戻り値:
    使用可能な場合、アクティブなメッセージの数。
  - afterShutdown
```
public int afterShutdown()
```
    インターフェースからコピーされた説明: OrderlyShutdownCapable
    スケジューラー、エグゼキューターなどの通常のシャットダウンの後、シャットダウン遅延が経過した後、残りのアクティブなスケジューラー / エグゼキュータースレッドの強制シャットダウンの前に呼び出されます。オプションで、まだ処理中のアクティブなメッセージの数を返すことができます。
    次で指定:
    インターフェース OrderlyShutdownCapable の afterShutdown
    戻り値:
    使用可能な場合、アクティブなメッセージの数。

クラス TcpInboundGateway

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

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

フィールドのサマリー

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

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

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

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

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

コンストラクターの概要

メソッドのサマリー

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

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

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

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

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

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

フィールドの詳細

DEFAULT_RETRY_INTERVAL

コンストラクターの詳細

TcpInboundGateway

メソッドの詳細

onMessage

isListening

setConnectionFactory

addNewConnection

removeDeadConnection

getComponentType

onInit

doStart

doStop

isClientMode

setClientMode

getRetryInterval

setRetryInterval

isClientModeConnected

retryConnection

beforeShutdown

afterShutdown