|
||||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
サーバーと一連の変換を実行するための、ステートフルなセッションです。
1つのセッションで生成できるのは1つの結果のみです。
データの送信はストリームを介して行います。 ファイルなどを簡単に送信するためのユーティリティはCTIUtilsで提供しています。
将来のバージョンでは、一度に複数の結果を生成するために、Keep-Aliveをサポートする可能性があります。
メソッドの概要 | |
void |
close()
セッションをクローズします。 |
void |
excludeResource(java.lang.String uriPattern)
サーバー側からのアクセスを禁止するリソースを指定します。 |
void |
formatMain(java.lang.String uri)
変換するリソース(本体)を指定すると同時に、本体の変換を開始します。 |
void |
includeResource(java.lang.String uriPattern)
サーバー側からのアクセスを許可するリソースを指定します。 |
java.io.OutputStream |
sendMain(java.lang.String uri,
java.lang.String mimeType,
java.lang.String encoding)
本体を送信するための出力ストリームを返します。 |
java.io.OutputStream |
sendResource(java.lang.String uri,
java.lang.String mimeType,
java.lang.String encoding)
リソースを送信するための出力ストリームを返します。 |
void |
setErrorHandler(ErrorHandler eh)
エラーを受け取るためのオブジェクトを設定します。 |
void |
setOutput(java.io.OutputStream out,
java.lang.String mimeType)
出力先を設定します。 |
void |
setProgressListener(ProgressListener l)
進行状況を監視するためのオブジェクトを設定します。 |
void |
setProperty(java.lang.String name,
java.lang.String value)
プロパティを設定します。 |
メソッドの詳細 |
public void setOutput(java.io.OutputStream out, java.lang.String mimeType) throws java.io.IOException
出力先を設定します。
このメソッドは本体の開始前に呼ぶ必要があります。 一度も呼ばない場合、出力先はSystem.out,出力タイプは"application/pdf"になります。
out
- 出力先ストリームmimeType
- 出力データのMIME型(省略する場合はnull)
java.io.IOException
public void setErrorHandler(ErrorHandler eh)
エラーを受け取るためのオブジェクトを設定します。
このメソッドは本体の開始前に呼ぶ必要があります。
eh
- エラーハンドラErrorHandler
public void setProgressListener(ProgressListener l)
進行状況を監視するためのオブジェクトを設定します。
このメソッドは本体の開始前に呼ぶ必要があります。
これは、データの変換状況を監視する目的以外に、出力結果の長さを取得するためにも用いられます。 HTTP通信などでContent-Lengthヘッダを送出する場合は重要です。
l
- 進行状況リスナProgressListener
public void setProperty(java.lang.String name, java.lang.String value) throws java.io.IOException
プロパティを設定します。
このメソッドは本体の開始前に呼ぶ必要があります。
name
- プロパティ名value
- 値
java.io.IOException
public void includeResource(java.lang.String uriPattern) throws java.io.IOException
サーバー側からのアクセスを許可するリソースを指定します。
このメソッドは本体の開始前に呼ぶ必要があります。
リソースの指定にはワイルドカードを含むことが出来る、URIパターンを用います。 詳細は「開発者ガイド」を参照してください。
uriPattern
- URIパターン
java.io.IOException
public void excludeResource(java.lang.String uriPattern) throws java.io.IOException
サーバー側からのアクセスを禁止するリソースを指定します。
このメソッドは本体の開始前に呼ぶ必要があります。
リソースの指定にはワイルドカードを含むことが出来る、URIパターンを用います。 詳細は「開発者ガイド」を参照してください。
uriPattern
- URIパターン
java.io.IOException
public void formatMain(java.lang.String uri) throws java.io.IOException
変換するリソース(本体)を指定すると同時に、本体の変換を開始します。
このメソッドは、1つのセッションに対して一度だけ呼ぶことが出来ます。
uri
- サーバー側の本体のURI
java.io.IOException
public java.io.OutputStream sendResource(java.lang.String uri, java.lang.String mimeType, java.lang.String encoding) throws java.io.IOException
リソースを送信するための出力ストリームを返します。
リソースを送信した後、出力ストリームは必ずクローズしてください。
このメソッドは本体の開始前に呼ぶ必要があります。
uri
- リソースの仮想URImimeType
- リソースのMIME型(省略する場合はnull)encoding
- リソースのエンコーディング(省略する場合はnull)
java.io.IOException
public java.io.OutputStream sendMain(java.lang.String uri, java.lang.String mimeType, java.lang.String encoding) throws java.io.IOException
本体を送信するための出力ストリームを返します。
本体を送信した後、出力ストリームは必ずクローズしてください。
このメソッドは、1つのセッションに対して一度だけ呼ぶことが出来ます。
uri
- 本体の仮想URImimeType
- 本体のMIME型(省略する場合はnull)encoding
- 本体のエンコーディング(省略する場合はnull)
java.io.IOException
public void close() throws java.io.IOException
セッションをクローズします。
このメソッドを呼び出した後は、セッションに対して何も出来ません。
java.io.IOException
|
||||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |