Package | Description |
---|---|
nablarch.common.web.download |
ダウンロード機能を提供する。
|
nablarch.fw.jaxrs |
NablarchのActionハンドラをJAX-RSのリソースクラスとして呼び出す事ができる機能を提供する。
|
nablarch.fw.web |
画面オンライン処理方式の主要APIを収めたパッケージ。
|
nablarch.test.core.http |
Modifier and Type | Class and Description |
---|---|
class |
DataRecordResponse
Map型のデータレコードのリストを一定のフォーマットに従って直列化し、
その内容をレスポンスボディとするHTTPレスポンスオブジェクト。
|
class |
FileResponse
File オブジェクトからHTTPレスポンスを生成するHttpResponse 継承クラス。 |
class |
StreamResponse
ストリームからHTTPレスポンスメッセージを生成するクラス。
本クラスは、ファイルシステム上のファイルやデータベースのBLOB型のカラムに格納した
バイナリデータのダウンロードに使用する。
|
Modifier and Type | Class and Description |
---|---|
class |
EntityResponse
Entityを持つレスポンス。
Produces を使用した場合に
レスポンスヘッダとステータスコードを指定したい場合に使用する。 |
Modifier and Type | Method and Description |
---|---|
HttpResponse |
EntityResponse.setStatusCode(int code) |
Modifier and Type | Method and Description |
---|---|
HttpResponse |
HttpResponse.addCookie(nablarch.fw.web.HttpCookie cookie)
サーバ側から送信されたクッキー情報を設定する。
|
HttpResponse |
HttpErrorResponse.getResponse()
レスポンス情報を取得する。
|
HttpResponse |
HttpResponse.Status.handle(HttpRequest req,
ExecutionContext ctx)
入力データに対する処理を実行する。
このクラスの実装では、以下のHTTPレスポンスメッセージに相当する
HttpResponse オブジェクトを返す。 |
HttpResponse |
HttpResponse.setContentDisposition(java.lang.String fileName)
Content-Dispositionの値を設定する。
Content-Typeが明示的に設定されていない場合、
設定されたファイル名の拡張子に応じたContent-Typeを自動的に設定する。
本メソッドではattachment属性を指定するため、ダウンロード時にダイアログが必ず表示される。 |
HttpResponse |
HttpResponse.setContentDisposition(java.lang.String fileName,
boolean inline)
Content-Dispositionの値を設定する。
Content-Typeが明示的に設定されていない場合、
設定されたファイル名の拡張子に応じたContent-Typeを自動的に設定する。
inline にtrue を指定した場合、ダウンロードされたファイルは
クライアントアプリで自動的に開かれる。ただし、実際にそのような挙動となるかどうかは、クライアントの設定 およびOSのセキュリティ設定に依存する。 |
HttpResponse |
HttpResponse.setContentPath(ResourceLocator resource)
コンテンツパスを設定する。
指定した
ResourceLocator オブジェクトがnull でない場合は、
リソース名からContent-Typeを自動的に設定した後、コンテンツパスを設定する。ResourceLocator オブジェクトがnull の場合は、コンテンツパスのみ設定する。 |
HttpResponse |
HttpResponse.setContentPath(java.lang.String path)
コンテンツパスを設定する。
本処理は
HttpResponse.setContentPath(ResourceLocator) に委譲する。 |
HttpResponse |
HttpResponse.setContentType(java.lang.String contentType)
Content-Typeを設定する。
Content-Typeのデフォルト値は、"text/plain;charset=UTF-8" である。
ボディに書き込む内容をコンテンツパスで指定する場合、 Content-Typeはコンテンツパスの拡張子から自動的に決定される為、 このメソッドを明示的に使用する必要は無い。 |
HttpResponse |
HttpResponse.setCookie(nablarch.fw.web.HttpCookie cookie)
Deprecated.
本メソッドは、複数のクッキー情報を設定することを意図したメソッド名を持つ
HttpResponse.addCookie(HttpCookie) に置き換わりました。 |
HttpResponse |
HttpResponse.setLocation(java.lang.String location)
Locationの値を設定する。
リダイレクト時のHTTPクライアントの遷移先URIを設定する。
デフォルトでは設定されない。 |
HttpResponse |
HttpResponse.setStatusCode(int code)
HTTPレスポンスのステータスコードを設定する。
デフォルトのステータスコードは
200 である。 |
HttpResponse |
HttpResponse.write(byte[] bytes)
HTTPレスポンスボディにバイト配列を書き込む。
このメソッドで書き込まれたデータは、本オブジェクトが保持する
バッファに保持され、クライアントソケットに対する書き込みは一切発生しない。
(このライタに対するflush()は単に無視される。)
実際にソケットに対するレスポンス処理が行われるのは、 nablarch.fw.web.handler.HttpResponseHandler にレスポンスオブジェクトが戻された後である。
また、このオブジェクトにコンテンツパスが設定されている場合、
このライタに書き込まれた内容は単に無視される。 |
HttpResponse |
HttpResponse.write(java.nio.ByteBuffer bytes)
HTTPレスポンスボディにバイト配列を書き込む。
このメソッドで書き込まれたデータは、本オブジェクトが保持する
バッファに保持され、クライアントソケットに対する書き込みは一切発生しない。
(このライタに対するflush()は単に無視される。)
実際にソケットに対するレスポンス処理が行われるのは、 nablarch.fw.web.handler.HttpResponseHandler にレスポンスオブジェクトが戻された後である。
また、このオブジェクトにコンテンツパスが設定されている場合、
このライタに書き込まれた内容は単に無視される。 |
HttpResponse |
HttpResponse.write(java.lang.CharSequence text)
HTTPレスポンスボディに文字列を書き込む。
このメソッドで書き込まれたデータは、本オブジェクトが保持する
バッファに保持され、クライアントソケットに対する書き込みは一切発生しない。
(このライタに対するflush()は単に無視される。)
実際にソケットに対するレスポンス処理が行われるのは、 nablarch.fw.web.handler.HttpResponseHandler にレスポンスオブジェクトが戻された後である。
また、このオブジェクトにコンテンツパスが設定されている場合、
このライタに書き込まれた内容は単に無視される。 |
Modifier and Type | Method and Description |
---|---|
HttpErrorResponse |
HttpErrorResponse.setResponse(HttpResponse response)
レスポンス情報を設定する。
|
Constructor and Description |
---|
HttpErrorResponse(HttpResponse response)
指定された
HttpResponse を持つHttpErrorResponse を生成する。 |
HttpErrorResponse(HttpResponse response,
java.lang.Throwable e)
指定された
HttpResponse と例外を持つHttpErrorResponse を生成する。 |
Modifier and Type | Method and Description |
---|---|
HttpResponse |
SimpleRestTestSupport.sendRequest(HttpRequest request)
テストリクエストを内蔵サーバに渡しレスポンスを返す。
|
HttpResponse |
SimpleRestTestSupport.sendRequest(HttpRequest request,
nablarch.test.core.http.RequestResponseProcessor processor)
テストリクエストを内蔵サーバに渡しレスポンスを返す。
|
HttpResponse |
SimpleRestTestSupport.sendRequestWithContext(HttpRequest request,
ExecutionContext context)
ExecutionContext を設定しテストリクエストを内蔵サーバに渡しレスポンスを返す。
ExecutionContext の設定はHttpRequestTestSupportHandler を利用する。 |
HttpResponse |
SimpleRestTestSupport.sendRequestWithContext(HttpRequest request,
ExecutionContext context,
nablarch.test.core.http.RequestResponseProcessor processor)
ExecutionContext を設定しテストリクエストを内蔵サーバに渡しレスポンスを返す。
ExecutionContext の設定はHttpRequestTestSupportHandler を利用する。 |
Modifier and Type | Method and Description |
---|---|
void |
SimpleRestTestSupport.assertStatusCode(java.lang.String message,
HttpResponse.Status expected,
HttpResponse response)
ステータスコードが想定通りであることを表明する。
|
void |
SimpleRestTestSupport.assertStatusCode(java.lang.String message,
int expected,
HttpResponse response)
ステータスコードが想定通りであることを表明する。
|
java.io.InputStream |
RestTestSupport.getBodyStream(HttpResponse httpResponse)
HTTPレスポンスボディの内容を保持するストリームを取得する。
|
java.lang.String |
RestTestSupport.getBodyString(HttpResponse httpResponse)
HTTPレスポンスボディの内容を表す文字列を返す。
文字列は HttpResponse#getCharset() で取得したキャラセットでデコードして取得される。 |