各製品の資料を入手。
詳細はこちら →
製品をチェック
JDBI からConfluence データ のデータアクセスオブジェクトを作成
JDBI でConfluence のデータ 用のSQL オブジェクトAPIを作成する方法を概説します。
最終更新日：2022-05-25
この記事で実現できるConfluence 連携のシナリオ
こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
JDBI は、Fluent スタイルとSQL オブジェクトスタイルという2つの異なるスタイルAPI を公開する、Java 用のSQL コンビニエンスライブラリです。CData JDBC Driver for Confluence は、Java アプリケーションとリアルタイムConfluence のデータ のデータ連携を実現します。これらの技術を組み合わせることによって、Confluence のデータ へのシンプルなコードアクセスが可能になります。ここでは、基本的なDAO（Data Access Object ）とそれに付随するConfluence のデータ の読み書きのためのコードの作成について説明します。
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 を作成します。
Confluence 接続プロパティの取得・設定方法
任意のConfluence Cloud またはConfluence Server インスタンスへの接続を確立できます。接続するにはURL 接続プロパティを設定します。例えば、https://yoursitename.atlassian.net です。
Confluence への認証
Confluence は、次の認証メソッドをサポートしています：API トークン、Basic 認証、OAuth 2.0、SSO。
API トークン - Confluence Cloud アカウント
トークンの取得
アカウント認証にはAPI トークンが必要です。API トークンを生成するには、Atlassian アカウントにログインしてAPI トークン -> API トークンの作成を選択します。生成されたトークンが表示されます。
トークンを使用する認証
Cloud アカウントへの認証を行うには、以下を入力します。
- AuthScheme：APIToken に設定。
- User：Confluence サーバーに認証する際に使用されるユーザー。
- APIToken：現在認証されているユーザーに紐づくAPI トークン。
- Url：Confluence エンドポイントに紐づくURL。例えば、https://yoursitename.atlassian.net です。
Basic 認証 - Confluence Server インスタンス
Server インスタンスへの認証を行うには、以下のように指定します。
- AuthScheme：Basic に設定。
- User：Confluence インスタンスに認証する際に使用されるユーザー。
- Password：Confluence サーバーに認証する際に使われるパスワード。
- Url：Confluence エンドポイントに紐づく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 データ について
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 を操作しましょう。
関連コンテンツ
