com.nec.baas.file

インタフェース NbFileBucket

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

NbBaseBucket<NbFileBucket>

public interface NbFileBucket
extends NbBaseBucket<NbFileBucket>

ファイルバケット。

通常は NbFileBucketManager.getBucket(String) でインスタンスを取得する。

導入されたバージョン:

1.0

ネストされたクラスのサマリー

ネストされたクラス

修飾子とタイプ	インタフェースと説明
static class	NbFileBucket.NewFileParam ファイル作成パラメータ。
static class	NbFileBucket.UpdateFileParam ファイル更新パラメータ。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	_deleteFile(java.lang.String fileName, boolean softDelete, NbResultCallback callback) 内部API: ファイル削除
void	_getFileMetadataList(boolean isPublished, boolean isDeleted, NbCallback<java.util.List<NbFileMetadata>> callback) 内部API: ファイルメタデータ一覧を取得する
void	deleteFile(java.lang.String fileName, NbResultCallback callback) ファイルの削除を行う。
void	disablePublishFile(java.lang.String fileName, NbCallback<NbFileMetadata> callback) ファイルの公開解除を行う。
void	disablePublishFile(java.lang.String fileName, NbFileMetadataCallback callback) 非推奨です。 disablePublishFile(String, NbCallback) で置き換え
void	downloadFile(java.lang.String fileName, java.io.File downloadFile, NbCallback<java.lang.String> callback) ファイルのダウンロードを行う(保存先ファイル指定)。
void	downloadFile(java.lang.String fileName, java.io.OutputStream outputStream, NbResultCallback callback) ファイルのダウンロードを行う(OutputStream指定)。
void	enablePublishFile(java.lang.String fileName, NbCallback<NbFileMetadata> callback) ファイルの公開を行う。
void	enablePublishFile(java.lang.String fileName, NbFileMetadataCallback callback) 非推奨です。 enablePublishFile(String, NbCallback) で置き換え
void	getFileMetadata(java.lang.String fileName, NbCallback<NbFileMetadata> callback) ファイルのメタデータを取得する。
void	getFileMetadata(java.lang.String fileName, NbFileMetadataCallback callback) 非推奨です。 getFileMetadata(String, NbCallback) で置き換え
void	getFileMetadataList(boolean isPublished, NbCallback<java.util.List<NbFileMetadata>> callback) ファイルのメタデータの一覧を取得する。
void	save(NbCallback<NbFileBucket> callback) バケットの設定を保存する。
void	uploadNewFile(NbFileBucket.NewFileParam param, NbCallback<NbFileMetadata> callback) ファイルの新規アップロードを行う。
void	uploadNewFile(java.lang.String fileName, java.io.InputStream fileData, NbAcl acl, long contentLength, java.lang.String contentType, NbCallback<NbFileMetadata> callback) ファイルの新規アップロードを行う(InputStream指定、Content-Length指定付き)。
void	uploadNewFile(java.lang.String fileName, java.io.InputStream fileData, NbAcl acl, long contentLength, java.lang.String contentType, NbFileMetadataCallback callback) 非推奨です。 uploadNewFile(String, InputStream, NbAcl, long, String, NbCallback) で置き換え
void	uploadNewFile(java.lang.String fileName, java.io.InputStream fileData, NbAcl acl, java.lang.String contentType, NbCallback<NbFileMetadata> callback) ファイルの新規アップロードを行う(InputStream指定)。
void	uploadNewFile(java.lang.String fileName, java.io.InputStream fileData, NbAcl acl, java.lang.String contentType, NbFileMetadataCallback callback) 非推奨です。 uploadNewFile(String, InputStream, NbAcl, String, NbCallback) で置き換え
void	uploadNewFile(java.lang.String fileName, java.lang.String filePath, NbAcl acl, java.lang.String contentType, NbCallback<NbFileMetadata> callback) ファイルの新規アップロードを行う(ファイルパス指定)。
void	uploadNewFile(java.lang.String fileName, java.lang.String filePath, NbAcl acl, java.lang.String contentType, NbFileMetadataCallback callback) 非推奨です。 uploadNewFile(String, String, NbAcl, String, NbCallback) で置き換え
void	uploadUpdateFile(NbFileBucket.UpdateFileParam param, NbCallback<NbFileMetadata> callback) ファイルの更新アップロードを行う。
void	uploadUpdateFile(java.lang.String fileName, java.io.InputStream fileData, long contentLength, java.lang.String contentType, NbCallback<NbFileMetadata> callback) Nb * ファイルの更新アップロードを行う(InputStream指定, Content-Length指定付き)。
void	uploadUpdateFile(java.lang.String fileName, java.io.InputStream fileData, long contentLength, java.lang.String contentType, NbFileMetadataCallback callback) 非推奨です。 uploadUpdateFile(String, InputStream, long, String, NbCallback) で置き換え
void	uploadUpdateFile(java.lang.String fileName, java.io.InputStream fileData, java.lang.String contentType, NbCallback<NbFileMetadata> callback) ファイルの更新アップロードを行う(InputStream指定)。
void	uploadUpdateFile(java.lang.String fileName, java.io.InputStream fileData, java.lang.String contentType, NbFileMetadataCallback callback) 非推奨です。 uploadUpdateFile(String, InputStream, String, NbCallback) で置き換え
void	uploadUpdateFile(java.lang.String fileName, java.lang.String filePath, java.lang.String contentType, NbCallback<NbFileMetadata> callback) ファイルの更新アップロードを行う(ファイルパス指定)。
void	uploadUpdateFile(java.lang.String fileName, java.lang.String filePath, java.lang.String contentType, NbFileMetadataCallback callback) 非推奨です。 uploadUpdateFile(String, String, String, NbCallback) で置き換え

インタフェースから継承されたメソッド com.nec.baas.core.NbBaseBucket

getAcl, getBucketName, getContentAcl, getDescription, getMode, setAcl, setContentAcl, setDescription

メソッドの詳細

uploadNewFile

void uploadNewFile(NbFileBucket.NewFileParam param,
                   NbCallback<NbFileMetadata> callback)

ファイルの新規アップロードを行う。

必要なパラメータは NbFileBucket.NewFileParam で指定する。 バケットのcreate権限が必要。 ファイルが既に存在する場合エラーとなる(コールバックで通知される)。

• 制限事項：キャッシュ禁止フラグは常にfalse扱いで動作する。

パラメータ:

param - アップロードパラメータ

callback - アップロードしたファイルのメタデータを取得するコールバック。

導入されたバージョン:

6.5.0

uploadNewFile

@Deprecated
void uploadNewFile(java.lang.String fileName,
                               java.lang.String filePath,
                               NbAcl acl,
                               java.lang.String contentType,
                               NbFileMetadataCallback callback)

非推奨です。 uploadNewFile(String, String, NbAcl, String, NbCallback) で置き換え

ファイルの新規アップロードを行う。

uploadNewFile

void uploadNewFile(java.lang.String fileName,
                   java.lang.String filePath,
                   NbAcl acl,
                   java.lang.String contentType,
                   NbCallback<NbFileMetadata> callback)

ファイルの新規アップロードを行う(ファイルパス指定)。

ACLはオプションのため指定しなくても良い。 バケットのcreate権限が必要。 ファイルが既に存在する場合エラーとなる(コールバックで通知される)。

• 制限事項：キャッシュ禁止フラグは常にfalse扱いで動作する。

パラメータ:

fileName - アップロードするファイルの名前。

filePath - アップロードするローカルファイルのパス(絶対パス)。

acl - アップロードするファイルに設定するACL。

contentType - アップロードするファイルのコンテンツタイプ。

callback - アップロードしたファイルのメタデータを取得するコールバック。

導入されたバージョン:

6.5.0

uploadNewFile

@Deprecated
void uploadNewFile(java.lang.String fileName,
                               java.io.InputStream fileData,
                               NbAcl acl,
                               java.lang.String contentType,
                               NbFileMetadataCallback callback)

非推奨です。 uploadNewFile(String, InputStream, NbAcl, String, NbCallback) で置き換え

ファイルの新規アップロードを行う。

uploadNewFile

void uploadNewFile(java.lang.String fileName,
                   java.io.InputStream fileData,
                   NbAcl acl,
                   java.lang.String contentType,
                   NbCallback<NbFileMetadata> callback)

ファイルの新規アップロードを行う(InputStream指定)。

ACLはオプションのため指定しなくても良い。 バケットのcreate権限が必要。 ファイルが既に存在する場合エラーとなる(コールバックでエラーが通知される)。

• 制限事項：メタデータのみキャッシュする。ファイルデータをキャッシュしたい際は ダウンロードや同期を実行すること。
• 制限事項：キャッシュ禁止フラグは常にfalse扱いで動作する。

パラメータ:

fileName - アップロードするファイルの名前

fileData - アップロードするファイルのデータを読み込むストリーム

acl - アップロードするファイルに設定するACL

contentType - アップロードするファイルのコンテンツタイプ

callback - アップロードしたファイルのメタデータを取得するコールバック

導入されたバージョン:

6.5.0

uploadNewFile

@Deprecated
void uploadNewFile(java.lang.String fileName,
                               java.io.InputStream fileData,
                               NbAcl acl,
                               long contentLength,
                               java.lang.String contentType,
                               NbFileMetadataCallback callback)

非推奨です。 uploadNewFile(String, InputStream, NbAcl, long, String, NbCallback) で置き換え

ファイルの新規アップロードを行う。

uploadNewFile

void uploadNewFile(java.lang.String fileName,
                   java.io.InputStream fileData,
                   NbAcl acl,
                   long contentLength,
                   java.lang.String contentType,
                   NbCallback<NbFileMetadata> callback)

ファイルの新規アップロードを行う(InputStream指定、Content-Length指定付き)。

ACLはオプションのため指定しなくても良い。 バケットのcreate権限が必要。 ファイルが既に存在する場合エラーとなる(コールバックでエラーが通知される)。

• contentLength はコンテンツのバイト数に正確に一致していなければならない。 一致していない場合、後続のリクエストにも影響を及ぼす。
• 制限事項：メタデータのみキャッシュする。ファイルデータをキャッシュしたい際は ダウンロードや同期を実行すること。
• 制限事項：キャッシュ禁止フラグは常にfalse扱いで動作する。

パラメータ:

fileName - アップロードするファイルの名前

fileData - アップロードするファイルのデータを読み込むストリーム

acl - アップロードするファイルに設定するACL

contentLength - アップロードするファイルのバイト数。不明時は -1 (chunked encoding)。

contentType - アップロードするファイルのコンテンツタイプ

callback - アップロードしたファイルのメタデータを取得するコールバック

導入されたバージョン:

6.5.0

uploadUpdateFile

void uploadUpdateFile(NbFileBucket.UpdateFileParam param,
                      NbCallback<NbFileMetadata> callback)

ファイルの更新アップロードを行う。

必要なパラメータは NbFileBucket.UpdateFileParam で指定する。 バケットのupdate権限が必要。 ファイルの上書きを行う場合ファイルの書き込み権限が必要となる。 該当ファイルが存在しない場合エラーとなる。

パラメータ:

param - 更新パラメータ

callback - アップロードしたファイルのメタデータを取得するコールバック。

導入されたバージョン:

6.5.0

uploadUpdateFile

@Deprecated
void uploadUpdateFile(java.lang.String fileName,
                                  java.lang.String filePath,
                                  java.lang.String contentType,
                                  NbFileMetadataCallback callback)

非推奨です。 uploadUpdateFile(String, String, String, NbCallback) で置き換え

ファイルの更新アップロードを行う。

uploadUpdateFile

void uploadUpdateFile(java.lang.String fileName,
                      java.lang.String filePath,
                      java.lang.String contentType,
                      NbCallback<NbFileMetadata> callback)

ファイルの更新アップロードを行う(ファイルパス指定)。

ACLはオプションのため指定しなくても良い。 バケットのupdate権限が必要。 ファイルの上書きを行う場合ファイルの書き込み権限が必要となる。 該当ファイルが存在しない場合エラーとなる。

• 制限事項：メタデータのみキャッシュする。ファイルデータをキャッシュしたい際は ダウンロードや同期を実行すること。
• 制限事項：キャッシュ禁止フラグは常にfalse扱いで動作する。例えば、 事前にダウンロードしてキャッシュ上にファイルが存在する状態でも、当該ファイルを 更新アップロードした場合は、キャッシュ上のファイル本体は削除される。

パラメータ:

fileName - アップロードするファイルの名前。

filePath - アップロードするファイルのローカルパス(絶対パス)。

contentType - アップロードするファイルのコンテンツタイプ。

callback - アップロードしたファイルのメタデータを取得するコールバック。

導入されたバージョン:

6.5.0

uploadUpdateFile

@Deprecated
void uploadUpdateFile(java.lang.String fileName,
                                  java.io.InputStream fileData,
                                  java.lang.String contentType,
                                  NbFileMetadataCallback callback)

非推奨です。 uploadUpdateFile(String, InputStream, String, NbCallback) で置き換え

ファイルの更新アップロードを行う。

uploadUpdateFile

void uploadUpdateFile(java.lang.String fileName,
                      java.io.InputStream fileData,
                      java.lang.String contentType,
                      NbCallback<NbFileMetadata> callback)

ファイルの更新アップロードを行う(InputStream指定)。

ACLはオプションのため指定しなくても良い。 バケットのupdate権限が必要。 ファイルの上書きを行う場合ファイルの書き込み権限が必要となる。 該当ファイルが存在しない場合エラーとなる。

• 制限事項：メタデータのみキャッシュする。ファイルデータをキャッシュしたい際は ダウンロードや同期を実行すること。
• 制限事項：キャッシュ禁止フラグは常にfalse扱いで動作する。例えば、 事前にダウンロードしてキャッシュ上にファイルが存在する状態でも、当該ファイルを 更新アップロードした場合は、キャッシュ上のファイル本体は削除される。

パラメータ:

fileName - アップロードするファイルの名前

fileData - アップロードするファイルのデータを読み込むストリーム

contentType - アップロードするファイルのコンテンツタイプ

callback - アップロードしたファイルのメタデータを取得するコールバック

導入されたバージョン:

6.5.0

uploadUpdateFile

@Deprecated
void uploadUpdateFile(java.lang.String fileName,
                                  java.io.InputStream fileData,
                                  long contentLength,
                                  java.lang.String contentType,
                                  NbFileMetadataCallback callback)

非推奨です。 uploadUpdateFile(String, InputStream, long, String, NbCallback) で置き換え

ファイルの更新アップロードを行う。

uploadUpdateFile

void uploadUpdateFile(java.lang.String fileName,
                      java.io.InputStream fileData,
                      long contentLength,
                      java.lang.String contentType,
                      NbCallback<NbFileMetadata> callback)

Nb * ファイルの更新アップロードを行う(InputStream指定, Content-Length指定付き)。

ACLはオプションのため指定しなくても良い。 バケットのupdate権限が必要。 ファイルの上書きを行う場合ファイルの書き込み権限が必要となる。 該当ファイルが存在しない場合エラーとなる。

• contentLength はコンテンツのバイト数に正確に一致していなければならない。 一致していない場合、後続のリクエストにも影響を及ぼす。
• 制限事項：メタデータのみキャッシュする。ファイルデータをキャッシュしたい際は ダウンロードや同期を実行すること。
• 制限事項：キャッシュ禁止フラグは常にfalse扱いで動作する。例えば、 事前にダウンロードしてキャッシュ上にファイルが存在する状態でも、当該ファイルを 更新アップロードした場合は、キャッシュ上のファイル本体は削除される。

パラメータ:

fileName - アップロードするファイルの名前

fileData - アップロードするファイルのデータを読み込むストリーム

contentLength - アップロードするファイルのバイト数。不明時は -1 (chunked encoding)。

contentType - アップロードするファイルのコンテンツタイプ

callback - アップロードしたファイルのメタデータを取得するコールバック

導入されたバージョン:

6.5.0

downloadFile

void downloadFile(java.lang.String fileName,
                  java.io.File downloadFile,
                  NbCallback<java.lang.String> callback)

ファイルのダウンロードを行う(保存先ファイル指定)。

バケットおよび対象ファイルのread権限が必要となる。 ダウンロードしたファイルの保存先の書き込み権限が必要となる。 downloadFileにファイルが存在する場合上書き保存となる。

制限事項：キャッシュ禁止フラグは常にfalse扱いで動作する。

パラメータ:

fileName - ダウンロードするファイルの名前

downloadFile - ダウンロードしたファイルの保存先

callback - ダウンロード結果を受け取るコールバック。保存先のファイルパスが渡される。

downloadFile

void downloadFile(java.lang.String fileName,
                  java.io.OutputStream outputStream,
                  NbResultCallback callback)

ファイルのダウンロードを行う(OutputStream指定)。

バケットおよび対象ファイルのread権限が必要となる。 ダウンロードしたファイルの保存先の書き込み権限が必要となる。

制限事項：キャッシュ禁止フラグは常にfalse扱いで動作する。

パラメータ:

fileName - ダウンロードするファイルの名前。

outputStream - ダウンロードしたファイルを書き込むストリーム

callback - ダウンロード結果を受け取るコールバック。

deleteFile

void deleteFile(java.lang.String fileName,
                NbResultCallback callback)

ファイルの削除を行う。
バケットおよび対象ファイルのdelete権限が必要となる。
オフラインのみで作成されたファイル（メタID=null）を削除する場合は、
キャッシュのみ削除する。サーバへリクエストしない。

パラメータ:

fileName - 削除するファイルの名前。

callback - 削除結果を受け取るコールバック。

_deleteFile

void _deleteFile(java.lang.String fileName,
                 boolean softDelete,
                 NbResultCallback callback)

内部API: ファイル削除

パラメータ:

fileName - ファイル名

softDelete - 仮削除フラグ

callback - コールバック

getFileMetadataList

void getFileMetadataList(boolean isPublished,
                         NbCallback<java.util.List<NbFileMetadata>> callback)

ファイルのメタデータの一覧を取得する。

バケットおよび対象ファイルのread権限が必要となる。
オフラインでメタデータを編集した状態で、オンラインでメタデータ一覧を取得した際、
キャッシュ上で衝突が発生しなければローカル（編集された）のメタデータを返却する。
キャッシュ上で衝突が発生した場合もローカル（編集された）のメタデータを返却するが、
当該データの同期状態(state)は「NbSyncState.CONFLICTED」になる。

パラメータ:

isPublished - trueの場合公開済みメタデータの一覧を取得する。

callback - メタデータの一覧を受け取るコールバック。

_getFileMetadataList

void _getFileMetadataList(boolean isPublished,
                          boolean isDeleted,
                          NbCallback<java.util.List<NbFileMetadata>> callback)

内部API: ファイルメタデータ一覧を取得する

パラメータ:

isPublished - 公開済みデータ一覧取得

isDeleted - 仮削除済みデータ一覧を含める

callback - コールバック

getFileMetadata

@Deprecated
void getFileMetadata(java.lang.String fileName,
                                 NbFileMetadataCallback callback)

非推奨です。 getFileMetadata(String, NbCallback) で置き換え

ファイルのメタデータを取得する。

getFileMetadata

void getFileMetadata(java.lang.String fileName,
                     NbCallback<NbFileMetadata> callback)

ファイルのメタデータを取得する。

バケットおよび対象ファイルのread権限が必要となる。

パラメータ:

fileName - メタデータを取得するファイルの名前。

callback - メタデータを受け取るコールバック。

enablePublishFile

@Deprecated
void enablePublishFile(java.lang.String fileName,
                                   NbFileMetadataCallback callback)

非推奨です。 enablePublishFile(String, NbCallback) で置き換え

ファイルの公開を行う。

enablePublishFile

void enablePublishFile(java.lang.String fileName,
                       NbCallback<NbFileMetadata> callback)

ファイルの公開を行う。

対象ファイルのadmin権限と対象バケットのupdate権限が必要となる。
オフライン時はエラーとなる。

パラメータ:

fileName - 公開を行うファイルの名前。

callback - 公開URLを保存したメタデータを受け取るコールバック。

disablePublishFile

@Deprecated
void disablePublishFile(java.lang.String fileName,
                                    NbFileMetadataCallback callback)

非推奨です。 disablePublishFile(String, NbCallback) で置き換え

ファイルの公開解除を行う。

disablePublishFile

void disablePublishFile(java.lang.String fileName,
                        NbCallback<NbFileMetadata> callback)

ファイルの公開解除を行う。

対象ファイルのadmin権限と対象バケットのupdate権限が必要となる。
オフライン時はエラーとなる。

パラメータ:

fileName - 公開解除を行うファイルの名前。

callback - 公開解除の結果を受け取るコールバック。

save

void save(NbCallback<NbFileBucket> callback)

バケットの設定を保存する。

ROOTバケットと本バケットのupdate権限が必要となる。
ACLの変更を行う際は本バケットのadmin権限が必要となる。
オフライン時はエラーとなる。

パラメータ:

callback - 設定の保存結果を受け取るコールバック。