クラス ServerEndpointRegistration

java.lang.ObjectSE
jakarta.websocket.server.ServerEndpointConfig.Configurator
org.springframework.web.socket.server.standard.ServerEndpointRegistration
実装されているすべてのインターフェース:
jakarta.websocket.EndpointConfig, jakarta.websocket.server.ServerEndpointConfig, Aware, BeanFactoryAware
public class ServerEndpointRegistration extends jakarta.websocket.server.ServerEndpointConfig.Configurator implements jakarta.websocket.server.ServerEndpointConfig, BeanFactoryAware
Spring ベースのアプリケーションで使用するための ServerEndpointConfig の実装。ServerEndpointRegistration Bean は ServerEndpointExporter によって検出され、起動時に Jakarta WebSocket ランタイムに登録されます。

クラスコンストラクターは、シングルトンの Endpoint インスタンス、または ClassSE 型で指定されたエンドポイントを受け入れます。型で指定されたエンドポイントは、各クライアントの WebSocket 接続の前に、Spring、ApplicationContext を介してインスタンス化および初期化されます。

このクラスは ServerEndpointConfig.Configurator も拡張して、ハンドシェイクプロセスをカスタマイズするためのメソッドを簡単にオーバーライドできるようにします。

導入:
4.0
作成者:
Rossen Stoyanchev, Juergen Hoeller
関連事項:

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

    • ServerEndpointRegistration

      public ServerEndpointRegistration(StringSE path, jakarta.websocket.Endpoint endpoint)
      jakarta.websocket.Endpoint インスタンスから新しい ServerEndpointRegistration インスタンスを作成します。
      パラメーター:
      path - エンドポイントパス
      endpoint - エンドポイントインスタンス

    • ServerEndpointRegistration

      public ServerEndpointRegistration(StringSE path, ClassSE<? extends jakarta.websocket.Endpoint> endpointClass)
      jakarta.websocket.Endpoint クラスから新しい ServerEndpointRegistration インスタンスを作成します。
      パラメーター:
      path - エンドポイントパス
      endpointClass - エンドポイントクラス

  • メソッドの詳細

    • getPath

      public StringSE getPath()
      次で指定:
      インターフェース jakarta.websocket.server.ServerEndpointConfig の getPath 

    • getEndpointClass

      public ClassSE<? extends jakarta.websocket.Endpoint> getEndpointClass()
      次で指定:
      インターフェース jakarta.websocket.server.ServerEndpointConfig の getEndpointClass 

    • getEndpoint

      public jakarta.websocket.Endpoint getEndpoint()

    • setSubprotocols

      public void setSubprotocols(ListSE<StringSE> subprotocols)

    • getSubprotocols

      public ListSE<StringSE> getSubprotocols()
      次で指定:
      インターフェース jakarta.websocket.server.ServerEndpointConfig の getSubprotocols 

    • setExtensions

      public void setExtensions(ListSE<jakarta.websocket.Extension> extensions)

    • getExtensions

      public ListSE<jakarta.websocket.Extension> getExtensions()
      次で指定:
      インターフェース jakarta.websocket.server.ServerEndpointConfig の getExtensions 

    • setEncoders

      public void setEncoders(ListSE<ClassSE<? extends jakarta.websocket.Encoder>> encoders)

    • getEncoders

      public ListSE<ClassSE<? extends jakarta.websocket.Encoder>> getEncoders()
      次で指定:
      インターフェース jakarta.websocket.EndpointConfig の getEncoders 

    • setDecoders

      public void setDecoders(ListSE<ClassSE<? extends jakarta.websocket.Decoder>> decoders)

    • getDecoders

      public ListSE<ClassSE<? extends jakarta.websocket.Decoder>> getDecoders()
      次で指定:
      インターフェース jakarta.websocket.EndpointConfig の getDecoders 

    • setUserProperties

      public void setUserProperties(MapSE<StringSE,ObjectSE> userProperties)

    • getUserProperties

      public MapSE<StringSE,ObjectSE> getUserProperties()
      次で指定:
      インターフェース jakarta.websocket.EndpointConfig の getUserProperties 

    • getConfigurator

      public jakarta.websocket.server.ServerEndpointConfig.Configurator getConfigurator()
      次で指定:
      インターフェース jakarta.websocket.server.ServerEndpointConfig の getConfigurator 

    • getEndpointInstance

      public final <T> T getEndpointInstance(ClassSE<T> clazz) throws InstantiationExceptionSE
      オーバーライド:
      クラス jakarta.websocket.server.ServerEndpointConfig.Configurator の getEndpointInstance 
      例外:
      InstantiationExceptionSE

    • modifyHandshake

      public void modifyHandshake(jakarta.websocket.server.ServerEndpointConfig sec, jakarta.websocket.server.HandshakeRequest request, jakarta.websocket.HandshakeResponse response)
      オーバーライド:
      クラス jakarta.websocket.server.ServerEndpointConfig.Configurator の modifyHandshake 

    • setBeanFactory

      public void setBeanFactory(BeanFactory beanFactory)
      インターフェースからコピーされた説明: BeanFactoryAware
      所有ファクトリを Bean インスタンスに提供するコールバック。

      通常の Bean プロパティの設定後、ただし InitializingBean.afterPropertiesSet() またはカスタム init-method などの初期化コールバックの前に呼び出されます。

      次で指定:
      インターフェース BeanFactoryAware の setBeanFactory 
      パラメーター:
      beanFactory - 所有 BeanFactory（非 null）。Bean は、ファクトリのメソッドをすぐに呼び出すことができます。
      関連事項:

    • toString

      public StringSE toString()
      オーバーライド:
      クラス ObjectSE の toString