各製品の資料を入手。
詳細はこちら →
製品をチェック
JDBI からBitbucket データ のデータアクセスオブジェクトを作成
JDBI でBitbucket のデータ 用のSQL オブジェクトAPIを作成する方法を概説します。
最終更新日：2022-05-25
この記事で実現できるBitbucket 連携のシナリオ
こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
JDBI は、Fluent スタイルとSQL オブジェクトスタイルという2つの異なるスタイルAPI を公開する、Java 用のSQL コンビニエンスライブラリです。CData JDBC Driver for Bitbucket は、Java アプリケーションとリアルタイムBitbucket のデータ のデータ連携を実現します。これらの技術を組み合わせることによって、Bitbucket のデータ へのシンプルなコードアクセスが可能になります。ここでは、基本的なDAO（Data Access Object ）とそれに付随するBitbucket のデータ の読み書きのためのコードの作成について説明します。
Bitbucket Issues Entity のDAO を作成
以下のインターフェースは、実装されるSQL ステートメントごとに単一のメソッドを作成するためのSQL オブジェクトの正しい動作を宣言します。
public interface MyIssuesDAO {
//insert new data into Bitbucket
@SqlUpdate("INSERT INTO Issues (Id, ContentRaw) values (:id, :contentRaw)")
void insert(@Bind("id") String id, @Bind("contentRaw") String contentRaw);
//request specific data from Bitbucket (String type is used for simplicity)
@SqlQuery("SELECT ContentRaw FROM Issues WHERE Id = :id")
String findContentRawById(@Bind("id") String id);
/*
* close with no args is used to close the connection
*/
void close();
}
Bitbucket への接続を開く
必要な接続プロパティを収集し、Bitbucket に接続するための適切なJDBC URL を作成します。
ほとんどのクエリでは、ワークスペースを設定する必要があります。唯一の例外は、Workspacesテーブルです。このテーブルはこのプロパティの設定を必要とせず、クエリを実行すると、Workspaceの設定に使用できるワークスペーススラッグのリストが提供されます。このテーブルにクエリを実行するには、スキーマを'Information'に設定し、SELECT * FROM Workspacesクエリを実行する必要があります。
Schemaを'Information'に設定すると、一般的な情報が表示されます。Bitbucketに接続するには、以下のパラメータを設定してください。
- Schema: ワークスペースのユーザー、リポジトリ、プロジェクトなどの一般的な情報を表示するには、これを'Information'に設定します。それ以外の場合は、クエリを実行するリポジトリまたはプロジェクトのスキーマに設定します。利用可能なスキーマの完全なセットを取得するには、sys_schemasテーブルにクエリを実行してください。
- Workspace: Workspacesテーブルにクエリを実行する場合を除き、必須です。Workspacesテーブルへのクエリにはこのプロパティは必要ありません。そのクエリはWorkspaceの設定に使用できるワークスペーススラッグのリストのみを返すためです。
Bitbucketでの認証
BitbucketはOAuth認証のみをサポートしています。すべてのOAuthフローからこの認証を有効にするには、カスタムOAuthアプリケーションを作成し、AuthSchemeをOAuthに設定する必要があります。
特定の認証ニーズ（デスクトップアプリケーション、Webアプリケーション、ヘッドレスマシン）に必要な接続プロパティについては、ヘルプドキュメントを必ず確認してください。
カスタムOAuthアプリケーションの作成
Bitbucketアカウントから、以下のステップを実行します。
- 設定（歯車アイコン）に移動し、ワークスペース設定を選択します。
- アプリと機能セクションで、OAuthコンシューマーを選択します。
- コンシューマーを追加をクリックします。
- カスタムアプリケーションの名前と説明を入力します。
- コールバックURLを設定します。
- デスクトップアプリケーションとヘッドレスマシンの場合、http://localhost:33333または任意のポート番号を使用します。ここで設定するURIがCallbackURLプロパティになります。
- Webアプリケーションの場合、信頼できるリダイレクトURLにコールバックURLを設定します。このURLは、ユーザーがアプリケーションにアクセスが許可されたことを確認するトークンを持って戻るWebの場所です。
- クライアント認証情報を使用して認証する予定の場合、これはプライベートコンシューマーですを選択する必要があります。ドライバーでは、AuthSchemeをclientに設定する必要があります。
- OAuthアプリケーションに与える権限を選択します。これにより、読み取りおよび書き込みできるデータが決まります。
- 新しいカスタムアプリケーションを保存するには、保存をクリックします。
- アプリケーションが保存された後、それを選択して設定を表示できます。アプリケーションのKeyとSecretが表示されます。これらを将来の使用のために記録してください。Keyを使用してOAuthClientIdを設定し、Secretを使用してOAuthClientSecretを設定します。
ビルトイン接続文字列デザイナー
JDBC URL の構成については、Bitbucket JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルのダブルクリック、またはコマンドラインからJAR ファイルを実行します。
java -jar cdata.jdbc.bitbucket.jar
接続プロパティを入力し、接続文字列をクリップボードにコピーします。
Bitbucket の接続文字列は、通常次のようになります。
jdbc:bitbucket:Workspace=myworkspaceslug;Schema=InformationInitiateOAuth=GETANDREFRESH
構成済みのJDBC URL を使用して、DAO インターフェースのインスタンスを取得します。以下に示す特定のメソッドはインスタンスにバインドされたハンドルを開くため、ハンドルとバインドされたJDBC 接続を開放するには、インスタンスを明示的に閉じる必要があります。
DBI dbi = new DBI("jdbc:bitbucket:Workspace=myworkspaceslug;Schema=InformationInitiateOAuth=GETANDREFRESH");
MyIssuesDAO dao = dbi.open(MyIssuesDAO.class);
//do stuff with the DAO
dao.close();
Bitbucket データ について
Bitbucket への接続を開いた状態で以前定義したメソッドを呼び出すだけで、Bitbucket のIssues エンティティからデータを取得できます。
//disply the result of our 'find' method
String contentRaw = dao.findContentRawById("1");
System.out.println(contentRaw);
Bitbucket データ の書き方
以前定義した方法を使用すれば、Bitbucket にデータを書き込むことも簡単になります。
//add a new entry to the Issues entity
dao.insert(newId, newContentRaw);
JDBI ライブラリはJDBC 接続を処理できるため、CData JDBC Driver for Bitbucket と統合することで、SQL Object API for Bitbucket を簡単に作成できます。今すぐ無料トライアルをダウンロードし、Java アプリケーションでリアルタイムBitbucket を操作しましょう。
関連コンテンツ
