このページを共有

# ALM Octane Java SDK

ALM Octane SDKは、Javaライブラリのセット、サンプルプロジェクト、ドキュメントおよびALM Octaneとの統合に役立つサンプルで構成されています。

このトピックの内容:

## 準備

要件

ALM Octane Java SDKを使用するには、次の要件と前提条件が必要です。

Java | 8.0以降
ALM Octane | 12.53.16以降

準備

事前に以下の項目をご用意ください。ALM Octane SDKを使用するにはそれらが必要です。

- ALM OctaneサーバーのURL。

- 共有スペースID。

- ワークスペースID。

トップに戻る

## ダウンロードとインストール

次のいずれかの場所からJava SDKをダウンロードします。

場所 | 説明
--- | ---
Maven | プロジェクトオブジェクトモデル (POM) ファイルを使用して、MavenリポジトリからJava SDKライブラリとサンプルをダウンロードできます。ALM Octane Java SDKをダウンロードすると、Mavenにすべての依存関係が自動的に含まれます。
GitHub | GitHubリポジトリからソースファイルをダウンロードできます。この方法を使用して、リポジトリに貢献することもできます。

Maven

SDKは、メインプロジェクト内の次のMavenモジュールで構成されています。

モジュール | 説明
--- | ---
sdk-root | これはSDKのメインルートです。これには、すべての統合テスト、ソースコード、および例が含まれています。
sdk-src | メインSDKのルート。SDKのみを使用する場合は、このモジュールのみを追加してください。
sdk-integration-tests | ALM Octaneインスタンスに対してSDKから統合テストを実行するために使用されるモジュール。
sdk-usage-examples | SDKの使用方法の簡単な例。

ALMOctaneJavaRESTSDKで説明したようにMavenで動作するように、あなたのpom.xmlファイルでプロジェクトにALMOctaneの依存関係を追加します。

GitHub

SDKリポジトリは次の場所にあります。

https://github.com/MicroFocus/ALMOctaneJavaRESTSDK

プロジェクトをコンパイルしてJavadocを作成する方法についての情報が表示されます。

トップに戻る

## 認証

ALM OctaneJava SDKを使用するには、REST APIを直接操作する場合と同様に認証する必要があります。詳細については、認証をご覧ください。

トップに戻る

## Javadocにアクセスする

Javadocは、Javaソースコードから生成されたHTMLドキュメントです。Javadocの説明:

- クラスとメソッド

- パラメーターと戻り値

- 非推奨のクラスとメソッド

- クラス階層

Mavenからダウンロードする場合は、Javadocが含まれているパッケージ済みのjarファイルを次の場所からダウンロードできます。

https://repo1.maven.org/maven2/com/microfocus/adm/almoctane/sdk/sdk-src/15.1.90/sdk-src-15.1.90-javadoc.jar

または、GitHubからソースファイルをダウンロードする場合は、Javadocを自分で作成できます。詳細については、GitHubのREADMEファイルを参照してください。

トップに戻る

## サンプルプロジェクト

ALM Octane Java SDKは、練習に使用できるサンプルプロジェクトを提供します。ここでの例は、このサンプルプロジェクトに基づいています。

サンプルプロジェクトにアクセスする

サンプルプロジェクトにアクセスするには、次のURLを入力します:https://github.com/MicroFocus/ALMOctaneJavaRESTSDK/tree/master/sdk-usage-examples

サンプルプロジェクトをよく理解してください

ALM Octaneでプロジェクトを開き、データとエンティティに精通します。

サンプル | 説明
--- | ---
CreateContextExample.java | この例は、REST API関数が動作するコンテキストを作成する方法を示しています。 認証は、ユーザーとパスワード、またはAPIアクセスキーによって行うことができます。この例は、ユーザーとパスワードによる認証を示しています。以降のすべてのREST APIアクションは、このユーザーが適切な権限を持っている場合にのみ実行されます。 次に、この例では、ALM Octaneサーバー、スペース、およびワークスペースのURLを設定します。 次に、このコンテキストのすべての不具合に対して基本的なgetが実行されます。
EntityExample.java | この例は、REST APIを使用してエンティティを操作する方法を示しています。デモの目的で、この例は不具合を処理しますが、同じ例を他のエンティティで使用できます。 IDが2010である特定の不具合の値を取得します。 作成時間で値をフィルタリングします。 表示するフィールドとその順序を指定します。 IDが文字列2と等しいすべてのエンティティをクエリします。 クロスフィルタークエリを実行します
MetadataExample.java | この例は、すべてのフィールドのメタデータを取得する方法を示しています。

トップに戻る

https://admhelp.microfocus.com ALM Octane 8942
検索結果を改善するためのヒント... ALM Octaneヘルプセンター ALM Octaneヘルプ 15.1.90 すべてローカルヘルプセンターを表示オンラインヘルプセンターを表示戻るブラウザーの履歴内を戻る進むブラウザーの履歴内を進む検索のハイライトを削除する次のトピック次のトピックに進む前のトピック前のトピックに戻る現在のトピックを印刷バージョン: