ServerEndpointRegistration (Spring Framework API)

java.lang.ObjectSE
- javax.websocket.server.ServerEndpointConfig.ConfiguratorEE
- - 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 によって検出され、起動時に Java WebSocket ランタイムに登録されます。
クラスコンストラクターは、シングルトン EndpointEE インスタンスまたは型 ClassSE で指定されたエンドポイントを受け入れます。型で指定した場合、エンドポイントは、各クライアント WebSocket 接続の前に Spring ApplicationContext を介してインスタンス化および初期化されます。
このクラスは ServerEndpointConfig.ConfiguratorEE も拡張して、ハンドシェイクプロセスをカスタマイズするためのメソッドをオーバーライドしやすくします。
導入:
4.0
作成者:
Rossen Stoyanchev, Juergen Hoeller
関連事項:
ServerEndpointExporter

ネストされたクラスのサマリー
- インターフェース javax.websocket.server.ServerEndpointConfigEE から継承されたネストクラス / インターフェース
  ServerEndpointConfig.BuilderEE, ServerEndpointConfig.ConfiguratorEE

コンストラクターのサマリー

コンストラクター
コンストラクターと説明
`ServerEndpointRegistration(StringSE path, ClassSE<? extends EndpointEE> endpointClass)` `javax.websocket.Endpoint` クラスから新しい `ServerEndpointRegistration` インスタンスを作成します。
`ServerEndpointRegistration(StringSE path, EndpointEE endpoint)` `javax.websocket.Endpoint` インスタンスから新しい `ServerEndpointRegistration` インスタンスを作成します。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`ServerEndpointConfig.ConfiguratorEE`	`getConfigurator()`
`ListSE<ClassSE<? extends DecoderEE>>`	`getDecoders()`
`ListSE<ClassSE<? extends EncoderEE>>`	`getEncoders()`
`EndpointEE`	`getEndpoint()`
`ClassSE<? extends EndpointEE>`	`getEndpointClass()`
`<T> T`	`getEndpointInstance(ClassSE<T> clazz)`
`ListSE<ExtensionEE>`	`getExtensions()`
`StringSE`	`getPath()`
`ListSE<StringSE>`	`getSubprotocols()`
`MapSE<StringSE, ObjectSE>`	`getUserProperties()`
`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)`
`StringSE`	`toString()`

クラス javax.websocket.server.ServerEndpointConfig.ConfiguratorEE から継承されたメソッド
checkOriginEE, getNegotiatedExtensionsEE, getNegotiatedSubprotocolEE

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, waitSE, waitSE, waitSE

- コンストラクターの詳細
  - ServerEndpointRegistration
```
public ServerEndpointRegistration(StringSE path,
                                  EndpointEE endpoint)
```
    javax.websocket.Endpoint インスタンスから新しい ServerEndpointRegistration インスタンスを作成します。
    パラメーター:
    path - エンドポイントパス
    endpoint - エンドポイントインスタンス
  - ServerEndpointRegistration
```
public ServerEndpointRegistration(StringSE path,
                                  ClassSE<? extends EndpointEE> endpointClass)
```
    javax.websocket.Endpoint クラスから新しい ServerEndpointRegistration インスタンスを作成します。
    パラメーター:
    path - エンドポイントパス
    endpointClass - エンドポイントクラス
- メソッドの詳細
  - getPath
```
public StringSE getPath()
```
    次で指定:
    インターフェース ServerEndpointConfigEE の getPathEE
  - getEndpointClass
```
public ClassSE<? extends EndpointEE> getEndpointClass()
```
    次で指定:
    インターフェース ServerEndpointConfigEE の getEndpointClassEE
  - getEndpoint
```
public EndpointEE getEndpoint()
```
  - setSubprotocols
```
public void setSubprotocols(ListSE<StringSE> subprotocols)
```
  - getSubprotocols
```
public ListSE<StringSE> getSubprotocols()
```
    次で指定:
    インターフェース ServerEndpointConfigEE の getSubprotocolsEE
  - setExtensions
```
public void setExtensions(ListSE<ExtensionEE> extensions)
```
  - getExtensions
```
public ListSE<ExtensionEE> getExtensions()
```
    次で指定:
    インターフェース ServerEndpointConfigEE の getExtensionsEE
  - setEncoders
```
public void setEncoders(ListSE<ClassSE<? extends EncoderEE>> encoders)
```
  - getEncoders
```
public ListSE<ClassSE<? extends EncoderEE>> getEncoders()
```
    次で指定:
    インターフェース EndpointConfigEE の getEncodersEE
  - setDecoders
```
public void setDecoders(ListSE<ClassSE<? extends DecoderEE>> decoders)
```
  - getDecoders
```
public ListSE<ClassSE<? extends DecoderEE>> getDecoders()
```
    次で指定:
    インターフェース EndpointConfigEE の getDecodersEE
  - setUserProperties
```
public void setUserProperties(MapSE<StringSE,ObjectSE> userProperties)
```
  - getUserProperties
```
public MapSE<StringSE,ObjectSE> getUserProperties()
```
    次で指定:
    インターフェース EndpointConfigEE の getUserPropertiesEE
  - getConfigurator
```
public ServerEndpointConfig.ConfiguratorEE getConfigurator()
```
    次で指定:
    インターフェース ServerEndpointConfigEE の getConfiguratorEE
  - getEndpointInstance
```
public final <T> T getEndpointInstance(ClassSE<T> clazz)
                                throws InstantiationExceptionSE
```
    オーバーライド:
    クラス ServerEndpointConfig.ConfiguratorEE の getEndpointInstanceEE
    例外:
    InstantiationExceptionSE
  - modifyHandshake
```
public void modifyHandshake(ServerEndpointConfigEE sec,
                            HandshakeRequestEE request,
                            HandshakeResponseEE response)
```
    オーバーライド:
    クラス ServerEndpointConfig.ConfiguratorEE の modifyHandshakeEE
  - setBeanFactory
```
public void setBeanFactory(BeanFactory beanFactory)
```
    インターフェースからコピーされた説明: BeanFactoryAware
    所有ファクトリを Bean インスタンスに提供するコールバック。
    通常の Bean プロパティの設定後、ただし InitializingBean.afterPropertiesSet() またはカスタム init-method などの初期化コールバックの前に呼び出されます。
    次で指定:
    インターフェース BeanFactoryAware の setBeanFactory
    パラメーター:
    beanFactory - 所有 BeanFactory（非 null）。Bean は、ファクトリのメソッドをすぐに呼び出すことができます。
    関連事項:
    BeanInitializationException
  - toString
```
public StringSE toString()
```
    オーバーライド:
    クラス ObjectSE の toStringSE

クラス ServerEndpointRegistration

ネストされたクラスのサマリー

インターフェース javax.websocket.server.ServerEndpointConfigEE から継承されたネストクラス / インターフェース

コンストラクターのサマリー

メソッドのサマリー

クラス javax.websocket.server.ServerEndpointConfig.ConfiguratorEE から継承されたメソッド

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

コンストラクターの詳細

ServerEndpointRegistration

ServerEndpointRegistration

メソッドの詳細

getPath

getEndpointClass

getEndpoint

setSubprotocols

getSubprotocols

setExtensions

getExtensions

setEncoders

getEncoders

setDecoders

getDecoders

setUserProperties

getUserProperties

getConfigurator

getEndpointInstance

modifyHandshake

setBeanFactory

toString