パッケージ org.springframework.integration.websocket.inbound

クラス WebSocketInboundChannelAdapter

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、ComponentSourceAware、ExpressionCapable、MessageProducer、IntegrationPattern、NamedComponent、IntegrationInboundManagement、IntegrationManagement、ManageableLifecycle、ManageableSmartLifecycle、TrackableComponent、WebSocketListener、SubProtocolCapable
public class WebSocketInboundChannelAdapter extends MessageProducerSupport implements WebSocketListener, ApplicationEventPublisherAware
受信 WebSocket メッセージ用の MessageProducerSupport。
導入:
4.1
作成者:
Artem Bilan, Ngoc Nhan

  • コンストラクターの詳細

  • 方法の詳細

    • 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 メッセージ本文を変換する
      関連事項:

    • 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)
      インターフェースからコピーされた説明: WebSocketListener
      WebSocketSession が開始した後に呼び出されます。
      次で指定:
      インターフェース WebSocketListener 内の afterSessionStarted 
      パラメーター:
      session - WebSocket セッション

    • afterSessionEnded

      public void afterSessionEnded(WebSocketSession session, CloseStatus closeStatus)
      インターフェースからコピーされた説明: WebSocketListener
      WebSocketSession が終了した後に呼び出されます。
      次で指定:
      インターフェース WebSocketListener 内の afterSessionEnded 
      パラメーター:
      session - WebSocket セッション
      closeStatus - セッションが閉じられた理由

    • onMessage

      public void onMessage(WebSocketSession session, WebSocketMessage<?> webSocketMessage)
      インターフェースからコピーされた説明: WebSocketListener
      受け取った WebSocketMessage を処理します。
      次で指定:
      インターフェース WebSocketListener 内の onMessage 
      パラメーター:
      session - WebSocket セッション
      webSocketMessage - WebSocket メッセージ

    • getComponentType

      public StringSE getComponentType()
      クラスからコピーされた説明: IntegrationObjectSupport
      サブクラスはこのメソッドを実装して、コンポーネント型情報を提供できます。
      次で指定:
      インターフェース NamedComponent 内の getComponentType 
      オーバーライド:
      クラス IntegrationObjectSupport の getComponentType 

    • doStart

      protected void doStart()
      クラスからコピーされた説明: MessageProducerSupport
      デフォルトでは何も実行されません。ライフサイクル管理された動作が必要な場合、サブクラスはこれをオーバーライドできます。'lifecycleLock' によって保護されています。
      オーバーライド:
      クラス MessageProducerSupport の doStart 

    • doStop

      protected void doStop()
      クラスからコピーされた説明: MessageProducerSupport
      デフォルトでは何もしません。サブクラスは、ライフサイクル管理の動作が必要な場合、これをオーバーライドできます。
      オーバーライド:
      クラス MessageProducerSupport の doStop 

    • isActive

      public boolean isActive()
      オーバーライド:
      クラス AbstractEndpoint の isActive