新しいオントロジーSDK (OSDK) Javaアプリケーションのブートストラップ

このページでは、オントロジーSDK (OSDK) を使用してJavaアプリケーションを作成する手順を説明します。

Developer Consoleアプリケーションの作成

オントロジーSDK (OSDK) を使用して新しいJavaアプリケーションを作成する前に、まず新しいDeveloper Consoleアプリケーションを作成する必要があります。これにより、アプリケーションの権限が設定され、Javaアプリケーションで使用したいオブジェクトを選択できます。

個人用アクセス トークンの設定

次に、個人用アクセス トークンをローカル環境にエクスポートします。これは、Palantirユーザーまたはアプリケーションに関連付けられたトークンで、サードパーティのアプリケーションやAPIを通じてFoundryリソースにアクセスできるようにします。以下にサンプルの個人用アクセス トークンを使用した例を示しますが、Developer Consoleでさらに長期間有効なものを生成することもできます。

Copied!
1
2
export FOUNDRY_TOKEN=<YOUR-TOKEN-FROM-GETTING-STARTED-PAGE>
# FOUNDRY_TOKEN環境変数に、GETTING STARTEDページから取得したトークンを設定します

Java バージョンの確認

Java OSDK は Java バージョン 17 から 21 の間を必要とします。使用している Java のバージョンを確認するには、以下のコマンドを実行し、必要に応じて Java をアップグレードしてください。

Copied!
1
2
java --version
# Javaのバージョンを表示するコマンド

最新バージョンの OSDK をインストールする

最新バージョンの SDK をインストールするために、以下のリポジトリと依存関係を build.gradle ファイル（または、異なるビルドツールを使用している場合はその相当ファイル）に追加してください。Developer Console のアプリケーション Overview ページに記載されているアプリケーション固有の値で < > を置き換えてください。

repositories {
    maven {
        credentials {
            // 環境変数からFOUNDRY_TOKENを取得してパスワードとして使用
            username ''
            password System.getenv('FOUNDRY_TOKEN')
        }
        url 'https://<APPLICATION-URL>' // MavenリポジトリのURLを指定
    }

    maven {
        credentials {
            // 環境変数からFOUNDRY_TOKENを取得してパスワードとして使用
            username ''
            password System.getenv('FOUNDRY_TOKEN')
        }
        url 'https://<GENERATOR-URL>' // 別のMavenリポジトリのURLを指定
    }
}

dependencies {
    implementation '<YOUR-PACKAGE-NAME>' // 依存関係として追加するパッケージ名を指定
}

Java アプリケーションの開発

アプリケーション内で Foundry クライアントを初期化して開発を開始します。バックエンドアプリケーションをホストするためのサービスユーザーを作成する必要がある場合、既存の Java サービスに Java SDK を統合する一般的な使用例については、必要な OAuth 情報の取得に関するガイドを参照してください。

ユーザートークンを使用して Foundry クライアントを初期化する

Copied!
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
import <PACKAGE-NAME>.FoundryClient;
import <PACKAGE-NAME>.objects.Aircraft;
import com.palantir.osdk.api.Auth;
import com.palantir.osdk.api.UserTokenAuth;
import com.palantir.osdk.internal.api.FoundryConnectionConfig;

// ユーザー認証トークンを設定
Auth auth = UserTokenAuth.builder().token(System.getenv("FOUNDRY_TOKEN")).build();

// Foundryクライアントの構築
FoundryClient client = FoundryClient.builder()
        .auth(auth)  // 認証情報を設定
        .connectionConfig(FoundryConnectionConfig.builder()
                .foundryUri("<YOUR-FOUNDRY-URL>")  // FoundryのURLを設定
                .build())
        .build();

// オブジェクトを1件フェッチしてコンソールに出力
System.out.println(client.ontology().objects().<ANY-OBJECT>.fetch(1));

OAuth を利用した Foundry クライアントの初期化

Copied!
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
import <PACKAGE-NAME>.FoundryClient;
import <PACKAGE-NAME>.objects.Aircraft;
import com.palantir.osdk.api.Auth;
import com.palantir.osdk.api.UserTokenAuth;
import com.palantir.osdk.internal.api.FoundryConnectionConfig;

// 認証情報を設定する
Auth auth = ConfidentialClientAuth.builder()
                .clientId("<YOUR-CLIENT-ID>") // クライアントIDを設定
                .clientSecret("<YOUR-SECURELY-STORED-CLIENT-SECRET>") // クライアントシークレットを設定
                .build();

// FoundryClientを構築する
FoundryClient client = FoundryClient.builder()
        .auth(auth) // 認証情報を追加
        .connectionConfig(FoundryConnectionConfig.builder()
                .foundryUri("<YOUR-FOUNDRY-URL>") // FoundryのURLを設定
                .build())
        .build();

// 任意のオブジェクトを取得し、表示する
System.out.println(client.ontology().objects().<ANY-OBJECT>.fetch(1)); // <ANY-OBJECT>は取得したいオブジェクトのタイプに置き換える