48.3.2. 一般的なユースケースに対する応答の作成

Response クラスは、RESTful サービスが必要とするより一般的な応答を処理するためのショートカットメソッドを提供します。これらのメソッドは、提供された値またはデフォルト値のいずれかを使用して適切なヘッダーの設定を処理します。また、必要に応じてエンティティーボディーの設定を処理します。

要求が正常に処理されると、アプリケーションが応答を送信して、要求が完了したことを確認する必要があります。この応答にはエンティティーが含まれる可能性があります。

応答を正常に完了した場合の最も一般的な応答は OK です。OK 応答には通常、リクエストに対応するエンティティーが含まれます。Response クラスには、応答のステータスを 200 に設定し、指定されたエンティティーを囲まれた応答ビルダーに追加するオーバーロードされた ok() メソッドがあります。ok() メソッドには 5 つのバージョンがあります。最も一般的に使用されるバリアントは以下のとおりです。

200 応答での応答の作成 は、OK ステータスで応答を作成する例を示しています。

import javax.ws.rs.core.Response;
import demo.jaxrs.server.Customer;
...

Customer customer = new Customer("Jane", 12);

return Response.ok(customer).build();

要求元がエンティティーボディーを期待しない場合は、200 OK のステータスではなく 204 No Content ステータスを送信する方が適切な場合があります。Response.noContent() メソッドにより、適切な応答オブジェクトが作成されます。

204 ステータスでの応答の作成 は、204 ステータスで応答を作成する例を示しています。

import javax.ws.rs.core.Response;

return Response.noContent().build();

Response クラスは、3 つのリダイレクト応答ステータスを処理するメソッドを提供します。

304 ステータスでの応答の作成 は、304 ステータスで応答を作成する例を示しています。

import javax.ws.rs.core.Response;

return Response.notModified().build();

Response クラスは、2 つの基本的な処理エラーに対する応答を作成するメソッドを提供します。

500 ステータスでの応答の作成 は、500 ステータスで応答を作成する例を示しています。

import javax.ws.rs.core.Response;

return Response.serverError().build();