クラス 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 ベースのアプリケーションで使用するための
ServerEndpointConfigEE の実装。ServerEndpointRegistration Bean は ServerEndpointExporter によって検出され、起動時に Jakarta WebSocket ランタイムに登録されます。 クラスコンストラクターは、シングルトン EndpointEE インスタンスまたは型 ClassSE で指定されたエンドポイントを受け入れます。型で指定した場合、エンドポイントは、各クライアント WebSocket 接続の前に Spring ApplicationContext を介してインスタンス化および初期化されます。
このクラスは ServerEndpointConfig.ConfiguratorEE も拡張して、ハンドシェイクプロセスをカスタマイズするためのメソッドをオーバーライドしやすくします。
- 導入:
- 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> TgetEndpointInstance(ClassSE<T> clazz) getPath()voidmodifyHandshake(ServerEndpointConfigEE sec, HandshakeRequestEE request, HandshakeResponseEE response) voidsetBeanFactory(BeanFactory beanFactory) 所有ファクトリを Bean インスタンスに提供するコールバック。voidsetDecoders(ListSE<ClassSE<? extends DecoderEE>> decoders) voidsetEncoders(ListSE<ClassSE<? extends EncoderEE>> encoders) voidsetExtensions(ListSE<ExtensionEE> extensions) voidsetSubprotocols(ListSE<StringSE> subprotocols) voidsetUserProperties(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