バックアップ用の AEM Forms の準備

このドキュメントのサンプルと例は、JEE 環境の AEM Forms のみを対象としています。

バックアップおよび復元サービスについて

バックアップおよび復元サービスを使用すると、AEM Forms を​バックアップモード​にして、ホットバックアップを実行できます。バックアップおよび復元サービスは、実際には AEM Forms のバックアップを実行したり、システムを復元したりしません。代わりに、サーバーを継続して実行できるようにしながら、サーバーを一貫性のある信頼性の高いバックアップの状態にします。グローバルドキュメントストレージ (GDS) とFormsサーバーに接続されたデータベースをバックアップするアクションは、ユーザーが担当します。 GDS は、長期間有効なプロセス内で使用されるファイルを格納するためのディレクトリです。

バックアップモードとは、バックアップ処理中に GDS 内のファイルがパージされないようにするために、サーバーが入る状態のことです。代わりに、GDS ディレクトリの下にサブディレクトリを作成し、バックアップモードの保存が終了した後にパージされるファイルのレコードを保持します。ファイルは、システムの再起動後も存続することを目的としており、数日、あるいは数年にわたる場合もあります。これらのファイルは、Forms Server の全体的な状態の重要な部分であり、PDFファイル、ポリシー、フォームテンプレートなどが含まれる場合があります。 これらのファイルが失われたり破損したりした場合は、Formsサーバー上のプロセスが不安定になり、データが失われる可能性があります。

スナップショットバックアップの実行を選択できます。この場合、通常は一定期間バックアップモードに入り、バックアップアクティビティの完了後にバックアップモードを終了します。GDS からファイルをパージして、ファイルが不必要に大きくならないようにするには、バックアップモードを終了する必要があります。バックアップモードを明示的に終了するか、バックアップモードのセッションで時間切れになるのを待ちます。

また、サーバーを永続的なバックアップモードのままにすることもできます。これは、ローリングバックアップや継続的なシステムカバレッジのバックアップ戦略に典型的なものです。ローリングバックアップモードでは、システムが常にバックアップモードになり、前のセッションが解放されるとすぐに新しいバックアップモードセッションが初期化されます。連続バックアップモードでは、ファイルは 2 回のバックアップモードセッションの後にパージされ、参照されなくなります。

Backup and Restore サービスを使用して、Forms Server に接続された GDS またはデータベースのバックアップを実行するために作成する既存のアプリケーションまたは新しいアプリケーションに追加できます。

バックアップおよび復元サービスを使用して、次のタスクを実行できます。

• バックアップモードに入ります。
• バックアップモードを終了します。

Forms Server でのバックアップモードの開始

Forms Server のホットバックアップを許可するには、バックアップモードに入ります。 バックアップモードを開始する場合は、組織のバックアップ手順に基づいて次の情報を指定します。

• バックアッププロセスに役立つバックアップモードセッションを識別する一意のラベル。
• バックアップ手順が完了するまでの時間。
• 連続バックアップモードにするかどうかを示すフラグ。ローリングバックアップを実行する場合にのみ役立ちます。

バックアップモードに入るためのアプリケーションを書き込む前に、Forms Server をバックアップモードにした後に使用するバックアップ手順を理解しておくことをお勧めします。 AEM Forms のバックアップを実行する際に考慮すべき事項について詳しくは、管理ヘルプを参照してください。

手順の概要

バックアップモードに入るアプリケーションを作成するには、次の手順を実行します。

1. プロジェクトファイルを含めます。
2. BackupService クライアントオブジェクトを作成します。
3. 一意のラベル、バックアップを実行する時間、継続的なバックアップモードにするかどうかを決定します。
4. バックアップモードに入ります。
5. （オプション）サーバー上のバックアップモードセッションに関する情報を取得します。
6. GDS（グローバルデータストア）とデータベースのバックアップを実行します。

プロジェクトファイルを含める

開発プロジェクトに必要なファイルを含めます。これらのファイルは、コードを正しくコンパイルし、バックアップおよび復元サービス API を使用するために、プロジェクトに含めることが重要です。

これらのファイルの場所については、AEM Forms Java ライブラリファイルを含めるを参照してください。

BackupService クライアント API オブジェクトを作成

プログラムでバックアップモードを終了するには、BackupService クライアントオブジェクトを作成して Backup and Restore Service API を使用します。

一意のラベルを決定し、バックアップを実行する時間を決定し、連続バックアップモードにするかどうかを決定

バックアップモードに入る前に、固有のラベルを決定し、バックアップの実行に割り当てる時間を決定し、Forms Server をバックアップモードに維持するかどうかを決定する必要があります。 これらの検討事項は、組織が確立したバックアップ手順と統合する際に重要です。 （管理ヘルプを参照。）

バックアップモードに移行

組織のバックアップ手順と一致するパラメーターを使用して、バックアップモードに入ります。

サーバー上のバックアップモードセッションに関する情報を取得

バックアップモードに入った後、セッションに関する情報を取得できます。この情報は、バックアップ手順との統合に使用可能

GDS とデータベースのバックアップを実行

バックアップモードに正常に入ったら、グローバルドキュメントストレージ (GDS) とFormsサーバーが接続されているデータベースのバックアップを実行できます。 この手順は、手動で実行することも、他のツールを実行してバックアップ手順を実行することもできるので、組織に固有の手順です。

Java API を使用してバックアップモードに移行

バックアップと復元サービス API を使用してバックアップモードに入ります。

1. プロジェクトファイルを含める

   必要なクライアント JAR ファイル（ adobe-backup-restore-client-sdk.jar など）を Java プロジェクトのクラスパスに含めます。 Java クライアントアプリケーションを作成するには、次の JAR ファイルをプロジェクトのクラスパスに追加する必要があります。

   • adobe-backup-restore-client-sdk.jar
   • adobe-livecycle-client.jar
   • adobe-usermanager-client.jar
   • adobe-utilities.jar（AEM Forms が JBoss Application Server にデプロイされている場合に必要）
   • jbossall-client.jar（AEM Forms が JBoss Application Server にデプロイされている場合に必要）

2. BackupService Client API オブジェクトを作成する

   ServiceClientFactory オブジェクトと BackupService クライアント API オブジェクトを一緒に使用します。

   • 接続プロパティを含む ServiceClientFactory オブジェクトを作成します。（接続プロパティの設定を参照）
   • コンストラクターを使用して ServiceClientFactory オブジェクトを渡すことによって、BackupService オブジェクトを作成します。

3. 固有のラベルを決定し、バックアップを実行する時間を決定し、継続的なバックアップモードにするかどうかを決定

   一意のラベルを決定し、バックアップの実行に割り当てる時間を決定し、Forms Server を継続的なバックアップモードに維持するかどうかを決定します。

4. バックアップモードに入る

   enterBackupMode メソッドを次のパラメーターで呼び出してバックアップモードに入ります。

   • バックアップモードセッションを識別する一意の人間が読み取れるラベルを指定する String 値。XML 形式にエンコードできないスペースや文字は使用しないことをお勧めします。

   • バックアップモードを維持する時間（分）を指定する int 値。1 から 10080（1 週間の分数）の値を指定できます。連続バックアップモードを使用する場合、この値は無視されます。

   • 連続バックアップモードにするかどうかを指定する Boolean 値。True の値は連続バックアップモードにするよう指定します。連続バックアップモードの場合、バックアップモードを維持する分数に指定した値は無視されます。

     連続バックアップモードとは、現在のバックアップモードが完了した後に新しいバックアップモードセッションが開始されることを意味します。 False の値は、継続的なバックアップモードが使用されず、バックアップモードを終了した後に、GDS からのファイルのパージが再開されることを意味します。

5. サーバー上のバックアップモードセッションに関する情報を取得する

   enterBackupMode メソッドを呼び出した後に返される BackupModeEntryResult オブジェクトを使用して情報を取得します。バックアップモードに入った後に取得できる情報は、バックアップ手順との統合に役立つ場合があります。例えば、バックアップ手順のファイル名の入力として、ラベル、バックアップ ID、開始時刻が役立つ場合があります。

6. GDS とデータベースのバックアップを実行

   グローバルドキュメントストレージ (GDS) と、Formsサーバーが接続されているデータベースをバックアップします。 バックアップを実行するためのアクションは、AEM Forms SDK の一部ではなく、組織内のバックアップ手順に固有の手動手順が含まれる場合もあります。

Web サービス API を使用してバックアップモードに移行

バックアップと復元サービス API が提供する web サービスを使用して、バックアップモードに入ります。

1. プロジェクトファイルを含める

   • Backup and Restore Service API WSDL を使用する Microsoft .NET クライアントアセンブリを作成します。
   • Microsoft .NET クライアントアセンブリを参照します。

2. BackupService Client API オブジェクトを作成する

   Microsoft .NET クライアントアセンブリを使用して、デフォルトのコンストラクターを呼び出して BackupServiceService オブジェクトを作成し、Credentials メソッドを使用して資格情報を指定します。

3. 固有のラベルを決定し、バックアップを実行する時間を決定し、継続的なバックアップモードにするかどうかを決定

   一意のラベルを決定し、バックアップの実行に割り当てる時間を決定し、Forms Server を継続的なバックアップモードに維持するかどうかを決定します。

4. バックアップモードに入る

   バックアップモードに入るには、enterBackupMode メソッドを呼び出して、次の値を渡します。

   • バックアップモードセッションを識別する一意の人間が読み取れるラベルを指定する String 値。XML 形式にエンコードできないスペースや文字は使用しないことをお勧めします。

   • バックアップモードで維持する時間（分）を指定する Uint32 値。1 から 10080（1 週間の分数）の値を指定できます。連続バックアップモードを使用する場合、この値は無視されます。

   • 連続バックアップモードにするかどうかを指定する Boolean 値。True の値は連続バックアップモードにするよう指定します。連続バックアップモードの場合、バックアップモードを維持する分数に指定した値は無視されます。連続バックアップモードとは、現在のバックアップモードセッションが完了した後に新しいバックアップモードセッションが開始されることを意味します。

     False の値は、継続的なバックアップモードは使用されず、バックアップモードを終了した後に、GDS からのファイルのパージが再開されることを意味します。

5. サーバー上のバックアップモードセッションに関する情報を取得する

   enterBackupMode メソッドを呼び出した後、バックアップモードセッションが成功したことを確認するために返される BackupModeEntryResult からバックアップモードセッションに関する情報を取得します。バックアップモードに入った後に取得できる情報は、バックアップ手順との統合に役立つ場合があります。例えば、バックアップ手順のファイル名の入力として、ラベル、バックアップ ID、開始時刻が役立つ場合があります。

6. GDS とデータベースのバックアップを実行

   グローバルドキュメントストレージ (GDS) と、Formsサーバーが接続されているデータベースをバックアップします。 バックアップを実行するためのアクションは、AEM Forms SDK の一部ではなく、組織内のバックアップ手順に固有の手動手順が含まれる場合もあります。

Forms Server でのバックアップモードの終了

FormsサーバーがFormsサーバー上の GDS（グローバルドキュメントストレージ）からのファイルのパージを再開するには、バックアップモードを終了します。

終了モードに入るためのアプリケーションを作成する前に、AEM Forms で使用されるバックアップ手順を理解しておくことをお勧めします。AEM Forms のバックアップを実行する際に考慮すべき事項について詳しくは、管理ヘルプを参照してください。

手順の概要

バックアップモードを終了するには、次の手順を実行します。

1. プロジェクトファイルを含めます。
2. BackupService クライアントオブジェクトを作成します。
3. バックアップモードを終了します。
4. （オプション）Forms Server 上で実行されていたバックアップモードセッションに関する情報を取得します。

プロジェクトファイルを含める

開発プロジェクトに必要なファイルをすべて含めます。これらのファイルは、コードを正しくコンパイルし、Backup and Restore Service API を使用する際に重要です。

これらのファイルの場所については、AEM Forms Java ライブラリファイルを含めるを参照してください。

BackupService クライアント API オブジェクトを作成

プログラムでバックアップモードを終了するには、BackupService クライアントオブジェクトを作成して Backup and Restore Service API を使用します。

バックアップモードの終了

バックアップモードを終了して、グローバルドキュメントストレージ（GDS）から通常どおりファイルをパージする処理を再開します。バックアップモードを終了する前に、バックアップ手順が完了したことを確認する必要があります。

終了したバックアップモードセッションに関する情報の取得

バックアップモードを終了した後、セッションに関する情報を取得できます。この情報は、バックアップ手順との統合に使用できます。

Java API を使用してバックアップモードを終了する

Backup and Restore Service API（Java）を使用してバックアップモードを終了します。

1. プロジェクトファイルを含める

   必要なクライアント JAR ファイル（ adobe-backup-restore-client-sdk.jar など）を Java プロジェクトのクラスパスに含めます。 Java クライアントアプリケーションを作成するには、次の JAR ファイルをプロジェクトのクラスパスに追加する必要があります。

   • adobe-backup-restore-client-sdk.jar
   • adobe-livecycle-client.jar
   • adobe-usermanager-client.jar
   • adobe-utilities.jar（AEM Forms が JBoss Application Server にデプロイされている場合に必要）
   • jbossall-client.jar（AEM Forms が JBoss Application Server にデプロイされている場合に必要）

2. BackupService Client API オブジェクトを作成する

   ServiceClientFactory オブジェクトと BackupService クライアント API オブジェクトを一緒に使用します。

   • 接続プロパティを含む ServiceClientFactory オブジェクトを作成します。（接続プロパティの設定を参照。）
   • コンストラクターを使用し、ServiceClientFactory オブジェクトをパラメーターとして渡すことによって、BackupService オブジェクトを作成します。

3. バックアップモードに入る

   leaveBackupMode メソッドを呼び出して、バックアップモードを終了します。

4. サーバー上のバックアップモードセッションに関する情報を取得する

   返された BackupModeResult オブジェクトを使用して、操作に関する情報を取得します。バックアップモードに入った後に取得できる情報は、バックアップ手順との統合に役立つ場合があります。例えば、バックアップ手順のファイル名の入力として、ラベル、バックアップ ID、開始時刻が役立つ場合があります。

Web サービス API を使用してバックアップモードを終了する

Backup and Restore Service API（web サービス）を使用して、バックアップモードを終了します。

1. プロジェクトファイルを含める

   Web サービスを使用するには、必ずプロキシファイルを含める必要があります。次の手順に従って、Backup and Restore Service API を web サービスとして使用するようにプロジェクトを設定します。

   • Backup and Restore Service API WSDL を使用する Microsoft .NET クライアントアセンブリを作成します。
   • Microsoft .NET クライアントアセンブリを参照します。

2. BackupService Client API オブジェクトを作成する

   Microsoft .NET クライアントアセンブリを使用し、デフォルトのコンストラクターを呼び出して BackupServiceService オブジェクトを作成します。

3. バックアップモードに入る

   leaveBackupMode web サービス操作を呼び出して、バックアップモードを終了します。

4. サーバー上のバックアップモードセッションに関する情報を取得する

   操作後にバックアップモード識別子を取得し、正常に実行されたことを確認します。バックアップモードを終了した後に取得できる情報は、バックアップ手順との統合に役立つ場合があります。