Box Connector のバージョン 5.x へのアップグレードおよび移行 - Mule 4

新しい機能を利用するには、Box 用 Anypoint Connector (Box Connector) をバージョン 4.x からバージョン 5.x にアップグレードします。

サポートされているアップグレードパス

開始バージョン 終了バージョン

4.x.x

5.x.x

このリリースでの変更

  • すべてのコネクタ操作のプレフィックスが ​mule-box-connector​ から ​box​ に変更されました。

  • OAuth 2.0 設定の XML 構造が変更されました。

    以前のリリースでは、OAuth 2.0 接続要素の XML は次のようになっていました。

    <mule-box-connector:config
    	name="Mule_box_connector_Config"
    	doc:name="Mule-box-connector Config"
    	property_clientId="clientId"
    	property_clientSecret="secret"
    	property_localCallbackConfig="HTTP_Listener_config"
    	property_host="api.box.com"
    	property_port="4439"
    	property_basePath="/2.0"
    	property_protocol="HTTPS"
    	property_responseTimeout="10000"
    	property_localCallbackPath="/callback"
    	property_externalCallbackUrl="http://my-app.cloudhub.io/callback"
    	property_localAuthorizationUrl="http://localhost:8081/authorize"
    	property_authorizationUrl="https://account.box.com/api/oauth2/authorize"
    	property_accessTokenUrl="https://api.box.com/oauth2/token"
    />
    xml

    最新リリースでは、XML は次のようになっています。

    <box:config name="Box_Connector_Config" doc:name="Box Connector Config" >
    	<box:oauth2security-connection >
    		<box:oauth-authorization-code
    			consumerKey="consumerKey"
    			consumerSecret="consumerSecret"
    			authorizationUrl="https://account.box.com/api/oauth2/authorize"
    			accessTokenUrl="https://api.box.com/oauth2/token"
    			resourceOwnerId=“resourceownerId” />
    		<box:oauth-callback-config
    			listenerConfig="HTTP_Listener_config"
    			callbackPath="/callback"
    			authorizePath="/authorize"
    			externalCallbackUrl="http://localhost:8081/callback" />
    	</box:oauth2security-connection>
    </box:config>
    xml

新規操作

Box Connector 5.0 には、次のような新しい操作があります。

Box 操作 説明

ファイルのアップロード

ファイルを Box にアップロードします。ファイルが 50 MB よりも大きい場合、代わりに ​Create upload session​ 操作を使用します。

Get file information

ファイルに関する詳細情報を取得します。

Upload file version

ファイルのコンテンツを更新する POST 操作。ファイルが 50 MB よりも大きい場合、代わりに ​Create upload session​ 操作を使用します。

Create upload session

新しいファイルのアップロードセッションを作成します。この操作は、50 MB よりも大きいファイルをアップロードする場合に使用します。大きなアップロードを連続するパートにチャンクして、個別にアップロードします。パートは、並列でアップロードできます。

Get upload session

アップロードセッションに関する情報を返します。

List parts

これまでにアップロードセッションにアップロードされたチャンクのリストを返します。

Create upload session for existing file

既存のファイルのアップロードセッションを作成します。

Commit upload session

アップロードセッションを終了して、アップロードされたチャンクからファイルを作成します。

Upload part of file

ファイルのアップロードセッションのチャンクを更新します。

Remove upload session

アップロードセッションを中止して、すべてのデータアップロードを破棄します。

アップグレード前提条件

アップグレードを実行する前に、復元する必要がある場合に備えて、ファイル、データ、および設定のバックアップを作成する必要があります。

アップグレード手順

以下の手順でアップグレードを実行します。

  1. Anypoint Studio で、Mule プロジェクトを作成します。

  2. [Mule Palette (Mule パレット)]​ ビューで、​[Search in Exchange (Exchange 内を検索)]​ をクリックします。

  3. [Add Dependencies to Project (連動関係をプロジェクトに追加)]​ で、検索項目に「​box​」と入力します。

  4. [Available modules (使用可能なモジュール)]​ で ​[Box Connector Config (Box Connector 設定)]​ を選択し、​[Add (追加)]​ をクリックします。

  5. [Finish (完了)]​ をクリックします。

  6. Mule プロジェクトの ​pom.xml​ ファイルで Box Connector 連動関係のバージョンが 5.0.0 であることを確認します。

Studio はコネクタを自動的にアップグレードします。

アップグレードを確認する

コネクタの最新バージョンをインストールしたら、次の手順に従ってアップグレードを確認します。

  1. Studio の ​[Problems (問題)]​ または ​[Console (コンソール)]​ ビューでエラーがないことを確認します。

  2. プロジェクトの ​pom.xml​ ファイルに問題がないことを確認します。

アップグレードの復元

以前のバージョンの Box Connector に戻す必要がある場合、プロジェクトの ​pom.xml​ ファイルの ​5.0.0​ 連動関係バージョンを前のバージョンに変更します。

Anypoint Studio でプロジェクトの ​pom.xml​ ファイルを更新する必要があります。