StandardWebSocketSession (Spring Framework API)

java.lang.ObjectSE
- org.springframework.web.socket.adapter.AbstractWebSocketSession<SessionEE>
- - org.springframework.web.socket.adapter.standard.StandardWebSocketSession

実装されたすべてのインターフェース:
CloseableSE, AutoCloseableSE, NativeWebSocketSession, WebSocketSession
```
public class StandardWebSocketSession
extends AbstractWebSocketSession<SessionEE>
```
Java API の標準 WebSocket で使用する WebSocketSession。
導入:
4.0
作成者:
Rossen Stoyanchev

フィールドのサマリー
- クラス org.springframework.web.socket.adapter.AbstractWebSocketSession から継承されたフィールド
  idGenerator, logger

コンストラクターの概要

コンストラクター
コンストラクターと説明
`StandardWebSocketSession(HttpHeaders headers, MapSE<StringSE, ObjectSE> attributes, InetSocketAddressSE localAddress, InetSocketAddressSE remoteAddress)` 標準の WebSocket セッションのコンストラクター。
`StandardWebSocketSession(HttpHeaders headers, MapSE<StringSE, ObjectSE> attributes, InetSocketAddressSE localAddress, InetSocketAddressSE remoteAddress, PrincipalSE user)` ユーザーを WebSocket セッションに関連付けるコンストラクター。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`protected void`	`closeInternal(CloseStatus status)`
`StringSE`	`getAcceptedProtocol()` ネゴシエートされたサブプロトコルを返します。
`int`	`getBinaryMessageSizeLimit()` 受信バイナリメッセージの構成済みの最大サイズを取得します。
`ListSE<WebSocketExtension>`	`getExtensions()` ネゴシエートされた拡張機能を決定します。
`HttpHeaders`	`getHandshakeHeaders()` ハンドシェイクリクエストで使用されるヘッダーを返します（非 `null`）。
`StringSE`	`getId()` 一意のセッション識別子を返します。
`InetSocketAddressSE`	`getLocalAddress()` リクエストが受信されたアドレスを返します。
`PrincipalSE`	`getPrincipal()` 認証されたユーザーの名前を含む `Principal`SE インスタンスを返します。
`InetSocketAddressSE`	`getRemoteAddress()` リモートクライアントのアドレスを返します。
`int`	`getTextMessageSizeLimit()` 受信テキストメッセージの構成済みの最大サイズを取得します。
`URISE`	`getUri()` WebSocket 接続を開くために使用される URI を返します。
`void`	`initializeNativeSession(SessionEE session)`
`boolean`	`isOpen()` 基になる接続が開いているかどうか。
`protected void`	`sendBinaryMessage(BinaryMessage message)`
`protected void`	`sendPingMessage(PingMessage message)`
`protected void`	`sendPongMessage(PongMessage message)`
`protected void`	`sendTextMessage(TextMessage message)`
`void`	`setBinaryMessageSizeLimit(int messageSizeLimit)` 受信バイナリメッセージの最大サイズを構成します。
`void`	`setTextMessageSizeLimit(int messageSizeLimit)` 受信テキストメッセージの最大サイズを構成します。

クラス org.springframework.web.socket.adapter.AbstractWebSocketSession から継承されたメソッド
checkNativeSessionInitialized, close, close, getAttributes, getNativeSession, getNativeSession, sendMessage, toString

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

- コンストラクターの詳細
  - StandardWebSocketSession
```
public StandardWebSocketSession(@Nullable
                                HttpHeaders headers,
                                @Nullable
                                MapSE<StringSE,ObjectSE> attributes,
                                @Nullable
                                InetSocketAddressSE localAddress,
                                @Nullable
                                InetSocketAddressSE remoteAddress)
```
    標準の WebSocket セッションのコンストラクター。
    パラメーター:
    headers - ハンドシェイクリクエストのヘッダー
    attributes - WebSocket セッションに関連付ける HTTP ハンドシェイクの属性。提供された属性がコピーされ、元のマップは使用されません。
    localAddress - リクエストが受信されたアドレス
    remoteAddress - リモートクライアントのアドレス
  - StandardWebSocketSession
```
public StandardWebSocketSession(@Nullable
                                HttpHeaders headers,
                                @Nullable
                                MapSE<StringSE,ObjectSE> attributes,
                                @Nullable
                                InetSocketAddressSE localAddress,
                                @Nullable
                                InetSocketAddressSE remoteAddress,
                                @Nullable
                                PrincipalSE user)
```
    ユーザーを WebSocket セッションに関連付けるコンストラクター。
    パラメーター:
    headers - ハンドシェイクリクエストのヘッダー
    attributes - WebSocket セッションに関連付ける HTTP ハンドシェイクの属性
    localAddress - リクエストが受信されたアドレス
    remoteAddress - リモートクライアントのアドレス
    user - セッションに関連付けられたユーザー。null の場合、基になる WebSocket セッションで使用可能なユーザーにフォールバックします
- メソッドの詳細
  - getId
```
public StringSE getId()
```
    インターフェースからコピーされた説明: WebSocketSession
    一意のセッション識別子を返します。
  - getUri
```
@Nullable
public URISE getUri()
```
    インターフェースからコピーされた説明: WebSocketSession
    WebSocket 接続を開くために使用される URI を返します。
  - getHandshakeHeaders
```
public HttpHeaders getHandshakeHeaders()
```
    インターフェースからコピーされた説明: WebSocketSession
    ハンドシェイクリクエストで使用されるヘッダーを返します（非 null）。
  - getAcceptedProtocol
```
public StringSE getAcceptedProtocol()
```
    インターフェースからコピーされた説明: WebSocketSession
    ネゴシエートされたサブプロトコルを返します。
    戻り値:
    プロトコル識別子、またはプロトコルが指定されていないか正常にネゴシエートされた場合は null
  - getExtensions
```
public ListSE<WebSocketExtension> getExtensions()
```
    インターフェースからコピーされた説明: WebSocketSession
    ネゴシエートされた拡張機能を決定します。
    戻り値:
    拡張機能のリスト、または拡張機能が指定されていないか正常にネゴシエートされていない場合は空のリスト
  - getPrincipal
```
public PrincipalSE getPrincipal()
```
    インターフェースからコピーされた説明: WebSocketSession
    認証されたユーザーの名前を含む PrincipalSE インスタンスを返します。
    ユーザーが認証されていない場合、メソッドは null を返します。
  - getLocalAddress
```
@Nullable
public InetSocketAddressSE getLocalAddress()
```
    インターフェースからコピーされた説明: WebSocketSession
    リクエストが受信されたアドレスを返します。
  - getRemoteAddress
```
@Nullable
public InetSocketAddressSE getRemoteAddress()
```
    インターフェースからコピーされた説明: WebSocketSession
    リモートクライアントのアドレスを返します。
  - setTextMessageSizeLimit
```
public void setTextMessageSizeLimit(int messageSizeLimit)
```
    インターフェースからコピーされた説明: WebSocketSession
    受信テキストメッセージの最大サイズを構成します。
  - getTextMessageSizeLimit
```
public int getTextMessageSizeLimit()
```
    インターフェースからコピーされた説明: WebSocketSession
    受信テキストメッセージの構成済みの最大サイズを取得します。
  - setBinaryMessageSizeLimit
```
public void setBinaryMessageSizeLimit(int messageSizeLimit)
```
    インターフェースからコピーされた説明: WebSocketSession
    受信バイナリメッセージの最大サイズを構成します。
  - getBinaryMessageSizeLimit
```
public int getBinaryMessageSizeLimit()
```
    インターフェースからコピーされた説明: WebSocketSession
    受信バイナリメッセージの構成済みの最大サイズを取得します。
  - isOpen
```
public boolean isOpen()
```
    インターフェースからコピーされた説明: WebSocketSession
    基になる接続が開いているかどうか。
  - initializeNativeSession
```
public void initializeNativeSession(SessionEE session)
```
    オーバーライド:
    クラス AbstractWebSocketSession<SessionEE> の initializeNativeSession
  - sendTextMessage
```
protected void sendTextMessage(TextMessage message)
                        throws IOExceptionSE
```
    次で指定:
    クラス AbstractWebSocketSession<SessionEE> の sendTextMessage
    例外:
    IOExceptionSE
  - sendBinaryMessage
```
protected void sendBinaryMessage(BinaryMessage message)
                          throws IOExceptionSE
```
    次で指定:
    クラス AbstractWebSocketSession<SessionEE> の sendBinaryMessage
    例外:
    IOExceptionSE
  - sendPingMessage
```
protected void sendPingMessage(PingMessage message)
                        throws IOExceptionSE
```
    次で指定:
    クラス AbstractWebSocketSession<SessionEE> の sendPingMessage
    例外:
    IOExceptionSE
  - sendPongMessage
```
protected void sendPongMessage(PongMessage message)
                        throws IOExceptionSE
```
    次で指定:
    クラス AbstractWebSocketSession<SessionEE> の sendPongMessage
    例外:
    IOExceptionSE
  - closeInternal
```
protected void closeInternal(CloseStatus status)
                      throws IOExceptionSE
```
    次で指定:
    クラス AbstractWebSocketSession<SessionEE> の closeInternal
    例外:
    IOExceptionSE

クラス StandardWebSocketSession

フィールドのサマリー

クラス org.springframework.web.socket.adapter.AbstractWebSocketSession から継承されたフィールド

コンストラクターの概要

メソッドのサマリー

クラス org.springframework.web.socket.adapter.AbstractWebSocketSession から継承されたメソッド

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

コンストラクターの詳細

StandardWebSocketSession

StandardWebSocketSession

メソッドの詳細

getId

getUri

getHandshakeHeaders

getAcceptedProtocol

getExtensions

getPrincipal

getLocalAddress

getRemoteAddress

setTextMessageSizeLimit

getTextMessageSizeLimit

setBinaryMessageSizeLimit

getBinaryMessageSizeLimit

isOpen

initializeNativeSession

sendTextMessage

sendBinaryMessage

sendPingMessage

sendPongMessage

closeInternal