パッケージ jakarta.ws.rs
RESTful なサービスリソースの作成に使用される高レベルのインターフェースとアノテーション。例:
@Path("widgets/{widgetid}")
@Consumes("application/widgets+xml")
@Produces("application/widgets+xml")
public class WidgetResource {
@GET
public String getWidget(@PathParam("widgetid") String id) {
return getWidgetAsXml(id);
}
@PUT
public void updateWidget(@PathParam("widgetid") String id,
Source update) {
updateWidgetFromXml(id, update);
}
...
}
インターフェースのサマリー インターフェース 説明 SeBootstrap Java SE 環境で JAX-RS アプリケーションを起動するために使用される Bootstrap クラス。SeBootstrap.Configuration アプリケーションをブートストラップするために JAX-RS 実装に必要な情報を提供します。SeBootstrap.Configuration.Builder ブートストラップSeBootstrap.Configurationのビルダー。SeBootstrap.Instance 実行中のアプリケーションインスタンスのハンドル。SeBootstrap.Instance.StopResult アプリケーションインスタンスを停止した結果。クラスのサマリー クラス 説明 Priorities JAX-RS ランタイムによって使用または適用されるときにjakarta.annotation.Priorityクラスレベルのアノテーション値に基づいて順序付けられることになっている JAX-RS コンポーネントの組み込み優先度定数のコレクション。列挙型のサマリー 列挙型 説明 RuntimeType JAX-RS ランタイム型の列挙。SeBootstrap.Configuration.SSLClientAuthentication セキュアソケットクライアント認証ポリシー例外のサマリー 例外 説明 BadRequestException bad client requestを示す実行時例外。ClientErrorException クライアントリクエストエラーを示す基本ランタイムアプリケーション例外(HTTP4xxステータスコード)。ForbiddenException クライアントによってリクエストされたリソースへのアクセスがサーバーによってforbiddenであったことを示す実行時例外。InternalServerErrorException internal server errorを示す実行時例外。NotAcceptableException サーバーによるクライアントリクエストがnot acceptableであることを示す実行時例外。NotAllowedException not allowedであるリソースメソッドをリクエストしているクライアントを示す実行時例外。NotAuthorizedException 次のシナリオのいずれかが原因でリクエストの認可が失敗したことを示すランタイム例外: クライアントが、リクエストされたリソースにアクセスするために必要な認可の認証情報を送信しませんでした。NotFoundException クライアントによってリクエストされたリソースを示すランタイム例外は、サーバー上のnot foundでした。NotSupportedException クライアントリクエストエンティティのメディア型がnot supportedであることを示す実行時例外。ProcessingException 基本の JAX-RS ランタイム処理例外。RedirectionException リクエストのリダイレクトを示すランタイムアプリケーション例外(HTTP3xxステータスコード)。ServerErrorException サーバーエラーを示すベースランタイムアプリケーション例外(HTTP5xxステータスコード)。ServiceUnavailableException リクエストされたリソースcannot be servedを示す実行時例外。WebApplicationException アプリケーションの実行時例外。アノテーション型のサマリー アノテーション型 説明 ApplicationPath Pathによって提供されるすべてのリソース URI のベース URI として機能するアプリケーションパスを識別します。BeanParam カスタム JAX-RS「パラメーターアグリゲーター」値オブジェクトをリソースクラスフィールド、プロパティ、リソースメソッドパラメーターに挿入するために使用できるアノテーション。ConstrainedTo アノテーション付き JAX-RS プロバイダーが適用可能なランタイムコンテキストを示します。Consumes リソースクラスまたはMessageBodyReaderのメソッドが受け入れることができるメディア型を定義します。CookieParam HTTP Cookie の値をリソースメソッドパラメーター、リソースクラスフィールド、リソースクラス Bean プロパティにバインドします。DefaultValue PathParam、QueryParam、MatrixParam、CookieParam、FormParam、HeaderParamのいずれかのアノテーションを使用してバインドされるリクエストメタデータのデフォルト値を定義します。DELETE アノテーション付きメソッドが HTTP DELETE リクエストに応答することを示します。Encoded FormParam リクエストエンティティ本体に含まれるフォームパラメーターの値をリソースメソッドパラメーターにバインドします。GET アノテーション付きメソッドが HTTP GET リクエストに応答することを示します。HEAD アノテーション付きメソッドが HTTP HEAD リクエストに応答することを示します。HeaderParam HTTP ヘッダーの値をリソースメソッドパラメーター、リソースクラスフィールド、リソースクラス Bean プロパティにバインドします。HttpMethod HTTP メソッドの名前をアノテーションに関連付けます。MatrixParam URI マトリックスパラメーターの値をリソースメソッドパラメーター、リソースクラスフィールド、リソースクラス Bean プロパティにバインドします。NameBinding フィルターおよびインターセプターの名前バインディングアノテーションを作成するために使用されるメタアノテーション。OPTIONS アノテーション付きメソッドが HTTP OPTIONS リクエストに応答することを示します。PATCH アノテーション付きメソッドが HTTP PATCH リクエストに応答することを示します。Path リソースクラスまたはクラスメソッドがリクエストを処理する URI パスを識別します。PathParam URI テンプレートパラメーターまたはテンプレートパラメーターを含むパスセグメントの値を、リソースメソッドパラメーター、リソースクラスフィールド、リソースクラス Bean プロパティにバインドします。POST アノテーション付きメソッドが HTTP POST リクエストに応答することを示します。Produces リソースクラスまたはMessageBodyWriterのメソッドが生成できるメディア型を定義します。PUT アノテーション付きメソッドが HTTP PUT リクエストに応答することを示します。QueryParam HTTP クエリパラメーターの値をリソースメソッドパラメーター、リソースクラスフィールド、リソースクラス Bean プロパティにバインドします。