HTTPResponseオブジェクト

コンポーネント情報
version	8.0.24
since	5.0

コンポーネント概要

HTTPレスポンスオブジェクト。

クライアントへ応答を送信する際の処理を支援するオブジェクトです。
Web#getHTTPResponseメソッドにて取得可能です。

メソッドの概要

返却値の型	メソッド名
void	addCookie (Cookie `cookie`) 指定されたクッキーをレスポンスに設定します。このメソッドは Ver.8.0.7 以降のバージョンで使用可能です。
void	addDateHeader (String `name`, Date `date`) 指定された名前と日付の値を持つレスポンスヘッダを追加します。このメソッドは Ver.8.0.7 以降のバージョンで使用可能です。
void	addDateHeader (String `name`, Number `date`) 指定された名前と日付の値を持つレスポンスヘッダを追加します。このメソッドは Ver.8.0.7 以降のバージョンで使用可能です。
void	addHeader (String `name`, String `value`) 指定された名前と値を持つレスポンスヘッダを追加します。このメソッドは Ver.8.0.7 以降のバージョンで使用可能です。
Boolean	sendError (Number `sc`, String `[msg]`) 指定されたステータスを使ってクライアントにエラーレスポンスを送ります。
void	sendMessageBodyAsBinary (Storage `source`) 指定のデータを送信します。
void	sendMessageBodyAsText (Storage `source`, String `charsetName`) 指定のデータを送信します。
void	sendMessageBodyFile (File `file`, Boolean `[isDelete]`) 指定のファイルを送信します。
void	sendMessageBodyString (String `str`) 指定のデータを送信します。
void	sendMessageBody (String `strm`) 指定のデータを送信します。
void	setContentLength (Number `len`) レスポンスのメッセージボディ部分の長さをセットします。
void	setContentType (String `type`) レスポンスの Content-Type を設定します。
void	setDateHeader (String `name`, Date `date`) 指定された名前と日付の値を持つレスポンスヘッダを設定します。このメソッドは Ver.8.0.7 以降のバージョンで使用可能です。
void	setDateHeader (String `name`, Number `date`) 指定された名前と日付の値を持つレスポンスヘッダを設定します。このメソッドは Ver.8.0.7 以降のバージョンで使用可能です。
void	setHeader (String `name`, String `value`) 指定された名前と値を持つレスポンスヘッダを設定します。
void	setStatus (Number `sc`) このレスポンスのステータスコードを設定します。

メソッドの詳細

void addCookie (Cookie cookie)

指定されたクッキーをレスポンスに設定します。このメソッドは Ver.8.0.7 以降のバージョンで使用可能です。

パラメータ

cookie : Cookie: クッキー

返却値

void

void addDateHeader (String name, Date date)

指定された名前と日付の値を持つレスポンスヘッダを追加します。このメソッドは Ver.8.0.7 以降のバージョンで使用可能です。
このヘッダが存在しない場合は新規に設定します。

パラメータ

name : String: ヘッダの名称

date : Date: 日付の値

返却値

void

void addDateHeader (String name, Number date)

指定された名前と日付の値を持つレスポンスヘッダを追加します。このメソッドは Ver.8.0.7 以降のバージョンで使用可能です。
このヘッダが存在しない場合は新規に設定します。
日付は、 GMT 1970 年 1 月 1 日からのミリ秒数として指定します。

パラメータ

name : String: ヘッダの名称

date : Number: 日付の値

返却値

void

void addHeader (String name, String value)

指定された名前と値を持つレスポンスヘッダを追加します。このメソッドは Ver.8.0.7 以降のバージョンで使用可能です。
このヘッダが存在しない場合は新規に設定します。

パラメータ

name : String: ヘッダの名称

value : String: ヘッダの値

返却値

void

Boolean sendError (Number sc, String [msg])

指定されたステータスを使ってクライアントにエラーレスポンスを送ります。

パラメータ

sc : Number: エラーステータスコード

[msg] : String: 説明文

返却値

Boolean: Boolean 失敗した場合は false。

void sendMessageBodyAsBinary (Storage source)

指定のデータを送信します。
JavaScript の現在の実行は中断します。再開する事はありません。

パラメータ

source : Storage: 送信データ（PublicStorage/SystemStorage/SessionScopeStorageのいずれか）

返却値

void

void sendMessageBodyAsText (Storage source, String charsetName)

指定のデータを送信します。
JavaScript の現在の実行は中断します。再開する事はありません。

パラメータ

source : Storage: 送信データ（PublicStorage/SystemStorage/SessionScopeStorageのいずれか）

charsetName : String: 文字コード

返却値

void

void sendMessageBodyFile (File file, Boolean [isDelete])

指定のファイルを送信します。
JavaScript の現在の実行は中断します。再開する事はありません。
本メソッドは、try...catch 文では使用できません。

パラメータ

file : File: 送信対象ファイル

[isDelete] : Boolean: ファイルの送信完了後に指定されたファイルを削除する場合は true, それ以外はfalseを指定してください。
指定されなかった場合は、falseが使用されます。

返却値

void

void sendMessageBodyString (String str)

指定のデータを送信します。
JavaScript の現在の実行は中断します。再開する事はありません。
送信データは文字列として扱われ、ServletResponse#getWriter() が返す Writer によって出力されます。したがって、文字コードは自動的に変換されます。
本メソッドは、try...catch 文では使用できません。

パラメータ

str : String: 送信データ

返却値

void

void sendMessageBody (String strm)

指定のデータを送信します。
JavaScript の現在の実行は中断します。再開する事はありません。
本メソッドは、try...catch 文では使用できません。

パラメータ

strm : String: 送信データ

返却値

void

void setContentLength (Number len)

レスポンスのメッセージボディ部分の長さをセットします。
HTTP Servlet ではこのメソッドは HTTP ヘッダの
Content-Length フィールドにセットします。

パラメータ

len : Number: クライアントに送り返すメッセージボディの長さを指定する整数値。 HTTP の Content-Length ヘッダフィールドの値

返却値

void

void setContentType (String type)

レスポンスの Content-Type を設定します。

パラメータ

type : String: コンテントタイプを指定する String

返却値

void

void setDateHeader (String name, Date date)

指定された名前と日付の値を持つレスポンスヘッダを設定します。このメソッドは Ver.8.0.7 以降のバージョンで使用可能です。
このヘッダが既に設定されている場合は上書きされます。

パラメータ

name : String: ヘッダの名称

date : Date: 日付の値

返却値

void

void setDateHeader (String name, Number date)

指定された名前と日付の値を持つレスポンスヘッダを設定します。このメソッドは Ver.8.0.7 以降のバージョンで使用可能です。
このヘッダが既に設定されている場合は上書きされます。
日付は、 GMT 1970 年 1 月 1 日からのミリ秒数として指定します。

パラメータ

name : String: ヘッダの名称

date : Number: 日付の値

返却値

void

void setHeader (String name, String value)

指定された名前と値を持つレスポンスヘッダを設定します。
このヘッダが既に設定されている場合は上書きされます。

パラメータ

name : String: ヘッダの名称

value : String: ヘッダの値

返却値

void

void setStatus (Number sc)

このレスポンスのステータスコードを設定します。

パラメータ

sc : Number: ステータスコード

返却値

void