nablarch.fw.jaxrs (Nablarch-API)

Interface Summary
Interface	Description
BodyConverter	リクエスト/レスポンスの変換を行うインタフェース。
JaxRsHandlerListFactory	JAX-RSで実行される`Handler`のリストを生成するインタフェース。
LogContentMaskingFilter	ログに出力する文字列をマスク処理するためのフィルタ。
MessageBodyLogTargetMatcher	メッセージボディがログ出力対象であるか判定するためのインタフェース。
ResponseFinisher	レスポンスを仕上げるインタフェース。 `JaxRsResponseHandler`が作成したレスポンス(エラーレスポンス含む)に共通する処理を行う。共通処理としてはセキュリティやCORSに対応したレスポンスヘッダの設定などを想定している。レスポンスの作成処理の後に実行する処理のため、このインタフェースの実装クラスでは例外を発生させてはならない。

Class Summary
Class	Description
AdoptHandlerResponseFinisher	`HttpRequestHandler`を`ResponseFinisher`として使用するクラス。このクラスで使用できる`HttpRequestHandler`は、自らレスポンスを作成せず、後続ハンドラが返すレスポンスに変更を加えるハンドラに限定される。
BodyConverterSupport	`BodyConverter`の実装クラスをサポートするクラス。
BodyConverterSupport.ContentType	ContentTypeを表すクラス。
BodyConvertHandler	`BodyConverter`によるリクエスト/レスポンスの変換を行うハンドラ。
CorsPreflightRequestHandler	CORSのプリフライトリクエストを処理するハンドラ。
EntityResponse	Entityを持つレスポンス。 `Produces`を使用した場合にレスポンスヘッダとステータスコードを指定したい場合に使用する。
ErrorResponseBuilder	JAX-RS用のエラーレスポンスを生成するクラス。例外の種類に応じて以下のレスポンスを生成する。
FormUrlEncodedConverter	"application/x-www-form-urlencoded"に対するリクエスト/レスポンスの変換を行うクラス。
JaxbBodyConverter	JAXBを使用してリクエスト/レスポンスの変換を行う`BodyConverter`実装クラス。
JaxRsAccessJsonLogFormatter	RESTfulウェブサービスのアクセスログのメッセージをフォーマットするクラス。
JaxRsAccessJsonLogFormatter.ClientHostBuilder	クライアント端末ホストを処理するクラス。
JaxRsAccessJsonLogFormatter.ClientIpAddressBuilder	クライアント端末IPアドレスを処理するクラス。
JaxRsAccessJsonLogFormatter.ClientUserAgentBuilder	HTTPヘッダのUser-Agentを処理するクラス。
JaxRsAccessJsonLogFormatter.EndTimeBuilder	終了日時を処理するクラス。
JaxRsAccessJsonLogFormatter.ExecutionTimeBuilder	実行時間を処理するクラス。
JaxRsAccessJsonLogFormatter.FreeMemoryBuilder	空きメモリ量(開始時)を処理するクラス。
JaxRsAccessJsonLogFormatter.LabelBuilder	ラベルを処理するクラス。
JaxRsAccessJsonLogFormatter.MaxMemoryBuilder	最大メモリ量を処理するクラス。
JaxRsAccessJsonLogFormatter.MethodBuilder	HTTPメソッドを処理するクラス。
JaxRsAccessJsonLogFormatter.ParametersBuilder	リクエストパラメータを処理するクラス。
JaxRsAccessJsonLogFormatter.PortBuilder	ポート番号を処理するクラス。
JaxRsAccessJsonLogFormatter.QueryStringBuilder	クエリ文字列を処理するクラス。
JaxRsAccessJsonLogFormatter.RequestBodyBuilder	リクエストのボディを処理する。
JaxRsAccessJsonLogFormatter.RequestIdBuilder	リクエストIDを処理するクラス。
JaxRsAccessJsonLogFormatter.ResponseBodyBuilder	レスポンスのボディを処理する。
JaxRsAccessJsonLogFormatter.SessionIdBuilder	セッションIDを処理するクラス。
JaxRsAccessJsonLogFormatter.SessionScopeBuilder	セッションスコープ情報を処理するクラス。
JaxRsAccessJsonLogFormatter.SessionStoreIdBuilder	セッションストアIDを処理するクラス。
JaxRsAccessJsonLogFormatter.StartTimeBuilder	開始日時を処理するクラス。
JaxRsAccessJsonLogFormatter.StatusCodeBuilder	ステータスコードを処理するクラス。
JaxRsAccessJsonLogFormatter.UrlBuilder	URLを処理するクラス。
JaxRsAccessJsonLogFormatter.UserIdBuilder	ユーザIDを処理するクラス。
JaxRsAccessLogFormatter	RESTfulウェブサービスのアクセスログのメッセージをフォーマットするクラス。
JaxRsAccessLogFormatter.ClientHostItem	クライアント端末ホストを取得するクラス。
JaxRsAccessLogFormatter.ClientIpAddressItem	クライアント端末IPアドレスを取得するクラス。
JaxRsAccessLogFormatter.ClientUserAgentItem	HTTPヘッダの User-Agent を取得する。
JaxRsAccessLogFormatter.EndTimeItem	終了日時を取得するクラス。
JaxRsAccessLogFormatter.ExecutionTimeItem	実行時間を取得するクラス。
JaxRsAccessLogFormatter.FreeMemoryItem	空きメモリ量(開始時)を取得するクラス。
JaxRsAccessLogFormatter.JaxRsAccessLogContext
JaxRsAccessLogFormatter.MaxMemoryItem	最大メモリ量を取得するクラス。
JaxRsAccessLogFormatter.MethodItem	HTTPメソッドを取得するクラス。
JaxRsAccessLogFormatter.ParametersItem	リクエストパラメータを取得するクラス。
JaxRsAccessLogFormatter.PortItem	ポート番号を取得するクラス。
JaxRsAccessLogFormatter.QueryStringItem	クエリ文字列を取得するクラス。
JaxRsAccessLogFormatter.RequestBodyItem	リクエストのボディを取得する。
JaxRsAccessLogFormatter.RequestIdItem	リクエストIDを取得するクラス。
JaxRsAccessLogFormatter.ResponseBodyItem	レスポンスのボディを取得する。
JaxRsAccessLogFormatter.SessionIdItem	セッションIDを取得するクラス。
JaxRsAccessLogFormatter.SessionScopeItem	セッションスコープ情報を取得するクラス。
JaxRsAccessLogFormatter.SessionStoreIdItem	セッションストアIDを取得するクラス。
JaxRsAccessLogFormatter.StartTimeItem	開始日時を取得するクラス。
JaxRsAccessLogFormatter.StatusCodeItem	ステータスコードを取得するクラス。
JaxRsAccessLogFormatter.UrlItem	URLを取得するクラス。
JaxRsAccessLogFormatter.UserIdItem	ユーザIDを取得する。
JaxRsAccessLogHandler	RESTfulウェブサービスのアクセスログを出力するハンドラ。
JaxRsAccessLogJsonSerializationManager	RESTfulウェブサービスのアクセスログのJSON形式による出力に対応した`JsonSerializationManager`の実装クラス。
JaxRsBeanValidationHandler	リソースメソッドが受け取るBeanオブジェクトに対してバリデーションを実行するハンドラ実装クラス。リソースメソッドに対して`Valid`アノテーションが設定されている場合、データオブジェクト(リソースメソッドの引数となるBeanオブジェクト)に対してバリデーションを行う。リソースメソッドに`ConvertGroup`アノテーションが設定されている場合、バリデーション時にBean Validationのグループを設定できる。バリデーションエラーが発生した場合には、`ApplicationException`を送出する。エラーが発生しなかった場合は、後続のハンドラに処理を委譲する。
JaxRsBodyLogTargetMatcher	JAX-RSのメッセージボディがログ出力対象であるか判定するクラス。
JaxRsBodyMaskingFilter	ログ出力するJAX-RSのボディ文字列をマスク処理するフィルタ。
JaxRsContext	JAX-RSのリソースクラスとしてActionハンドラを呼び出すのに必要な情報を保持するクラス。
JaxRsErrorLogWriter	JAX-RSのエラー情報をログに出力するクラス。このクラスでは、`ApplicationException`以外の例外の場合に、 `FailureLogUtil`を用いてログ出力を行う。このクラスで要件を満たせない場合には、サブクラスで実装を置き換えること。
JaxRsHttpRequest	JAX-RS用の`HttpRequest`クラス。 `JaxRsHttpRequest.getParamMap()`、`JaxRsHttpRequest.getParam(String)` を公開APIとし、それ以外のメソッドは保持するHttpRequestに委譲している。
JaxRsMethodBinder	JAX-RS用の`MethodBinder`実装クラス。
JaxRsMethodBinder.ResourceMethod	リソースメソッドを表すクラス。
JaxRsMethodBinderFactory	JAX-RS用の`MethodBinder`を生成する。
JaxRsResponseHandler	JAX-RS用のレスポンスを返却するハンドラ。このハンドラでは、後続のハンドラから戻された`HttpResponse`の内容を、クライアントへのレスポンスとして書き込む。後続のハンドラで例外が発生した場合には、`ErrorResponseBuilder`を使用してエラー用のレスポンスを作成し、クライアントへのレスポンスとして書き込む。後続のハンドラ及び`ErrorResponseBuilder`で`HttpResponse`を生成する際には、レスポンスヘッダーも含めて設定する必要がある。このハンドラでは、レスポンスヘッダーを自動的に設定するようなことはしない。
JsonStringToJsonSerializer	JSON文字列をシリアライズするクラス。
JsonStringToJsonSerializer.JsonString	JSON文字列を表現するクラス。

Package nablarch.fw.jaxrs Description

NablarchのActionハンドラをJAX-RSのリソースクラスとして呼び出す事ができる機能を提供する。