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

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

ServiceDesk Plus AnnouncementComments Entity のDAO を作成

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

public interface MyAnnouncementCommentsDAO {
  //request specific data from ServiceDesk Plus (String type is used for simplicity)
  @SqlQuery("SELECT  FROM AnnouncementComments WHERE AnnouncementId = :announcementId")
  String findByAnnouncementId(@Bind("announcementId") String announcementId);

  /*
   * close with no args is used to close the connection
   */
  void close();
}

ServiceDesk Plus への接続を開く

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

OAuth 認証の設定

ServiceDeskPlus は、安全な認証のために Zoho OAuth 2.0 を使用します。OAuth アクセスをセットアップするには、以下のステップで進めます：

1. https://api-console.zoho.com の Zoho Developer Console でアプリケーションを登録します
2. アプリケーション構成に合わせてリダイレクト URI を設定します
3. アプリケーション設定から Client ID と Client Secret を控えておきます

以下の接続プロパティを設定して接続を確立してください：

• AuthScheme：OAuth に設定します。
• OAuthClientId：Zoho アプリケーションの Client ID に設定します。
• OAuthClientSecret：Zoho アプリケーションの Client Secret に設定します。
• Scope：必要な ServiceDeskPlus の権限に設定します（デフォルトでは requests、problems、assets、projects への読み取りアクセスが含まれます）。
• Domain：ServiceDeskPlus のドメインに設定します。
• Portal：ServiceDeskPlus のポータルに設定します。

接続文字列の例

Profile=C:\profiles\ServiceDeskPlus.apip;ProfileSettings="Portal=itdesk;Domain=.in;Scope=SDPOnDemand.requests.READ SDPOnDemand.problems.READ SDPOnDemand.assets.READ SDPOnDemand.projects.READ";AuthScheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;

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

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

java -jar cdata.jdbc.api.jar

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

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

jdbc:api:Profile=C:\profiles\ServiceDeskPlus.apip;ProfileSettings="Portal=itdesk;Domain=.in;Scope=SDPOnDemand.requests.READ SDPOnDemand.problems.READ SDPOnDemand.assets.READ SDPOnDemand.projects.READ";AuthScheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;

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

DBI dbi = new DBI("jdbc:api:Profile=C:\profiles\ServiceDeskPlus.apip;ProfileSettings="Portal=itdesk;Domain=.in;Scope=SDPOnDemand.requests.READ SDPOnDemand.problems.READ SDPOnDemand.assets.READ SDPOnDemand.projects.READ";AuthScheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;");
MyAnnouncementCommentsDAO dao = dbi.open(MyAnnouncementCommentsDAO.class);

//do stuff with the DAO

dao.close();

ServiceDesk Plus データについて

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

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

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