ファイルをストリーム転送するクラスです。
本クラスは、サーブレット・コンテナが作成するHttpServletオブジェクトの使用を前提としています。
java.lang.Object
└com.fujitsu.systemwalker.outputassist.servlet.WebOutputStream
public class WebOutputStream
extends java.lang.Object
WebOutputStreamクラスのコンストラクタを以下に示します。
WebOutputStreamクラスのコンストラクタ
コンストラクタの概要 | |
---|---|
WebOutputStreamを作成します。 |
WebOutputStreamクラスのメソッドを以下に示します。
WebOutputStream クラスのメソッド
分類 | メソッド一覧 | |||
---|---|---|---|---|
○ | void | |||
指定されたresponseオブジェクトで表される応答に対し、sFilePathパラメータで指定されたファイルをバイナリ形式で転送します。 |
○:List Managerでサポートしているメソッドです。
-:List Managerでサポートしていないメソッドです。
用途
WebOutputStreamオブジェクトを生成します。
例外
java.io.FileNotFoundException, java.io.IOException
●ファイル転送に関するメソッド
|
用途
指定されたresponseオブジェクトで表される応答に対し、sFilePathパラメータで指定されたファイルをバイナリ形式で転送します。
転送間隔、および一度に転送するファイルサイズは、設定ファイルで以下のように設定します。
WebOutputStream.properties
設定ファイル内にtransmission.interval="時間をミリ秒単位で指定"
設定ファイル内にtransmission.size="転送量をバイト単位で指定"
サーブレット・コンテナから参照可能なディレクトリに配置
なお、応答がすでにコミットされていた場合、このメソッドはIllegalStateExceptionをスロー します。
パラメータ
HttpServletResponseオブジェクトを指定します。
ファイルのフルパスを指定します。
転送の完了後に、ファイルを削除するかどうかを指定します。
例外
java.io.FileNotFoundException
(ファイルが存在しない、ディレクトリである、またはファイルを開くことができない場合)
java.io.IOException(入出力例外が発生した場合)
java.lang. SecurityException
(ファイルへの読み込みアクセスが拒否された場合、またはファイルの削除に失敗した場合)
java.io.IllegalArgumentException
(引数がnullの場合、または指定されたファイルがPDFファイル/OWFファイル以外の場合)
java.lang.IllegalStateException
(応答がコミットされていた場合)
注意
このメソッドで使用したresponseオブジェクトは他のメソッドで指定しないでください。
このメソッドを呼び出した後は、応答はコミットされたものとみなされます。したがって、それ以降、応答への書き出しを行わないでください。
このメソッドに指定できるファイルは、PDFファイルまたはOWFファイル(ファイルの拡張子が「.pdf」または「.owf」のファイル)だけです。それ以外のファイルを指定しないでください。
転送間隔および転送量が指定されていない場合、以下の値が初期値になります。
transmission.interval=0
transmission.size=128
転送量に0が指定された場合は初期値で動作します。