CTISession (CSSJ Javaドライバ バージョン 1.0.7 API)
Keywords: jp.cssj.cti.CTISession interface

概要 | パッケージ | クラス | 階層ツリー | 非推奨 API | 索引 | ヘルプ
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

## jp.cssj.cti
インタフェース CTISession

既知の実装クラスの一覧:
  AbstractCTIPSession

public interface CTISession

サーバーと一連の変換を実行するための、ステートフルなセッションです。

1つのセッションで生成できるのは1つの結果のみです。

データの送信はストリームを介して行います。 ファイルなどを簡単に送信するためのユーティリティはCTIUtilsで提供しています。

将来のバージョンでは、一度に複数の結果を生成するために、Keep-Aliveをサポートする可能性があります。

バージョン:
  $Id: CTISession.java,v 1.2 2005/08/18 04:51:26 harumanx Exp $
作成者:
  MIYABE Tatsuhiko

メソッドの概要
`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)` プロパティを設定します。

メソッドの詳細

### setOutput

    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`

### setErrorHandler

    public void setErrorHandler(ErrorHandler eh)

  エラーを受け取るためのオブジェクトを設定します。

  このメソッドは本体の開始前に呼ぶ必要があります。

  パラメータ:
    `eh` - エラーハンドラ
  関連項目:
    `ErrorHandler`

### setProgressListener

    public void setProgressListener(ProgressListener l)

  進行状況を監視するためのオブジェクトを設定します。

  このメソッドは本体の開始前に呼ぶ必要があります。

  これは、データの変換状況を監視する目的以外に、出力結果の長さを取得するためにも用いられます。 HTTP通信などでContent-Lengthヘッダを送出する場合は重要です。

  パラメータ:
    `l` - 進行状況リスナ
  関連項目:
    `ProgressListener`

### setProperty

    public void setProperty(java.lang.String name,
                            java.lang.String value)
                     throws java.io.IOException

  プロパティを設定します。

  このメソッドは本体の開始前に呼ぶ必要があります。

  パラメータ:
    `name` - プロパティ名
    `value` - 値
  例外:
    `java.io.IOException`

### includeResource

    public void includeResource(java.lang.String uriPattern)
                         throws java.io.IOException

  サーバー側からのアクセスを許可するリソースを指定します。

  このメソッドは本体の開始前に呼ぶ必要があります。

  リソースの指定にはワイルドカードを含むことが出来る、URIパターンを用います。 詳細は「開発者ガイド」を参照してください。

  パラメータ:
    `uriPattern` - URIパターン
  例外:
    `java.io.IOException`

### excludeResource

    public void excludeResource(java.lang.String uriPattern)
                         throws java.io.IOException

  サーバー側からのアクセスを禁止するリソースを指定します。

  このメソッドは本体の開始前に呼ぶ必要があります。

  リソースの指定にはワイルドカードを含むことが出来る、URIパターンを用います。 詳細は「開発者ガイド」を参照してください。

  パラメータ:
    `uriPattern` - URIパターン
  例外:
    `java.io.IOException`

### formatMain

    public void formatMain(java.lang.String uri)
                    throws java.io.IOException

  変換するリソース(本体)を指定すると同時に、本体の変換を開始します。

  このメソッドは、1つのセッションに対して一度だけ呼ぶことが出来ます。

  パラメータ:
    `uri` - サーバー側の本体のURI
  例外:
    `java.io.IOException`

### sendResource

    public java.io.OutputStream sendResource(java.lang.String uri,
                                             java.lang.String mimeType,
                                             java.lang.String encoding)
                                      throws java.io.IOException

  リソースを送信するための出力ストリームを返します。

  リソースを送信した後、出力ストリームは必ずクローズしてください。

  このメソッドは本体の開始前に呼ぶ必要があります。

  パラメータ:
    `uri` - リソースの仮想URI
    `mimeType` - リソースのMIME型(省略する場合はnull)
    `encoding` - リソースのエンコーディング(省略する場合はnull)
  戻り値:
    サーバーへの出力ストリーム。
  例外:
    `java.io.IOException`

### sendMain

    public java.io.OutputStream sendMain(java.lang.String uri,
                                         java.lang.String mimeType,
                                         java.lang.String encoding)
                                  throws java.io.IOException

  本体を送信するための出力ストリームを返します。

  本体を送信した後、出力ストリームは必ずクローズしてください。

  このメソッドは、1つのセッションに対して一度だけ呼ぶことが出来ます。

  パラメータ:
    `uri` - 本体の仮想URI
    `mimeType` - 本体のMIME型(省略する場合はnull)
    `encoding` - 本体のエンコーディング(省略する場合はnull)
  戻り値:
    サーバーへの出力ストリーム。
  例外:
    `java.io.IOException`

### close

    public void close()
               throws java.io.IOException

  セッションをクローズします。

  このメソッドを呼び出した後は、セッションに対して何も出来ません。

  例外:
    `java.io.IOException`

概要 | パッケージ | クラス | 階層ツリー | 非推奨 API | 索引 | ヘルプ
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

Copyright(c) 2005-2008 GNN & Co.,Ltd All Rights Reserved.