Apache Camel を使用してShort.io のデータと連携

加藤龍彦
加藤龍彦
デジタルマーケティング
Apache Camel のルーティングとCData JDBC Driver を使用してShort.io のデータをディスク上のJSON ファイルにコピーするシンプルなJava アプリを作成。



Apache Camel は、データを消費または生成するさまざまなシステムを統合できる、オープンソースの統合フレームワークです。CData JDBC Driver for API と組み合わせることで、リアルタイムShort.io のデータと連携するCamel ルートを使用するJava アプリを作成できます。この記事では、Short.io のデータをJSON ファイルに接続、クエリ、及びルーティングするアプリをNetBeans で作成する方法について説明します。

ビルトインの最適化されたデータ処理により、CData JDBC Driver は、リアルタイムShort.io のデータとやり取りする際に比類のないパフォーマンスを提供します。Short.io に複雑なSQL クエリを発行すると、ドライバーはフィルタや集計などのサポートされているSQL 操作をShort.io に直接プッシュし、組み込まれたSQL エンジンを利用してサポートされていない操作(主にSQL 関数とJOIN 操作)をクライアント側で処理します。組み込みの動的メタデータクエリを使用すると、ネイティブデータソース型を使用してShort.io のデータを操作および分析することができます。

新しいMaven/Java プロジェクトを作成する

以下の手順に従って、新しいJava プロジェクトを作成し、適切な依存関係を追加します。

  1. NetBeans を開き、新しいプロジェクトを作成します。
  2. カテゴリリストからMaven を選択し、プロジェクトリストからJava Application を選択して、「Next」をクエリします。
  3. プロジェクトに名前を付け、他のプロパティを調整して「Finish」をクリックします。
  4. ソースパッケージで新しいJava クラス(ここではApp.java を使用)を作成し、クラスにmain メソッドを追加します。

プロジェクトの依存関係を追加する

プロジェクトが作成されたら、アプリからリアルタイムShort.io のデータを操作するために必要な依存関係を追加できるようになります。まだMaven を環境にインストールしていない場合、CData JDBC ドライバのJAR ファイルをプロジェクトに追加するのに必要なため、インストールしてください。

Maven を使用してCData JDBC Driver for API をインストールする

  1. Short.io 用のCData JDBC Driver をダウンロードしてパッケージを解凍し、JAR を実行してドライバーをインストールします。
  2. Maven を使用し、コネクタとしてJDBC Driver をインストールします。
    mvn install:install-file
    	-Dfile="C:\Program Files\CData\CData JDBC Driver for API 2019\lib\cdata.jdbc.api.jar"
    	-DgroupId="org.cdata.connectors"
    	-DartifactId="cdata-api-connector"
    	-Dversion="19"
    	-Dpackaging=jar
    

JDBC Driver をインストールしたら、プロジェクトに依存関係を追加できます。依存関係を追加するには、pom.xml を編集するか、依存関係にあるフォルダを右クリックして「Add Dependency」をクリックします。各依存関係のプロパティは以下の通りですが、「Add Dependency」ウィザードの「Query」ボックスに依存関係の名前を入力することで使用可能なライブラリを検索できます。

Selecting a dependency

必要な依存関係

DependencyGroup IDArtifact IDVersion
camel-coreorg.apache.camelcamel-core3.0.0
camel-jacksonorg.apache.camelcamel-jackson3.0.0
camel-jdbcorg.apache.camelcamel-jdbc3.0.0
camel-jsonpathorg.apache.camelcamel-jsonpath3.0.0
cdata-api-connectororg.cdata.connectorscdata-salesforce-connector19
commons-dbcp2org.apache.commonscommons-dbcp22.7.0
slf4j-log4j12org.slf4jslf4j-log4j121.7.30
log4jorg.apache.logging.log4jlog4j2.12.1

Camel を使用してJava アプリでShort.io のデータにアクセスする

必要な依存関係を追加したら、Java DSL(Domain Specific Language)を使用してリアルタイムShort.io のデータにアクセスできるルートを作成できます。以下はコードの一部です。サンプルプロジェクト(zip ファイル)をダウンロードして以下を実行してください。(TODO コメントに注意してください。)

必要なクラスをメインクラスにインポートすることから始めます。

import org.apache.camel.CamelContext;
import org.apache.camel.builder.RouteBuilder;
import org.apache.camel.impl.DefaultCamelContext;
import org.apache.camel.support.SimpleRegistry;
import org.apache.commons.dbcp2.BasicDataSource;
import org.apache.log4j.BasicConfigurator;

次に、main メソッドでロギングを構成し、新しいBasicDataSource を作成してレジストリに追加し、新しいCamelContext を作成して、最後にコンテクストへのルートに追加します。この例では、Short.io のデータをJSON ファイルにルーティングします。

ロギングを構成する

BasicConfigurator.configure();

BasicDataSource を作成する

BasicDataSource を作成し、ドライバークラス名(cdata.jdbc.salesforce.SalesforceDriver)とURL(必要な接続プロパティを使用)を設定します。

API キー認証の設定

Short.io は API キー認証を使用します。API キーを取得するには、以下のステップで進めます:

  1. Short.io アカウントにログインします
  2. Settings > Integrations & API > API に移動します
  3. Create API Key をクリックして API キーをコピーします

API キーを取得したら、接続を確立できます:

  • AuthScheme:APIKey に設定します。
  • APIKey:Settings > Integrations & API > API から取得した Short.io の API キーに設定します。

接続文字列の例:

Profile=C:\profiles\ShortIo.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';

利用可能なテーブル

Short.io プロファイルでは、以下のテーブルにアクセスできます:

  • Domains - 認証済みアカウントに関連付けられた Short.io ドメイン
  • Links - ドメインの短縮リンク
  • LinkExpand - ドメインとパスから短縮リンクを展開
  • LinksByOriginalUrl - 指定した元の宛先 URL に一致する複数の短縮リンクを取得
  • Folders - 特定のドメイン内のリンクフォルダー
  • LinkPermissions - ドメイン内の特定のリンクの権限レコード
  • CountryTargeting - 特定の短縮リンクの国別リダイレクトターゲティングルール
  • RegionTargeting - 特定の短縮リンクの地域別リダイレクトターゲティングルール
  • Regions - 指定した国コードに対する利用可能な地域/州の一覧
  • DomainStatistics - Short.io ドメインのクリック数とトラフィックの集計統計
  • LinkStatistics - 特定の Short.io リンクのクリック数とトラフィックの集計統計
BasicDataSource basic = new BasicDataSource();
basic.setDriverClassName("cdata.jdbc.api.APIDriver");
basic.setUrl("jdbc:api:Profile=C:\profiles\ShortIo.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';");

CData JDBC ドライバには、接続URL の構成に役立つ組み込みの接続文字列デザイナーが含まれています。

組み込みの接続文字列デザイナ

JDBC URL の構築については、Short.io JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルをダブルクリックするか、コマンドラインからjar ファイルを実行します。

java -jar cdata.jdbc.api.jar

接続プロパティを入力し、接続文字列をクリップボードにコピーします。

Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)

BasicDataSource をレジストリに追加し、CamelContext を作成する

SimpleRegistry reg = new SimpleRegistry();
reg.bind("myDataSource", basic);

CamelContext context = new DefaultCamelContext(reg);

CamelContext にルーティングを追加する

以下のルーティングでは、timer コンポーネントを使用して一度実行し、SQL クエリをJDBC Driver に渡します。結果はJSON として整理され、(きれいに印刷できるようにフォーマットされて)file コンポーネントに渡され、JSON ファイルとしてディスクに書き込まれます。

context.addRoutes(new RouteBuilder() {
	@Override
	public void configure() {
		from("timer://foo?repeatCount=1")
			.setBody(constant("SELECT * FROM Account LIMIT 10"))
			.to("jdbc:myDataSource")
			.marshal().json(true)
			.to("file:C:\\Users\\USER\\Documents?fileName=account.json");
	}
});

CamelContext ライフサイクルを管理する

ルートを定義したら、CamelContext を開始してライフサイクルを始めます。この例では、10 秒待機してからコンテクストをシャットダウンします。

context.start();
Thread.sleep(10000);
context.stop();

無償トライアル、サンプルプロジェクト、テクニカルサポート

これで、Camel を使用してShort.io からJSON ファイルにデータをルーティングするJava アプリケーションを使用できるようになりました。CData JDBC Driver for API の30日の無償評価版と、サンプルプロジェクトをダウンロードして(TODO コメントに注意して)、Apache Camel でリアルタイムShort.io のデータの操作を開始します。ご不明な点があれば、サポートチームにお問い合わせください。

はじめる準備はできましたか?

API Driver で Short.io のライブデータに接続

Short.io に接続