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

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

## jp.cssj.cti.ctip
クラス AbstractCTIPSession

    java.lang.Object
      jp.cssj.cti.ctip.AbstractCTIPSession

すべての実装インタフェース:
  CTISession

直系の既知のサブクラス:
  CTIPSession

public abstract class AbstractCTIPSession
extends java.lang.Object
implements CTISession

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

フィールドの概要
`protected ErrorHandler` | `errorHandler`
`protected java.io.OutputStream` | `out`
`protected ContentProducer` | `producer`
`protected ProgressListener` | `progressListener`
`protected RequestConsumer` | `request`
`protected int` | `state`

コンストラクタの概要
`AbstractCTIPSession(ContentProducer producer, RequestConsumer request)`

メソッドの概要
`boolean` | `buildNext(ContentBuilder builder)`
`void` | `excludeResource(java.lang.String uriPattern)` サーバー側からのアクセスを禁止するリソースを指定します。
`void` | `formatMain(java.lang.String uri)` 変換するリソース(本体)を指定すると同時に、本体の変換を開始します。
`void` | `includeResource(java.lang.String uriPattern)` サーバー側からのアクセスを許可するリソースを指定します。
`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 key, java.lang.String value)` プロパティを設定します。

クラス java.lang.Object から継承したメソッド
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

インタフェース jp.cssj.cti.CTISession から継承したメソッド
`close, sendMain`

フィールドの詳細

### producer

    protected final ContentProducer producer

### request

    protected final RequestConsumer request

### out

    protected java.io.OutputStream out

### errorHandler

    protected ErrorHandler errorHandler

### progressListener

    protected ProgressListener progressListener

### state

    protected int state

コンストラクタの詳細

### AbstractCTIPSession

    public AbstractCTIPSession(ContentProducer producer,
                               RequestConsumer request)

メソッドの詳細

### setOutput

    public void setOutput(java.io.OutputStream out,
                          java.lang.String mimeType)
                   throws java.io.IOException

  インタフェース `CTISession` の記述:

  出力先を設定します。

  このメソッドは本体の開始前に呼ぶ必要があります。 一度も呼ばない場合、出力先はSystem.out,出力タイプは"application/pdf"になります。

  定義:
    インタフェース `CTISession` 内の `setOutput`
  パラメータ:
    `out` - 出力先ストリーム
    `mimeType` - 出力データのMIME型(省略する場合はnull)
  例外:
    `java.io.IOException`

### setErrorHandler

    public void setErrorHandler(ErrorHandler eh)

  インタフェース `CTISession` の記述:

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

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

  定義:
    インタフェース `CTISession` 内の `setErrorHandler`
  パラメータ:
    `eh` - エラーハンドラ
  関連項目:
    `ErrorHandler`

### setProgressListener

    public void setProgressListener(ProgressListener l)

  インタフェース `CTISession` の記述:

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

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

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

  定義:
    インタフェース `CTISession` 内の `setProgressListener`
  パラメータ:
    `l` - 進行状況リスナ
  関連項目:
    `ProgressListener`

### setProperty

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

  インタフェース `CTISession` の記述:

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

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

  定義:
    インタフェース `CTISession` 内の `setProperty`
  パラメータ:
    `key` - プロパティ名
    `value` - 値
  例外:
    `java.io.IOException`

### includeResource

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

  インタフェース `CTISession` の記述:

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

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

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

  定義:
    インタフェース `CTISession` 内の `includeResource`
  パラメータ:
    `uriPattern` - URIパターン
  例外:
    `java.io.IOException`

### excludeResource

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

  インタフェース `CTISession` の記述:

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

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

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

  定義:
    インタフェース `CTISession` 内の `excludeResource`
  パラメータ:
    `uriPattern` - URIパターン
  例外:
    `java.io.IOException`

### formatMain

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

  インタフェース `CTISession` の記述:

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

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

  定義:
    インタフェース `CTISession` 内の `formatMain`
  パラメータ:
    `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

  インタフェース `CTISession` の記述:

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

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

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

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

### buildNext

    public boolean buildNext(ContentBuilder builder)
                      throws java.io.IOException

  例外:
    `java.io.IOException`

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

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