jp.cssj.cti2
インタフェース CTISession

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

public interface CTISession

ドキュメント変換処理を実行するためのサーバーとの接続です。

バージョン:
$Id: CTISession.java 315 2009-07-31 10:38:56Z miyabe $
作成者:
MIYABE Tatsuhiko

フィールドの概要
static byte ABORT_FORCE
          強制的に中断する処理の定数です。
static byte ABORT_NORMAL
          きりのよいところまで処理する中断処理の定数です。
 
メソッドの概要
 void abort(byte mode)
           変換を中断します。
 void close()
           セッションをクローズします。
 InputStream getServerInfo(URI uri)
          サーバー情報を返します。
 void property(String name, String value)
           プロパティを設定します。
 void reset()
           送られたリソースと、プロパティ、メッセージハンドラ等の全ての設定をクリアして初期状態に戻します。
 OutputStream resource(MetaSource metaSource)
           リソースを送信するための出力ストリームを返します。
 void resource(Source source)
           リソースを送信します。
 void setMessageHandler(MessageHandler messageHandler)
           メッセージを受け取るためのオブジェクトを設定します。
 void setProgressListener(ProgressListener progressListener)
           進行状況を監視するためのオブジェクトを設定します。
 void setResults(Results results)
           出力先を設定します。
 void setSourceResolver(SourceResolver resolver)
           リソースを読み込むためのオブジェクトを設定します。
 OutputStream transcode(MetaSource metaSource)
           メインドキュメントを送信するための出力ストリームを返します。
 void transcode(Source source)
           メインドキュメントをデータソースから取得して変換します。
 void transcode(URI uri)
           指定されたアドレスへサーバー側からアクセスしてメインドキュメントを取得して変換します。
 

フィールドの詳細

ABORT_NORMAL

public static final byte ABORT_NORMAL
きりのよいところまで処理する中断処理の定数です。abortメソッドに渡します。

関連項目:
定数フィールド値

ABORT_FORCE

public static final byte ABORT_FORCE
強制的に中断する処理の定数です。abortメソッドに渡します。

関連項目:
定数フィールド値
メソッドの詳細

getServerInfo

public InputStream getServerInfo(URI uri)
                          throws IOException
サーバー情報を返します。

パラメータ:
uri - サーバー情報を選択するためのURI。
戻り値:
サーバー情報データのストリーム。
例外:
IOException

setResults

public void setResults(Results results)
                throws IOException

出力先を設定します。

このメソッドは各transcodeメソッドの前に呼ぶ必要があります。

パラメータ:
results - 出力先。
例外:
IOException

setMessageHandler

public void setMessageHandler(MessageHandler messageHandler)
                       throws IOException

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

このメソッドは各transcodeメソッドの前に呼ぶ必要があります。

パラメータ:
messageHandler - メッセージハンドラ
例外:
IOException
関連項目:
MessageHandler

setProgressListener

public void setProgressListener(ProgressListener progressListener)
                         throws IOException

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

このメソッドは各transcodeメソッドの前に呼ぶ必要があります。

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

パラメータ:
progressListener - 進行状況リスナ
例外:
IOException
関連項目:
ProgressListener

property

public void property(String name,
                     String value)
              throws IOException

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

このメソッドは各transcodeメソッドの前に呼ぶ必要があります。

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

resource

public OutputStream resource(MetaSource metaSource)
                      throws IOException

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

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

このメソッドは各transcodeメソッドの前に呼ぶ必要があります。

パラメータ:
metaSource - リソースデータのメタ情報。
戻り値:
サーバーへの出力ストリーム。
例外:
IOException

resource

public void resource(Source source)
              throws IOException

リソースを送信します。

このメソッドは各transcodeメソッドの前に呼ぶ必要があります。

パラメータ:
source - リソースのデータソース。
例外:
IOException

setSourceResolver

public void setSourceResolver(SourceResolver resolver)
                       throws IOException

リソースを読み込むためのオブジェクトを設定します。

パラメータ:
resolver - サーバー側から要求したリソースを取得するためのSourceResolver。
例外:
IOException

transcode

public OutputStream transcode(MetaSource metaSource)
                       throws IOException

メインドキュメントを送信するための出力ストリームを返します。

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

パラメータ:
metaSource - メインドキュメントのメタ情報。
戻り値:
サーバーへの出力ストリーム。
例外:
IOException

transcode

public void transcode(URI uri)
               throws IOException,
                      TranscoderException

指定されたアドレスへサーバー側からアクセスしてメインドキュメントを取得して変換します。

パラメータ:
uri - メインドキュメントのURI。
例外:
IOException
TranscoderException

transcode

public void transcode(Source source)
               throws IOException,
                      TranscoderException

メインドキュメントをデータソースから取得して変換します。

パラメータ:
source - メインドキュメントのデータソース。
例外:
IOException
TranscoderException

abort

public void abort(byte mode)
           throws IOException

変換を中断します。 変換済みのページが含まれた出力結果が得られます。

パラメータ:
mode - きりのよいところまで出力する場合はABORT_NORMAL、強制的に処理を停止するにはABORT_FORCEを指定します。
例外:
IOException

reset

public void reset()
           throws IOException

送られたリソースと、プロパティ、メッセージハンドラ等の全ての設定をクリアして初期状態に戻します。

例外:
IOException

close

public void close()
           throws IOException

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

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

例外:
IOException


(c)2008-2009 GNN & Co.,Ltd.