HttpResponse.Status (Nablarch-API)

java.lang.Object
- java.lang.Enum<HttpResponse.Status>
- - nablarch.fw.web.HttpResponse.Status

すべての実装されたインタフェース:: java.io.Serializable, java.lang.Comparable<HttpResponse.Status>, Handler<HttpRequest,HttpResponse>, HttpRequestHandler

含まれているクラス:: HttpResponse

@Published
public static enum HttpResponse.Status
extends java.lang.Enum<HttpResponse.Status>
implements HttpRequestHandler

HTTPレスポンスステータス。

 HTTPレスポンスフォーマットにおけるHTTPステータスコード・ステータスフレーズの値と
 それに関連する責務を実装したEnum。

列挙型定数のサマリー

列挙型定数
列挙型定数と説明
`ACCEPTED` 正常終了:処理の受付が完了した。
`BAD_GATEWAY` 不正なゲートウェイ
`BAD_REQUEST` ユーザエラー:リクエストの内容に問題があるので処理を継続できない。
`CONFLICT` リソース競合エラー
`CONTINUE` 継続
`CREATED` 正常終了:リソースが正常に作成された。
`EXPECTATION_FAILED` Expectヘッダによる拡張が失敗。
`FORBIDDEN` 認証・認可エラー
`FOUND` リダイレクト
`GATEWAY_TIMEOUT` ゲートウェイタイムアウト
`GONE` 消滅した。
`HTTP_VERSION_NOT_SUPPORTED` サポートしていないHTTPバージョン
`INTERNAL_SERVER_ERROR` システムエラー:システム上の問題が発生したため処理を継続できない。
`LENGTH_REQUIRED` 長さが必要。
`METHOD_NOT_ALLOWED` 許可されていないメソッド
`MOVED_PERMANENTLY` 恒久的に移動した。
`NO_CONTENT` 内容なし
`NOT_ACCEPTABLE` 受理できない。
`NOT_FOUND` ユーザエラー:リクエストURIに相当するリソースが存在しない。
`NOT_IMPLEMENTED` 実装されていない。
`NOT_MODIFIED` コンテンツに変更が無い。
`OK` 正常終了
`PARTIAL_CONTENT` 部分的内容
`PAYMENT_REQUIRED` 支払いが必要である。
`PRECONDITION_FAILED` 前提条件で失敗した。
`PROXY_AUTHENTICATION_REQUIRED` プロキシ認証が必要である。
`REQUEST_ENTITY_TOO_LARGE` リクエストエンティティが大きすぎる。
`REQUEST_TIMEOUT` リクエストタイムアウト
`REQUEST_URI_TOO_LONG` URIが大きすぎる。
`REQUESTED_RANGE_NOT_SATISFIABLE` レンジは範囲外にある。
`RESET_CONTENT` 内容のリセット
`SEE_OTHER` リダイレクト
`SERVICE_UNAVAILABLE` システムエラー:サービスを一時的に停止している。
`TEMPORARY_REDIRECT` 一時的リダイレクト
`UNAUTHORIZED` 未認証
`UNSUPPORTED_MEDIA_TYPE` サポートしていないメディアタイプ
`USE_PROXY` プロキシを使用せよ。

メソッドのサマリー

すべてのメソッド staticメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`int`	`getStatusCode()` HTTPステータスコードを取得する。
`HttpResponse`	`handle(HttpRequest req, ExecutionContext ctx)` 入力データに対する処理を実行する。
`static HttpResponse.Status`	`valueOf(java.lang.String name)` 指定した名前を持つこの型の列挙型定数を返します。
`static HttpResponse.Status`	`valueOfCode(int code)` 指定されたステータスコードに対する`Status`オブジェクトを返す。
`static HttpResponse.Status[]`	`values()` この列挙型の定数を含む配列を宣言されている順序で返します。

クラスから継承されたメソッド java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

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

- 列挙型定数の詳細
  - CONTINUE
```
public static final HttpResponse.Status CONTINUE
```
    継続
  - OK
```
public static final HttpResponse.Status OK
```
    正常終了
  - CREATED
```
public static final HttpResponse.Status CREATED
```
    正常終了:リソースが正常に作成された。
  - ACCEPTED
```
public static final HttpResponse.Status ACCEPTED
```
    正常終了:処理の受付が完了した。(後続処理がある場合)
  - NO_CONTENT
```
public static final HttpResponse.Status NO_CONTENT
```
    内容なし
  - RESET_CONTENT
```
public static final HttpResponse.Status RESET_CONTENT
```
    内容のリセット
  - PARTIAL_CONTENT
```
public static final HttpResponse.Status PARTIAL_CONTENT
```
    部分的内容
  - MOVED_PERMANENTLY
```
public static final HttpResponse.Status MOVED_PERMANENTLY
```
    恒久的に移動した。
  - FOUND
```
public static final HttpResponse.Status FOUND
```
    リダイレクト
  - SEE_OTHER
```
public static final HttpResponse.Status SEE_OTHER
```
    リダイレクト
  - NOT_MODIFIED
```
public static final HttpResponse.Status NOT_MODIFIED
```
    コンテンツに変更が無い。
  - USE_PROXY
```
public static final HttpResponse.Status USE_PROXY
```
    プロキシを使用せよ。
  - TEMPORARY_REDIRECT
```
public static final HttpResponse.Status TEMPORARY_REDIRECT
```
    一時的リダイレクト
  - BAD_REQUEST
```
public static final HttpResponse.Status BAD_REQUEST
```
    ユーザエラー:リクエストの内容に問題があるので処理を継続できない。
  - UNAUTHORIZED
```
public static final HttpResponse.Status UNAUTHORIZED
```
    未認証
  - PAYMENT_REQUIRED
```
public static final HttpResponse.Status PAYMENT_REQUIRED
```
    支払いが必要である。
  - FORBIDDEN
```
public static final HttpResponse.Status FORBIDDEN
```
    認証・認可エラー
  - NOT_FOUND
```
public static final HttpResponse.Status NOT_FOUND
```
    ユーザエラー:リクエストURIに相当するリソースが存在しない。
  - METHOD_NOT_ALLOWED
```
public static final HttpResponse.Status METHOD_NOT_ALLOWED
```
    許可されていないメソッド
  - NOT_ACCEPTABLE
```
public static final HttpResponse.Status NOT_ACCEPTABLE
```
    受理できない。
  - PROXY_AUTHENTICATION_REQUIRED
```
public static final HttpResponse.Status PROXY_AUTHENTICATION_REQUIRED
```
    プロキシ認証が必要である。
  - REQUEST_TIMEOUT
```
public static final HttpResponse.Status REQUEST_TIMEOUT
```
    リクエストタイムアウト
  - CONFLICT
```
public static final HttpResponse.Status CONFLICT
```
    リソース競合エラー
  - GONE
```
public static final HttpResponse.Status GONE
```
    消滅した。
  - LENGTH_REQUIRED
```
public static final HttpResponse.Status LENGTH_REQUIRED
```
    長さが必要。
  - PRECONDITION_FAILED
```
public static final HttpResponse.Status PRECONDITION_FAILED
```
    前提条件で失敗した。
  - REQUEST_ENTITY_TOO_LARGE
```
public static final HttpResponse.Status REQUEST_ENTITY_TOO_LARGE
```
    リクエストエンティティが大きすぎる。
  - REQUEST_URI_TOO_LONG
```
public static final HttpResponse.Status REQUEST_URI_TOO_LONG
```
    URIが大きすぎる。
  - UNSUPPORTED_MEDIA_TYPE
```
public static final HttpResponse.Status UNSUPPORTED_MEDIA_TYPE
```
    サポートしていないメディアタイプ
  - REQUESTED_RANGE_NOT_SATISFIABLE
```
public static final HttpResponse.Status REQUESTED_RANGE_NOT_SATISFIABLE
```
    レンジは範囲外にある。
  - EXPECTATION_FAILED
```
public static final HttpResponse.Status EXPECTATION_FAILED
```
    Expectヘッダによる拡張が失敗。
  - INTERNAL_SERVER_ERROR
```
public static final HttpResponse.Status INTERNAL_SERVER_ERROR
```
    システムエラー:システム上の問題が発生したため処理を継続できない。
  - NOT_IMPLEMENTED
```
public static final HttpResponse.Status NOT_IMPLEMENTED
```
    実装されていない。
  - BAD_GATEWAY
```
public static final HttpResponse.Status BAD_GATEWAY
```
    不正なゲートウェイ
  - SERVICE_UNAVAILABLE
```
public static final HttpResponse.Status SERVICE_UNAVAILABLE
```
    システムエラー:サービスを一時的に停止している。
  - GATEWAY_TIMEOUT
```
public static final HttpResponse.Status GATEWAY_TIMEOUT
```
    ゲートウェイタイムアウト
  - HTTP_VERSION_NOT_SUPPORTED
```
public static final HttpResponse.Status HTTP_VERSION_NOT_SUPPORTED
```
    サポートしていないHTTPバージョン
- メソッドの詳細
  - values
```
public static HttpResponse.Status[] values()
```
    この列挙型の定数を含む配列を宣言されている順序で返します。このメソッドは次のようにして定数を反復するために使用できます:
```
for(HttpResponse.Status c: HttpResponse.Status.values())
  System.out.println(c);
```
    戻り値:
    
    この列挙型の定数を含む、宣言されている順序での配列
  - valueOf
```
public static HttpResponse.Status valueOf(java.lang.String name)
```
    指定した名前を持つこの型の列挙型定数を返します。文字列は、この型の列挙型定数を宣言するのに使用した識別子と正確に 一致している必要があります。 (余分な空白文字を含めることはできません。)
    
    パラメータ:
    
    name - 返される列挙型定数の名前。
    
    戻り値:
    
    指定した名前の列挙型定数
    
    例外:
    
    java.lang.IllegalArgumentException - この列挙型に、指定した名前の定数がない場合
    
    java.lang.NullPointerException - 引数がnullの場合
  - valueOfCode
```
public static HttpResponse.Status valueOfCode(int code)
                                       throws java.lang.IllegalArgumentException
```
    指定されたステータスコードに対するStatusオブジェクトを返す。
    
    パラメータ:
    
    code - HTTPステータスコード
    
    戻り値:
    
    Statusオブジェクト
    
    例外:
    
    java.lang.IllegalArgumentException - ステータスコードがStatusオブジェクトに含まれていない場合
  - handle
```
public HttpResponse handle(HttpRequest req,
                           ExecutionContext ctx)
```
    入力データに対する処理を実行する。
    このクラスの実装では、以下のHTTPレスポンスメッセージに相当する HttpResponseオブジェクトを返す。
```
     HTTP/1.1 (ステータスコード) (ステータスフレーズ)
     Content-Type: text/plain;charset=UTF-8
 
```
    定義:
    
    handle インタフェース内 Handler<HttpRequest,HttpResponse>
    
    定義:
    
    handle インタフェース内 HttpRequestHandler
    
    パラメータ:
    
    req - 入力データ
    
    ctx - 実行コンテキスト
    
    戻り値:
    
    本オブジェクト
  - getStatusCode
```
public int getStatusCode()
```
    HTTPステータスコードを取得する。
    
    戻り値:
    
    HTTPステータスコード

列挙型 HttpResponse.Status

列挙型定数のサマリー

メソッドのサマリー

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

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

列挙型定数の詳細

CONTINUE

OK

CREATED

ACCEPTED

NO_CONTENT

RESET_CONTENT

PARTIAL_CONTENT

MOVED_PERMANENTLY

FOUND

SEE_OTHER

NOT_MODIFIED

USE_PROXY

TEMPORARY_REDIRECT

BAD_REQUEST

UNAUTHORIZED

PAYMENT_REQUIRED

FORBIDDEN

NOT_FOUND

METHOD_NOT_ALLOWED

NOT_ACCEPTABLE

PROXY_AUTHENTICATION_REQUIRED

REQUEST_TIMEOUT

CONFLICT

GONE

LENGTH_REQUIRED

PRECONDITION_FAILED

REQUEST_ENTITY_TOO_LARGE

REQUEST_URI_TOO_LONG

UNSUPPORTED_MEDIA_TYPE

REQUESTED_RANGE_NOT_SATISFIABLE

EXPECTATION_FAILED

INTERNAL_SERVER_ERROR

NOT_IMPLEMENTED

BAD_GATEWAY

SERVICE_UNAVAILABLE

GATEWAY_TIMEOUT

HTTP_VERSION_NOT_SUPPORTED

メソッドの詳細

values

valueOf

valueOfCode

handle

getStatusCode