uCosminexus DocumentBroker Version 5 リファレンス API

[目次][用語][索引][前へ][次へ]

6.4.10 downloadContents文書のコンテンツのダウンロード

<この項の構成>
(1) 機能
(2) 形式
(3) 引数
(4) 戻り値
(5) 例外

(1) 機能

文書のコンテンツをダウンロードします。

形式1では,レンディションタイプを指定した文書のコンテンツを,指定したローカルファイルにダウンロードします。リファレンスファイル文書に対しては実行できません。リファレンスファイル文書に対して実行した場合は,DbjException例外がスローされます。形式2では,リファレンスファイル文書のコンテンツを指定したパスにダウンロードします。リファレンスファイル文書に対してだけ実行できます。リファレンスファイル文書以外にこのメソッドを実行した場合はDbjContentTypeMismatchException例外がスローされます。形式3では,指定したレンディションタイプの文書のコンテンツを一時ディレクトリ下の一時ファイルにダウンロードします。DbjContentInfo#getInputStreamの呼び出しにより入力ストリームで取得することができます。リファレンスファイル文書に対しても実行できます。形式3を使用する場合,文書空間構成定義ファイルのTempDirectoryプロパティを指定してください。指定されたディレクトリ下に一時ファイルを作成します。作成した一時ファイルは,DbjContentInfo#close()メソッド実行時またはDbjSession#logout()メソッド実行時に削除されます。

(2) 形式

(a) 形式1
DbjContentInfo downloadContents(
     String     renditionType,
     String     filePath
)
(b) 形式2
DbjReferenceContentInfo downloadContents(
     String                     renditionType,
     DbjReferencePathInfo       pathInfo
)
(c) 形式3
DbjContentInfo downloadContents(
     String     renditionType,
)
 

(3) 引数

renditionType(入力)
レンディションタイプを指定します。nullを指定するとマスタレンディションが仮定されます。
filePath(入力)
ダウンロード先のパス名(ローカルファイル,およびファイル名を含みます)を指定します。nullを指定すると例外がスローされます。
pathInfo(入力)
ダウンロード先の情報を指定します。nullを指定すると例外がスローされます。

(4) 戻り値

形式1,形式3の場合
コンテンツ情報(DbjContentInfoインターフェース)
形式2の場合
リファレンスファイル機能用のコンテンツ情報(DbjReferenceContentInfoインタフェース)

(5) 例外

DbjAccessControlException
アクセス権エラーの場合
DbjDBException
DBエラーの場合
DbjException
DocumentBrokerクラスライブラリ固有のエラーの場合
DbjIllegalObjectTypeException
指定オブジェクト種別が不適切の場合
DbjIOException
DocumentBrokerクラスライブラリ固有のIOエラーの場合
DbjNotCheckOutException
チェックアウトされていないオブジェクトに対して仮のバージョン識別子が指定された場合
DbjObjectNotFoundException
指定オブジェクトが存在しなかった場合
DbjRenditionNotFoundException
指定レンディションが存在しなかった場合
DbjSessionNotConnectException
セッションが接続されていなかった場合
DbjContentTypeMismatchException
このメソッドでは操作できないコンテントを対象に実行した場合
DbjFileReferenceOperationFailedException
リファレンスファイル機能を使用するサーバのコンテント操作においてエラーが発生した場合
DbjTargetContentPathNotSetException
リファレンスファイル機能において相対パスのベースとなるパスが設定されていない場合
DbjContentNotRegisteredException
コンテンツが登録されていない場合
NullPointerException
引数filePathまたは引数pathInfoがnullの場合