Java で Jira のデータ エンティティのオブジェクト リレーショナル マッピング(ORM)を行う

Jerod Johnson
Jerod Johnson
Senior Technology Evangelist
オブジェクト リレーショナル マッピング(ORM)技術を使用すると、リレーショナルデータソースの操作が容易になり、論理的なビジネスモデルと物理ストレージモデルを橋渡しできます。本記事では、Java ベースの ORM フレームワーク Hibernate に Jira のデータ への接続を組み込む方法を説明します。

Hibernate を使用して、オブジェクト指向のドメインモデルを従来のリレーショナルデータベースにマッピングできます。以下のチュートリアルでは、CData JDBC Driver for Jira を使用して Hibernate で Jira リポジトリの ORM を生成する方法を説明します。

本記事では IDE として Eclipse を使用していますが、CData JDBC Driver for Jira は Java ランタイム環境をサポートするあらゆる製品で使用できます。Knowledge Base には、IntelliJ IDEA や NetBeans から Jira のデータ に接続するためのチュートリアルも用意しています。

Jira データ連携について

CData は、Jira のライブデータへのアクセスと統合を簡素化します。お客様は CData の接続機能を以下の目的で活用しています:

  • Issue、Project、Workflow などの Jira オブジェクトへの双方向アクセスを実現します。
  • SQL ストアドプロシージャを使用して、Issue のステータス変更、カスタムフィールドの作成、添付ファイルのダウンロード・アップロード、時間追跡設定の変更・取得などの機能的なアクションを実行できます。
  • ユーザー名とパスワード、OAuth、パーソナルアクセストークン、API トークン、Crowd または OKTA SSO、LDAP など、さまざまな方法で安全に認証できます。

多くのユーザーは、CData Sync を直接使用するか、SSIS や Azure Data Factory などのプラットフォームとの CData の互換性を活用して、Jira データをデータベースやデータウェアハウスに統合するために CData ソリューションを活用しています。また、Tableau や Power BI などのお気に入りの分析ツールからライブ Jira データの分析やレポートを行いたい方もいます。

お客様がビジネス上の問題を解決するために Jira データにシームレスに接続している方法については、ブログをご覧ください:Drivers in Focus: Collaboration Tools


はじめに


Hibernate のインストール

以下の手順に従って、Eclipse に Hibernate プラグインをインストールします。

  1. Eclipse で、Help -> Install New Software を選択します。
  2. Work With ボックスに「http://download.jboss.org/jbosstools/neon/stable/updates/」を入力します。
  3. フィルタボックスに「Hibernate」と入力します。
  4. Hibernate Tools を選択します。

新規プロジェクトの作成

以下の手順に従って、新しいプロジェクトにドライバー JAR を追加します。

  1. 新規プロジェクトを作成します。プロジェクトタイプとして Java Project を選択し、Next をクリックします。プロジェクト名を入力して Finish をクリックします。
  2. プロジェクトを右クリックして Properties をクリックします。Java Build Path をクリックし、Libraries タブを開きます。
  3. Add External JARs をクリックして、インストールディレクトリの lib サブフォルダにある cdata.jdbc.jira.jar ライブラリを追加します。

Hibernate 設定ファイルの追加

以下の手順に従って、Jira のデータ への接続プロパティを設定します。

  1. 新規プロジェクトを右クリックし、New -> Hibernate -> Hibernate Configuration File (cfg.xml) を選択します。
  2. src を親フォルダとして選択し、Next をクリックします。
  3. 以下の値を入力します:

    • Hibernate version:: 5.2
    • Database dialect: Derby
    • Driver class: cdata.jdbc.jira.JIRADriver
    • Connection URL: JDBC URL です。jdbc:jira: から始まり、セミコロン区切りの接続プロパティが続きます。

      JIRA への接続には、User、Password およびURL を使います。URL はhttps://yoursitename.atlassian.net などです。

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

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

      java -jar cdata.jdbc.jira.jar
      

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

      一般的な JDBC URL は以下のとおりです:

      jdbc:jira:User=admin;Password=123abc;Url=https://yoursitename.atlassian.net;

Hibernate から Jira のデータ に接続

以下の手順に従って、前のステップで作成した設定を選択します。

  1. Hibernate Configurations パースペクティブに切り替えます: Window -> Open Perspective -> Hibernate。
  2. Hibernate Configurations パネルを右クリックし、Add Configuration をクリックします。
  3. Hibernate version を 5.2 に設定します。
  4. Browse ボタンをクリックし、プロジェクトを選択します。
  5. Configuration file フィールドで、Setup -> Use Existing をクリックし、hibernate.cfg.xml ファイルの場所(このデモでは src フォルダ内)を選択します。
  6. Classpath タブで、User Entries の下に何もない場合は、Add External JARS をクリックしてドライバー jar を再度追加します。設定が完了したら OK をクリックします。
  7. 新しく作成した Hibernate 設定ファイルの Database ノードを展開します。

Jira のデータ のリバースエンジニアリング

以下の手順に従って、reveng.xml 設定ファイルを生成します。オブジェクトとしてアクセスするテーブルを指定します。

  1. Package Explorer に戻ります。
  2. プロジェクトを右クリックし、New -> Hibernate -> Hibernate Reverse Engineering File (reveng.xml) を選択します。Next をクリックします。
  3. src を親フォルダとして選択し、Next をクリックします。
  4. Console configuration ドロップダウンメニューで、上記で作成した Hibernate 設定ファイルを選択し、Refresh をクリックします。
  5. ノードを展開し、リバースエンジニアリングするテーブルを選択します。完了したら Finish をクリックします。

Hibernate の実行設定

以下の手順に従って、Jira テーブルの POJO(Plain Old Java Object)を生成します。

  1. メニューバーから、Run -> Hibernate Code Generation -> Hibernate Code Generation Configurations をクリックします。
  2. Console configuration ドロップダウンメニューで、前のセクションで作成した Hibernate 設定ファイルを選択します。Output directory の横にある Browse をクリックし、src を選択します。
  3. Reverse Engineer from JDBC Connection チェックボックスを有効にします。Setup ボタンをクリックし、Use Existing をクリックして、hibernate.reveng.xml ファイルの場所(このデモでは src フォルダ内)を選択します。
  4. Exporters タブで、Domain code (.java) と Hibernate XML Mappings (hbm.xml) をチェックします。
  5. Run をクリックします。

前のステップのリバースエンジニアリング設定に基づいて、1 つ以上の POJO が作成されます。

マッピングタグの挿入

生成した各マッピングに対して、hibernate.cfg.xml にマッピングタグを作成し、Hibernate がマッピングリソースを参照できるようにする必要があります。hibernate.cfg.xml を開き、以下のようにマッピングタグを挿入します:





  
    
      cdata.jira.JIRADriver
    
    
      jdbc:jira:User=admin;Password=123abc;Url=https://yoursitename.atlassian.net;
    
    
      org.hibernate.dialect.SQLServerDialect
    
    
    
    

SQL の実行

前のステップで作成したエンティティを使用して、Jira のデータ のデータの検索と変更が可能になります:


import java.util.*;
import org.hibernate.Session;
import org.hibernate.cfg.Configuration;
import org.hibernate.query.Query;

public class App {
  public static void main(final String[] args) {
    Session session =  new
    Configuration().configure().buildSessionFactory().openSession();
    String SELECT = "FROM Issues I WHERE ReporterDisplayName = :ReporterDisplayName";
    Query q = session.createQuery(SELECT, Issues.class);
    q.setParameter("ReporterDisplayName","Bob");
    List<Issues> resultList = (List<Issues>) q.list();

    for(Issues s: resultList){
      System.out.println(s.getSummary());
      System.out.println(s.getTimeSpent());
    }
  }
}

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

Jira Driver の無料トライアルをダウンロードしてお試しください:

 ダウンロード

詳細:

Jira Icon Jira JDBC Driver お問い合わせ

JIRA データ連携のパワフルなJava アプリケーションを素早く作成して配布。