JavaでBuildVuマイクロサービスにアクセスする

はじめに

このチュートリアルでは、ホストされたBuildVuクラウドAPIを使用して、PDFファイルをHTMLまたはSVGに変換する方法を説明します。対象となるサービスは以下の通りです：

IDRsolutionsのトライアルおよびクラウドサブスクリプションサービス
独自のセルフホスト型BuildVuマイクロサービス

上記のサービスは通常のHTTPリクエストでアクセスできますが、このチュートリアルでは、REST API をシンプルなJavaラッパーで包んだオープンソースのJava IDRCloudClient を使用します。

前提条件

開始する前に、最新バージョンのJDK（バージョン8以上）がインストールされていることを確認する必要があります。詳細はJavaのウェブサイトを参照してください。

コード例

以下は、PDFファイルをHTMLまたはSVGに変換する基本的なコード例です。設定オプションと高度な機能については、以下のセクションで説明します。

import java.util.Map;

public final class ExampleUsage {

    public static void main(final String[] args) {

        final IDRCloudClient client = new IDRCloudClient("https://cloud.idrsolutions.com/cloud/" + IDRCloudClient.BUILDVU);

        
        final HashMap<String, String> params = new HashMap<>();
        params.put("token", "token"); //Required only when connecting to the IDRsolutions trial and cloud subscription service
        params.put("input", IDRCloudClient.UPLOAD);
        params.put("file", "path/to/file.pdf");
        
        try {
            final Map<String, String> results = client.convert(params);

            System.out.println("   ---------   ");
            System.out.println(results.get("previewUrl"));

            IDRCloudClient.downloadResults(results, "path/to/outputDir", "example");
        } catch (final ClientException | InterruptedException e) {
            e.printStackTrace();
        }
    }
}

結果をコールバックURLに返す

BuildVuマイクロサービスは、変換完了時に変換のステータスを送信するコールバックURLを受け付けます。コールバックURLを使用することで、変換が完了したかどうかを判断するためにサービスをポーリングする必要がなくなります。
コールバックURLは、以下のようにparamsマップに提供できます。

final HashMap<String, String> params = new HashMap<>();
params.put("token", "token"); //Required only when connecting to the IDRsolutions trial and cloud subscription service
params.put("input", IDRCloudClient.UPLOAD);
params.put("file", "path/to/file.pdf");
params.put("callbackUrl", "http://listener.url");

設定オプション

BuildVu APIは、変換をカスタマイズするためのキーと値のペアの設定オプションを含む、文字列化されたJSONオブジェクトを受け付けます。設定はparameters配列に追加する必要があります。PDFファイルをHTMLまたはSVGに変換するための設定オプションの完全なリストはこちらで確認できます。

params.put("settings", "{\"key\":\"value\",\"key\":\"value\"}");

URLによるアップロード

ローカルファイルをアップロードする代わりに、BuildVuマイクロサービスがダウンロードして変換を実行するURLを指定することもできます。これを行うには、parameters変数のinputとfileの値を以下のように置き換える必要があります。

params.put("input", IDRCloudClient.DOWNLOAD);
params.put("url", "http://exampleURL/exampleFile.pdf");

認証の使用

BuildVuマイクロサービスが認証を必要とする場合、ユーザー名とパスワードを提供する必要があります。以下のように、usernameとpasswordという名前の2つの変数をconvertメソッドに渡すことで提供されます。

params.put("username","yourUsername");
params.put("password","yourPassword");

詳細情報

GitHub上のIDRCloudClient BuildVuマイクロサービスAPI
BuildVuマイクロサービスの使用方法