jp.cssj.cti2

インタフェース CTISession

すべてのスーパーインタフェース:

AutoCloseable, Closeable

既知の実装クラスのリスト:

AbstractCTISession

public interface CTISession
extends Closeable

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

バージョン:

$Id: CTISession.java 1552 2018-04-26 01:43:24Z miyabe $

作成者:

MIYABE Tatsuhiko

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
static byte	ABORT_FORCE 強制的に中断する処理の定数です。
static byte	ABORT_NORMAL きりのよいところまで処理する中断処理の定数です。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	abort(byte mode) 変換を中断します。
void	close() セッションをクローズします。
InputStream	getServerInfo(URI uri) サーバー情報を返します。
void	join() setContinues(true) が設定された状態で、複数回のtranscodeにより生成された結果を結合して出力します。
void	property(String name, String value) プロパティを設定します。
void	reset() 送られたリソースと、プロパティ、メッセージハンドラ等の全ての設定をクリアして、セッションが作られた時点と同じ初期状態に戻します。
OutputStream	resource(MetaSource metaSource) リソースを送信するための出力ストリームを返します。
void	resource(Source source) リソースを送信します。
void	setContinuous(boolean continuous) 複数の結果を結合するモードに切り替えます。
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

static final byte ABORT_NORMAL

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

関連項目:

定数フィールド値

ABORT_FORCE

static final byte ABORT_FORCE

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

関連項目:

定数フィールド値

メソッドの詳細

getServerInfo

InputStream getServerInfo(URI uri)
                   throws IOException

サーバー情報を返します。 詳細はCopper PDF ドキュメントを参照して下さい。

パラメータ:

uri - サーバー情報を選択するためのURI。

戻り値:

サーバー情報データのストリーム。

例外:

IOException

setResults

void setResults(Results results)
         throws IOException

出力先を設定します。

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

パラメータ:

results - 出力先。

例外:

IOException

setMessageHandler

void setMessageHandler(MessageHandler messageHandler)
                throws IOException

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

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

パラメータ:

messageHandler - メッセージハンドラ

例外:

IOException

関連項目:

MessageHandler

setProgressListener

void setProgressListener(ProgressListener progressListener)
                  throws IOException

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

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

パラメータ:

progressListener - 進行状況リスナ

例外:

IOException

関連項目:

ProgressListener

property

void property(String name,
              String value)
       throws IOException

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

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

パラメータ:

name - プロパティ名

value - 値

例外:

IOException

resource

OutputStream resource(MetaSource metaSource)
               throws IOException

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

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

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

パラメータ:

metaSource - リソースデータのメタ情報。

戻り値:

サーバーへの出力ストリーム。

例外:

IOException

resource

void resource(Source source)
       throws IOException

リソースを送信します。

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

パラメータ:

source - リソースのデータソース。

例外:

IOException

setSourceResolver

void setSourceResolver(SourceResolver resolver)
                throws IOException

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

パラメータ:

resolver - サーバー側から要求したリソースを取得するためのSourceResolver。

例外:

IOException

transcode

OutputStream transcode(MetaSource metaSource)
                throws IOException

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

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

パラメータ:

metaSource - メインドキュメントのメタ情報。

戻り値:

サーバーへの出力ストリーム。

例外:

IOException

transcode

void transcode(URI uri)
        throws IOException,
               TranscoderException

指定されたアドレスへサーバー側からアクセスしてメインドキュメントを取得して変換します。 resourceメソッドで事前に送信したリソースに対しても有効です。

パラメータ:

uri - メインドキュメントのURI。

例外:

IOException

TranscoderException

transcode

void transcode(Source source)
        throws IOException,
               TranscoderException

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

パラメータ:

source - メインドキュメントのデータソース。

例外:

IOException

TranscoderException

setContinuous

void setContinuous(boolean continuous)
            throws IOException

複数の結果を結合するモードに切り替えます。

パラメータ:

continuous - trueであればjoinにより結果を結合するモードにします。

例外:

IOException

join

void join()
   throws IOException

setContinues(true) が設定された状態で、複数回のtranscodeにより生成された結果を結合して出力します。

例外:

IOException

abort

void abort(byte mode)
    throws IOException

変換を中断します。 このメソッドは非同期的に（別スレッドから）呼び出す必要があります。 実際に処理が中断された場合は、変換処理を行なっている（transcodeを呼び出した ）スレッドで、TranscoderExceptionがスローされます。

パラメータ:

mode - きりのよいところまで出力する場合はABORT_NORMAL、強制的に処理を停止するにはABORT_FORCEを指定します。

例外:

IOException

reset

void reset()
    throws IOException

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

例外:

IOException

close

void close()
    throws IOException

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

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

定義:

close インタフェース内 AutoCloseable

定義:

close インタフェース内 Closeable

例外:

IOException