WebSocketInboundChannelAdapter (Spring Integration API)

java.lang.ObjectSE
- org.springframework.integration.context.IntegrationObjectSupport
- - org.springframework.integration.endpoint.AbstractEndpoint
  - - org.springframework.integration.endpoint.MessageProducerSupport
    - - org.springframework.integration.websocket.inbound.WebSocketInboundChannelAdapter

実装されているすべてのインターフェース:
Aware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, SmartInitializingSingleton, ApplicationContextAware, ApplicationEventPublisherAware, Lifecycle, Phased, SmartLifecycle, ExpressionCapable, MessageProducer, IntegrationPattern, NamedComponent, ManageableLifecycle, ManageableSmartLifecycle, TrackableComponent, WebSocketListener, SubProtocolCapable
```
public class WebSocketInboundChannelAdapter
extends MessageProducerSupport
implements WebSocketListener, ApplicationEventPublisherAware
```
導入:
4.1
作成者:
Artem Bilan

フィールドのサマリー
- クラス org.springframework.integration.endpoint.AbstractEndpoint から継承されたフィールド
  lifecycleCondition, lifecycleLock
- クラス org.springframework.integration.context.IntegrationObjectSupport から継承されたフィールド
  EXPRESSION_PARSER, logger
- インターフェース org.springframework.context.SmartLifecycle から継承されたフィールド
  DEFAULT_PHASE

コンストラクターの概要

コンストラクター
コンストラクターと説明
`WebSocketInboundChannelAdapter(IntegrationWebSocketContainer webSocketContainer)`
`WebSocketInboundChannelAdapter(IntegrationWebSocketContainer webSocketContainer, SubProtocolHandlerRegistry protocolHandlerRegistry)`

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`void`	`afterSessionEnded(WebSocketSession session, CloseStatus closeStatus)` `WebSocketSession` が終了した後に呼び出されます。
`void`	`afterSessionStarted(WebSocketSession session)` `WebSocketSession` が開始した後に呼び出されます。
`protected void`	`doStart()` デフォルトでは何もしません。
`protected void`	`doStop()` デフォルトでは何もしません。
`StringSE`	`getComponentType()` サブクラスはこのメソッドを実装して、コンポーネント型情報を提供できます。
`ListSE<StringSE>`	`getSubProtocols()`
`protected void`	`onInit()` サブクラスは、初期化ロジック用にこれを実装できます。
`void`	`onMessage(WebSocketSession session, WebSocketMessage<?> webSocketMessage)` 受け取った `WebSocketMessage` を処理します。
`void`	`setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)`
`void`	`setMergeWithDefaultConverters(boolean mergeWithDefaultConverters)` カスタムコンバーターの後にデフォルトコンバーターを使用できるかどうかを決定するフラグ。
`void`	`setMessageConverters(ListSE<MessageConverter> messageConverters)` 使用するメッセージコンバーターを設定します。
`void`	`setPayloadType(ClassSE<?> payloadType)` WebSocket メッセージ本文を変換するターゲットメッセージペイロードの型を設定します。
`void`	`setUseBroker(boolean useBroker)` このアダプターが `non-MESSAGE` `WebSocketMessage` に対して既存の単一の `AbstractBrokerMessageHandler` Bean を使用するかどうか、およびブローカー宛先を使用してメッセージをルーティングするかどうかを指定します。

クラス org.springframework.integration.endpoint.MessageProducerSupport から継承されたメソッド
afterSingletonsInstantiated, buildErrorMessage, getErrorChannel, getErrorMessageAttributes, getIntegrationPatternType, getMessagingTemplate, getOutputChannel, sendErrorMessageIfNecessary, sendMessage, setErrorChannel, setErrorChannelName, setErrorMessageStrategy, setOutputChannel, setOutputChannelName, setSendTimeout, setShouldTrack, subscribeToPublisher

クラス org.springframework.integration.endpoint.AbstractEndpoint から継承されたメソッド
destroy, 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.context.NamedComponent から継承されたメソッド
getBeanName, getComponentName

- コンストラクターの詳細
  - WebSocketInboundChannelAdapter
```
public WebSocketInboundChannelAdapter(IntegrationWebSocketContainer webSocketContainer)
```
  - WebSocketInboundChannelAdapter
```
public WebSocketInboundChannelAdapter(IntegrationWebSocketContainer webSocketContainer,
                                      SubProtocolHandlerRegistry protocolHandlerRegistry)
```
- メソッドの詳細
  - setMessageConverters
```
public void setMessageConverters(ListSE<MessageConverter> messageConverters)
```
    使用するメッセージコンバーターを設定します。これらのコンバーターは、適切な内部 subProtocols 型に送信するメッセージを変換するために使用されます。
    パラメーター:
    messageConverters - メッセージコンバーター。
  - setMergeWithDefaultConverters
```
public void setMergeWithDefaultConverters(boolean mergeWithDefaultConverters)
```
    カスタムコンバーターの後にデフォルトコンバーターを使用できるかどうかを決定するフラグ。
    パラメーター:
    mergeWithDefaultConverters - マージする場合は true、置き換える場合は false。
  - setPayloadType
```
public void setPayloadType(ClassSE<?> payloadType)
```
    WebSocket メッセージ本文を変換するターゲットメッセージペイロードの型を設定します。
    パラメーター:
    payloadType - 受信 WebSocket メッセージ本文を変換する
    関連事項:
    CompositeMessageConverter
  - setUseBroker
```
public void setUseBroker(boolean useBroker)
```
    このアダプターが non-MESSAGE WebSocketMessage に対して既存の単一の AbstractBrokerMessageHandler Bean を使用するかどうか、およびブローカー宛先を使用してメッセージをルーティングするかどうかを指定します。現在のアプリケーションコンテキストでは単一の AbstractBrokerMessageHandler Bean のみが許可されているため、Bean 参照を適用するのではなく、型によって前者をルックアップするアルゴリズム。これはサーバー側でのみ使用され、クライアント側では無視されます。
    パラメーター:
    useBroker - ブールフラグ。
  - setApplicationEventPublisher
```
public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)
```
    次で指定:
    インターフェース ApplicationEventPublisherAware の setApplicationEventPublisher
  - onInit
```
protected void onInit()
```
    クラスからコピーされた説明: IntegrationObjectSupport
    サブクラスは、初期化ロジック用にこれを実装できます。
    オーバーライド:
    クラス MessageProducerSupport の onInit
  - getSubProtocols
```
public ListSE<StringSE> getSubProtocols()
```
    次で指定:
    インターフェース SubProtocolCapable の getSubProtocols
  - afterSessionStarted
```
public void afterSessionStarted(WebSocketSession session)
                         throws ExceptionSE
```
    インターフェースからコピーされた説明: WebSocketListener
    WebSocketSession が開始した後に呼び出されます。
    次で指定:
    インターフェース WebSocketListener の afterSessionStarted
    パラメーター:
    session - WebSocket セッション
    例外:
    ExceptionSE - "afterSessionStarted" 例外
  - afterSessionEnded
```
public void afterSessionEnded(WebSocketSession session,
                              CloseStatus closeStatus)
                       throws ExceptionSE
```
    インターフェースからコピーされた説明: WebSocketListener
    WebSocketSession が終了した後に呼び出されます。
    次で指定:
    インターフェース WebSocketListener の afterSessionEnded
    パラメーター:
    session - WebSocket セッション
    closeStatus - セッションが閉じられた理由
    例外:
    ExceptionSE - "afterSessionEnded" 例外
  - onMessage
```
public void onMessage(WebSocketSession session,
                      WebSocketMessage<?> webSocketMessage)
               throws ExceptionSE
```
    インターフェースからコピーされた説明: WebSocketListener
    受け取った WebSocketMessage を処理します。
    次で指定:
    インターフェース WebSocketListener の onMessage
    パラメーター:
    session - WebSocket セッション
    webSocketMessage - WebSocket メッセージ
    例外:
    ExceptionSE - "onMessage" 例外
  - getComponentType
```
public StringSE getComponentType()
```
    クラスからコピーされた説明: IntegrationObjectSupport
    サブクラスはこのメソッドを実装して、コンポーネント型情報を提供できます。
    次で指定:
    インターフェース NamedComponent の getComponentType
    オーバーライド:
    クラス IntegrationObjectSupport の getComponentType
  - doStart
```
protected void doStart()
```
    クラスからコピーされた説明: MessageProducerSupport
    デフォルトでは何も実行されません。ライフサイクル管理された動作が必要な場合、サブクラスはこれをオーバーライドできます。'lifecycleLock' によって保護されています。
    オーバーライド:
    クラス MessageProducerSupport の doStart
  - doStop
```
protected void doStop()
```
    クラスからコピーされた説明: MessageProducerSupport
    デフォルトでは何もしません。サブクラスは、ライフサイクル管理の動作が必要な場合、これをオーバーライドできます。
    オーバーライド:
    クラス MessageProducerSupport の doStop

クラス WebSocketInboundChannelAdapter

フィールドのサマリー

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

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

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

コンストラクターの概要

メソッドのサマリー

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

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

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

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

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

コンストラクターの詳細

WebSocketInboundChannelAdapter

WebSocketInboundChannelAdapter

メソッドの詳細

setMessageConverters

setMergeWithDefaultConverters

setPayloadType

setUseBroker

setApplicationEventPublisher

onInit

getSubProtocols

afterSessionStarted

afterSessionEnded

onMessage

getComponentType

doStart

doStop