jp.co.intra_mart.foundation.bloommaker.content

インタフェース BMFileInfoService

public interface BMFileInfoService

IM-BloomMaker の添付ファイル操作サービスです。
保存、永続化、取得、削除の機能を提供します。
永続化、取得、削除の機能は、ファイルを添付するためのエレメントでアップロードした結果に含まれるキーを引数に取ります。

導入されたバージョン:

8.0.2

バージョン:

8.0.11

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	delete(java.lang.String... key) 指定されたファイルを特定するキーに紐付いたファイル情報を削除します。
BMFileInfo	getStream(java.lang.String key) 指定されたファイルを特定するキーに紐付いたファイル情報を取得します。
void	register(java.util.Map<java.lang.String,java.lang.String> metadata, java.lang.String... key) 指定されたファイルを特定するキーに紐付いたファイル情報とメタデータ情報を永続化します。
void	register(java.lang.String... key) 指定されたファイルを特定するキーに紐付いたファイル情報を登録します。
void	register(java.lang.String applicationId, java.lang.String businessKey, java.util.Map<java.lang.String,java.lang.String> metadata, java.lang.String... key) 指定されたファイルを特定するキーに紐付いたファイル情報とメタデータ情報を永続化します。
void	register(java.lang.String applicationId, java.lang.String businessKey, java.lang.String... key) 指定されたファイルを特定するキーに紐付いたファイル情報とアプリケーション、業務を特定するキーを永続化します。
java.util.Collection<BMFileInfo>	search(java.lang.String applicationId, java.lang.String businessKey) 指定されたアプリケーションID、ビジネスキーに一致するファイル情報の一覧を取得します。
java.lang.String	upload(java.lang.String fileName, java.io.InputStream input) ファイルを保存します。

メソッドの詳細

delete

void delete(java.lang.String... key)
     throws BloomMakerException

指定されたファイルを特定するキーに紐付いたファイル情報を削除します。

パラメータ:

key - ファイルを特定するキー

例外:

BloomMakerException - ファイル情報の削除に失敗した場合にスローされます。

getStream

BMFileInfo getStream(java.lang.String key)
              throws BloomMakerException

指定されたファイルを特定するキーに紐付いたファイル情報を取得します。

パラメータ:

key - ファイルを特定するキー

戻り値:

ファイル情報

例外:

BloomMakerException - ファイル情報の取得に失敗した場合にスローされます。

register

void register(java.util.Map<java.lang.String,java.lang.String> metadata,
              java.lang.String... key)
       throws BloomMakerException

指定されたファイルを特定するキーに紐付いたファイル情報とメタデータ情報を永続化します。

パラメータ:

metadata - メタデータ情報

key - ファイルを特定するキー

例外:

BloomMakerException - ファイル情報の登録に失敗した場合にスローされます。

導入されたバージョン:

8.0.11

register

void register(java.lang.String... key)
       throws BloomMakerException

指定されたファイルを特定するキーに紐付いたファイル情報を登録します。

パラメータ:

key - ファイルを特定するキー

例外:

BloomMakerException - ファイル情報の登録に失敗した場合にスローされます。

register

void register(java.lang.String applicationId,
              java.lang.String businessKey,
              java.util.Map<java.lang.String,java.lang.String> metadata,
              java.lang.String... key)
       throws BloomMakerException

指定されたファイルを特定するキーに紐付いたファイル情報とメタデータ情報を永続化します。

パラメータ:

applicationId - アプリケーションID

businessKey - ビジネスキー

metadata - メタデータ情報

key - ファイルを特定するキー

例外:

BloomMakerException - ファイル情報の登録に失敗した場合にスローされます。

導入されたバージョン:

8.0.11

register

void register(java.lang.String applicationId,
              java.lang.String businessKey,
              java.lang.String... key)
       throws BloomMakerException

指定されたファイルを特定するキーに紐付いたファイル情報とアプリケーション、業務を特定するキーを永続化します。

パラメータ:

applicationId - アプリケーションを特定するID

businessKey - 業務を特定するキー

key - ファイルを特定するキー

例外:

BloomMakerException - ファイル情報の登録に失敗した場合にスローされます。

search

java.util.Collection<BMFileInfo> search(java.lang.String applicationId,
                                        java.lang.String businessKey)
                                 throws BloomMakerException

指定されたアプリケーションID、ビジネスキーに一致するファイル情報の一覧を取得します。

パラメータ:

applicationId - アプリケーションID

businessKey - ビジネスキー

戻り値:

ファイル情報の一覧
contents は含まれません。 contents が必要な場合は、getStream(String) を使用してください。

例外:

BloomMakerException - ファイル情報の取得に失敗した場合にスローされます。

導入されたバージョン:

8.0.11

upload

java.lang.String upload(java.lang.String fileName,
                        java.io.InputStream input)
                 throws BloomMakerException,
                        java.io.IOException

ファイルを保存します。
この機能はファイルサイズの制限制御は行われません。

パラメータ:

fileName - ファイル名

input - ファイル

戻り値:

ファイルを特定するキー

例外:

BloomMakerException - ファイルアップロードに失敗したときにスローされます。

java.io.IOException - ファイルアップロードに失敗したときにスローされます。