FW ファイルアップロードダウンロード機能利用ガイド Version 年 9 月 21 日富士通株式会社 i All Right Reserved, Copyright FUJITSU LIMITED

Size: px

Start display at page:

ゆきすえがら
5 years ago
Views:

1 FW ファイルアップロードダウンロード機能利用ガイド Version 年 9 月 21 日富士通株式会社 i

2 改訂履歴改訂 No. 日付 Version 章 No. 項 No. 改訂内容 /12/ 新規作成 /09/ text/plan を text/plain に修正章立てを修正 ii

3 目次第 1 章はじめに... 1 第 2 章ファイルアップロード機能... 2 第 3 章ファイルダウンロード機能... 3 第 4 章作業詳細リクエストの送信... 4 メソッド... 4 ヘッダ... 4 multipart の内部構造レスポンスの受信... 6 ヘッダ... 6 ボディ部フレームワーク定義の設定... 7 定義ファイル SIMPLEEVENTFLOW 定義の編集業務処理の実装... 9 実行対象のメソッドの引数設定... 9 業務処理の実装アップロードファイルの情報を取得し業務処理を実装する例ダウンロードファイル情報を返却するための処理を実装する例 iii

4 第 1 章はじめに本資料はファイルのアップロードダウンロード機能の利用方法について説明します 1

第 2 章ファイルアップロード機能ファイルアップロード機能は http リクエストにファイルデータを設定し対応する業務処理に連携することでファイルのアップロードを実現するための機能ですファイルアップロード処理時に対象のファイルに問題がないか以下のチェックを行いますチェックで問題となった場合は http レスポンスにエラーコードを返却し処理を中断しますチェック項目デフォルト値備考

5 第 2 章ファイルアップロード機能ファイルアップロード機能は http リクエストにファイルデータを設定し対応する業務処理に連携することでファイルのアップロードを実現するための機能ですファイルアップロード処理時に対象のファイルに問題がないか以下のチェックを行いますチェックで問題となった場合は http レスポンスにエラーコードを返却し処理を中断しますチェック項目デフォルト値備考ファイルのアップロード数の上限チェック 100 個フレームワーク定義で任意設定可能ですアップロードファイルの単体ファイルサイズチェックバイトフレームワーク定義で任意設定可能ですアップロードファイルの1リクエストに対する全体サイズチェックバイトフレームワーク定義で任意設定可能ですクライアントフレームワークプラグイン業務処理でファイルアップロード機能として必要な作業は以下の通りです作業を行う箇所必要となる作業説明備考クライアントリクエストの送信 http リクエストでファイルデータを含むデータを送信します送信するデータ形式は FW の指定したインターフェースで設定してくださいフレームワークフレームワーク定義の設定フレームワークの共通設定を定義している定義ファイル (xframeworkconfig.xml) にファイルアップロードダウンロード処理に関連する値を設定しますプラグイン SimpleEventFlow 定義の編集 FW プラグインの SimpleEventFlow デザイナーにて SimpleEventFlow 定義の編集を行いますモデルベースオブジェクト (MBC) のパラメーターリストに BPM_CONTEXT を定義します業務処理業務処理の実装モデルオブジェクトクラス (MBC) にて IBPMContext よりアップロードファイルに関連する値を取得する処理を実装します取得した IBPMContext よりアップロードファイル情報を取得しアップロード処理を実装しますフレームワークの定義ファイルについては別紙 FW 全体定義体ガイドを参照してください SimpleEventFlow 定義 SimpleEventFlow デザイナーと関連する用語については別紙 SimpleEventFlow 定義ツールマニュアルを参照してくださいファイルアップロード機能に関連する機能配置の概要は以下の通りですクライアントフレームワーク BPM IBPMContext モデルオブジェクト (MBC) 業務処理 HTTP リクエストにファイルのデータを設定し送信します multipart 形式により複数ファイルを送信できますフレームワーク定義 (xframeworkconfig.xml) プラグイン (BPM 資産の自動生成 ) SimpleEventFlow 定義 2

6 第 3 章ファイルダウンロード機能ファイルダウンロード機能は http レスポンスに業務処理で書き込んだファイルの情報を返却することでファイルのダウンロードを実現するための機能ですリクエストについてはフレームワークで許可している GET,POST,PUT,DELETE のメソッドが使用可能ですクライアントフレームワークプラグイン業務処理でファイルダウンロード機能として必要な作業は以下の通りです作業を行う箇所必要となる作業説明備考クライアントレスポンスの受信 http レスポンスで FW が設定したファイルデータを受信しますフレームワークフレームワーク定義の設定フレームワークの共通設定を定義している定義ファイルにファイルアップロードダウンロード処理に関連する値を設定しますプラグイン SimpleEventFlow 定義の編集 FW プラグインの SimpleEventFlow デザイナーにて SimpleEventFlow 定義の編集を行いますモデルベースオブジェクト (MBC) のパラメーターリストに BPM_CONTEXT を定義します業務処理業務処理の実装モデルベースオブジェクトクラス (MBC) にて IBPMContext より値を取得する処理を実装します取得した IBPMContext よりアップロードファイル情報を取得しアップロード処理を実装しますフレームワークの定義ファイルについては別紙 FW 全体定義体ガイドを参照してください SimpleEventFlow 定義 SimpleEventFlow デザイナーと関連する用語については別紙 SimpleEventFlow 定義ツールマニュアルを参照してくださいファイルダウンロード機能に関連する機能配置の概要は以下の通りですクライアントフレームワークファイルのデータが設定されている http レスポンスを受信しますファイルは 1 レスポンスにつき 1 ファイルのみ設定されています BPM IBPMContext モデルオブジェクト (MBC) 業務処理フレームワーク定義 (xframeworkconfig.xml) プラグイン (BPM 資産の自動生成 ) SimpleEventFlow 定義 3

7 第 4 章作業詳細各作業の詳細を以下に示します 4.1 リクエストの送信ファイルアップロードを行う際の http リクエストのインターフェースを以下に示しますメソッド POST と PUT が使用可能ですヘッダファイルアップロードに関連する http リクエストヘッダの形式は以下の通りですフィールド設定説明設定必須 / 任意 Content-Type: multipart/form-data; boundary=[ バウンダリ文字列 ] ファイルアップロード処理ではマルチパートの形式で受信することを想定しているため必須 Content-Type には "multipart/form-data" を設定してください備考 multipart の内部構造内部構造は http の multipart 形式の記述に準拠してください multipart 形式の http リクエストについてボディ部の設定は下記の通りに設定します 1 バウンダリ区切り 1 件目のデータのヘッダとボディ部構造バウンダリ区切り 1 件目に IF データ定義にて定義した Json 形式のデータを設定しますヘッダの形式は以下の通りですフィールド設定説明設定必須 / 任意 Content-Type: application/json バウンダリの1 区切り目は IF データ定義の形式で受信することを想定しているため必須 "application/json" を設定してください備考ボディ部は IF データ定義の形式の Json データを設定します IF データ定義に対応する値を特に設定しない場合は {} ( 空設定 json の囲みのみ設定 ) をしてください ( しない場合はフレームワークエラーが発生します ) 2 バウンダリ区切り 2 件目以降のヘッダとボディ部構造バウンダリ区切り 2 件目以降にアップロードしたいファイルの情報を設定します関連するヘッダの形式は以下の通りですフィールド設定説明設定必須 / 任意 Content-Type:[ 任意の設定 ] アップロードファイルに対応する Content-Type と charset を設定してください任意ただし値の使用は業務処理に依存します Content-Disposition: Content-Disposition ヘッダの filename 引数に任意 filename=[ ファイル名 ] アップロードファイルに対応するファイル名を設定してくださいただし値の使用は業務処理に依存します備考ファイル名に日本語等マルチバイト文字を使用する場合は URLEncode を実施する必要がありますボディ部はファイルデータを設定しますボディ部の末尾にバウンダリの終了区切り (-- を末尾に設定 ) を設定してください 4

8 multipart の内部構造の例は以下の通りです IF データ定義の値有 http リクエストヘッダに Content-Type: multipart/form-data; boundary=fw_rest_server_handle_xf423f 1511E8D8EF が設定されている場合の内部構造です --FW_REST_SERVER_HANDLE_XF423F 1511E8D8EF Content-type: application/json { "string_hankaku" : "test", "string_zenkaku" : " テスト ", "lastupdate" : " ", "number_long" : 1, "number_decimal" : 1.1, "catalog_string" : "01", "catalog_nmber" : 0 } --FW_REST_SERVER_HANDLE_XF423F 1511E8D8EF Content-type: text/plain Content-Disposition: attachment; filename=uploadfile.txt IF データ定義に対応した Json 形式の値を設定しますバウンダリ区切り 2 区切り目以降はファイルの情報を設定しますファイルデータ箇所ファイルアップロードのデータ ( テキストベース ) --FW_REST_SERVER_HANDLE_XF423F 1511E8D8EF Content-type: text/plain Content-Disposition: attachment; filename=%e3%83%80%e3%82%a6%e3%83%b3%e3%83%ad%e3%83%bc%e3%83%89%e7%94%a8%e8%a9%a6%e9%a8%93%e3%83%95%e3%82%a1%e3%82%a4%e3%83%ab.txt ファイル名に日本語等マルチバイト文字を使用する場合は URLEncode を実施する必要がありますファイルアップロードのデータ ( テキストベース ) --FW_REST_SERVER_HANDLE_XF423F 1511E8D8EF バウンダリの終了区切り IF データ定義の値無 http リクエストヘッダに Content-Type: multipart/form-data; boundary=fw_rest_server_handle_xf423f 1511E8D8EF が設定されている場合の内部構造です IF データ定義の値が無い場合であってもバウンダリ区切り 1 件目は json を設定してくださいボディ部には {}( 空設定 ) を行ってください --FW_REST_SERVER_HANDLE_XF423F 1511E8D8EF Content-type: application/json {} --FW_REST_SERVER_HANDLE_XF423F 1511E8D8EF Content-type: text/plain Content-Disposition: attachment; filename=uploadfile.txt {} ( 空設定 ) をしてくださいファイルアップロードのデータ ( テキストベース ) --FW_REST_SERVER_HANDLE_XF423F 1511E8D8EF Content-type: text/plain Content-Disposition: attachment; filename=%e3%83%80%e3%82%a6%e3%83%b3%e3%83%ad%e3%83%bc%e3%83%89%e7%94%a8%e8%a9%a6%e9%a8%93%e3%83%95%e3%82%a1%e3%82%a4%e3%83%ab.txt ファイルアップロードのデータ ( テキストベース ) --FW_REST_SERVER_HANDLE_XF423F 1511E8D8EF

9 4.2 レスポンスの受信ファイルダウンロードを行う際の http レスポンスのインターフェースを以下に示しますヘッダファイルダウンロードに関連する http レスポンスヘッダは以下の通りですフィールド設定説明備考 Content-Disposition: attachment; filename=[ ファイル名 ] ダウンロードファイルのファイル名が設定されます業務処理でファイル名が設定されない場合は当フィールドは設定されません値の設定有無設定値については連携した業務処理に依存します 1Content-Type: [ コンテンツ種別 ] もしくは 2Content-Type: [ コンテンツ種別 ] ;charset=[ エンコード ] ダウンロードファイルのコンテンツ種別とエンコードが設定されます業務処理でコンテンツ種別やエンコードが設定されない場合は当フィールドは設定されません値の設定有無設定値については連携した業務処理に依存しますコンテンツ種別のみ業務処理で設定した場合は1 コンテンツ種別とエンコードを業務処理で設定した場合は2が設定されますボディ部ボディ部に設定されているストリームがファイルのデータとなります 6

10 4.3 フレームワーク定義の設定フレームワークで使用している定義ファイルにアップロード処理に関連する値を設定します設定内容を以下に示します定義ファイルファイル名 :xframeworkconfig.xml 概要 : フレームワークを構成するモジュールが共通で使用する定義体関連する領域の設定は以下の通りです値の詳細については別紙 FW 全体定義体ガイドを参照してください領域名 FILE_UTIL X71_SV_REQUEST_CHECKER X71_SV_REQUEST_CHECKER 定義名 temporary.file.path com.fujitsu.xframework.x71.server.check.httprequestsizechecker com.fujitsu.xframework.x71.server.check.httprequestcountchecker 7

11 4.4 SimpleEventFlow 定義の編集 SimpleEventFlow 定義のモデルベースオブジェクト (MBC) のプロパティパラメーターリストの格納 RP キーに BPM_CONTEXT を設定します格納 RP キーに BPM_CONTEXT を設定します呼び出し対象のメソッドの引数の順番と合わせる必要があります 8

12 4.5 業務処理の実装ファイルアップロードダウンロード処理で必要となる業務実装を以下に示します実行対象のメソッドの引数設定ファイルアップロードダウンロードの処理を行うクラスのインターフェース (IBPMContext) を実行対象メソッドのパラメータに追加します IBPMContext のインターフェースは下記の通りですクラス名機能概要 com.fujitsu.fw.parameter.context.ibpmcontext HTTP 連携で設定される情報について格納編集取得する機能提供します当資料ではファイルアップロードダウンロードに関する説明を記述しますメソッド名パラメータ返却値例外説明 getuploadfilessize 無 int 無処理概要アップロードファイル数を取得します返却値設定されたアップロードファイル数 getuploadfilecontents int index IUploadFileContents 無処理概要アップロードファイル情報 1を取得しますアップロードされた順序に対応した index を設定し取得できます設定されていない index を指定した場合は null を返却しますパラメータ index - ファイル設定位置 ( 位置は boundary で区切られたダウンロードファイルの順に 0 から始まります ) 返却値アップロードファイル情報 createdownloadfilecontents 無 IDownloadFileContents 無処理概要ダウンロードファイル情報 2を作成します返却値ダウンロードファイル情報 removedownloadfile 無無 com.fujitsu.fw.exception.frameworkexception 処理概要ダウンロードファイル情報を削除します 9

13 1: アップロードファイル情報 : アップロードファイルに関連する情報の取得機能を提供するクラスインターフェースは以下の通りですクラス名機能概要 com.fujitsu.fw.url.file.iuploadfilecontents アップロードファイルの情報を操作する機能を提供しますメソッド名パラメータ返却値例外説明 getuploadfilename 無 String 無処理概要アップロードファイル名を取得します返却値アップロードファイル名未設定の場合は null を返却します getuploadfilecontenttype 無 String 無処理概要アップロードファイルのコンテンツ種別を取得します返却値コンテンツ種別未設定の場合は null を返却します getuploadfilestream 無 java.io.inputstream com.fujitsu.fw.exception.frameworkexception 処理概要アップロードファイルのストリームを取得します返却値アップロードファイルのストリーム getuploadfileheaders 無 Map<java.lang.String,java.lang.String[]> 無処理概要アップロードファイルのヘッダ情報を取得します返却値アップロードフィルのヘッダ情報 10

14 2: ダウンロードファイル情報 : ダウンロードファイルに関連する情報の作成取得削除機能を提供するクラスインターフェースは以下の通りです設定する値 ( ストリームファイル名コンテンツ種別エンコード ) は任意設定です設定していない場合は対応する箇所に値が設定されませんストリームが設定されていない場合は http レスポンスのボディが空となりますダウンロードファイル情報を作成した場合 http レスポンスはファイル情報を返却しますダウンロードファイルを作成していない場合もしくは作成後 IBPMContext.removeDownloadFile を実行した場合はファイル情報を返却せず IF データ定義に対応する値を http レスポンスとして返却しますクラス名機能概要 com.fujitsu.fw.url.file.idownloadfilecontents ダウンロードファイルの情報を操作する機能を提供しますメソッド名パラメータ返却値例外説明 getoutputstream 無 java.io.outputstream com.fujitsu.fw.exception.frameworkexception 処理概要ダウンロードファイル用のストリームを取得しますダウンロードさせたい内容を取得したストリームに書き込みます書き込んだ情報がダウンロードファイルの中身となります返却値ダウンロードファイル用ストリーム setfilename String filename 無無処理概要ダウンロードファイルの名前を設定します設定した場合レスポンスのヘッダに以下の内容が追加されます Content-Disposition: attachment; filename=[ 設定した値 ] ファイル名はサーバのデフォルトエンコードで URLEncode されますパラメータ filename ダウンロードファイル名 getfilename 無 String 無処理概要ダウンロードファイル名を取得します返却値ダウンロードファイル名 setcontenttype String contenttype 無無処理概要ダウンロードファイルのコンテンツ種別を設定します設定した場合レスポンスのヘッダに以下の内容が追加されます Content-Type: [ 設定した値 ] パラメータ contenttype コンテンツ種別 getcontenttype 無 String 無処理概要ダウンロードファイルのコンテンツ種別を取得します返却値コンテンツ種別 setencode String encode 無無処理概要ダウンロードファイルのエンコードを設定します設定した場合レスポンスヘッダが以下の内容が追加されます Content-Type: [ 設定したコンテンツ種別 ;charset=[ 設定した値 ] ただし setcontenttype でコンテンツ種別を設定しない場合はエンコードは設定されませんパラメータ encode エンコード getencode 無 String 無処理概要ダウンロードファイルのエンコードを取得します返却値エンコード remove 無無 com.fujitsu.fw.exception.frameworkexception 処理概要ダウンロードファイル情報の削除処理を行います 11

15 12

16 業務処理の実装 http リクエストで設定されたアップロードファイルの情報を取得し業務がファイルアップロード業務に関連する処理を実装しますまた http レスポンスにダウンロードファイルの情報を返却するために業務がダウンロードファイル情報を返却するための処理を実装します実装例は以下の通りですアップロードファイルの情報を取得し業務処理を実装する例 public IFDataTypeTextOutput fileuploaddownload(isessionhandle handle, IFDataTypeTextInput ifdatatypetextinput, IBPMContext context) { ILogger logger = this.getlogger(); // 設定されているアップロードファイルの数分処理を行う for (int i = 0; i < context.getuploadfilessize(); i++) { // アップロードファイル情報を取得する IUploadFileContents uploadfile = context.getuploadfilecontents(i); // 設定されているファイル名を取得する String filename = uploadfile.getuploadfilename(); // アップロードファイルの中身をストリームで取得する try (InputStream is = uploadfile.getuploadfilestream()) { IBPMContext をパラメータに設定しますパラメータの位置は ISessionHandle を除き SimpleEventFlow 定義の編集で設定したパラメータの順となります設定されているアップロードファイルの数分ループしながら各種情報を取得しアップロード処理を実装します ~ ストリームを取得し業務で必要なアップロード処理を実装する ~ } } catch (Exception e) { logger.log(basiclevel.debug, " アップロードファイル処理に失敗しました ", e); throw new ModelLogicException(e, " アップロードファイル処理に失敗しました ","ERROR_CODE_FILE"); } ~ 以降の処理記述省略 ~ 13

17 ダウンロードファイル情報を返却するための処理を実装する例 public IFDataTypeTextOutput fileuploaddownload(isessionhandle handle, IFDataTypeTextInput ifdatatypetextinput, IBPMContext context) { ILogger logger = this.getlogger(); // ダウンロードファイル情報を作成 IDownloadFileContents downloadfile = context.createdownloadfilecontents(); OutputStream output = downloadfile.getoutputstream(); output.write(" ファイルダウンロードのサンプル ".getbytes()); // コンテンツ種別を設定 downloadfile.setcontenttype("text/plain"); // ファイル名を設定 ( ファイル名はサーバのデフォルトエンコードで URLEncode されます ) downloadfile.setfilename(" ダウンロード用試験ファイル.txt"); ~ 以降の処理記述省略 ~ IBPMContext をパラメータに設定しますパラメータの位置は ISessionHandle を除き SimpleEventFlow 定義の編集で設定したパラメータの順となりますダウンロードファイル情報を作成しますダウンロードファイル情報を作成した場合 http レスポンスはファイル情報を返却します } 取得したストリームにファイルの中身を書き込みますフレームワークがクローズ処理を行うため業務処理では特にクローズする必要はありません 14

FW APIServer 設定ガイド Version 年 2 月 3 日富士通株式会社 i All Right Reserved, Copyright FUJITSU LIMITED

FW APIServer 設定ガイド Version 年 2 月 3 日富士通株式会社 i All Right Reserved, Copyright FUJITSU LIMITED FW APIServer 設定ガイド Version 1.4 2016 年 2 月 3 日富士通株式会社 i 改訂履歴改訂 No. 日付 Version 章 No. 項 No. 改訂内容 1 2015/04/14 1.0 - - 新規作成 2 2015/06/02 1.1 3 表内 No.12 の備考欄を追記 3 2015/06/23 1.2 3 メソッドのフォワード先をとする注意事項を追記 4

FW ファイルアップロード ダウンロード機能利用ガイド Version 年 9 月 21 日富士通株式会社 i All Right Reserved, Copyright FUJITSU LIMITED

FW ファイルアップロードダウンロード機能利用ガイド Version 年 9 月 21 日富士通株式会社 i All Right Reserved, Copyright FUJITSU LIMITED