jp.co.intra_mart.foundation.office365.service.storage

クラス SharePointStorage

java.lang.Object

jp.co.intra_mart.foundation.office365.service.storage.SharePointStorage

すべての実装されたインタフェース:

Serializable, Comparable<SharePointStorage>, Storage<SharePointStorage>

public class SharePointStorage
extends Object
implements Storage<SharePointStorage>

Office 365のSharePointのファイルサービスにアクセスするためのクラスです。
このAPIでは、チームサイト上の「Shared Documents」配下のドキュメントを対象とします。
このAPIを利用するためには以下の前提条件を満たしている必要があります。

• intra-mart Accel Platformのユーザに対応するOffice365ユーザが存在すること
• Microsoft Azure にてアプリケーションが登録・設定されていること
• OAuth プロバイダ設定ファイルにOffice 365 連携を行うための設定が記述されていること

上記の設定方法についてはOffice 365 連携セットアップガイドを参照してください。

コンストラクタで指定するプロバイダIDには、上記OAuth プロバイダ設定ファイルにてOffice 365 連携用に設定したプロバイダIDを指定してください。

サイトパスにはこのAPIでドキュメントを扱う Office 365 SharePoint Online 上のサイトパスを指定します。
例えば、チームサイトが「https://yourcompany.sharepoint.com/sites/foo」の場合、サイトパスには "foo" でなく "sites/foo" と記述します。

ユーザコードはOffice 365へアクセスを行う intra-mart Accel Platform ユーザのユーザコードを指定します。

Office 365 SharePoint Online へアクセスを行う前に、「外部連携アプリケーション」画面にて該当のアプリケーションの利用を許可してください。この操作はアクセスする各ユーザ毎に必要です。
アプリケーションの利用許可が行われていない状態でAPIを実行した場合 OAuthPreconditionException が発生します。

このAPIでは、ファイルのID、ファイルサイズ、更新時刻などのメタ情報をキャッシュします。キャッシュは、それらの情報の取得メソッドが実行された際に作成されます。
キャッシュがすでに行われているか確認したい場合はhasCache()を、最新の情報を取得したい場合はclearCache()を実行後に取得メソッドを実行してください。

このAPIでは、Office365へのデータのアップロード・ダウンロードを行う際にアプリケーションサーバ内に一時ファイルを作成します。
（一時ファイルが作成される場所は、システムプロパティ「-Djava.io.tmpdir」で指定したディレクトリ、ファイル名は「im_office365_[ランダムな文字列]」です。）
一時ファイルは、処理が完了次第自動で削除されますが、処理を行っている最中にアプリケーションサーバが停止した場合、一時ファイルが残留してしまうことがあります。

導入されたバージョン:

8.0.0

バージョン:

8.0.5

関連項目:

直列化された形式

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
static String	OFFICE365_FILE_PATHSEPARATOR Office365のファイルパスのセパレータ

インタフェースから継承されたフィールド jp.co.intra_mart.foundation.service.client.file.Storage

CHARSET, FILE_SEPARATOR, FILE_SEPARATOR_CHAR

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
SharePointStorage(String userCd, String providerId, String path) ストレージインスタンスを作成します。
SharePointStorage(String userCd, String providerId, String sitePath, String path) ストレージインスタンスを作成します。
SharePointStorage(String userCd, String providerId, String sitePath, String driveId, String path) ストレージインスタンスを作成します。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
OutputStream	append() このストレージの出力ストリームを追記モードで取得します。
void	append(CharSequence src) 文字列を標準のキャラセットでこのストレージに追記します。
void	append(CharSequence src, Charset charset) 文字列を指定されたキャラセットで変換しこのストレージに追記します。
void	append(CharSequence src, String charsetName) 文字列を指定されたキャラセット名で変換しこのストレージに追記します。
void	clearCache() このストレージが持つファイルのメタ情報のキャッシュを削除します。
int	compareTo(SharePointStorage storage) このストレージと引数のストレージを語彙的に比較します。
void	copy(SharePointStorage to, boolean overwrite) このファイル、またはディレクトリを引数で指定された対象にコピーします。
OutputStream	create() このストレージの出力ストリームを取得します。
long	created() このストレージが示すファイルが作成された時刻を返します。
String	createdApplicationId() このストレージが示すファイルを作成したOffice365上でのアプリケーションIDを返します。
String	createdApplicationName() このストレージが示すファイルを作成したOffice365上でのアプリケーション名を返します。
String	createdUserId() このストレージが示すファイルを作成したOffice365上でのユーザIDを返します。
String	createdUserName() このストレージが示すファイルを作成したOffice365上でのユーザ名を返します。
Collection<String>	directories() このストレージが示すディレクトリの配下にあるディレクトリのパスのコレクションを返します。
Collection<String>	directories(boolean recursive) このストレージが示すディレクトリの配下にあるディレクトリのパスのコレクションを返します。
Collection<SharePointStorage>	directoriesStorages() このストレージが示すディレクトリ内のディレクトリを示すストレージのコレクションを返します。
Collection<SharePointStorage>	directoriesStorages(boolean recursive) このストレージが示すディレクトリ内のディレクトリを示すストレージのコレクションを返します。
boolean	equals(Object obj) このオブジェクトと「等価」になるオブジェクトがあるかどうかを示します。
boolean	exists() このストレージが示すファイルまたはディレクトリが存在するかどうかを判定します。
Collection<String>	files() このストレージが示すディレクトリの配下にあるファイルのパスのコレクションを返します。
Collection<String>	files(boolean recursive) このストレージが示すディレクトリの配下にあるファイルのパスのコレクションを返します。
Collection<SharePointStorage>	filesStorages() このストレージが示すディレクトリ内のファイルを示すストレージのコレクションを返します。
Collection<SharePointStorage>	filesStorages(boolean recursive) このストレージが示すディレクトリ内のファイルを示すストレージのコレクションを返します。
String	getCanonicalPath() 正規化したパスを返します。
String	getContentUrl() 非推奨です。
String	getDriveId() ドライブIDを返します。
static Collection<Drive>	getDrives(String userCd, String providerId)
static Collection<Drive>	getDrives(String userCd, String providerId, String sitePath)
String	getId() アイテムIDを取得します。
Map<String,Object>	getListItemFields() このストレージが示すファイルに対するリストアイテムの持つアイテムフィールドを取得します。
String	getName() このストレージが示すファイルまたはディレクトリの名前を返します。
String	getParent() 親パスを返します。
SharePointStorage	getParentStorage() 親ストレージを返します。
String	getPath() パスを返します。
String	getProviderId() プロバイダIDを返します。
String	getRelativePath(SharePointStorage targetStorage) このストレージとの相対パスを返します。
SharePointStorage	getRootStorage() ルートストレージを返します。
String	getSitePath() サイトパスを返します。
String	getUserCd() Office 365 SharePoint Online へアクセスを行う intra-mart Accel Platform のユーザコードを返します。
String	getWebUrl() コンテンツをブラウザ上で確認可能なWeb URLを取得します。
boolean	hasCache() ファイルのメタ情報をキャッシュしているか否かを取得します。
int	hashCode() オブジェクトのハッシュコード値を返します。
boolean	isDirectory() このストレージが示すファイルがディレクトリであるかどうかを判定します。
boolean	isFile() このストレージが示すファイルが普通のファイルかどうかを判定します。
long	lastModified() このストレージが示すファイルが最後に変更された時刻を返します。
String	lastModifiedApplicationId() このストレージが示すファイルを最後に変更したOffice365上でのアプリケーションIDを返します。
String	lastModifiedApplicationName() このストレージが示すファイルを最後に変更したOffice365上でのアプリケーション名を返します。
String	lastModifiedUserId() このストレージが示すファイルを最後に変更したOffice365上でのユーザIDを返します。
String	lastModifiedUserName() このストレージが示すファイルを最後に変更したOffice365上でのユーザ名を返します。
long	length() このストレージが指定されているファイルの長さを返します。
Collection<String>	list() このストレージが示すディレクトリの配下にあるファイル、および、ディレクトリのパスのコレクションを返します。
Collection<String>	list(boolean recursive) このストレージが示すディレクトリの配下にあるファイル、および、ディレクトリのパスのコレクションを返します。
Collection<String>	list(StoragenameFilter<SharePointStorage> filter) このストレージが示すディレクトリにあるファイルおよびディレクトリの中で、指定されたフィルタの基準を満たすものの相対パスのコレクションを返します。
Collection<SharePointStorage>	listStorages() このストレージが示すディレクトリ内のファイルおよびディレクトリを示すストレージのコレクションを返します。
Collection<SharePointStorage>	listStorages(boolean recursive) このストレージが示すディレクトリ内のファイルおよびディレクトリを示すストレージのコレクションを返します。
Collection<SharePointStorage>	listStorages(StorageFilter<SharePointStorage> filter) このストレージが示すディレクトリにあるファイルおよびディレクトリの中で、指定されたフィルタの基準を満たすもののストレージのコレクションを返します。
Collection<SharePointStorage>	listStorages(StoragenameFilter<SharePointStorage> filter) このストレージが示すディレクトリにあるファイルおよびディレクトリの中で、指定されたフィルタの基準を満たすもののストレージのコレクションを返します。
byte[]	load() このストレージの内容をバイト配列で取得します。
byte[]	loadAs(String format) このストレージが示すファイルを指定した形式で開きます。
boolean	makeDirectories() このストレージが示すディレクトリを生成します。
boolean	move(CharSequence newPath) このストレージが示すファイルを移動します。
InputStream	open() このストレージの入力ストリームを取得します。
InputStream	openAs(String format) このストレージが示すファイルを指定した形式で開きます。
String	read() このストレージの内容を標準のキャラセットで変換し文字列で取得します。
String	read(Charset charset) このストレージの内容を指定されたキャラセットで変換し文字列で取得します。
String	read(String charsetName) このストレージの内容を指定されたキャラセット名で変換し文字列で取得します。
boolean	remove() このストレージが示すファイルまたはディレクトリを削除します。
boolean	remove(boolean recursive) このストレージが示すファイルまたはディレクトリを削除します。
SharePointStorage	resolve(CharSequence other) このストレージから相対ストレージを返します。
void	save(byte[] byteArray) バイト配列をこのストレージに書き込みます。
String	toString()
Map<String,Object>	updateListItemFields(Map<String,Object> fields) このストレージが示すファイルに対するリストアイテムのフィールドを更新します。
void	write(CharSequence src) 文字列を標準のキャラセットでこのストレージに書き込みます。
void	write(CharSequence src, Charset charset) 文字列を指定されたキャラセットでこのストレージに書き込みます。
void	write(CharSequence src, String charsetName) 文字列を指定されたキャラセット名でこのストレージに書き込みます。

クラスから継承されたメソッド java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

フィールドの詳細

OFFICE365_FILE_PATHSEPARATOR

public static final String OFFICE365_FILE_PATHSEPARATOR

Office365のファイルパスのセパレータ

関連項目:

定数フィールド値

コンストラクタの詳細

SharePointStorage

public SharePointStorage(String userCd,
                         String providerId,
                         String path)

ストレージインスタンスを作成します。

パラメータ:

userCd - ユーザコード

providerId - プロバイダID

path - パス

SharePointStorage

public SharePointStorage(String userCd,
                         String providerId,
                         String sitePath,
                         String path)

ストレージインスタンスを作成します。

パラメータ:

userCd - ユーザコード

providerId - プロバイダID

sitePath - サイトパス

path - パス

SharePointStorage

public SharePointStorage(String userCd,
                         String providerId,
                         String sitePath,
                         String driveId,
                         String path)

ストレージインスタンスを作成します。

パラメータ:

userCd - ユーザコード

providerId - プロバイダID

sitePath - サイトパス

driveId - ドライブID

path - パス

メソッドの詳細

getDrives

public static Collection<Drive> getDrives(String userCd,
                                          String providerId)
                                   throws IOException

例外:

IOException

getDrives

public static Collection<Drive> getDrives(String userCd,
                                          String providerId,
                                          String sitePath)
                                   throws IOException

例外:

IOException

append

public OutputStream append()
                    throws IOException

インタフェースからコピーされた説明: Storage

このストレージの出力ストリームを追記モードで取得します。

定義:

append インタフェース内 Storage<SharePointStorage>

戻り値:

出力ストリーム

例外:

IOException - 出力ストリームの取得に失敗した場合

append

public void append(CharSequence src)
            throws IOException

インタフェースからコピーされた説明: Storage

文字列を標準のキャラセットでこのストレージに追記します。

定義:

append インタフェース内 Storage<SharePointStorage>

パラメータ:

src - 文字列

例外:

IOException - 追記に失敗した場合

append

public void append(CharSequence src,
                   Charset charset)
            throws IOException

インタフェースからコピーされた説明: Storage

文字列を指定されたキャラセットで変換しこのストレージに追記します。

定義:

append インタフェース内 Storage<SharePointStorage>

パラメータ:

src - 文字列

charset - キャラセット

例外:

IOException - 追記に失敗した場合

append

public void append(CharSequence src,
                   String charsetName)
            throws IOException

インタフェースからコピーされた説明: Storage

文字列を指定されたキャラセット名で変換しこのストレージに追記します。

定義:

append インタフェース内 Storage<SharePointStorage>

パラメータ:

src - 文字列

charsetName - キャラセット名

例外:

IOException - 追記に失敗した場合

clearCache

public void clearCache()

このストレージが持つファイルのメタ情報のキャッシュを削除します。

compareTo

public int compareTo(SharePointStorage storage)

このストレージと引数のストレージを語彙的に比較します。
プロバイダID、サイトパス、ストレージのパスを利用して比較を行います。

定義:

compareTo インタフェース内 Comparable<SharePointStorage>

定義:

compareTo インタフェース内 Storage<SharePointStorage>

パラメータ:

storage - 比較を行うストレージ

戻り値:

等しい場合は0、このストレージが語彙的に小さい場合は、負の値。大きい場合は正の値。

関連項目:

Storage.compareTo(jp.co.intra_mart.foundation.service.client.file.Storage)

copy

public void copy(SharePointStorage to,
                 boolean overwrite)
          throws HttpRequestException,
                 HttpResponseException,
                 Office365APIResponseException,
                 OAuthClientException,
                 ProviderSettingException,
                 FileNotFoundException,
                 APIOperationException,
                 IOException

このファイル、またはディレクトリを引数で指定された対象にコピーします。
このインスタンスのユーザコード（getUserCd()）、プロバイダID（getProviderId()）、サイトパス(getSitePath()）がコピー先のそれらと異なる場合：

• APIOperationExceptionがスローされます。

このインスタンスが存在しない場合:

• FileNotFoundExceptionがスローされます。

このインスタンスがファイルの場合:

• toが存在しない場合はtoに対してコピーを行います。
• toがファイルの場合は、引数overwriteに従います。
• toがディレクトリの場合はAPIOperationExceptionがスローされます。

このインスタンスがディレクトリの場合:

• toが存在しない場合はtoディレクトリを作成し、コピーを行います。
• toがファイルの場合はAPIOperationExceptionがスローされます。
• toがディレクトリの場合、かつtoディレクトリ配下にファイルまたはディレクトリが存在した場合は引数overwriteに従います。
  このインスタンス配下のファイルと同名の階層のディレクトリがコピー先に存在した場合はAPIOperationExceptionがスローされます。
• toがディレクトリの場合、かつtoディレクトリ配下にファイルまたはディレクトリが存在していない場合はこのインスタンス配下のファイルまたはディレクトリをtoディレクトリ配下にコピーします。
• toがディレクトリの場合、かつこのインスタンス配下のファイルと一致しないファイルがtoディレクトリ配下に存在した場合は、そのファイルに対しては何も行われません。
  (mergeする動作となります、削除が必要な場合はコピー先に対してremove(boolean)を呼び出した後このメソッドを実行して下さい)

定義:

copy インタフェース内 Storage<SharePointStorage>

パラメータ:

to - コピー先

overwrite - trueの場合上書きします

例外:

HttpRequestException - HTTP通信に失敗した場合

HttpResponseException - HTTP通信のレスポンスが不正だった場合

Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合

OAuthClientException - OAuth関連の処理に失敗した場合

ProviderSettingException - プロバイダ設定が不正だった場合

FileNotFoundException - コピー対象が存在しない場合

APIOperationException - 禁止されている操作が実行された場合

IOException - コピーに失敗した場合

create

public OutputStream create()
                    throws IOException

インタフェースからコピーされた説明: Storage

このストレージの出力ストリームを取得します。

定義:

create インタフェース内 Storage<SharePointStorage>

戻り値:

出力ストリーム

例外:

IOException - 出力ストリームの取得に失敗した場合

created

public long created()
             throws HttpRequestException,
                    HttpResponseException,
                    Office365APIResponseException,
                    OAuthClientException,
                    ProviderSettingException

このストレージが示すファイルが作成された時刻を返します。
パスが指す場所に何も存在しない場合は0Lを返します。

戻り値:

ファイルが作成された時刻を表す long 値。エポック (1970 年 1 月 1 日 0 時 0 分 0 秒、グリニッジ標準時) からミリ秒単位で測定。

例外:

HttpRequestException - HTTP通信に失敗した場合

HttpResponseException - HTTP通信のレスポンスが不正だった場合

Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合

OAuthClientException - OAuth関連の処理に失敗した場合

ProviderSettingException - プロバイダ設定が不正だった場合

createdApplicationId

public String createdApplicationId()
                            throws HttpRequestException,
                                   HttpResponseException,
                                   Office365APIResponseException,
                                   OAuthClientException,
                                   ProviderSettingException

このストレージが示すファイルを作成したOffice365上でのアプリケーションIDを返します。
パスが指す場所に何も存在しない場合はnullを返します。

戻り値:

作成したアプリケーションID

例外:

HttpRequestException - HTTP通信に失敗した場合

HttpResponseException - HTTP通信のレスポンスが不正だった場合

Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合

OAuthClientException - OAuth関連の処理に失敗した場合

ProviderSettingException - プロバイダ設定が不正だった場合

createdApplicationName

public String createdApplicationName()
                              throws HttpRequestException,
                                     HttpResponseException,
                                     Office365APIResponseException,
                                     OAuthClientException,
                                     ProviderSettingException

このストレージが示すファイルを作成したOffice365上でのアプリケーション名を返します。
パスが指す場所に何も存在しない場合はnullを返します。

戻り値:

作成したアプリケーション名

例外:

HttpRequestException - HTTP通信に失敗した場合

HttpResponseException - HTTP通信のレスポンスが不正だった場合

Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合

OAuthClientException - OAuth関連の処理に失敗した場合

ProviderSettingException - プロバイダ設定が不正だった場合

createdUserId

public String createdUserId()
                     throws HttpRequestException,
                            HttpResponseException,
                            Office365APIResponseException,
                            OAuthClientException,
                            ProviderSettingException

このストレージが示すファイルを作成したOffice365上でのユーザIDを返します。
パスが指す場所に何も存在しない場合はnullを返します。

戻り値:

作成したユーザID

例外:

HttpRequestException - HTTP通信に失敗した場合

HttpResponseException - HTTP通信のレスポンスが不正だった場合

Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合

OAuthClientException - OAuth関連の処理に失敗した場合

ProviderSettingException - プロバイダ設定が不正だった場合

createdUserName

public String createdUserName()
                       throws HttpRequestException,
                              HttpResponseException,
                              Office365APIResponseException,
                              OAuthClientException,
                              ProviderSettingException

このストレージが示すファイルを作成したOffice365上でのユーザ名を返します。
パスが指す場所に何も存在しない場合はnullを返します。

戻り値:

作成したユーザ名

例外:

HttpRequestException - HTTP通信に失敗した場合

HttpResponseException - HTTP通信のレスポンスが不正だった場合

Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合

OAuthClientException - OAuth関連の処理に失敗した場合

ProviderSettingException - プロバイダ設定が不正だった場合

directories

public Collection<String> directories()
                               throws HttpRequestException,
                                      HttpResponseException,
                                      Office365APIResponseException,
                                      ProviderSettingException,
                                      OAuthClientException,
                                      IOException

このストレージが示すディレクトリの配下にあるディレクトリのパスのコレクションを返します。
パスは、このストレージのパスからの相対パスです。
このメソッドは、directories(false)と動作は一緒です。

定義:

directories インタフェース内 Storage<SharePointStorage>

戻り値:

このストレージが示すディレクトリの配下にあるディレクトリの相対パスのコレクション。コレクションは、ディレクトリが空の場合は空になります。このストレージがディレクトリを示さない場合、または入出力エラーが発生した場合は null

例外:

HttpRequestException - HTTP通信に失敗した場合

HttpResponseException - HTTP通信のレスポンスが不正だった場合

Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合

OAuthClientException - OAuth関連の処理に失敗した場合

ProviderSettingException - プロバイダ設定が不正だった場合

IOException - 取得に失敗した場合

directories

public Collection<String> directories(boolean recursive)
                               throws HttpRequestException,
                                      HttpResponseException,
                                      Office365APIResponseException,
                                      ProviderSettingException,
                                      OAuthClientException,
                                      IOException

このストレージが示すディレクトリの配下にあるディレクトリのパスのコレクションを返します。
パスは、このストレージのパスからの相対パスです。

 ROOT
 ┗directory-1
   ┗directory-1-1
     ┣directory-1-1-1
     ┃┣directory-1-1-1-1
     ┃┗file-1-1-1-2
     ┣directory-1-1-2
     ┣file-1-1-3
     ┗file-1-1-4
 

上記のようなファイル構成である場合、
directory-1-1に対してdirectories(false)を実行した場合の戻り値は以下の通りです。

• directory-1-1-1
• directory-1-1-2

directory-1-1に対してdirectories(true)を実行した場合の戻り値は以下の通りです。

• directory-1-1-1
• directory-1-1-1/directory-1-1-1-1
• directory-1-1-2

定義:

directories インタフェース内 Storage<SharePointStorage>

パラメータ:

recursive - ディレクトリを再帰的に探索する場合は true、そうでない場合は false

戻り値:

このストレージが示すディレクトリの配下にあるディレクトリの相対パスのコレクション。コレクションは、ディレクトリが空の場合は空になります。このストレージがディレクトリを示さない場合、 または入出力エラーが発生した場合は null

例外:

HttpRequestException - HTTP通信に失敗した場合

HttpResponseException - HTTP通信のレスポンスが不正だった場合

Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合

OAuthClientException - OAuth関連の処理に失敗した場合

ProviderSettingException - プロバイダ設定が不正だった場合

IOException - 取得に失敗した場合

directoriesStorages

public Collection<SharePointStorage> directoriesStorages()
                                                  throws HttpRequestException,
                                                         HttpResponseException,
                                                         Office365APIResponseException,
                                                         ProviderSettingException,
                                                         OAuthClientException,
                                                         IOException

このストレージが示すディレクトリ内のディレクトリを示すストレージのコレクションを返します。

定義:

directoriesStorages インタフェース内 Storage<SharePointStorage>

戻り値:

このストレージが示すディレクトリ内のディレクトリを示すストレージのコレクション。コレクションは、ディレクトリが空の場合は空になります。このストレージがディレクトリを示さない場合、または入出力エラーが発生した場合は null

例外:

HttpRequestException - HTTP通信に失敗した場合

HttpResponseException - HTTP通信のレスポンスが不正だった場合

Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合

OAuthClientException - OAuth関連の処理に失敗した場合

ProviderSettingException - プロバイダ設定が不正だった場合

IOException - 取得に失敗した場合

directoriesStorages

public Collection<SharePointStorage> directoriesStorages(boolean recursive)
                                                  throws HttpRequestException,
                                                         HttpResponseException,
                                                         Office365APIResponseException,
                                                         ProviderSettingException,
                                                         OAuthClientException,
                                                         IOException

このストレージが示すディレクトリ内のディレクトリを示すストレージのコレクションを返します。

定義:

directoriesStorages インタフェース内 Storage<SharePointStorage>

パラメータ:

recursive - ディレクトリを再帰的に探索する場合は true、そうでない場合は false

戻り値:

このストレージが示すディレクトリ内のディレクトリを示すパスのコレクション。コレクションは、ディレクトリが空の場合は空になります。このストレージがディレクトリを示さない場合、または入出力エラーが発生した場合は null

例外:

HttpRequestException - HTTP通信に失敗した場合

HttpResponseException - HTTP通信のレスポンスが不正だった場合

Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合

OAuthClientException - OAuth関連の処理に失敗した場合

ProviderSettingException - プロバイダ設定が不正だった場合

IOException - 取得に失敗した場合

equals

public boolean equals(Object obj)

インタフェースからコピーされた説明: Storage

このオブジェクトと「等価」になるオブジェクトがあるかどうかを示します。

定義:

equals インタフェース内 Storage<SharePointStorage>

オーバーライド:

equals クラス内 Object

パラメータ:

obj - 比較対象の参照オブジェクト

戻り値:

obj 引数に指定されたオブジェクトとこのオブジェクトが等しい場合は true、そうでない場合は false

exists

public boolean exists()
               throws HttpRequestException,
                      HttpResponseException,
                      Office365APIResponseException,
                      OAuthClientException,
                      ProviderSettingException,
                      IOException

このストレージが示すファイルまたはディレクトリが存在するかどうかを判定します。

定義:

exists インタフェース内 Storage<SharePointStorage>

戻り値:

ファイルまたはディレクトリが存在する場合は true、そうでない場合は false

例外:

HttpRequestException - HTTP通信に失敗した場合

HttpResponseException - HTTP通信のレスポンスが不正だった場合

Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合

OAuthClientException - OAuth関連の処理に失敗した場合

ProviderSettingException - プロバイダ設定が不正だった場合

IOException - 判定に失敗した場合

files

public Collection<String> files()
                         throws HttpRequestException,
                                HttpResponseException,
                                Office365APIResponseException,
                                ProviderSettingException,
                                OAuthClientException,
                                IOException

このストレージが示すディレクトリの配下にあるファイルのパスのコレクションを返します。
パスは、このストレージのパスからの相対パスです。
このメソッドは、files(false)と動作は一緒です。

定義:

files インタフェース内 Storage<SharePointStorage>

戻り値:

このストレージが示すディレクトリの配下にあるファイルの相対パスのコレクション。コレクションは、ディレクトリが空の場合は空になります。このストレージがディレクトリを示さない場合、または入出力エラーが発生した場合は null

例外:

HttpRequestException - HTTP通信に失敗した場合

HttpResponseException - HTTP通信のレスポンスが不正だった場合

Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合

OAuthClientException - OAuth関連の処理に失敗した場合

ProviderSettingException - プロバイダ設定が不正だった場合

IOException - 取得に失敗した場合

files

public Collection<String> files(boolean recursive)
                         throws HttpRequestException,
                                HttpResponseException,
                                Office365APIResponseException,
                                ProviderSettingException,
                                OAuthClientException,
                                IOException

このストレージが示すディレクトリの配下にあるファイルのパスのコレクションを返します。
パスは、このストレージのパスからの相対パスです。

 ROOT
 ┗directory-1
   ┗directory-1-1
     ┣directory-1-1-1
     ┃┣directory-1-1-1-1
     ┃┗file-1-1-1-2
     ┣directory-1-1-2
     ┣file-1-1-3
     ┗file-1-1-4
 

上記のようなファイル構成である場合、
directory-1-1に対してfiles(false)を実行した場合の戻り値は以下の通りです。

• file-1-1-3
• file-1-1-4

directory-1-1に対してfiles(true)を実行した場合の戻り値は以下の通りです。

• directory-1-1-1/file-1-1-1-2
• file-1-1-3
• file-1-1-4

定義:

files インタフェース内 Storage<SharePointStorage>

パラメータ:

recursive - ディレクトリを再帰的に探索する場合は true、そうでない場合は false

戻り値:

このストレージが示すディレクトリの配下にあるファイルの相対パスのコレクション。コレクションは、ディレクトリが空の場合は空になります。このストレージがディレクトリを示さない場合、または入出力エラーが発生した場合は null

例外:

HttpRequestException - HTTP通信に失敗した場合

HttpResponseException - HTTP通信のレスポンスが不正だった場合

Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合

OAuthClientException - OAuth関連の処理に失敗した場合

ProviderSettingException - プロバイダ設定が不正だった場合

IOException - 取得に失敗した場合

filesStorages

public Collection<SharePointStorage> filesStorages()
                                            throws HttpRequestException,
                                                   HttpResponseException,
                                                   Office365APIResponseException,
                                                   ProviderSettingException,
                                                   OAuthClientException,
                                                   IOException

このストレージが示すディレクトリ内のファイルを示すストレージのコレクションを返します。

定義:

filesStorages インタフェース内 Storage<SharePointStorage>

戻り値:

このストレージが示すディレクトリ内のファイルを示すストレージのコレクション。コレクションは、ディレクトリが空の場合は空になります。このストレージがディレクトリを示さない場合、または入出力エラーが発生した場合は null

例外:

HttpRequestException - HTTP通信に失敗した場合

HttpResponseException - HTTP通信のレスポンスが不正だった場合

Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合

OAuthClientException - OAuth関連の処理に失敗した場合

ProviderSettingException - プロバイダ設定が不正だった場合

IOException - 取得に失敗した場合

filesStorages

public Collection<SharePointStorage> filesStorages(boolean recursive)
                                            throws HttpRequestException,
                                                   HttpResponseException,
                                                   Office365APIResponseException,
                                                   ProviderSettingException,
                                                   OAuthClientException,
                                                   IOException

このストレージが示すディレクトリ内のファイルを示すストレージのコレクションを返します。

定義:

filesStorages インタフェース内 Storage<SharePointStorage>

パラメータ:

recursive - ディレクトリを再帰的に探索する場合は true、そうでない場合は false

戻り値:

このストレージが示すディレクトリ内のファイルを示すストレージのコレクション。コレクションは、ディレクトリが空の場合は空になります。このストレージがディレクトリを示さない場合、または入出力エラーが発生した場合は null

例外:

HttpRequestException - HTTP通信に失敗した場合

HttpResponseException - HTTP通信のレスポンスが不正だった場合

Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合

OAuthClientException - OAuth関連の処理に失敗した場合

ProviderSettingException - プロバイダ設定が不正だった場合

IOException - 取得に失敗した場合

getCanonicalPath

public String getCanonicalPath()

インタフェースからコピーされた説明: Storage

正規化したパスを返します。
パスをセパレータ（区切り文字）とセグメント（区切り文字の間の文字列）に分割し、解析を行い正規化されたパスを返します。
正規化されたパスでは、以下の特殊セグメントが解釈されたパスです。

• .
• ..

先頭および末尾に付与されているセパレータはトリムされます。

定義:

getCanonicalPath インタフェース内 Storage<SharePointStorage>

戻り値:

正規化したパス

getContentUrl

@Deprecated
public String getContentUrl()
                                 throws HttpRequestException,
                                        HttpResponseException,
                                        Office365APIResponseException,
                                        OAuthClientException,
                                        ProviderSettingException

非推奨です。

コンテンツ自体を表すURLを取得します。
ディレクトリの場合、パスが指す場所に何も存在しない場合はnullを返します。
バージョン8.0.2以後、該当メソッドは必ずnullを返します。ファイルのダウンロードを行う場合は、open() を利用してください。

戻り値:

コンテンツ自体を表すURL

例外:

HttpRequestException - HTTP通信に失敗した場合

HttpResponseException - HTTP通信のレスポンスが不正だった場合

Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合

OAuthClientException - OAuth関連の処理に失敗した場合

ProviderSettingException - プロバイダ設定が不正だった場合

getDriveId

public String getDriveId()

ドライブIDを返します。

戻り値:

サイトパス

getId

public String getId()
             throws HttpRequestException,
                    HttpResponseException,
                    Office365APIResponseException,
                    OAuthClientException,
                    ProviderSettingException

アイテムIDを取得します。
パスが指す場所に何も存在しない場合はnullを返します。

戻り値:

Office365でのID

例外:

HttpRequestException - HTTP通信に失敗した場合

HttpResponseException - HTTP通信のレスポンスが不正だった場合

Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合

OAuthClientException - OAuth関連の処理に失敗した場合

ProviderSettingException - プロバイダ設定が不正だった場合

getListItemFields

public Map<String,Object> getListItemFields()
                                     throws HttpResponseException,
                                            OAuthClientException,
                                            ProviderSettingException,
                                            HttpRequestException

このストレージが示すファイルに対するリストアイテムの持つアイテムフィールドを取得します。
パスが指す場所に何も存在しない場合はnullを返します。

戻り値:

ファイルに対するリストアイテムのフィールド情報

例外:

HttpRequestException - HTTP通信に失敗した場合

HttpResponseException - HTTP通信のレスポンスが不正だった場合

Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合

OAuthClientException - OAuth関連の処理に失敗した場合

ProviderSettingException - プロバイダ設定が不正だった場合

getName

public String getName()

インタフェースからコピーされた説明: Storage

このストレージが示すファイルまたはディレクトリの名前を返します。

定義:

getName インタフェース内 Storage<SharePointStorage>

戻り値:

ファイルまたはディレクトリの名前

getParent

public String getParent()

インタフェースからコピーされた説明: Storage

親パスを返します。

定義:

getParent インタフェース内 Storage<SharePointStorage>

戻り値:

親パス

getParentStorage

public SharePointStorage getParentStorage()

インタフェースからコピーされた説明: Storage

親ストレージを返します。

定義:

getParentStorage インタフェース内 Storage<SharePointStorage>

戻り値:

親ストレージ。このストレージがルートストレージだった場合は、null

getPath

public String getPath()

パスを返します。

定義:

getPath インタフェース内 Storage<SharePointStorage>

戻り値:

パス。

getProviderId

public String getProviderId()

プロバイダIDを返します。

戻り値:

プロバイダID

getRelativePath

public String getRelativePath(SharePointStorage targetStorage)
                       throws APIOperationException,
                              IOException

このストレージとの相対パスを返します。
このインスタンスのユーザコード（getUserCd()）、プロバイダID（getProviderId()）、サイトパス(getSitePath()）がコピー先のそれらと異なる場合：

• APIOperationExceptionがスローされます。

定義:

getRelativePath インタフェース内 Storage<SharePointStorage>

パラメータ:

targetStorage - 比較対象ストレージ

戻り値:

このストレージとの相対パスを返します。

例外:

APIOperationException - 禁止されている操作が実行された場合

IOException - 相対パスの取得に失敗した場合

getRootStorage

public SharePointStorage getRootStorage()

インタフェースからコピーされた説明: Storage

ルートストレージを返します。

定義:

getRootStorage インタフェース内 Storage<SharePointStorage>

戻り値:

ルートストレージ

getSitePath

public String getSitePath()

サイトパスを返します。

戻り値:

サイトパス

getUserCd

public String getUserCd()

Office 365 SharePoint Online へアクセスを行う intra-mart Accel Platform のユーザコードを返します。

戻り値:

ユーザコード

getWebUrl

public String getWebUrl()
                 throws HttpRequestException,
                        HttpResponseException,
                        Office365APIResponseException,
                        OAuthClientException,
                        ProviderSettingException

コンテンツをブラウザ上で確認可能なWeb URLを取得します。
パスが指す場所に何も存在しない場合はnullを返します。

戻り値:

Web URL

例外:

HttpRequestException - HTTP通信に失敗した場合

HttpResponseException - HTTP通信のレスポンスが不正だった場合

Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合

OAuthClientException - OAuth関連の処理に失敗した場合

ProviderSettingException - プロバイダ設定が不正だった場合

hasCache

public boolean hasCache()

ファイルのメタ情報をキャッシュしているか否かを取得します。

戻り値:

キャッシュが存在する場合は true

hashCode

public int hashCode()

インタフェースからコピーされた説明: Storage

オブジェクトのハッシュコード値を返します。

定義:

hashCode インタフェース内 Storage<SharePointStorage>

オーバーライド:

hashCode クラス内 Object

戻り値:

このオブジェクトのハッシュコード値

isDirectory

public boolean isDirectory()
                    throws HttpRequestException,
                           HttpResponseException,
                           Office365APIResponseException,
                           OAuthClientException,
                           ProviderSettingException

このストレージが示すファイルがディレクトリであるかどうかを判定します。

定義:

isDirectory インタフェース内 Storage<SharePointStorage>

戻り値:

このストレージが示すファイルが存在し、さらにそれがディレクトリである場合は true、そうでない場合は false

例外:

HttpRequestException - HTTP通信に失敗した場合

HttpResponseException - HTTP通信のレスポンスが不正だった場合

Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合

OAuthClientException - OAuth関連の処理に失敗した場合

ProviderSettingException - プロバイダ設定が不正だった場合

isFile

public boolean isFile()
               throws HttpRequestException,
                      HttpResponseException,
                      Office365APIResponseException,
                      OAuthClientException,
                      ProviderSettingException

このストレージが示すファイルが普通のファイルかどうかを判定します。

定義:

isFile インタフェース内 Storage<SharePointStorage>

戻り値:

このストレージが示すファイルが存在し、さらにそれが普通のファイルである場合は true、そうでない場合は false

例外:

HttpRequestException - HTTP通信に失敗した場合

HttpResponseException - HTTP通信のレスポンスが不正だった場合

Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合

OAuthClientException - OAuth関連の処理に失敗した場合

ProviderSettingException - プロバイダ設定が不正だった場合

lastModified

public long lastModified()
                  throws HttpRequestException,
                         HttpResponseException,
                         Office365APIResponseException,
                         OAuthClientException,
                         ProviderSettingException

このストレージが示すファイルが最後に変更された時刻を返します。

定義:

lastModified インタフェース内 Storage<SharePointStorage>

戻り値:

ファイルが最後に変更された時刻を表す long 値。エポック (1970 年 1 月 1 日 0 時 0 分 0 秒、グリニッジ標準時) からミリ秒単位で測定。ファイルが存在しない場合は 0L

例外:

HttpRequestException - HTTP通信に失敗した場合

HttpResponseException - HTTP通信のレスポンスが不正だった場合

Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合

OAuthClientException - OAuth関連の処理に失敗した場合

ProviderSettingException - プロバイダ設定が不正だった場合

lastModifiedApplicationId

public String lastModifiedApplicationId()
                                 throws HttpRequestException,
                                        HttpResponseException,
                                        Office365APIResponseException,
                                        OAuthClientException,
                                        ProviderSettingException

このストレージが示すファイルを最後に変更したOffice365上でのアプリケーションIDを返します。

戻り値:

最後に変更したアプリケーションID

例外:

HttpRequestException - HTTP通信に失敗した場合

HttpResponseException - HTTP通信のレスポンスが不正だった場合

Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合

OAuthClientException - OAuth関連の処理に失敗した場合

ProviderSettingException - プロバイダ設定が不正だった場合

lastModifiedApplicationName

public String lastModifiedApplicationName()
                                   throws HttpRequestException,
                                          HttpResponseException,
                                          Office365APIResponseException,
                                          OAuthClientException,
                                          ProviderSettingException

このストレージが示すファイルを最後に変更したOffice365上でのアプリケーション名を返します。

戻り値:

最後に変更したアプリケーション名

例外:

HttpRequestException - HTTP通信に失敗した場合

HttpResponseException - HTTP通信のレスポンスが不正だった場合

Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合

OAuthClientException - OAuth関連の処理に失敗した場合

ProviderSettingException - プロバイダ設定が不正だった場合

lastModifiedUserId

public String lastModifiedUserId()
                          throws HttpRequestException,
                                 HttpResponseException,
                                 Office365APIResponseException,
                                 OAuthClientException,
                                 ProviderSettingException

このストレージが示すファイルを最後に変更したOffice365上でのユーザIDを返します。

戻り値:

最後に変更したユーザID

例外:

HttpRequestException - HTTP通信に失敗した場合

HttpResponseException - HTTP通信のレスポンスが不正だった場合

Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合

OAuthClientException - OAuth関連の処理に失敗した場合

ProviderSettingException - プロバイダ設定が不正だった場合

lastModifiedUserName

public String lastModifiedUserName()
                            throws HttpRequestException,
                                   HttpResponseException,
                                   Office365APIResponseException,
                                   OAuthClientException,
                                   ProviderSettingException

このストレージが示すファイルを最後に変更したOffice365上でのユーザ名を返します。

戻り値:

最後に変更したユーザ名

例外:

HttpRequestException - HTTP通信に失敗した場合

HttpResponseException - HTTP通信のレスポンスが不正だった場合

Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合

OAuthClientException - OAuth関連の処理に失敗した場合

ProviderSettingException - プロバイダ設定が不正だった場合

length

public long length()
            throws HttpRequestException,
                   HttpResponseException,
                   Office365APIResponseException,
                   OAuthClientException,
                   ProviderSettingException

このストレージが指定されているファイルの長さを返します。パス名にディレクトリが指定されている場合、戻り値は指定されません。

定義:

length インタフェース内 Storage<SharePointStorage>

戻り値:

このストレージが示すファイルの長さ (バイト単位)。ファイルが存在しない場合は 0L。

例外:

HttpRequestException - HTTP通信に失敗した場合

HttpResponseException - HTTP通信のレスポンスが不正だった場合

Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合

OAuthClientException - OAuth関連の処理に失敗した場合

ProviderSettingException - プロバイダ設定が不正だった場合

list

public Collection<String> list()
                        throws HttpRequestException,
                               HttpResponseException,
                               Office365APIResponseException,
                               ProviderSettingException,
                               OAuthClientException,
                               IOException

このストレージが示すディレクトリの配下にあるファイル、および、ディレクトリのパスのコレクションを返します。
パスは、このストレージのパスからの相対パスです。
このメソッドは、list(false)と動作は一緒です。

定義:

list インタフェース内 Storage<SharePointStorage>

戻り値:

このストレージが示すディレクトリの配下にあるファイル、および、ディレクトリの相対パスのコレクション。コレクションは、ディレクトリが空の場合は空になります。このストレージがディレクトリを示さない場合は null

例外:

HttpRequestException - HTTP通信に失敗した場合

HttpResponseException - HTTP通信のレスポンスが不正だった場合

Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合

OAuthClientException - OAuth関連の処理に失敗した場合

ProviderSettingException - プロバイダ設定が不正だった場合

IOException - 取得に失敗した場合

list

public Collection<String> list(boolean recursive)
                        throws HttpRequestException,
                               HttpResponseException,
                               Office365APIResponseException,
                               ProviderSettingException,
                               OAuthClientException,
                               IOException

このストレージが示すディレクトリの配下にあるファイル、および、ディレクトリのパスのコレクションを返します。
パスは、このストレージのパスからの相対パスです。

 ROOT
 ┗directory-1
   ┗directory-1-1
     ┣directory-1-1-1
     ┃┣directory-1-1-1-1
     ┃┗file-1-1-1-2
     ┣directory-1-1-2
     ┣file-1-1-3
     ┗file-1-1-4
 

上記のようなファイル構成である場合、
directory-1-1に対してlist(false)を実行した場合の戻り値は以下の通りです。

• directory-1-1-1
• directory-1-1-2
• file-1-1-3
• file-1-1-4

directory-1-1に対してlist(true)を実行した場合の戻り値は以下の通りです。

• directory-1-1-1
• directory-1-1-1/directory-1-1-1-1
• directory-1-1-1/file-1-1-1-2
• directory-1-1-2
• file-1-1-3
• file-1-1-4

定義:

list インタフェース内 Storage<SharePointStorage>

パラメータ:

recursive - ディレクトリを再帰的に探索する場合は true、そうでない場合は false

戻り値:

このストレージが示すディレクトリの配下にあるファイル、および、ディレクトリの相対パスのコレクション。コレクションは、ディレクトリが空の場合は空になります。このストレージがディレクトリを示さない場合は null

例外:

HttpRequestException - HTTP通信に失敗した場合

HttpResponseException - HTTP通信のレスポンスが不正だった場合

Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合

OAuthClientException - OAuth関連の処理に失敗した場合

ProviderSettingException - プロバイダ設定が不正だった場合

IOException - 取得に失敗した場合

list

public Collection<String> list(StoragenameFilter<SharePointStorage> filter)
                        throws HttpRequestException,
                               HttpResponseException,
                               Office365APIResponseException,
                               ProviderSettingException,
                               OAuthClientException,
                               IOException

このストレージが示すディレクトリにあるファイルおよびディレクトリの中で、指定されたフィルタの基準を満たすものの相対パスのコレクションを返します。

定義:

list インタフェース内 Storage<SharePointStorage>

パラメータ:

filter - ファイル名フィルタ

戻り値:

指定された filter によって受け入れられた、このストレージが示すディレクトリ内のファイル名およびディレクトリ名のコレクション。コレクションは、ディレクトリが空の場合またはフィルタがどの名前も受け入れない場合は空になる 。このストレージがディレクトリを示さない場合は null

例外:

HttpRequestException - HTTP通信に失敗した場合

HttpResponseException - HTTP通信のレスポンスが不正だった場合

Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合

OAuthClientException - OAuth関連の処理に失敗した場合

ProviderSettingException - プロバイダ設定が不正だった場合

IOException - 取得に失敗した場合

listStorages

public Collection<SharePointStorage> listStorages()
                                           throws HttpRequestException,
                                                  HttpResponseException,
                                                  Office365APIResponseException,
                                                  ProviderSettingException,
                                                  OAuthClientException,
                                                  IOException

このストレージが示すディレクトリ内のファイルおよびディレクトリを示すストレージのコレクションを返します。

定義:

listStorages インタフェース内 Storage<SharePointStorage>

戻り値:

このストレージが示すディレクトリ内のファイルおよびディレクトリを示すストレージのコレクション。コレクションは、ディレクトリが空の場合は空になります。このストレージがディレクトリを示さない場合は null

例外:

HttpRequestException - HTTP通信に失敗した場合

HttpResponseException - HTTP通信のレスポンスが不正だった場合

Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合

OAuthClientException - OAuth関連の処理に失敗した場合

ProviderSettingException - プロバイダ設定が不正だった場合

IOException - 取得に失敗した場合

listStorages

public Collection<SharePointStorage> listStorages(boolean recursive)
                                           throws HttpRequestException,
                                                  HttpResponseException,
                                                  Office365APIResponseException,
                                                  ProviderSettingException,
                                                  OAuthClientException,
                                                  IOException

このストレージが示すディレクトリ内のファイルおよびディレクトリを示すストレージのコレクションを返します。

定義:

listStorages インタフェース内 Storage<SharePointStorage>

パラメータ:

recursive - ディレクトリを再帰的に探索する場合は true、そうでない場合は false

戻り値:

このストレージが示すディレクトリ内のファイルおよびディレクトリを示すストレージのコレクション。コレクションは、ディレクトリが空の場合は空になります。このストレージがディレクトリを示さない場合は null

例外:

HttpRequestException - HTTP通信に失敗した場合

HttpResponseException - HTTP通信のレスポンスが不正だった場合

Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合

OAuthClientException - OAuth関連の処理に失敗した場合

ProviderSettingException - プロバイダ設定が不正だった場合

IOException - 取得に失敗した場合

listStorages

public Collection<SharePointStorage> listStorages(StorageFilter<SharePointStorage> filter)
                                           throws HttpRequestException,
                                                  HttpResponseException,
                                                  Office365APIResponseException,
                                                  ProviderSettingException,
                                                  OAuthClientException,
                                                  IOException

このストレージが示すディレクトリにあるファイルおよびディレクトリの中で、指定されたフィルタの基準を満たすもののストレージのコレクションを返します。

定義:

listStorages インタフェース内 Storage<SharePointStorage>

パラメータ:

filter - ファイルフィルタ

戻り値:

このストレージが示すディレクトリ内のファイルおよびディレクトリを示すストレージのコレクション。コレクションは、ディレクトリが空の場合は空になります。このストレージがディレクトリを示さない場合は null

例外:

HttpRequestException - HTTP通信に失敗した場合

HttpResponseException - HTTP通信のレスポンスが不正だった場合

Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合

OAuthClientException - OAuth関連の処理に失敗した場合

ProviderSettingException - プロバイダ設定が不正だった場合

IOException - 取得に失敗した場合

listStorages

public Collection<SharePointStorage> listStorages(StoragenameFilter<SharePointStorage> filter)
                                           throws HttpRequestException,
                                                  HttpResponseException,
                                                  Office365APIResponseException,
                                                  ProviderSettingException,
                                                  OAuthClientException,
                                                  IOException

このストレージが示すディレクトリにあるファイルおよびディレクトリの中で、指定されたフィルタの基準を満たすもののストレージのコレクションを返します。

定義:

listStorages インタフェース内 Storage<SharePointStorage>

パラメータ:

filter - ファイル名フィルタ

戻り値:

このストレージが示すディレクトリ内のファイルおよびディレクトリを示すストレージのコレクション。コレクションは、ディレクトリが空の場合は空になります。このストレージがディレクトリを示さない場合は null

例外:

HttpRequestException - HTTP通信に失敗した場合

HttpResponseException - HTTP通信のレスポンスが不正だった場合

Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合

OAuthClientException - OAuth関連の処理に失敗した場合

ProviderSettingException - プロバイダ設定が不正だった場合

IOException - 取得に失敗した場合

load

public byte[] load()
            throws IOException

インタフェースからコピーされた説明: Storage

このストレージの内容をバイト配列で取得します。

定義:

load インタフェース内 Storage<SharePointStorage>

戻り値:

ストレージの内容のバイト配列

例外:

IOException - 取得に失敗した場合

loadAs

public byte[] loadAs(String format)
              throws IOException

このストレージが示すファイルを指定した形式で開きます。
指定したフォーマット以外に追加のパラメータが必要な場合はフォーマット文字列に追加パラメータを追記してください。
例: "jpg&width=300&height=300"
指定できる形式は下記ドキュメントに記載されています。 Query string parameters

パラメータ:

format - フォーマット

戻り値:

指定した形式のファイルコンテンツ

例外:

IOException - 出力に失敗した場合

makeDirectories

public boolean makeDirectories()
                        throws HttpRequestException,
                               HttpResponseException,
                               Office365APIResponseException,
                               APIOperationException,
                               OAuthClientException,
                               ProviderSettingException,
                               IOException

このストレージが示すディレクトリを生成します。

定義:

makeDirectories インタフェース内 Storage<SharePointStorage>

戻り値:

必要なすべての親ディレクトリを含めてディレクトリが生成された場合は true、そうでない場合は false

例外:

HttpRequestException - HTTP通信に失敗した場合

HttpResponseException - HTTP通信のレスポンスが不正だった場合

Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合

OAuthClientException - OAuth関連の処理に失敗した場合

APIOperationException - 禁止されている操作が行われた場合

ProviderSettingException - プロバイダ設定が不正だった場合

IOException - 作成に失敗した場合

move

public boolean move(CharSequence newPath)
             throws HttpRequestException,
                    HttpResponseException,
                    Office365APIResponseException,
                    APIOperationException,
                    OAuthClientException,
                    ProviderSettingException,
                    FileNotFoundException,
                    IOException

このストレージが示すファイルを移動します。

定義:

move インタフェース内 Storage<SharePointStorage>

パラメータ:

newPath - このストレージの新しいパス

戻り値:

移動が成功した場合は true、そうでない場合は false

例外:

HttpRequestException - HTTP通信に失敗した場合

HttpResponseException - HTTP通信のレスポンスが不正だった場合

Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合

OAuthClientException - OAuth関連の処理に失敗した場合

ProviderSettingException - プロバイダ設定が不正だった場合

FileNotFoundException - コピー対象が存在しない場合

APIOperationException - 禁止されている操作が実行された場合

IOException - 移動に失敗した場合

open

public InputStream open()
                 throws IOException

インタフェースからコピーされた説明: Storage

このストレージの入力ストリームを取得します。

定義:

open インタフェース内 Storage<SharePointStorage>

戻り値:

入力ストリーム

例外:

IOException - 入力ストリームの取得に失敗した場合

openAs

public InputStream openAs(String format)
                   throws IOException

このストレージが示すファイルを指定した形式で開きます。
指定したフォーマット以外に追加のパラメータが必要な場合はフォーマット文字列に追加パラメータを追記してください。
例: "jpg&width=300&height=300" 指定できる形式は下記ドキュメントに記載されています。
Query string parameters

パラメータ:

format - フォーマット

戻り値:

指定した形式に変換されたコンテンツ

例外:

IOException - 出力に失敗した場合

read

public String read()
            throws IOException

インタフェースからコピーされた説明: Storage

このストレージの内容を標準のキャラセットで変換し文字列で取得します。

定義:

read インタフェース内 Storage<SharePointStorage>

戻り値:

ストレージの内容の文字列

例外:

IOException - 取得に失敗した場合

read

public String read(Charset charset)
            throws IOException

インタフェースからコピーされた説明: Storage

このストレージの内容を指定されたキャラセットで変換し文字列で取得します。

定義:

read インタフェース内 Storage<SharePointStorage>

パラメータ:

charset - キャラセット

戻り値:

ストレージの内容の文字列

例外:

IOException - 取得に失敗した場合

read

public String read(String charsetName)
            throws IOException

インタフェースからコピーされた説明: Storage

このストレージの内容を指定されたキャラセット名で変換し文字列で取得します。

定義:

read インタフェース内 Storage<SharePointStorage>

パラメータ:

charsetName - キャラセット名

戻り値:

ストレージの内容の文字列

例外:

IOException - 取得に失敗した場合

remove

public boolean remove()
               throws HttpRequestException,
                      HttpResponseException,
                      Office365APIResponseException,
                      APIOperationException,
                      OAuthClientException,
                      ProviderSettingException,
                      IOException

このストレージが示すファイルまたはディレクトリを削除します。 このメソッドは再帰的な削除は行いません。

定義:

remove インタフェース内 Storage<SharePointStorage>

戻り値:

ファイルまたはディレクトリが正常に削除された場合は true、そうでない場合は false

例外:

HttpRequestException - HTTP通信に失敗した場合

HttpResponseException - HTTP通信のレスポンスが不正だった場合

Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合

OAuthClientException - OAuth関連の処理に失敗した場合

APIOperationException - 禁止されている操作が行われた場合

ProviderSettingException - プロバイダ設定が不正だった場合

IOException - 削除に失敗した場合

remove

public boolean remove(boolean recursive)
               throws HttpRequestException,
                      HttpResponseException,
                      Office365APIResponseException,
                      APIOperationException,
                      OAuthClientException,
                      ProviderSettingException,
                      IOException

このストレージが示すファイルまたはディレクトリを削除します。

定義:

remove インタフェース内 Storage<SharePointStorage>

パラメータ:

recursive - 再帰的に削除する場合はtrueを指定してください

戻り値:

ファイルまたはディレクトリが正常に削除された場合は true、そうでない場合は false

例外:

HttpRequestException - HTTP通信に失敗した場合

HttpResponseException - HTTP通信のレスポンスが不正だった場合

Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合

OAuthClientException - OAuth関連の処理に失敗した場合

APIOperationException - 禁止されている操作が行われた場合

ProviderSettingException - プロバイダ設定が不正だった場合

IOException - 削除に失敗した場合

resolve

public SharePointStorage resolve(CharSequence other)
                          throws IOException

インタフェースからコピーされた説明: Storage

このストレージから相対ストレージを返します。

定義:

resolve インタフェース内 Storage<SharePointStorage>

パラメータ:

other - このストレージからの相対パス

戻り値:

このストレージからの相対ストレージ

例外:

IOException - 相対ストレージの取得に失敗した場合

save

public void save(byte[] byteArray)
          throws IOException

インタフェースからコピーされた説明: Storage

バイト配列をこのストレージに書き込みます。

定義:

save インタフェース内 Storage<SharePointStorage>

パラメータ:

byteArray - バイト配列

例外:

IOException - 書き込みに失敗した場合

toString

public String toString()

オーバーライド:

toString クラス内 Object

updateListItemFields

public Map<String,Object> updateListItemFields(Map<String,Object> fields)
                                        throws HttpResponseException,
                                               OAuthClientException,
                                               ProviderSettingException,
                                               HttpRequestException

このストレージが示すファイルに対するリストアイテムのフィールドを更新します。
パスが指す場所に何も存在しない場合はnullを返します。

戻り値:

ファイル対するリストアイテムの持つフィールド情報

例外:

HttpRequestException - HTTP通信に失敗した場合

HttpResponseException - HTTP通信のレスポンスが不正だった場合

Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合

OAuthClientException - OAuth関連の処理に失敗した場合

ProviderSettingException - プロバイダ設定が不正だった場合

write

public void write(CharSequence src)
           throws IOException

インタフェースからコピーされた説明: Storage

文字列を標準のキャラセットでこのストレージに書き込みます。

定義:

write インタフェース内 Storage<SharePointStorage>

パラメータ:

src - 文字列

例外:

IOException - 書き込みに失敗した場合

write

public void write(CharSequence src,
                  Charset charset)
           throws IOException

インタフェースからコピーされた説明: Storage

文字列を指定されたキャラセットでこのストレージに書き込みます。

定義:

write インタフェース内 Storage<SharePointStorage>

パラメータ:

src - 文字列

charset - キャラセット

例外:

IOException - 書き込みに失敗した場合

write

public void write(CharSequence src,
                  String charsetName)
           throws IOException

インタフェースからコピーされた説明: Storage

文字列を指定されたキャラセット名でこのストレージに書き込みます。

定義:

write インタフェース内 Storage<SharePointStorage>

パラメータ:

src - 文字列

charsetName - キャラセット名

例外:

IOException - 書き込みに失敗した場合