パッケージ org.springframework.web.socket

クラス CloseStatus

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

    clone, finalize, getClass, notify, notifyAll, wait, 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 制御フレームのステータスコードとして設定してはなりません。これは、Close 制御フレームの送受信を行わずに接続が異常終了したことを示すステータスコードを期待するアプリケーションで使用するために指定されています。」

    • 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 制御フレームのステータスコードとして設定してはなりません。これは、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 の hashCode 

    • toString

      public StringSE toString()
      オーバーライド:
      クラス ObjectSE の toString