FilesOperation (javadoc-all-dev 8.0.0 API)

java.lang.Object
- jp.co.intra_mart.foundation.office365.api.v1_0.files.operation.FilesOperation

非推奨です。
```
@Deprecated
public class FilesOperation
extends Object
```
Office365 Files REST API操作を行います。このAPIでは、チームサイト上のドキュメントを対象とします。
このAPIを利用するためには以下の前提条件を満たしている必要があります。
- intra-mart Accel Platformのユーザに対応するOffice365ユーザが存在すること
- Microsoft Azure にてアプリケーションが登録・設定されていること
- OAuth プロバイダ設定ファイルにOffice 365 連携を行うための設定が記述されていること
上記の設定方法については Office 365 連携セットアップガイドを参照してください。
コンストラクタで指定するプロバイダIDには、上記OAuth プロバイダ設定ファイルにてOffice 365 連携用に設定したプロバイダIDを指定してください。
サイトパスにはこのAPIでドキュメントを扱う Office 365 SharePoint Online 上のサイトパスを指定します。
ユーザコードはOffice 365へアクセスを行う intra-mart Accel Platform ユーザのユーザコードを指定します。
Office 365 SharePoint Online へアクセスを行う前に、「外部連携アプリケーション」画面にて該当のアプリケーションの利用を許可してください。この操作はアクセスする各ユーザ毎に必要です。
アプリケーションの利用許可が行われていない状態でAPIを実行した場合 OAuthPreconditionException が発生します。

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

8.0.1

バージョン:

8.0.2

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

コンストラクタ
コンストラクタと説明
`FilesOperation(String userCd, String providerId)` 非推奨です。コンストラクタ
`FilesOperation(String userCd, String providerId, String sitePath)` 非推奨です。コンストラクタ

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド非推奨のメソッド
修飾子とタイプ	メソッドと説明
`Item`	`copyById(String id, CopyToItemProperty properties)` 非推奨です。 IDを指定してアイテムをコピーします。
`Item`	`copyByPath(String path, CopyToItemProperty properties)` 非推奨です。パスを指定してアイテムをコピーします。
`File`	`createFile(String name)` 非推奨です。ファイルを作成します。
`Folder`	`createFolderById(String parentId, String folderName)` 非推奨です。親フォルダIDとフォルダ名を指定してフォルダを作成します。
`Folder`	`createFolderByPath(String folderPath)` 非推奨です。パスを指定してフォルダを作成します。
`void`	`deleteById(String id, String eTag)` 非推奨です。 IDを指定してアイテムを削除します。
`void`	`deleteByPath(String path, String eTag)` 非推奨です。パスを指定してアイテムを削除します。
`void`	`downloadById(String id, OutputStream stream)` 非推奨です。 IDを指定してファイルの内容をダウンロードします。
`void`	`downloadByPath(String path, OutputStream stream)` 非推奨です。パスを指定してファイルの内容をダウンロードします。
`Item`	`getPropertiesById(String id, boolean withChildren)` 非推奨です。 IDを指定してアイテムのプロパティ情報を取得します。
`Item`	`getPropertiesByPath(String path, boolean withChildren)` 非推奨です。パスを指定してアイテムのプロパティ情報を取得します。
`Item[]`	`listContentsById(String id, boolean descending)` 非推奨です。 IDを指定して保持する子のアイテム一覧を取得します。
`Item[]`	`listContentsByPath(String path, boolean descending)` 非推奨です。パスを指定して保持する子のアイテム一覧を取得します。
`Item`	`updatePropertiesById(String id, String eTag, UpdatableItemProperty properties)` 非推奨です。 IDを指定してアイテムのメタ情報を更新します。
`Item`	`updatePropertiesByPath(String path, String eTag, UpdatableItemProperty properties)` 非推奨です。パスを指定してアイテムのメタ情報を更新します。
`void`	`uploadById(String fileId, InputStream stream)` 非推奨です。 IDを指定してファイルの内容をアップロードします。
`void`	`uploadByPath(String filePath, InputStream stream)` 非推奨です。パスを指定してファイルの内容をアップロードします。

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクタの詳細
  - FilesOperation
```
public FilesOperation(String userCd,
                      String providerId)
               throws ProviderSettingException
```
    非推奨です。
    
    コンストラクタ
    
    パラメータ:
    
    userCd - ユーザコード
    
    providerId - プロバイダID
    
    例外:
    
    ProviderSettingException - プロバイダ設定が不正であった場合に発生します。
  - FilesOperation
```
public FilesOperation(String userCd,
                      String providerId,
                      String sitePath)
               throws ProviderSettingException
```
    非推奨です。
    
    コンストラクタ
    
    パラメータ:
    
    userCd - ユーザコード
    
    providerId - プロバイダID
    
    sitePath - サイトパス。トップサイトの場合はnullを指定します。
    
    例外:
    
    ProviderSettingException - プロバイダ設定が不正であった場合に発生します。
- メソッドの詳細
  - copyById
```
public Item copyById(String id,
                     CopyToItemProperty properties)
              throws HttpRequestException,
                     HttpResponseException,
                     Office365APIResponseException,
                     OAuthClientException
```
    非推奨です。
    
    IDを指定してアイテムをコピーします。
    
    パラメータ:
    
    id - ID
    
    properties - 変更を行うプロパティ
    
    戻り値:
    
    コピーされたアイテム
    
    例外:
    
    HttpRequestException - HTTP通信に失敗した場合に発生します。
    
    HttpResponseException - HTTP通信のレスポンスが不正だった場合に発生します
    
    Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合に発生します
    
    OAuthClientException - OAuth関連の処理に失敗した場合に発生します
  - copyByPath
```
public Item copyByPath(String path,
                       CopyToItemProperty properties)
                throws HttpRequestException,
                       HttpResponseException,
                       Office365APIResponseException,
                       OAuthClientException
```
    非推奨です。
    
    パスを指定してアイテムをコピーします。
    
    パラメータ:
    
    path - パス
    
    properties - 変更を行うプロパティ
    
    戻り値:
    
    コピーされたアイテム
    
    例外:
    
    HttpRequestException - HTTP通信に失敗した場合に発生します。
    
    HttpResponseException - HTTP通信のレスポンスが不正だった場合に発生します
    
    Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合に発生します
    
    OAuthClientException - OAuth関連の処理に失敗した場合に発生します
  - createFile
```
public File createFile(String name)
                throws HttpRequestException,
                       HttpResponseException,
                       Office365APIResponseException,
                       OAuthClientException
```
    非推奨です。
    
    ファイルを作成します。
    
    パラメータ:
    
    name - ファイル名
    
    戻り値:
    
    作成したファイル
    
    例外:
    
    HttpRequestException - HTTP通信に失敗した場合に発生します。
    
    HttpResponseException - HTTP通信のレスポンスが不正だった場合に発生します
    
    Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合に発生します
    
    OAuthClientException - OAuth関連の処理に失敗した場合に発生します
  - createFolderById
```
public Folder createFolderById(String parentId,
                               String folderName)
                        throws HttpRequestException,
                               HttpResponseException,
                               Office365APIResponseException,
                               OAuthClientException
```
    非推奨です。
    
    親フォルダIDとフォルダ名を指定してフォルダを作成します。
    
    パラメータ:
    
    parentId - 親ID
    
    folderName - フォルダ名
    
    戻り値:
    
    作成したフォルダ
    
    例外:
    
    HttpRequestException - HTTP通信に失敗した場合に発生します。
    
    HttpResponseException - HTTP通信のレスポンスが不正だった場合に発生します
    
    Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合に発生します
    
    OAuthClientException - OAuth関連の処理に失敗した場合に発生します
  - createFolderByPath
```
public Folder createFolderByPath(String folderPath)
                          throws HttpRequestException,
                                 HttpResponseException,
                                 Office365APIResponseException,
                                 OAuthClientException
```
    非推奨です。
    
    パスを指定してフォルダを作成します。
    
    パラメータ:
    
    folderPath - フォルダパス
    
    戻り値:
    
    作成したフォルダ
    
    例外:
    
    HttpRequestException - HTTP通信に失敗した場合に発生します。
    
    HttpResponseException - HTTP通信のレスポンスが不正だった場合に発生します
    
    Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合に発生します
    
    OAuthClientException - OAuth関連の処理に失敗した場合に発生します
  - deleteById
```
public void deleteById(String id,
                       String eTag)
                throws HttpRequestException,
                       HttpResponseException,
                       Office365APIResponseException,
                       OAuthClientException
```
    非推奨です。
    
    IDを指定してアイテムを削除します。
    
    パラメータ:
    
    id - ID
    
    eTag - ETag
    
    例外:
    
    HttpRequestException - HTTP通信に失敗した場合に発生します。
    
    HttpResponseException - HTTP通信のレスポンスが不正だった場合に発生します
    
    Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合に発生します
    
    OAuthClientException - OAuth関連の処理に失敗した場合に発生します
  - deleteByPath
```
public void deleteByPath(String path,
                         String eTag)
                  throws HttpRequestException,
                         HttpResponseException,
                         Office365APIResponseException,
                         OAuthClientException
```
    非推奨です。
    
    パスを指定してアイテムを削除します。
    
    パラメータ:
    
    path - パス
    
    eTag - ETag
    
    例外:
    
    HttpRequestException - HTTP通信に失敗した場合に発生します。
    
    HttpResponseException - HTTP通信のレスポンスが不正だった場合に発生します
    
    Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合に発生します
    
    OAuthClientException - OAuth関連の処理に失敗した場合に発生します
  - downloadById
```
public void downloadById(String id,
                         OutputStream stream)
                  throws HttpRequestException,
                         HttpResponseException,
                         Office365APIResponseException,
                         OAuthClientException,
                         IOException
```
    非推奨です。
    
    IDを指定してファイルの内容をダウンロードします。
    
    パラメータ:
    
    id - ID
    
    stream - ファイルの内容を書き込むストリーム
    
    例外:
    
    HttpRequestException - HTTP通信に失敗した場合に発生します。
    
    HttpResponseException - HTTP通信のレスポンスが不正だった場合に発生します
    
    Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合に発生します
    
    OAuthClientException - OAuth関連の処理に失敗した場合に発生します
    
    IOException - ストリーム処理に失敗した場合に発生します
  - downloadByPath
```
public void downloadByPath(String path,
                           OutputStream stream)
                    throws HttpRequestException,
                           HttpResponseException,
                           Office365APIResponseException,
                           OAuthClientException,
                           IOException
```
    非推奨です。
    
    パスを指定してファイルの内容をダウンロードします。
    
    パラメータ:
    
    path - パス
    
    stream - ファイルの内容を書き込むストリーム
    
    例外:
    
    HttpRequestException - HTTP通信に失敗した場合に発生します。
    
    HttpResponseException - HTTP通信のレスポンスが不正だった場合に発生します
    
    Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合に発生します
    
    OAuthClientException - OAuth関連の処理に失敗した場合に発生します
    
    IOException - ストリーム処理に失敗した場合に発生します
  - getPropertiesById
```
public Item getPropertiesById(String id,
                              boolean withChildren)
                       throws HttpRequestException,
                              HttpResponseException,
                              Office365APIResponseException,
                              OAuthClientException
```
    非推奨です。
    
    IDを指定してアイテムのプロパティ情報を取得します。
    
    パラメータ:
    
    id - ID
    
    withChildren - 内包するアイテム情報を取得するか
    
    戻り値:
    
    アイテムのプロパティ
    
    例外:
    
    HttpRequestException - HTTP通信に失敗した場合に発生します。
    
    HttpResponseException - HTTP通信のレスポンスが不正だった場合に発生します
    
    Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合に発生します
    
    OAuthClientException - OAuth関連の処理に失敗した場合に発生します
  - getPropertiesByPath
```
public Item getPropertiesByPath(String path,
                                boolean withChildren)
                         throws HttpRequestException,
                                HttpResponseException,
                                Office365APIResponseException,
                                OAuthClientException
```
    非推奨です。
    
    パスを指定してアイテムのプロパティ情報を取得します。
    
    パラメータ:
    
    path - パス
    
    withChildren - 内包するアイテム情報を取得するか
    
    戻り値:
    
    アイテムのプロパティ
    
    例外:
    
    HttpRequestException - HTTP通信に失敗した場合に発生します。
    
    HttpResponseException - HTTP通信のレスポンスが不正だった場合に発生します
    
    Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合に発生します
    
    OAuthClientException - OAuth関連の処理に失敗した場合に発生します
  - listContentsById
```
public Item[] listContentsById(String id,
                               boolean descending)
                        throws HttpRequestException,
                               HttpResponseException,
                               Office365APIResponseException,
                               OAuthClientException
```
    非推奨です。
    
    IDを指定して保持する子のアイテム一覧を取得します。
    
    パラメータ:
    
    id - ID
    
    descending - 降順でソートするか
    
    戻り値:
    
    アイテム一覧
    
    例外:
    
    HttpRequestException - HTTP通信に失敗した場合に発生します。
    
    HttpResponseException - HTTP通信のレスポンスが不正だった場合に発生します
    
    Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合に発生します
    
    OAuthClientException - OAuth関連の処理に失敗した場合に発生します
  - listContentsByPath
```
public Item[] listContentsByPath(String path,
                                 boolean descending)
                          throws HttpRequestException,
                                 HttpResponseException,
                                 Office365APIResponseException,
                                 OAuthClientException
```
    非推奨です。
    
    パスを指定して保持する子のアイテム一覧を取得します。
    
    パラメータ:
    
    path - パス
    
    descending - 降順でソートするか
    
    戻り値:
    
    アイテム一覧
    
    例外:
    
    HttpRequestException - HTTP通信に失敗した場合に発生します。
    
    HttpResponseException - HTTP通信のレスポンスが不正だった場合に発生します
    
    Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合に発生します
    
    OAuthClientException - OAuth関連の処理に失敗した場合に発生します
  - updatePropertiesById
```
public Item updatePropertiesById(String id,
                                 String eTag,
                                 UpdatableItemProperty properties)
                          throws HttpRequestException,
                                 HttpResponseException,
                                 Office365APIResponseException,
                                 OAuthClientException
```
    非推奨です。
    
    IDを指定してアイテムのメタ情報を更新します。
    
    パラメータ:
    
    id - ID
    
    eTag - ETag
    
    properties - メタ情報
    
    戻り値:
    
    更新されたアイテム
    
    例外:
    
    HttpRequestException - HTTP通信に失敗した場合に発生します。
    
    HttpResponseException - HTTP通信のレスポンスが不正だった場合に発生します
    
    Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合に発生します
    
    OAuthClientException - OAuth関連の処理に失敗した場合に発生します
  - updatePropertiesByPath
```
public Item updatePropertiesByPath(String path,
                                   String eTag,
                                   UpdatableItemProperty properties)
                            throws HttpRequestException,
                                   HttpResponseException,
                                   Office365APIResponseException,
                                   OAuthClientException
```
    非推奨です。
    
    パスを指定してアイテムのメタ情報を更新します。
    
    パラメータ:
    
    path - パス
    
    eTag - ETag
    
    properties - メタ情報
    
    戻り値:
    
    更新されたアイテム
    
    例外:
    
    HttpRequestException - HTTP通信に失敗した場合に発生します。
    
    HttpResponseException - HTTP通信のレスポンスが不正だった場合に発生します
    
    Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合に発生します
    
    OAuthClientException - OAuth関連の処理に失敗した場合に発生します
  - uploadById
```
public void uploadById(String fileId,
                       InputStream stream)
                throws HttpRequestException,
                       HttpResponseException,
                       Office365APIResponseException,
                       OAuthClientException,
                       IOException
```
    非推奨です。
    
    IDを指定してファイルの内容をアップロードします。
    
    パラメータ:
    
    fileId - ファイルID
    
    stream - ファイルの内容
    
    例外:
    
    HttpRequestException - HTTP通信に失敗した場合に発生します。
    
    HttpResponseException - HTTP通信のレスポンスが不正だった場合に発生します
    
    Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合に発生します
    
    OAuthClientException - OAuth関連の処理に失敗した場合に発生します
    
    IOException - ストリーム処理に失敗した場合に発生します
  - uploadByPath
```
public void uploadByPath(String filePath,
                         InputStream stream)
                  throws HttpRequestException,
                         HttpResponseException,
                         Office365APIResponseException,
                         OAuthClientException,
                         IOException
```
    非推奨です。
    
    パスを指定してファイルの内容をアップロードします。
    
    パラメータ:
    
    filePath - ファイルパス
    
    stream - ファイルの内容
    
    例外:
    
    HttpRequestException - HTTP通信に失敗した場合に発生します。
    
    HttpResponseException - HTTP通信のレスポンスが不正だった場合に発生します
    
    Office365APIResponseException - 操作の失敗を表すOffice365レスポンスが返った場合に発生します
    
    OAuthClientException - OAuth関連の処理に失敗した場合に発生します
    
    IOException - ストリーム処理に失敗した場合に発生します

クラス FilesOperation

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

メソッドのサマリー

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

コンストラクタの詳細

FilesOperation

FilesOperation

メソッドの詳細

copyById

copyByPath

createFile

createFolderById

createFolderByPath

deleteById

deleteByPath

downloadById

downloadByPath

getPropertiesById

getPropertiesByPath

listContentsById

listContentsByPath

updatePropertiesById

updatePropertiesByPath

uploadById

uploadByPath