パッケージ jakarta.websocket
列挙型クラス CloseReason.CloseCodes
- 実装されたすべてのインターフェース:
CloseReason.CloseCode、SerializableSE、ComparableSE<CloseReason.CloseCodes>、ConstableSE
- 含まれているクラス:
- CloseReason
public static enum CloseReason.CloseCodes
extends EnumSE<CloseReason.CloseCodes>
implements CloseReason.CloseCode
仕様で定義されている Web ソケットクローズのステータスコードの列挙。
ネストされたクラスのサマリー
クラス java.lang.EnumSE から継承されたネストクラス / インターフェース
Enum.EnumDescSE<ESE extends EnumSE<ESE>>列挙定数のサマリー
列挙型定数列挙定数説明1003 は、エンドポイントが受け入れることができない型のデータを受信したために接続を終了していることを示します（たとえば、テキストデータのみを理解するエンドポイントは、バイナリメッセージを受信した場合にこれを送信できます）。1006 は予約値であり、エンドポイントによって Close コントロールフレームのステータスコードとして設定してはなりません（MUSTNOT）。1001 は、サーバーがダウンしたり、ブラウザーがページから移動したりするなど、エンドポイントが「なくなる」ことを示します。1010 は、サーバーが 1 つ以上の内線番号をネゴシエートすることを期待しているが、サーバーが WebSocket ハンドシェイクのレスポンスメッセージで返さなかったため、エンドポイント（クライアント）が接続を終了していることを示します。1005 は予約値であり、エンドポイントによって Close コントロールフレームのステータスコードとして設定してはなりません（MUSTNOT）。1000 は通常の閉包を示し、接続が確立された目的が達成されたことを意味します。1007 は、エンドポイントがメッセージの型と一致しないメッセージ内のデータ（たとえば、テキストメッセージ内の非 UTF-8 データ）を受信したために接続を終了していることを示します。1002 は、プロトコルエラーが原因でエンドポイントが接続を終了していることを示します。予約済み。1012 は、サービスが再起動されることを示します。1015 は予約値であり、エンドポイントによって Close コントロールフレームのステータスコードとして設定してはなりません（MUSTNOT）。1009 は、エンドポイントが大きすぎて処理できないメッセージを受信したため、エンドポイントが接続を終了していることを示します。1013 は、サービスでオーバーロードが発生していることを示しています1011 は、サーバーがリクエストを実行できない予期しない状態が発生したため、サーバーが接続を終了していることを示します。1008 は、ポリシーに違反するメッセージを受信したため、エンドポイントが接続を終了していることを示します。メソッドのサマリー
修飾子と型メソッド説明static CloseReason.CloseCodegetCloseCode(int code) 指定された int コード番号から CloseCode を作成します。intgetCode()このステータスコードのコード番号を返します。static CloseReason.CloseCodes指定された名前でこのクラスの列挙型定数を返します。static CloseReason.CloseCodes[]values()この列挙型クラスの定数を含む配列を、宣言されている順序で返します。クラス java.lang.EnumSE から継承されたメソッド
clone, compareToSE, describeConstable, equalsSE, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOfSE
列挙型定数の詳細
NORMAL_CLOSURE
1000 は通常の閉包を示し、接続が確立された目的が達成されたことを意味します。GOING_AWAY
1001 は、サーバーがダウンしたり、ブラウザーがページから移動したりするなど、エンドポイントが「なくなる」ことを示します。PROTOCOL_ERROR
1002 は、プロトコルエラーが原因でエンドポイントが接続を終了していることを示します。CANNOT_ACCEPT
1003 は、エンドポイントが受け入れることができない型のデータを受信したために接続を終了していることを示します（たとえば、テキストデータのみを理解するエンドポイントは、バイナリメッセージを受信した場合にこれを送信できます）。RESERVED
予約済み。具体的な意味は将来定義されるかもしれません。NO_STATUS_CODE
1005 は予約値であり、エンドポイントによって Close コントロールフレームのステータスコードとして設定してはなりません（MUSTNOT）。これは、ステータスコードが実際に存在しなかったことを示すステータスコードを期待するアプリケーションで使用するために指定されています。CLOSED_ABNORMALLY
1006 は予約値であり、エンドポイントによって Close コントロールフレームのステータスコードとして設定してはなりません（MUSTNOT）。これは、接続が異常に閉じられたことを示すステータスコードを期待するアプリケーションで使用するために指定されています。たとえば、Close コントロールフレームを送受信しません。NOT_CONSISTENT
1007 は、エンドポイントがメッセージの型と一致しないメッセージ内のデータ（たとえば、テキストメッセージ内の非 UTF-8 データ）を受信したために接続を終了していることを示します。VIOLATED_POLICY
1008 は、ポリシーに違反するメッセージを受信したため、エンドポイントが接続を終了していることを示します。これは一般的なステータスコードであり、他に適切なステータスコード（1003 または 1009 など）がない場合、またはポリシーに関する特定の詳細を非表示にする必要がある場合に返されます。TOO_BIG
1009 は、エンドポイントが大きすぎて処理できないメッセージを受信したため、エンドポイントが接続を終了していることを示します。NO_EXTENSION
1010 は、サーバーが 1 つ以上の内線番号をネゴシエートすることを期待しているが、サーバーが WebSocket ハンドシェイクのレスポンスメッセージで返さなかったため、エンドポイント（クライアント）が接続を終了していることを示します。必要な拡張機能のリストは、閉じるフレームの /reason/ 部分に表示される必要があります。このステータスコードは、WebSocket ハンドシェイクに失敗する可能性があるため、サーバーでは使用されないことに注意してください。UNEXPECTED_CONDITION
1011 は、サーバーがリクエストを実行できない予期しない状態が発生したため、サーバーが接続を終了していることを示します。SERVICE_RESTART
1012 は、サービスが再起動されることを示します。TRY_AGAIN_LATER
1013 は、サービスでオーバーロードが発生していることを示していますTLS_HANDSHAKE_FAILURE
1015 は予約値であり、エンドポイントによって Close コントロールフレームのステータスコードとして設定してはなりません（MUSTNOT）。これは、TLS ハンドシェイクの実行に失敗したために接続が閉じられたことを示すステータスコードを期待するアプリケーションで使用するように指定されています（たとえば、サーバー証明書を検証できません）。
メソッドの詳細
values
この列挙型クラスの定数を含む配列を、宣言されている順序で返します。- 戻り値:
- この列挙型クラスの定数を宣言された順序で含む配列
valueOf
指定された名前でこのクラスの列挙型定数を返します。文字列は、このクラスで列挙型定数を宣言するために使用される識別子と正確に一致する必要があります。(余分な空白文字は許可されません。)- パラメーター:
name- 返される列挙定数の名前。- 戻り値:
- 指定された名前の列挙定数
- 例外:
IllegalArgumentExceptionSE- この列挙型クラスに指定された名前の定数がない場合NullPointerExceptionSE- 引数が null の場合
getCloseCode
指定された int コード番号から CloseCode を作成します。int が次のいずれでもない場合、このメソッドは IllegalArgumentException をスローします。- パラメーター:
code- 整数コード番号- 戻り値:
- 指定されたコード番号の新しい CloseCode
- 例外:
IllegalArgumentExceptionSE- コードが有効なクローズコードでない場合
getCode
public int getCode()このステータスコードのコード番号を返します。- 次で指定:
- インターフェース
CloseReason.CloseCodeのgetCode - 戻り値:
- コード。