クラス ServerEndpointRegistration
java.lang.ObjectSE
jakarta.websocket.server.ServerEndpointConfig.Configurator
org.springframework.web.socket.server.standard.ServerEndpointRegistration
- 実装されたすべてのインターフェース:
EndpointConfigEE
、ServerEndpointConfigEE
、Aware
、BeanFactoryAware
public class ServerEndpointRegistration
extends ServerEndpointConfig.ConfiguratorEE
implements ServerEndpointConfigEE, BeanFactoryAware
Spring ベースのアプリケーションで使用するための
ServerEndpointConfig
EE の実装。ServerEndpointRegistration
Bean は ServerEndpointExporter
によって検出され、起動時に Jakarta WebSocket ランタイムに登録されます。 クラスコンストラクターは、シングルトン Endpoint
EE インスタンスまたは型 Class
SE で指定されたエンドポイントを受け入れます。型で指定した場合、エンドポイントは、各クライアント WebSocket 接続の前に Spring ApplicationContext を介してインスタンス化および初期化されます。
このクラスは ServerEndpointConfig.Configurator
EE も拡張して、ハンドシェイクプロセスをカスタマイズするためのメソッドをオーバーライドしやすくします。
- 導入:
- 4.0
- 作成者:
- Rossen Stoyanchev, Juergen Hoeller
- 関連事項:
ネストされたクラスのサマリー
インターフェース jakarta.websocket.server.ServerEndpointConfigEE から継承されたネストクラス / インターフェース
ServerEndpointConfig.BuilderEE, ServerEndpointConfig.ConfiguratorEE
コンストラクターの概要
コンストラクターコンストラクター説明ServerEndpointRegistration
(StringSE path, EndpointEE endpoint) jakarta.websocket.Endpoint
インスタンスから新しいServerEndpointRegistration
インスタンスを作成します。ServerEndpointRegistration
(StringSE path, ClassSE<? extends EndpointEE> endpointClass) jakarta.websocket.Endpoint
クラスから新しいServerEndpointRegistration
インスタンスを作成します。メソッドのサマリー
修飾子と型メソッド説明ClassSE<? extends EndpointEE>
final <T> T
getEndpointInstance
(ClassSE<T> clazz) getPath()
void
modifyHandshake
(ServerEndpointConfigEE sec, HandshakeRequestEE request, HandshakeResponseEE response) void
setBeanFactory
(BeanFactory beanFactory) 所有ファクトリを Bean インスタンスに提供するコールバック。void
setDecoders
(ListSE<ClassSE<? extends DecoderEE>> decoders) void
setEncoders
(ListSE<ClassSE<? extends EncoderEE>> encoders) void
setExtensions
(ListSE<ExtensionEE> extensions) void
setSubprotocols
(ListSE<StringSE> subprotocols) void
setUserProperties
(MapSE<StringSE, ObjectSE> userProperties) toString()
クラス jakarta.websocket.server.ServerEndpointConfig.ConfiguratorEE から継承されたメソッド
checkOriginEE, getContainerDefaultConfiguratorEE, getNegotiatedExtensionsEE, getNegotiatedSubprotocolEE
コンストラクターの詳細
ServerEndpointRegistration
jakarta.websocket.Endpoint
インスタンスから新しいServerEndpointRegistration
インスタンスを作成します。- パラメーター:
path
- エンドポイントパスendpoint
- エンドポイントインスタンス
ServerEndpointRegistration
jakarta.websocket.Endpoint
クラスから新しいServerEndpointRegistration
インスタンスを作成します。- パラメーター:
path
- エンドポイントパスendpointClass
- エンドポイントクラス
メソッドの詳細
getPath
- 次で指定:
- インターフェース
ServerEndpointConfigEE
のgetPathEE
getEndpointClass
- 次で指定:
- インターフェース
ServerEndpointConfigEE
のgetEndpointClassEE
getEndpoint
setSubprotocols
getSubprotocols
- 次で指定:
- インターフェース
ServerEndpointConfigEE
のgetSubprotocolsEE
setExtensions
getExtensions
- 次で指定:
- インターフェース
ServerEndpointConfigEE
のgetExtensionsEE
setEncoders
getEncoders
- 次で指定:
- インターフェース
EndpointConfigEE
のgetEncodersEE
setDecoders
getDecoders
- 次で指定:
- インターフェース
EndpointConfigEE
のgetDecodersEE
setUserProperties
getUserProperties
- 次で指定:
- インターフェース
EndpointConfigEE
のgetUserPropertiesEE
getConfigurator
- 次で指定:
- インターフェース
ServerEndpointConfigEE
のgetConfiguratorEE
getEndpointInstance
- オーバーライド:
- クラス
ServerEndpointConfig.ConfiguratorEE
のgetEndpointInstanceEE
- 例外:
InstantiationExceptionSE
modifyHandshake
public void modifyHandshake(ServerEndpointConfigEE sec, HandshakeRequestEE request, HandshakeResponseEE response) - オーバーライド:
- クラス
ServerEndpointConfig.ConfiguratorEE
のmodifyHandshakeEE
setBeanFactory
インターフェースからコピーされた説明:BeanFactoryAware
所有ファクトリを Bean インスタンスに提供するコールバック。通常の Bean プロパティの設定後、ただし
InitializingBean.afterPropertiesSet()
またはカスタム init-method などの初期化コールバックの前に呼び出されます。- 次で指定:
- インターフェース
BeanFactoryAware
のsetBeanFactory
- パラメーター:
beanFactory
- 所有 BeanFactory(非null
)。Bean は、ファクトリのメソッドをすぐに呼び出すことができます。- 関連事項:
toString