JDBI からConfluence Data のデータアクセスオブジェクトを作成

詳細情報をご希望ですか?

無償トライアル:

ダウンロードへ

製品の詳細情報へ:

Confluence JDBC Driver

Confluence に連携するJava アプリケーションを素早く、簡単に開発できる便利なドライバー。



JDBI でConfluence data 用のSQL オブジェクトAPIを作成する方法を概説します。

JDBI は、Fluent スタイルとSQL オブジェクトスタイルという2つの異なるスタイルAPI を公開する、Java 用のSQL コンビニエンスライブラリです。CData JDBC Driver for Confluence は、Java アプリケーションとリアルタイムConfluence data のデータ連携を実現します。これらの技術を組み合わせることによって、Confluence data へのシンプルなコードアクセスが可能になります。ここでは、基本的なDAO(Data Access Object )とそれに付随するConfluence data の読み書きのためのコードの作成について説明します。

Confluence Pages Entity のDAO を作成

以下のインターフェースは、実装されるSQL ステートメントごとに単一のメソッドを作成するためのSQL オブジェクトの正しい動作を宣言します。

public interface MyPagesDAO { //request specific data from Confluence (String type is used for simplicity) @SqlQuery("SELECT Name FROM Pages WHERE Id = :id") String findNameById(@Bind("id") String id); /* * close with no args is used to close the connection */ void close(); }

Confluence への接続を開く

必要な接続プロパティを収集し、Confluence に接続するための適切なJDBC URL を作成します。

API Token を取得する方法

API token は、アカウントへの認証に必須です。トークンの生成には、Atlassian アカウントでサービスにログインし、API tokens > Create API token に進みます。生成されたトークンが表示されます。

Confluence Cloud Account への接続

Cloud アカウントへの接続には、以下のプロパティを設定します(Password は、Server Instance への接続時のみ必要で、Cloud Account への接続には不要になりました。):

  • User: Confluence サーバーに認証するユーザー名。
  • APIToken: 認証するユーザーに紐付けられたAPI Token。
  • Url: JIRA エンドポイントのURL。例: https://yoursitename.atlassian.net

Confluence Server Instance への接続

Server instance への接続には以下を設定します:

  • User: Confluence Instance に接続するユーザー名。
  • Password: Confluence Instance に接続するユーザーのパスワード。
  • Url: JIRA エンドポイントのURL。例: https://yoursitename.atlassian.net

ビルトイン接続文字列デザイナー

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

java -jar cdata.jdbc.confluence.jar

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

Confluence の接続文字列は、通常次のようになります。

jdbc:confluence:User=admin;APIToken=myApiToken;Url=https://yoursitename.atlassian.net;Timezone=America/New_York;

構成済みのJDBC URL を使用して、DAO インターフェースのインスタンスを取得します。以下に示す特定のメソッドはインスタンスにバインドされたハンドルを開くため、ハンドルとバインドされたJDBC 接続を開放するには、インスタンスを明示的に閉じる必要があります。

DBI dbi = new DBI("jdbc:confluence:User=admin;APIToken=myApiToken;Url=https://yoursitename.atlassian.net;Timezone=America/New_York;"); MyPagesDAO dao = dbi.open(MyPagesDAO.class); //do stuff with the DAO dao.close();

Confluence Data について

Confluence への接続を開いた状態で以前定義したメソッドを呼び出すだけで、Confluence のPages エンティティからデータを取得できます。

//disply the result of our 'find' method String name = dao.findNameById("10000"); System.out.println(name);

JDBI ライブラリはJDBC 接続を処理できるため、CData JDBC Driver for Confluence と統合することで、SQL Object API for Confluence を簡単に作成できます。今すぐ無料トライアルをダウンロードし、Java アプリケーションでライブConfluence を操作しましょう。