ServerEndpointRegistration (Spring Framework 5.1.1.RELEASE API)

java.lang.Object
- javax.websocket.server.ServerEndpointConfig.Configurator
- - org.springframework.web.socket.server.standard.ServerEndpointRegistration

実装済みのインターフェース一覧:
javax.websocket.EndpointConfig, javax.websocket.server.ServerEndpointConfig, Aware, BeanFactoryAware
```
public class ServerEndpointRegistration
extends javax.websocket.server.ServerEndpointConfig.Configurator
implements javax.websocket.server.ServerEndpointConfig, BeanFactoryAware
```
Spring ベースのアプリケーションで使用するための ServerEndpointConfig の実装。ServerEndpointRegistration Bean は ServerEndpointExporter によって検出され、起動時に Java WebSocket ランタイムに登録されます。
クラスコンストラクターは、シングルトン Endpoint インスタンスまたは型 Class で指定されたエンドポイントを受け入れます。型で指定すると、エンドポイントは、各クライアント WebSocket 接続の前に、Spring ApplicationContext を介してインスタンス化および初期化されます。
このクラスは ServerEndpointConfig.Configurator も拡張して、ハンドシェイクプロセスをカスタマイズするためのメソッドを簡単にオーバーライドできるようにします。
導入:
4.0
作成者:
Rossen Stoyanchev, Juergen Hoeller
関連事項:
ServerEndpointExporter

ネストされたクラスの概要
- インターフェース javax.websocket.server.ServerEndpointConfig から継承されたネストクラス / インターフェース
  javax.websocket.server.ServerEndpointConfig.Builder, javax.websocket.server.ServerEndpointConfig.Configurator

コンストラクター概要

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

方法の概要

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`javax.websocket.server.ServerEndpointConfig.Configurator`	`getConfigurator()`
`java.util.List<java.lang.Class<? extends javax.websocket.Decoder>>`	`getDecoders()`
`java.util.List<java.lang.Class<? extends javax.websocket.Encoder>>`	`getEncoders()`
`javax.websocket.Endpoint`	`getEndpoint()`
`java.lang.Class<? extends javax.websocket.Endpoint>`	`getEndpointClass()`
`<T> T`	`getEndpointInstance(java.lang.Class<T> clazz)`
`java.util.List<javax.websocket.Extension>`	`getExtensions()`
`java.lang.String`	`getPath()`
`java.util.List<java.lang.String>`	`getSubprotocols()`
`java.util.Map<java.lang.String,java.lang.Object>`	`getUserProperties()`
`void`	`modifyHandshake(javax.websocket.server.ServerEndpointConfig sec, javax.websocket.server.HandshakeRequest request, javax.websocket.HandshakeResponse response)`
`void`	`setBeanFactory(BeanFactory beanFactory)` 所有ファクトリを Bean インスタンスに提供するコールバック。
`void`	`setDecoders(java.util.List<java.lang.Class<? extends javax.websocket.Decoder>> decoders)`
`void`	`setEncoders(java.util.List<java.lang.Class<? extends javax.websocket.Encoder>> encoders)`
`void`	`setExtensions(java.util.List<javax.websocket.Extension> extensions)`
`void`	`setSubprotocols(java.util.List<java.lang.String> subprotocols)`
`void`	`setUserProperties(java.util.Map<java.lang.String,java.lang.Object> userProperties)`
`java.lang.String`	`toString()`

クラス javax.websocket.server.ServerEndpointConfig.Configurator から継承されたメソッド
checkOrigin, getNegotiatedExtensions, getNegotiatedSubprotocol

クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- コンストラクターの詳細
  - ServerEndpointRegistration
```
public ServerEndpointRegistration(java.lang.String path,
                                  javax.websocket.Endpoint endpoint)
```
    javax.websocket.Endpoint インスタンスから新しい ServerEndpointRegistration インスタンスを作成します。
    パラメーター:
    path - エンドポイントパス
    endpoint - エンドポイントインスタンス
  - ServerEndpointRegistration
```
public ServerEndpointRegistration(java.lang.String path,
                                  java.lang.Class<? extends javax.websocket.Endpoint> endpointClass)
```
    javax.websocket.Endpoint クラスから新しい ServerEndpointRegistration インスタンスを作成します。
    パラメーター:
    path - エンドポイントパス
    endpointClass - エンドポイントクラス
- メソッドの詳細
  - getPath
```
public java.lang.String getPath()
```
    次で指定:
    インターフェース javax.websocket.server.ServerEndpointConfig 内の getPath
  - getEndpointClass
```
public java.lang.Class<? extends javax.websocket.Endpoint> getEndpointClass()
```
    次で指定:
    インターフェース javax.websocket.server.ServerEndpointConfig 内の getEndpointClass
  - getEndpoint
```
public javax.websocket.Endpoint getEndpoint()
```
  - setSubprotocols
```
public void setSubprotocols(java.util.List<java.lang.String> subprotocols)
```
  - getSubprotocols
```
public java.util.List<java.lang.String> getSubprotocols()
```
    次で指定:
    インターフェース javax.websocket.server.ServerEndpointConfig 内の getSubprotocols
  - setExtensions
```
public void setExtensions(java.util.List<javax.websocket.Extension> extensions)
```
  - getExtensions
```
public java.util.List<javax.websocket.Extension> getExtensions()
```
    次で指定:
    インターフェース javax.websocket.server.ServerEndpointConfig 内の getExtensions
  - setEncoders
```
public void setEncoders(java.util.List<java.lang.Class<? extends javax.websocket.Encoder>> encoders)
```
  - getEncoders
```
public java.util.List<java.lang.Class<? extends javax.websocket.Encoder>> getEncoders()
```
    次で指定:
    インターフェース javax.websocket.EndpointConfig 内の getEncoders
  - setDecoders
```
public void setDecoders(java.util.List<java.lang.Class<? extends javax.websocket.Decoder>> decoders)
```
  - getDecoders
```
public java.util.List<java.lang.Class<? extends javax.websocket.Decoder>> getDecoders()
```
    次で指定:
    インターフェース javax.websocket.EndpointConfig 内の getDecoders
  - setUserProperties
```
public void setUserProperties(java.util.Map<java.lang.String,java.lang.Object> userProperties)
```
  - getUserProperties
```
public java.util.Map<java.lang.String,java.lang.Object> getUserProperties()
```
    次で指定:
    インターフェース javax.websocket.EndpointConfig 内の getUserProperties
  - getConfigurator
```
public javax.websocket.server.ServerEndpointConfig.Configurator getConfigurator()
```
    次で指定:
    インターフェース javax.websocket.server.ServerEndpointConfig 内の getConfigurator
  - getEndpointInstance
```
public final <T> T getEndpointInstance(java.lang.Class<T> clazz)
                                throws java.lang.InstantiationException
```
    オーバーライド:
    クラス javax.websocket.server.ServerEndpointConfig.Configurator の getEndpointInstance
    例外:
    java.lang.InstantiationException
  - modifyHandshake
```
public void modifyHandshake(javax.websocket.server.ServerEndpointConfig sec,
                            javax.websocket.server.HandshakeRequest request,
                            javax.websocket.HandshakeResponse response)
```
    オーバーライド:
    クラス javax.websocket.server.ServerEndpointConfig.Configurator の modifyHandshake
  - setBeanFactory
```
public void setBeanFactory(BeanFactory beanFactory)
```
    インターフェースからコピーされた説明: BeanFactoryAware
    所有ファクトリを Bean インスタンスに提供するコールバック。
    通常の Bean プロパティの設定後、ただし InitializingBean.afterPropertiesSet() またはカスタム init-method などの初期化コールバックの前に呼び出されます。
    次で指定:
    インターフェース BeanFactoryAware 内の setBeanFactory
    パラメーター:
    beanFactory - 所有 BeanFactory（非 null）。Bean は、ファクトリのメソッドをすぐに呼び出すことができます。
    関連事項:
    BeanInitializationException
  - toString
```
public java.lang.String toString()
```
    オーバーライド:
    クラス java.lang.Object の toString

クラス ServerEndpointRegistration

ネストされたクラスの概要

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

コンストラクター概要

方法の概要

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

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

コンストラクターの詳細

ServerEndpointRegistration

ServerEndpointRegistration

メソッドの詳細

getPath

getEndpointClass

getEndpoint

setSubprotocols

getSubprotocols

setExtensions

getExtensions

setEncoders

getEncoders

setDecoders

getDecoders

setUserProperties

getUserProperties

getConfigurator

getEndpointInstance

modifyHandshake

setBeanFactory

toString