CloseStatus (Spring Framework API)

java.lang.ObjectSE
- org.springframework.web.socket.CloseStatus

実装されているすべてのインターフェース:
SerializableSE
```
public final class CloseStatus
extends ObjectSE
implements SerializableSE
```
WebSocket クローズステータスコードと理由を表します。1xxx の範囲のステータスコードは、プロトコルによって事前に定義されています。オプションで、ステータスコードが理由とともに送信される場合があります。
RFC 6455、セクション 7.4.1「定義されたステータスコード」を参照してください。
導入:
4.0
作成者:
Rossen Stoyanchev
関連事項:
連載形式

フィールドのサマリー

フィールド
修飾子と型	フィールドと説明
`static CloseStatus`	`BAD_DATA` 「1007 は、メッセージの型と一致しないメッセージ内のデータ（たとえば、テキストメッセージ内の非 UTF-8 [RFC3629] データ）を受信したため、エンドポイントが接続を終了していることを示します。」
`static CloseStatus`	`GOING_AWAY` 「1001 は、サーバーがダウンしたり、ブラウザーがページから移動したりするなど、エンドポイントが「離れる」ことを示します。
`static CloseStatus`	`NO_CLOSE_FRAME` 「1006 は予約済みの値であり、エンドポイントによって Close コントロールフレームのステータスコードとして設定してはなりません（MUST NOT）。
`static CloseStatus`	`NO_STATUS_CODE` 「1005 は予約済みの値であり、エンドポイントによって Close コントロールフレームのステータスコードとして設定してはなりません（MUST NOT）。
`static CloseStatus`	`NORMAL` 「1000 は通常の閉鎖を示します。つまり、接続が確立された目的が達成されたことを意味します。」
`static CloseStatus`	`NOT_ACCEPTABLE` 「1003 は、エンドポイントが受信できない型のデータを受信したため、エンドポイントが接続を終了していることを示します（たとえば、テキストデータのみを理解するエンドポイントは、バイナリメッセージを受信した場合にこれを送信できます）。」
`static CloseStatus`	`POLICY_VIOLATION` 「1008 は、ポリシーに違反するメッセージを受信したため、エンドポイントが接続を終了していることを示します。
`static CloseStatus`	`PROTOCOL_ERROR` 「1002 は、プロトコルエラーが原因でエンドポイントが接続を終了していることを示します。」
`static CloseStatus`	`REQUIRED_EXTENSION` 「1010 は、サーバーが 1 つ以上の内線をネゴシエートすることを期待していたが、サーバーが WebSocket ハンドシェイクのレスポンスメッセージで返さなかったため、エンドポイント（クライアント）が接続を終了していることを示します。
`static CloseStatus`	`SERVER_ERROR` 「1011 は、サーバーがリクエストの実行を妨げる予期しない状況が発生したため、サーバーが接続を終了していることを示しています。」
`static CloseStatus`	`SERVICE_OVERLOAD` 「1013 は、サービスがオーバーロードになっていることを示します。
`static CloseStatus`	`SERVICE_RESTARTED` 「1012 は、サービスが再起動されることを示します。
`static CloseStatus`	`SESSION_NOT_RELIABLE` フレームワーク内で使用するステータスコードは、セッションが信頼できなくなったことを示します（例:
`static CloseStatus`	`TLS_HANDSHAKE_FAILURE` 「1015 は予約済みの値であり、エンドポイントによって Close コントロールフレームのステータスコードとして設定してはなりません（MUST NOT）。
`static CloseStatus`	`TOO_BIG_TO_PROCESS` 「1009 は、処理するには大きすぎるメッセージを受信したため、エンドポイントが接続を終了していることを示します。」

コンストラクターの概要

コンストラクター
コンストラクターと説明
`CloseStatus(int code)` 新しい `CloseStatus` インスタンスを作成します。
`CloseStatus(int code, StringSE reason)` 新しい `CloseStatus` インスタンスを作成します。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`boolean`	`equals(ObjectSE other)`
`boolean`	`equalsCode(CloseStatus other)`
`int`	`getCode()` ステータスコードを返します。
`StringSE`	`getReason()` 理由を返します。ない場合は `null` を返します。
`int`	`hashCode()`
`StringSE`	`toString()`
`CloseStatus`	`withReason(StringSE reason)` 指定された理由で、この `CloseStatus` から新しい `CloseStatus` を作成します。

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

- フィールドの詳細
  - NORMAL
```
public static final CloseStatus NORMAL
```
    「1000 は通常の閉鎖を示します。つまり、接続が確立された目的が達成されたことを意味します。」
  - GOING_AWAY
```
public static final CloseStatus GOING_AWAY
```
    「1001 は、サーバーがダウンしたり、ブラウザーがページから移動したりするなど、エンドポイントが「離れる」ことを示します。
  - PROTOCOL_ERROR
```
public static final CloseStatus PROTOCOL_ERROR
```
    「1002 は、プロトコルエラーが原因でエンドポイントが接続を終了していることを示します。」
  - NOT_ACCEPTABLE
```
public static final CloseStatus NOT_ACCEPTABLE
```
    「1003 は、エンドポイントが受信できない型のデータを受信したため、エンドポイントが接続を終了していることを示します（たとえば、テキストデータのみを理解するエンドポイントは、バイナリメッセージを受信した場合にこれを送信できます）。」
  - NO_STATUS_CODE
```
public static final CloseStatus NO_STATUS_CODE
```
    「1005 は予約済みの値であり、エンドポイントによって Close コントロールフレームのステータスコードとして設定してはなりません（MUST NOT）。これは、ステータスコードが実際に存在しないことを示すステータスコードを期待するアプリケーションで使用するために指定されています。」
  - NO_CLOSE_FRAME
```
public static final CloseStatus NO_CLOSE_FRAME
```
    「1006 は予約済みの値であり、エンドポイントによって Close コントロールフレームのステータスコードとして設定してはなりません（MUST NOT）。これは、接続が異常に閉じられたことを示すステータスコードを期待するアプリケーションで使用するために指定されています。クローズコントロールフレーム。」
  - BAD_DATA
```
public static final CloseStatus BAD_DATA
```
    「1007 は、メッセージの型と一致しないメッセージ内のデータ（たとえば、テキストメッセージ内の非 UTF-8 [RFC3629] データ）を受信したため、エンドポイントが接続を終了していることを示します。」
  - POLICY_VIOLATION
```
public static final CloseStatus POLICY_VIOLATION
```
    「1008 は、ポリシーに違反するメッセージを受信したため、エンドポイントが接続を終了していることを示します。これは、他に適切なステータスコード（1003 または 1009 など）がない場合、またはポリシーに関する特定の詳細を非表示にする必要があります。」
  - TOO_BIG_TO_PROCESS
```
public static final CloseStatus TOO_BIG_TO_PROCESS
```
    「1009 は、処理するには大きすぎるメッセージを受信したため、エンドポイントが接続を終了していることを示します。」
  - REQUIRED_EXTENSION
```
public static final CloseStatus REQUIRED_EXTENSION
```
    「1010 は、サーバーが 1 つ以上の拡張をネゴシエートすることを期待していたが、サーバーが WebSocket ハンドシェイクのレスポンスメッセージで返さなかったため、エンドポイント（クライアント）が接続を終了していることを示しています。必要な拡張のリストクローズフレームの /reason/ 部分に表示する必要があります。このステータスコードは WebSocket ハンドシェイクに失敗する可能性があるため、サーバーでは使用されないことに注意してください。
  - SERVER_ERROR
```
public static final CloseStatus SERVER_ERROR
```
    「1011 は、サーバーがリクエストの実行を妨げる予期しない状況が発生したため、サーバーが接続を終了していることを示しています。」
  - SERVICE_RESTARTED
```
public static final CloseStatus SERVICE_RESTARTED
```
    「1012 はサービスが再起動されたことを示します。クライアントは再接続する場合があり、再起動する場合は 5 〜 30 秒のランダムな遅延を使用して再接続する必要があります。」
  - SERVICE_OVERLOAD
```
public static final CloseStatus SERVICE_OVERLOAD
```
    「1013 は、サービスにオーバーロードが発生していることを示します。クライアントは、異なる IP に接続するか（ターゲットに複数ある場合）、ユーザーの操作時に同じ IP に再接続する必要があります。」
  - TLS_HANDSHAKE_FAILURE
```
public static final CloseStatus TLS_HANDSHAKE_FAILURE
```
    「1015 は予約済みの値であり、エンドポイントによって Close コントロールフレームのステータスコードとして設定してはなりません（MUST NOT）。これは、TLS の実行の失敗により接続が閉じられたことを示すステータスコードを期待するアプリケーションで使用するために指定されています。ハンドシェイク（例: サーバー証明書を確認できません）。」
  - SESSION_NOT_RELIABLE
```
public static final CloseStatus SESSION_NOT_RELIABLE
```
    フレームワーク内で使用するステータスコードは、セッションが信頼できなくなったこと（たとえば、メッセージの送信中にタイムアウトになったこと）を示し、追加の注意を払う必要があります。通常のシャットダウン中に行われる可能性があるデータをクライアントに送信しないでください。
    導入:
    4.0.3
- コンストラクターの詳細
  - CloseStatus
```
public CloseStatus(int code)
```
    新しい CloseStatus インスタンスを作成します。
    パラメーター:
    code - ステータスコード
  - CloseStatus
```
public CloseStatus(int code,
                   @Nullable
                   StringSE reason)
```
    新しい CloseStatus インスタンスを作成します。
    パラメーター:
    code - ステータスコード
    reason - 理由
- メソッドの詳細
  - getCode
```
public int getCode()
```
    ステータスコードを返します。
  - getReason
```
@Nullable
public StringSE getReason()
```
    理由を返します。ない場合は null を返します。
  - withReason
```
public CloseStatus withReason(StringSE reason)
```
    指定された理由で、この CloseStatus から新しい CloseStatus を作成します。
    パラメーター:
    reason - 理由
    戻り値:
    新しい CloseStatus インスタンス
  - equalsCode
```
public boolean equalsCode(CloseStatus other)
```
  - equals
```
public boolean equals(@Nullable
                      ObjectSE other)
```
    オーバーライド:
    クラス ObjectSE の equalsSE
  - hashCode
```
public int hashCode()
```
    オーバーライド:
    クラス ObjectSE の hashCodeSE
  - toString
```
public StringSE toString()
```
    オーバーライド:
    クラス ObjectSE の toStringSE

クラス CloseStatus

フィールドのサマリー

コンストラクターの概要

メソッドのサマリー

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

フィールドの詳細

NORMAL

GOING_AWAY

PROTOCOL_ERROR

NOT_ACCEPTABLE

NO_STATUS_CODE

NO_CLOSE_FRAME

BAD_DATA

POLICY_VIOLATION

TOO_BIG_TO_PROCESS

REQUIRED_EXTENSION

SERVER_ERROR

SERVICE_RESTARTED

SERVICE_OVERLOAD

TLS_HANDSHAKE_FAILURE

SESSION_NOT_RELIABLE

コンストラクターの詳細

CloseStatus

CloseStatus

メソッドの詳細

getCode

getReason

withReason

equalsCode

equals

hashCode

toString