Java SDK ガイド

Red Hat Virtualization 4.0

Red Hat Virtualization Java SDK の使用

Red Hat Virtualization Documentation Team

Red Hat Customer Content Services

rhev-docs@redhat.com

法律上の通知

概要

本ガイドは、Red Hat Virtualization の Java ソフトウェア開発キットバージョン 3 と 4 のインストール方法および使用方法を説明します。

第1章概要
リンクのコピー

Java ソフトウェア開発キットは、Java ベースプロジェクトで Red Hat Virtualization Manager との対話を可能にするクラスのコレクションです。これらのクラスをダウンロードしてプロジェクトに追加することにより、管理タスクを高度に自動化するさまざまな機能を利用することができます。

Red Hat Virtualization では、Java ソフトウェア開発キットの 2 つのバージョンを提供しています。

バージョン 3: Java ソフトウェア開発キットバージョン 3 では、Red Hat Enterprise Virtualization 3.6 の最新リリースの時点で Java ソフトウェア開発キットで提供されているクラスとメソッド構造との後方互換性があります。Red Hat Enterprise Virtualization 3.6 の Java ソフトウェア開発キットを使用して記述されたアプリケーションは、修正なしにこのバージョンで使用することができます。
バージョン 4: Java ソフトウェア開発キットバージョン 4 では、クラスやメソッド名および署名が更新されています。Red Hat Enterprise Virtualization 3.6 の Java ソフトウェア開発キットで記述されたアプリケーションは更新してからでないと、このバージョンでは使用できません。

Red Hat Virtualization 環境では、適切なパッケージをインストールしたり、Java プロジェクトに必要なライブラリーを追加したりする際に必要であるため、Java ソフトウェア開発キットのどちらのバージョンも使用できます。

1.1. 前提条件
リンクのコピー

Java ソフトウェア開発キットをインストールする場合の前提条件は以下のとおりです。

Red Hat Enterprise Linux 7 がインストールされたシステム。Server バージョンと Workstation バージョンがサポートされます。
Red Hat Hat Virtualization エンタイトルメントのサブスクリプション。

重要

ソフトウェア開発キットは、Red Hat Virtualization REST API のインターフェースです。このように、Red Hat Virtualization 環境のバージョンに適したソフトウェア開発キットのバージョンを使用する必要があります。たとえば、Red Hat Virtualization 4.0 を使用している場合には、4.0 向けに設計されたソフトウェア開発キットのバージョンを使用する必要があります。

1.2. Java ソフトウェア開発キットのインストール
リンクのコピー

Java ソフトウェア開発キットと付属ドキュメントをインストールします。

手順1.1 Java ソフトウェア開発キットのインストール

必要なチャンネルを有効にします。

subscription-manager repos --enable=rhel-7-server-rpms
subscription-manager repos --enable=rhel-7-server-rhv-4.0-rpms
subscription-manager repos --enable=jb-eap-7-for-rhel-7-server-rpms

# subscription-manager repos --enable=rhel-7-server-rpms
# subscription-manager repos --enable=rhel-7-server-rhv-4.0-rpms
# subscription-manager repos --enable=jb-eap-7-for-rhel-7-server-rpms

Copy to Clipboard

Toggle word wrap

必要なパッケージをインストールします。
- バージョン 3 の場合:
```
yum install ovirt-engine-sdk-java ovirt-engine-sdk-javadoc
```
```
# yum install ovirt-engine-sdk-java ovirt-engine-sdk-javadoc
```
  Copy to Clipboard Toggle word wrap
- バージョン 4 の場合:
```
yum install java-ovirt-engine-sdk4
```
```
# yum install java-ovirt-engine-sdk4
```
  Copy to Clipboard Toggle word wrap

Java ソフトウェア開発キットと付属ドキュメントが /usr/share/java/rhevm-sdk-java のディレクトリーにダウンロードされ、Java プロジェクトに追加できる状態となりました。

1.3. 依存関係
リンクのコピー

Java アプリケーションで Java ソフトウェア開発キットを使用するには、これらのアプリケーションのクラスパスに以下の JAR ファイルを追加する必要があります。

commons-beanutils.jar
commons-codec.jar
httpclient.jar
httpcore.jar
jakarta-commons-logging.jar
log4j.jar

これらの JAR ファイルを提供するパッケージが ovirt-engine-sdk-java パッケージの依存関係としてインストールされます。デフォルトでは、Red Hat Enterprise Linux 6 および Red Hat Enterprise Linux 7 システムでは、/usr/share/java から入手できます。

1.4. SSL の設定
リンクのコピー

Red Hat Virtualization Manager Java SDK は、Java Secure Socket Extension (JSSE) を使用して、Secure Sockets Layer (SSL) および IETF Transport Layer Security (TLS) プロトコルを介した HTTP の完全なサポートを提供します。JSSE は Java 2 にバージョン 1.4 として実装されており、Java-SDK では追加設定なしで使用することができます。Java 2 の旧バージョンには、JSSE は手動でインストールおよび設定する必要があります。

1.4.1. SSL の設定
リンクのコピー

以下の手順では、Java SDK を使用して SSL を設定する方法を説明します。

手順1.2 SSL の設定

Red Hat Virtualization Manager で使用する証明書をダウンロードします。
注記
デフォルトでは、Red Hat Virtualization Manager で使用する証明書の場所は /etc/pki/ovirt-engine/ca.pem です。

トラストストアを作成します。

keytool -import -alias "server.crt truststore" -file ca.crt -keystore server.truststore

$ keytool -import -alias "server.crt truststore" -file ca.crt -keystore server.truststore

Copy to Clipboard

Toggle word wrap

Api または Connection オブジェクトのインスタンスを構築する際には、trustStoreFile および trustStorePassword の引数を指定します。
```
myBuilder.trustStoreFile("/home/username/server.truststore");
myBuilder.trustStorePassword("p@ssw0rd");
```
```
myBuilder.trustStoreFile("/home/username/server.truststore");
myBuilder.trustStorePassword("p@ssw0rd");
```
Copy to Clipboard Toggle word wrap
注記
接続の作成時に trustStoreFile オプションを指定しない場合には、Java SDK はシステム変数 javax.net.ssl.trustStore で指定したデフォルトのトラストストアを使用するように試行します。このシステム変数がトラストストアを指定しない場合は、Java SDK は $JAVA_HOME/lib/security/jssecacerts または $JAVA_HOME/lib/security/cacerts で指定のトラストストアを使用するように試行します。

1.4.2. ホストの検証
リンクのコピー

デフォルトでは、Red Hat Virtualization Manager への接続を確立しようとすると、証明書のホスト名のアイデンティティーが検証されます。Connection クラスのインスタンスを構築している場合に、以下の引数を渡すとこの検証を無効にできます。

myBuilder.insecure(true);

myBuilder.insecure(true);

Copy to Clipboard

Toggle word wrap

重要

ホストのアイデンティティーを検証しないことによってもたらされるセキュリティーへの影響を認識した上での意識的な決断でない限りは、この方法は、セキュリティー上の理由から、実稼働システムで使用すべきではありません。

第2章ソフトウェア開発キットの使用
リンクのコピー

本章には、Java ソフトウェア開発キットの使用方法に関する例を記載します。特に記載がない限り、本章の例はすべて、ソフトウェア開発キットのバージョン 3 を使用します。

2.1. バージョン 3 での Red Hat Enterprise Virtualization Manager への接続
リンクのコピー

Java ソフトウェア開発キットバージョン 3 では、Api クラスは Red Hat Enterprise Virtualization 環境のオブジェクトに接続して操作するために使用する主要なクラスです。このクラスのインスタンスを宣言するには、ApiBuilder クラスのインスタンスを宣言して、builder メソッドでこのインスタンスに必要な引数を渡し、このインスタンス上で build メソッドを呼び出します。build メソッドは、Api クラスのインスタンスを返し、その後にこのクラスを変数に割り当てて、後続のアクションを実行する際に使用することができます。

Red Hat Enterprise Virtualization 環境との接続を作成して正常にシャットダウンし、接続を終了するとうい簡単な Java SE プログラムの例を以下に示します。

例2.1 Red Hat Enterprise Virtualization Manager への接続

package rhevm;

import org.ovirt.engine.sdk.Api;
import java.io.IOException;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.ovirt.engine.sdk.ApiBuilder;
import org.ovirt.engine.sdk.exceptions.ServerException;
import org.ovirt.engine.sdk.exceptions.UnsecuredConnectionAttemptError;

public class rhevm {

    public static void main(String[] args) {

        Api api = null;

        try {

            ApiBuilder myBuilder = new ApiBuilder()

            .url("https://rhevm.example.com/api")
            .user("admin@internal")
            .password("p@ssw0rd")
            .keyStorePath("/home/username/server.truststore")
            .keyStorePassword("p@ssw0rd");

            api = myBuilder.build();

            api.shutdown();

        } catch (ServerException | UnsecuredConnectionAttemptError | IOException ex) {
            Logger.getLogger(Ovirt.class.getName()).log(Level.SEVERE, null, ex);
        } finally {
            if (api != null) {
                try {
                    api.close();
                } catch (Exception ex) {
                    Logger.getLogger(Ovirt.class.getName()).log(Level.SEVERE, null, ex);
                }
            }
        }
    }
}

package rhevm;

import org.ovirt.engine.sdk.Api;
import java.io.IOException;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.ovirt.engine.sdk.ApiBuilder;
import org.ovirt.engine.sdk.exceptions.ServerException;
import org.ovirt.engine.sdk.exceptions.UnsecuredConnectionAttemptError;

public class rhevm {

    public static void main(String[] args) {

        Api api = null;

        try {

            ApiBuilder myBuilder = new ApiBuilder()

            .url("https://rhevm.example.com/api")
            .user("admin@internal")
            .password("p@ssw0rd")
            .keyStorePath("/home/username/server.truststore")
            .keyStorePassword("p@ssw0rd");

            api = myBuilder.build();

            api.shutdown();

        } catch (ServerException | UnsecuredConnectionAttemptError | IOException ex) {
            Logger.getLogger(Ovirt.class.getName()).log(Level.SEVERE, null, ex);
        } finally {
            if (api != null) {
                try {
                    api.close();
                } catch (Exception ex) {
                    Logger.getLogger(Ovirt.class.getName()).log(Level.SEVERE, null, ex);
                }
            }
        }
    }
}

Copy to Clipboard

Toggle word wrap

この例は、基本的な認証を使用した接続を作成していますが、ほかのメソッドも利用できます。ApiBuilder クラスのインスタンスに渡すことができる主要な引数の一覧については、「付録A ApiBuilder メソッド」を参照してください。

注記

Api クラスは、Autocloseable インターフェースを実装しない点に注意してください。そのため、上記の例のように finally ブロック内の Api クラスのインスタンスをシャットダウンして Red Hat Virtualization Manager との接続が正常にシャットダウンされるようにすることを推奨します。

2.2. バージョン 4 での Red Hat Virtualization Manager への接続
リンクのコピー

Java ソフトウェア開発キットバージョン 4 では、Connection クラスは Red Hat Virtualization 環境のオブジェクトに接続して操作するために使用する主要なクラスです。このクラスのインスタンスを宣言するには、ConnectionBuilder クラスのインスタンスを宣言して、builder メソッドでこのインスタンスに必要な引数を渡し、このインスタンス上で build メソッドを呼び出します。build メソッドは、Connection クラスのインスタンスを返し、その後にこのクラスを変数に割り当てて、後続のアクションを実行する際に使用することができます。

ソフトウェア開発キットバージョン 4 を使用して Red Hat Virtualization 環境の接続を作成する簡単な Java SE プログラムの例を以下に示します。

例2.2 Red Hat Virtualization Manager への接続

package rhevm;

import org.ovirt.engine.sdk4.Connection;
import org.ovirt.engine.sdk4.ConnectionBuilder;

public class rhevm {

    public static void main(String[] args) {

            ConnectionBuilder myBuilder = ConnectionBuilder.connection()

            .url("https://rhevm.example.com/ovirt-engine/api")
            .user("admin@internal")
            .password("p@ssw0rd")
            .trustStoreFile("/home/username/server.truststore")
            .trustStorePassword("p@ssw0rd");
        
        try (Connection conn = myBuilder.build()) {

            // Requests

        } catch (Exception e) {
           
            // Error handling
 
        }
    }
}

package rhevm;

import org.ovirt.engine.sdk4.Connection;
import org.ovirt.engine.sdk4.ConnectionBuilder;

public class rhevm {

    public static void main(String[] args) {

            ConnectionBuilder myBuilder = ConnectionBuilder.connection()

            .url("https://rhevm.example.com/ovirt-engine/api")
            .user("admin@internal")
            .password("p@ssw0rd")
            .trustStoreFile("/home/username/server.truststore")
            .trustStorePassword("p@ssw0rd");
        
        try (Connection conn = myBuilder.build()) {

            // Requests

        } catch (Exception e) {
           
            // Error handling
 
        }
    }
}

Copy to Clipboard

Toggle word wrap

この例は、基本的な認証を使用した接続を作成していますが、ほかのメソッドも利用できます。ConnectionBuilder クラスのインスタンスに渡すことができる主要な引数の一覧については、「付録B ConnectionBuilder メソッド」を参照してください。

2.3. エンティティーの一覧表示
リンクのコピー

以下の例では、Red Hat Virtualization Manager のエンティティーを一覧表示する方法を説明します。この例では、一覧表示するエンティティーは仮想マシンで、Api クラスの getVMs() メソッドを使用して一覧表示します。

手順2.1 エンティティーの一覧表示

一覧表示するエンティティーのタイプの List を宣言し、対応するメソッドを使用してエンティティーを一覧表示します。
```
List<VM> vms = api.getVMs().list();
```
```
List<VM> vms = api.getVMs().list();
```
Copy to Clipboard Toggle word wrap

2.4. リソースの属性の変更
リンクのコピー

以下の例では、リソースの属性を変更する方法について説明します。この例では、変更する属性は、「test」という名前の仮想マシンの説明で、これを「java_sdk」に変更します。

手順2.2 リソースの属性の変更

属性を変更するリソースのインスタンスを宣言します。
```
VM vm = api.getVMs().get("test");
```
```
VM vm = api.getVMs().get("test");
```
Copy to Clipboard Toggle word wrap
新しい属性値を設定します。
```
vm.setDescription("java_sdk");
```
```
vm.setDescription("java_sdk");
```
Copy to Clipboard Toggle word wrap
変更を適用する仮想マシンを更新します。
```
VM newVM = vm.update();
```
```
VM newVM = vm.update();
```
Copy to Clipboard Toggle word wrap

2.5. リソースの取得
リンクのコピー

Java ソフトウェア開発キットでは、リソースはname および UUID の 2 つの属性で参照することができます。そのオブジェクトが存在している場合には、いずれも指定した属性のオブジェクトが返されます。

name 属性値を使用してリソースを取得するには、以下の方法を使用します。

VM vm = api.getVMs().get("test");

VM vm = api.getVMs().get("test");

Copy to Clipboard

Toggle word wrap

UUID 属性値を使用してリソースを取得するには、以下の方法を使用します。

VM vm = api.getVMs().get(UUID.fromString("5a89a1d2-32be-33f7-a0d1-f8b5bc974ff6"));

VM vm = api.getVMs().get(UUID.fromString("5a89a1d2-32be-33f7-a0d1-f8b5bc974ff6"));

Copy to Clipboard

Toggle word wrap

2.6. リソースの追加
リンクのコピー

以下の例では、Red Hat Virtualization Manager にリソースを追加する 2 つの方法について説明します。これらの例では、追加するリソースは仮想マシンです。

例 1

以下の例では、VM クラスを宣言して、追加する新規仮想マシンを表現し、次にその仮想マシンの属性を希望する値に設定した後、最後に新規仮想マシンを Manager に追加します。

org.ovirt.engine.sdk.entities.VM vmParams = new org.ovirt.engine.sdk.entities.VM();

vmParams.setName("myVm");
vmParams.setCluster(api.getClusters().get("myCluster"));
vmParams.setTemplate(api.getTemplates().get("myTemplate"));
...

org.ovirt.engine.sdk.entities.VM vmParams = new org.ovirt.engine.sdk.entities.VM();

vmParams.setName("myVm");
vmParams.setCluster(api.getClusters().get("myCluster"));
vmParams.setTemplate(api.getTemplates().get("myTemplate"));
...

Copy to Clipboard

Toggle word wrap

VM vm = api.getVMs().add(vmParams);

VM vm = api.getVMs().add(vmParams);

Copy to Clipboard

Toggle word wrap

例 2

以下の例では、VM クラスのインスタンスは、例 1 と同じ方法で宣言しますが、get メソッドを使用して Manager 内の既存のオブジェクトを参照する方法の代わりに、各属性のインスタンスを宣言することによってその属性を参照します。最後に新規仮想マシンを Manager に追加します。

org.ovirt.engine.sdk.entities.VM vmParams = new org.ovirt.engine.sdk.entities.VM();

vmParams.setName("myVm");
org.ovirt.engine.sdk.entities.Cluster clusterParam = new Cluster();
clusterParam.setName("myCluster");
vmParams.setCluster(clusterParam);
org.ovirt.engine.sdk.entities.Template templateParam = new Template();
templateParam.setName("myTemplate");
vmParams.setTemplate(templateParam);
...

org.ovirt.engine.sdk.entities.VM vmParams = new org.ovirt.engine.sdk.entities.VM();

vmParams.setName("myVm");
org.ovirt.engine.sdk.entities.Cluster clusterParam = new Cluster();
clusterParam.setName("myCluster");
vmParams.setCluster(clusterParam);
org.ovirt.engine.sdk.entities.Template templateParam = new Template();
templateParam.setName("myTemplate");
vmParams.setTemplate(templateParam);
...

Copy to Clipboard

Toggle word wrap

VM vm = api.getVMs().add(vmParams);

VM vm = api.getVMs().add(vmParams);

Copy to Clipboard

Toggle word wrap

2.7. リソースに対するアクションの実行
リンクのコピー

以下の例では、リソースに対してアクションを実行する方法について説明します。この例では、「test」という名前の仮想マシンを起動します。

手順2.3 リソースに対するアクションの実行

リソースのインスタンスを宣言します。
```
 VM vm = api.getVMs().get("test");
```
```
 VM vm = api.getVMs().get("test");
```
Copy to Clipboard Toggle word wrap

リソースに送るアクションパラメーターを宣言します。

Action actionParam = new Action();
org.ovirt.engine.sdk.entities.VM vmParam = new org.ovirt.engine.sdk.entities.VM();
actionParam.setVm(vmParam);

Action actionParam = new Action();
org.ovirt.engine.sdk.entities.VM vmParam = new org.ovirt.engine.sdk.entities.VM();
actionParam.setVm(vmParam);

Copy to Clipboard

Toggle word wrap

アクションを実行します。
```
Action res = vm.start(actionParam);
```
```
Action res = vm.start(actionParam);
```
Copy to Clipboard Toggle word wrap

代わりに、内部メソッドとしてアクションを実行することも可能です。

Action res = vm.start(new Action()
{
    {
        setVm(new org.ovirt.engine.sdk.entities.VM());
    }
});

Action res = vm.start(new Action()
{
    {
        setVm(new org.ovirt.engine.sdk.entities.VM());
    }
});

Copy to Clipboard

Toggle word wrap

2.8. サブリソースの一覧表示
リンクのコピー

以下の例では、リソースのサブリソースを一覧表示する方法について説明します。この例では、「test」という名前の仮想マシンのサブリソースを一覧表示します。

手順2.4 サブリソースの一覧表示

一覧表示するサブリソースが含まれているリソースのインスタンスを宣言します。
```
VM vm = api.getVMs().get("test");
```
```
VM vm = api.getVMs().get("test");
```
Copy to Clipboard Toggle word wrap
サブリソースを一覧表示します。
```
List<VMDisk> disks = vm.getDisks().list();
```
```
List<VMDisk> disks = vm.getDisks().list();
```
Copy to Clipboard Toggle word wrap

2.9. サブリソースの取得
リンクのコピー

以下の例では、リソースのサブリソースを参照する方法について説明します。この例では、「test」という名前の仮想マシンに属する「my disk」という名前のディスクを参照します。

手順2.5 リソースのサブリソースの取得

参照するサブリソースが含まれているリソースのインスタンスを宣言します。
```
VM vm = api.getVMs().get("test");
```
```
VM vm = api.getVMs().get("test");
```
Copy to Clipboard Toggle word wrap
参照するサブリソースのインスタンスを宣言します。
```
VMDisk disk = vm.getDisks().get("my disk");
```
```
VMDisk disk = vm.getDisks().get("my disk");
```
Copy to Clipboard Toggle word wrap

2.10. リソースへのサブリソース追加
リンクのコピー

以下の例では、リソースにサブリソースを追加する方法を説明します。この例では、サイズが「1073741824L」で、「virtio」インターフェースを使用する「cow」形式の新規ディスクを「test」という名前の仮想マシンに追加します。

手順2.6 リソースへのサブソースの追加

サブリソースを追加するリソースのインスタンスを宣言します。
```
VM vm = api.getVMs().get("test");
```
```
VM vm = api.getVMs().get("test");
```
Copy to Clipboard Toggle word wrap

そのリソースの属性を定義するパラメーターを作成します。

Disk diskParam = new Disk();
diskParam.setProvisionedSize(1073741824L);
diskParam.setInterface("virtio");
diskParam.setFormat("cow");

Disk diskParam = new Disk();
diskParam.setProvisionedSize(1073741824L);
diskParam.setInterface("virtio");
diskParam.setFormat("cow");

Copy to Clipboard

Toggle word wrap

サブリソースを追加します。
```
Disk disk = vm.getDisks().add(diskParam);
```
```
Disk disk = vm.getDisks().add(diskParam);
```
Copy to Clipboard Toggle word wrap

2.11. サブリソースの変更
リンクのコピー

以下の例では、サブリソースの変更方法を説明します。この例では、「test」という名前の仮想マシンに属する「test_Disk1」という名前のディスクを「test_Disk1_updated」という名前に変更します。

手順2.7 サブリソースの更新

変更するサブリソースが含まれているリソースのインスタンスを宣言します。
```
VM vm = api.getVMs().get("test");
```
```
VM vm = api.getVMs().get("test");
```
Copy to Clipboard Toggle word wrap
変更するサブリソースのインスタンスを宣言します。
```
VMDisk disk = vm.getDisks().get("test_Disk1");
```
```
VMDisk disk = vm.getDisks().get("test_Disk1");
```
Copy to Clipboard Toggle word wrap
新しい属性値を設定します。
```
disk.setAlias("test_Disk1_updated");
```
```
disk.setAlias("test_Disk1_updated");
```
Copy to Clipboard Toggle word wrap
サブリソースを更新します。
```
VMDisk updateDisk = disk.update();
```
```
VMDisk updateDisk = disk.update();
```
Copy to Clipboard Toggle word wrap

2.12. サブリソースに対するアクションの実行
リンクのコピー

以下の例では、サブリソースに対するアクションの実行方法を説明します。この例では、「test」という名前の仮想マシンに属する「test_Disk1」という名前のディスクがアクティブ化されます。

手順2.8 サブリソースに対するアクションの実行

アクションを実行する対象となるサブリソースが含まれているリソースのインスタンスを宣言します。
```
VM vm = api.getVMs().get("test");
```
```
VM vm = api.getVMs().get("test");
```
Copy to Clipboard Toggle word wrap
サブリソースのインスタンスを宣言します。
```
VMDisk disk = vm.getDisks().get("test_Disk1");
```
```
VMDisk disk = vm.getDisks().get("test_Disk1");
```
Copy to Clipboard Toggle word wrap
サブリソースに送信するアクションパラメーターを宣言します。
```
Action actionParam = new Action();
```
```
Action actionParam = new Action();
```
Copy to Clipboard Toggle word wrap
アクションを実行します。
```
Action result = disk.activate(actionParam);
```
```
Action result = disk.activate(actionParam);
```
Copy to Clipboard Toggle word wrap

付録A ApiBuilder メソッド
リンクのコピー

以下の表では、Java ソフトウェア開発キット V3 で使用する ApiBuilder クラスで利用可能な主要メソッドについて説明します。

Expand

表A.1 ApiBuilder メソッド
メソッド	引数タイプ	説明
`user`	`文字列`	Manager への接続に使用するユーザー。`admin@internal` のようにユーザー名とドメインの両方を指定する必要があります。このメソッドは、`password` メソッドと合わせて使用する必要があります。
`password`	`文字列`	Manager への接続に使用するユーザーのパスワード。
`sessionID`	`文字列`	Manager への接続に使用するセッションの ID。Manager の認証が済んでいて、セッションが利用できる場合には、ユーザー名とパスワードではなくこの引数を指定することができます。
`requestTimeout`	`整数`	要求に応答するまで待機するタイムアウトの値 (秒)。この値よりも長く、要求に応答するまでに時間がかかった場合には、要求はキャンセルされ、例外が送出されます。この引数は任意です。
`sessionTimeout`	`整数`	Manager に要求が出されない場合にアクティブなセッションを破棄する
`persistentAuth`	`ブール値`	cookie を使用した永続的な認証を有効化または無効化します。デフォルトではこのオプションは有効となっているため、このオプションを無効にする場合のみこのメソッドが必要です。
`noHostVerification`	`ブール値`	Manager のホスト先のサーバーが公開する SSL 証明書のホスト名の検証を有効化または無効化します。デフォルトでは、ホスト名のアイデンティティーは検証され、ホスト名が正しくない場合には接続が拒否されます。そのため、このオプションを無効にする場合のみこのメソッドが必要です。
`keyStorePath`	`文字列`	Manager のホスト先のサーバーが公開する証明書の検証に使用する CA 証明書が含まれるファイルの場所を指定します。このメソッドは、`keyStorePassword` メソッドと合わせて使用する必要があります。
`keyStorePassword`	`文字列`	`keyStorePath` メソッドで指定するキーストアファイルにアクセスする際に使用するパスワード。
`filter`	`ブール値`	要求を行うユーザーのパーミッションをベースにしたオブジェクトのフィルタリングを有効化または無効化します。デフォルトでは、このオプションは無効になっており、この環境内のオブジェクトがすべてユーザーに表示されます。このメソッドは、要求を行うユーザーにだけ環境内のオブジェクトを表示するように制限する際にのみ必要です。
`debug`	`ブール値`	デバッグの出力を有効化または無効化します。デフォルトでは、このオプションは無効になっています。

付録B ConnectionBuilder メソッド
リンクのコピー

以下の表では、Java ソフトウェア開発キット V4 で使用する ConnectionBuilder クラスで利用可能な主要メソッドについて説明します。

Expand

表B.1 ConnectionBuilder メソッド
メソッド	引数タイプ	説明
`user`	`文字列`	Manager への接続に使用するユーザー。`admin@internal` のようにユーザー名とドメインの両方を指定する必要があります。このメソッドは、`password` メソッドと合わせて使用する必要があります。
`password`	`文字列`	Manager への接続に使用するユーザーのパスワード。
`compress`	`ブール値`	Manager をホストしているサーバーからの応答を圧縮するべきかどうかを指定します。デフォルトでは、このオプションは無効になっているため、このオプションを有効にする場合のみにこのメソッドは必要です。
`timeout`	`整数`	要求に応答するまで待機するタイムアウトの値 (秒)。要求への応答時間がこの値よりも長い場合には、要求はキャンセルされ、例外が送出されます。この引数は任意です。
`ssoUrl`	`文字列`	Manager をホストするサーバーのベース URL。たとえば、パスワード認証には `https://server.example.com/ovirt-engine/sso/oauth/token?\grant_type=password&scope=ovirt-app-api` を使用します。
`ssoRevokeUrl`	`文字列`	SSO 呼び出しサービスのベース URL。外部認証サービスを使用する場合にのみこのオプションを指定する必要があります。デフォルトでは、engine の一部となっている SSO サービスを使用して SSO トークンの呼び出しが実行されるように、この URL は自動的に `url` オプションの値から算出されます。
`ssoTokenName`	`文字列`	SSO サーバーから返される JSON SSO の応答にあるトークン名。デフォルトでは、この値は `access_token` です。
`insecure`	`ブール値`	Manager のホスト先のサーバーが公開する SSL 証明書のホスト名の検証を有効化または無効化します。デフォルトでは、ホスト名のアイデンティティーは検証され、ホスト名が正しくない場合には接続が拒否されます。そのため、このオプションを無効にする場合のみこのメソッドが必要です。
`trustStoreFile`	`文字列`	Manager のホスト先のサーバーが公開する証明書の検証に使用する CA 証明書が含まれるファイルの場所を指定します。このメソッドは、`trustStorePassword` メソッドと合わせて使用する必要があります。
`trustStorePassword`	`文字列`	`trustStorePath` メソッドで指定するキーストアファイルにアクセスする際に使用するパスワード。

付録C 改訂履歴
リンクのコピー

改訂履歴

改訂 4.0-1.1

Thu Aug 25 2016

Red Hat Localization Services

翻訳ファイルを XML ソースバージョン 4.0-1 と同期

改訂 4.0-1

Wed 15 Jun 2016

Red Hat Virtualization Documentation Team

Red Hat Virtualization 4.0 リリースの初版作成

法律上の通知
リンクのコピー

This document is licensed by Red Hat under the Creative Commons Attribution-ShareAlike 3.0 Unported License. If you distribute this document, or a modified version of it, you must provide attribution to Red Hat, Inc. and provide a link to the original. If the document is modified, all Red Hat trademarks must be removed.

Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.

Red Hat, Red Hat Enterprise Linux, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.

Linux® is the registered trademark of Linus Torvalds in the United States and other countries.

Java® is a registered trademark of Oracle and/or its affiliates.

XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.

MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.

Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.

The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.

All other trademarks are the property of their respective owners.

Java SDK ガイド

Red Hat Virtualization Java SDK の使用

Red Hat Virtualization Documentation Team

第1章概要
リンクのコピー

1.1. 前提条件
リンクのコピー

1.2. Java ソフトウェア開発キットのインストール
リンクのコピー

1.3. 依存関係
リンクのコピー

1.4. SSL の設定
リンクのコピー

1.4.1. SSL の設定
リンクのコピー

1.4.2. ホストの検証
リンクのコピー

第2章ソフトウェア開発キットの使用
リンクのコピー

2.1. バージョン 3 での Red Hat Enterprise Virtualization Manager への接続
リンクのコピー

2.2. バージョン 4 での Red Hat Virtualization Manager への接続
リンクのコピー

2.3. エンティティーの一覧表示
リンクのコピー

2.4. リソースの属性の変更
リンクのコピー

2.5. リソースの取得
リンクのコピー

2.6. リソースの追加
リンクのコピー

2.7. リソースに対するアクションの実行
リンクのコピー

2.8. サブリソースの一覧表示
リンクのコピー

2.9. サブリソースの取得
リンクのコピー

2.10. リソースへのサブリソース追加
リンクのコピー

2.11. サブリソースの変更
リンクのコピー

2.12. サブリソースに対するアクションの実行
リンクのコピー

付録A ApiBuilder メソッド
リンクのコピー

付録B ConnectionBuilder メソッド
リンクのコピー

付録C 改訂履歴
リンクのコピー

法律上の通知
リンクのコピー

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

多様性を受け入れるオープンソースの強化

会社概要

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

Java SDK ガイド

Red Hat Virtualization Java SDK の使用

Red Hat Virtualization Documentation Team

第1章 概要リンクのコピーリンクがクリップボードにコピーされました!

1.1. 前提条件リンクのコピーリンクがクリップボードにコピーされました!

1.2. Java ソフトウェア開発キットのインストールリンクのコピーリンクがクリップボードにコピーされました!

1.3. 依存関係リンクのコピーリンクがクリップボードにコピーされました!

1.4. SSL の設定リンクのコピーリンクがクリップボードにコピーされました!

1.4.1. SSL の設定リンクのコピーリンクがクリップボードにコピーされました!

1.4.2. ホストの検証リンクのコピーリンクがクリップボードにコピーされました!

第2章 ソフトウェア開発キットの使用リンクのコピーリンクがクリップボードにコピーされました!

2.1. バージョン 3 での Red Hat Enterprise Virtualization Manager への接続リンクのコピーリンクがクリップボードにコピーされました!

2.2. バージョン 4 での Red Hat Virtualization Manager への接続リンクのコピーリンクがクリップボードにコピーされました!

2.3. エンティティーの一覧表示リンクのコピーリンクがクリップボードにコピーされました!

2.4. リソースの属性の変更リンクのコピーリンクがクリップボードにコピーされました!

2.5. リソースの取得リンクのコピーリンクがクリップボードにコピーされました!

2.6. リソースの追加リンクのコピーリンクがクリップボードにコピーされました!

2.7. リソースに対するアクションの実行リンクのコピーリンクがクリップボードにコピーされました!

2.8. サブリソースの一覧表示リンクのコピーリンクがクリップボードにコピーされました!

2.9. サブリソースの取得リンクのコピーリンクがクリップボードにコピーされました!

2.10. リソースへのサブリソース追加リンクのコピーリンクがクリップボードにコピーされました!

2.11. サブリソースの変更リンクのコピーリンクがクリップボードにコピーされました!

2.12. サブリソースに対するアクションの実行リンクのコピーリンクがクリップボードにコピーされました!

付録A ApiBuilder メソッドリンクのコピーリンクがクリップボードにコピーされました!

付録B ConnectionBuilder メソッドリンクのコピーリンクがクリップボードにコピーされました!

付録C 改訂履歴リンクのコピーリンクがクリップボードにコピーされました!

法律上の通知リンクのコピーリンクがクリップボードにコピーされました!

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

多様性を受け入れるオープンソースの強化

会社概要

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

第1章概要
リンクのコピー

1.1. 前提条件
リンクのコピー

1.2. Java ソフトウェア開発キットのインストール
リンクのコピー

1.3. 依存関係
リンクのコピー

1.4. SSL の設定
リンクのコピー

1.4.1. SSL の設定
リンクのコピー

1.4.2. ホストの検証
リンクのコピー

第2章ソフトウェア開発キットの使用
リンクのコピー

2.1. バージョン 3 での Red Hat Enterprise Virtualization Manager への接続
リンクのコピー

2.2. バージョン 4 での Red Hat Virtualization Manager への接続
リンクのコピー

2.3. エンティティーの一覧表示
リンクのコピー

2.4. リソースの属性の変更
リンクのコピー

2.5. リソースの取得
リンクのコピー

2.6. リソースの追加
リンクのコピー

2.7. リソースに対するアクションの実行
リンクのコピー

2.8. サブリソースの一覧表示
リンクのコピー

2.9. サブリソースの取得
リンクのコピー

2.10. リソースへのサブリソース追加
リンクのコピー

2.11. サブリソースの変更
リンクのコピー

2.12. サブリソースに対するアクションの実行
リンクのコピー

付録A ApiBuilder メソッド
リンクのコピー

付録B ConnectionBuilder メソッド
リンクのコピー

付録C 改訂履歴
リンクのコピー

法律上の通知
リンクのコピー