PDFドキュメントのプログラムによるアセンブリ

このドキュメントのサンプルと例は、JEE上のAEM Forms環境に限られています。

AssemblerサービスAPIを使用して、複数のPDFドキュメントを1つのPDFドキュメントにアセンブリできます。 次の図は、3つのPDFドキュメントを1つのPDFドキュメントに結合する場合を示しています。

pa_pa_document_assembly

2つ以上のPDFドキュメントを1つのPDFドキュメントにアセンブリするには、DDXドキュメントが必要です。 DDXドキュメントは、Assemblerサービスが生成するPDFドキュメントを記述します。 つまり、DDXドキュメントは、実行するアクションをAssemblerサービスに指示します。

この説明では、次のDDXドキュメントが使用されているとします。

 <?xml version="1.0" encoding="UTF-8"?>
 <DDX xmlns="https://ns.adobe.com/DDX/1.0/">
     <PDF result="out.pdf">
         <PDF source="map.pdf" />
         <PDF source="directions.pdf" />
     </PDF>
 </DDX>

このDDXドキュメントは、map.pdf​および​directions.pdf​という2つのPDFドキュメントを1つのPDFドキュメントにマージします。

メモ

PDFドキュメントを分解するDDXドキュメントを表示するには、「PDFドキュメントのプログラムによる分解」を参照してください。

メモ

Assemblerサービスについて詳しくは、『AEM Forms🔗向けサービスリファレンス』を参照してください。

メモ

DDXドキュメントについて詳しくは、『AssemblerサービスとDDXリファレンス』を参照してください。

Webサービスを使用してAssemblerサービスを呼び出す際の考慮事項

大きなドキュメントのアセンブリ中にヘッダーとフッターを追加すると、OutOfMemoryエラーが発生し、ファイルがアセンブルされない場合があります。 この問題が発生する可能性を減らすには、次の例に示すように、DDXドキュメントにDDXProcessorSetting要素を追加します。

<DDXProcessorSetting name="checkpoint" value="2000" />

この要素は、DDX要素の子として、またはPDF result要素の子として追加できます。 この設定のデフォルト値は0(ゼロ)で、チェックポイントをオフにし、DDXはDDXProcessorSetting要素が存在しない場合と同じように動作します。 OutOfMemoryエラーが発生した場合は、値を整数に設定する必要がある場合があります(通常は500 ~ 5000)。 チェックポイントの値が小さいと、チェックポイントが頻繁に行われます。

手順の概要

複数のPDFドキュメントから1つのPDFドキュメントをアセンブリするには、次のタスクを実行します。

  1. プロジェクトファイルを含めます。
  2. PDFアセンブラークライアントを作成します。
  3. 既存のDDXドキュメントの参照
  4. 入力PDFドキュメントを参照します。
  5. 実行時オプションを設定します。
  6. 入力PDFドキュメントをアセンブリします。
  7. 結果を抽出します。

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

必要なファイルを開発プロジェクトに含めます。 Javaを使用してクライアントアプリケーションを作成する場合は、必要なJARファイルを含めます。 Webサービスを使用する場合は、プロキシファイルを必ず含めてください。

次のJARファイルをプロジェクトのクラスパスに追加する必要があります。

  • adobe-livecycle-client.jar
  • adobe-usermanager-client.jar
  • adobe-assembler-client.jar
  • adobe-utilities.jar(AEM FormsをJBossにデプロイする場合に必要)
  • jbossall-client.jar(AEM FormsをJBossにデプロイする場合に必要)

AEM FormsがJBoss以外のサポート対象のJ2EEアプリケーションサーバーにデプロイされている場合は、adobe-utilities.jarファイルとjbossall-client.jarファイルを、AEM FormsがデプロイされているJ2EEアプリケーションサーバーに固有のJARファイルに置き換える必要があります。

PDFアセンブラークライアントの作成

プログラムによってAssembler操作を実行する前に、Assemblerクライアントを作成する必要があります。

既存のDDXドキュメントの参照

PDFドキュメントをアセンブリするには、DDXドキュメントを参照する必要があります。 例えば、この節で紹介したDDXドキュメントについて考えてみましょう。 このDDXドキュメントは、2つのPDFドキュメントを1つのPDFドキュメントに結合するようAssemblerサービスに指示します。

入力PDFドキュメントの参照

Assemblerサービスに渡す入力PDFドキュメントを参照します。 例えば、MapとDirectionsという名前の2つの入力PDFドキュメントを渡す場合、対応するPDFファイルを渡す必要があります。

map.pdfファイルとdirections.pdfファイルの両方をコレクションオブジェクトに配置する必要があります。 キーの名前は、DDXドキュメントのPDF source属性の値と一致する必要があります。 DDXドキュメントのキーとソース属性が一致する場合、PDFファイルの名前は関係ありません。

メモ

invokeDDX操作を呼び出すと、コレクションオブジェクトを含むAssemblerResultオブジェクトが返されます。 この操作は、2つ以上の入力PDFドキュメントをAssemblerサービスに渡す場合に使用されます。 ただし、Assemblerサービスに入力PDFを1つだけ渡し、1つの戻り文書しか渡さない場合は、invokeOneDocument操作を呼び出します。 この操作を呼び出すと、1つのドキュメントが返されます。 この操作の使用について詳しくは、暗号化されたPDFドキュメントのアセンブリを参照してください。

実行時オプションの設定

ジョブの実行中にAssemblerサービスの動作を制御する実行時オプションを設定できます。 例えば、エラーが発生した場合にジョブの処理を続行するようAssemblerサービスに指示するオプションを設定できます。 設定できる実行時オプションについて詳しくは、『AEM Forms APIリファレンス』のAssemblerOptionSpecクラス参照を参照してください。

入力PDFドキュメントのアセンブリ

サービスクライアントを作成し、DDXファイルを参照し、入力PDFドキュメントを格納するコレクションオブジェクトを作成し、実行時オプションを設定した後、DDX操作を呼び出すことができます。 この節で指定したDDXドキュメントを使用する場合、map.pdfファイルとdirection.pdfファイルが1つのPDFドキュメントにマージされます。

結果の抽出

Assemblerサービスは、java.util.Mapオブジェクトを返します。このオブジェクトは、AssemblerResultオブジェクトから取得でき、操作結果が格納されます。 返されるjava.util.Mapオブジェクトには、結果のドキュメントと例外が含まれます。

次の表に、返されるjava.util.Mapオブジェクトに配置できるキー値とオブジェクトの種類の概要を示します。

キー値

オブジェクトタイプ

説明

documentName

com.adobe.idp.Document

DDX結果要素で指定された結果ドキュメントを含みます

documentName

Exception

ドキュメントの例外を含みます

OutputMapConstants.LOG_NAME

com.adobe.idp.Documen

ジョブログを含みます

関連トピック

AEM Forms Java ライブラリファイルを含める

接続プロパティの設定

PDFドキュメントのプログラムによる分解

Java APIを使用したPDFドキュメントのアセンブリ

AssemblerサービスAPI(Java)を使用してPDFドキュメントをアセンブリします。

  1. プロジェクトファイルを含めます。

    Javaプロジェクトのクラスパスに、adobe-assembler-client.jarなどのクライアントJARファイルを含めます。

  2. PDFアセンブラークライアントを作成します。

    • 接続プロパティを含む ServiceClientFactory オブジェクトを作成します。
    • コンストラクターを使用してAssemblerServiceClientオブジェクトを渡し、ServiceClientFactoryオブジェクトを作成します。
  3. 既存のDDXドキュメントの参照

    • コンストラクターを使用し、DDXファイルの場所を指定する文字列値を渡して、DDXドキュメントを表すjava.io.FileInputStreamオブジェクトを作成します。
    • コンストラクタを使用して com.adobe.idp.Document オブジェクトを渡すことによって、java.io.FileInputStream オブジェクトを作成します。
  4. 入力PDFドキュメントを参照します。

    • HashMapコンストラクターを使用して、入力PDFドキュメントの格納に使用するjava.util.Mapオブジェクトを作成します。

    • 各入力PDFドキュメントに対して、コンストラクターを使用し、入力PDFドキュメントの場所を渡してjava.io.FileInputStreamオブジェクトを作成します。

    • 入力PDFドキュメントごとに、com.adobe.idp.Documentオブジェクトを作成し、そのPDFドキュメントを含むjava.io.FileInputStreamオブジェクトを渡します。

    • 各入力ドキュメントに対して、 putメソッドを呼び出し、次の引数を渡して、java.util.Mapオブジェクトにエントリを追加します。

      • キー名を表すstring値です。 この値は、DDXドキュメントで指定されたPDFソース要素の値と一致する必要があります。
      • ソースPDFドキュメントを含むcom.adobe.idp.Documentオブジェクト(または複数のドキュメントを指定するjava.util.Listオブジェクト)。
  5. 実行時オプションを設定します。

    • コンストラクターを使用して、実行時オプションを格納するAssemblerOptionSpecオブジェクトを作成します。
    • AssemblerOptionSpecオブジェクトに属するメソッドを呼び出して、ビジネス要件に合った実行時オプションを設定します。 例えば、エラーが発生したときにジョブの処理を続行するようにAssemblerサービスに指示するには、AssemblerOptionSpecオブジェクトのsetFailOnErrorメソッドを呼び出し、falseを渡します。
  6. 入力PDFドキュメントをアセンブリします。

    AssemblerServiceClientオブジェクトのinvokeDDXメソッドを呼び出し、次の必須値を渡します。

    • 使用するDDXドキュメントを表すcom.adobe.idp.Documentオブジェクト
    • アセンブリ対象の入力PDFファイルが格納されたjava.util.Mapオブジェクト
    • デフォルトのフォントやジョブのログレベルを含む、実行時のオプションを指定するcom.adobe.livecycle.assembler.client.AssemblerOptionSpecオブジェクト

    invokeDDXメソッドは、ジョブの結果と発生した例外を含むcom.adobe.livecycle.assembler.client.AssemblerResultオブジェクトを返します。

  7. 結果を抽出します。

    新しく作成したPDFドキュメントを取得するには、次の操作を実行します。

    • AssemblerResultオブジェクトのgetDocumentsメソッドを呼び出します。 java.util.Mapオブジェクトを返します。
    • java.util.Mapオブジェクトを繰り返し処理して、結果のcom.adobe.idp.Documentオブジェクトを見つけます。 (DDXドキュメントで指定されたPDF結果要素を使用して、ドキュメントを取得できます)。
    • com.adobe.idp.DocumentオブジェクトのcopyToFileメソッドを呼び出して、PDFドキュメントを抽出します。
    メモ

    LOG_LEVELをログの生成に設定した場合は、AssemblerResultオブジェクトのgetJobLogメソッドを使用してログを抽出できます。

関連トピック

クイックスタート(SOAPモード):Java APIを使用したPDFドキュメントのアセンブリ

AEM Forms Java ライブラリファイルを含める

接続プロパティの設定

WebサービスAPIを使用したPDFドキュメントのアセンブリ

AssemblerサービスAPI(Webサービス)を使用してPDFドキュメントをアセンブリします。

  1. プロジェクトファイルを含めます。

    MTOMを使用するMicrosoft .NETプロジェクトを作成します。 次のWSDL定義を使用していることを確認します。http://localhost:8080/soap/services/AssemblerService?WSDL&lc_version=9.0.1.

    メモ

    localhostを、AEM FormsをホストするサーバーのIPアドレスに置き換えます。

  2. PDFアセンブラークライアントを作成します。

    • デフォルトのコンストラクターを使用してAssemblerServiceClientオブジェクトを作成します。

    • System.ServiceModel.EndpointAddressコンストラクターを使用してAssemblerServiceClient.Endpoint.Addressオブジェクトを作成します。 AEM FormsサービスにWSDLを指定するstring値を渡します(例:http://localhost:8080/soap/services/AssemblerService?blob=mtom)。 lc_version属性を使用する必要はありません。 この属性は、サービス参照を作成する際に使用されます。

    • AssemblerServiceClient.Endpoint.Bindingフィールドの値を取得してSystem.ServiceModel.BasicHttpBindingオブジェクトを作成します。 戻り値を BasicHttpBinding にキャストします。

    • System.ServiceModel.BasicHttpBindingオブジェクトのMessageEncodingフィールドをWSMessageEncoding.Mtomに設定します。 この値は、MTOMが使用されるようにします。

    • 次のタスクを実行して、基本的なHTTP認証を有効にします。

      • フィールドAssemblerServiceClient.ClientCredentials.UserName.UserNameにAEM formsユーザー名を割り当てます。
      • 対応するパスワード値をフィールドAssemblerServiceClient.ClientCredentials.UserName.Passwordに割り当てます。
      • フィールドBasicHttpBindingSecurity.Transport.ClientCredentialTypeに定数値HttpClientCredentialType.Basicを割り当てます。
      • フィールドBasicHttpBindingSecurity.Security.Modeに定数値BasicHttpSecurityMode.TransportCredentialOnlyを割り当てます。
  3. 既存のDDXドキュメントの参照

    • コンストラクタを使用して BLOB オブジェクトを作成します。BLOBオブジェクトは、DDXドキュメントの格納に使用されます。
    • コンストラクターを呼び出し、DDXドキュメントのファイルの場所とファイルを開くモードを表すstring値を渡して、System.IO.FileStreamオブジェクトを作成します。
    • System.IO.FileStreamオブジェクトの内容を格納するバイト配列を作成します。 System.IO.FileStreamオブジェクトのLengthプロパティを取得することで、バイト配列のサイズを判断できます。
    • System.IO.FileStreamオブジェクトのReadメソッドを呼び出し、読み取るバイト配列、開始位置、ストリーム長を渡すことによって、バイト配列にストリームデータを入力します。
    • BLOBオブジェクトのMTOMプロパティにバイト配列の内容を割り当てて、オブジェクトを設定します。
  4. 入力PDFドキュメントを参照します。

    • 各入力PDFドキュメントに対して、コンストラクタを使用してBLOBオブジェクトを作成します。 BLOBオブジェクトは、入力PDFドキュメントの保存に使用されます。
    • コンストラクターを呼び出し、入力PDFドキュメントのファイルの場所とファイルを開くモードを表すstring値を渡して、System.IO.FileStreamオブジェクトを作成します。
    • System.IO.FileStreamオブジェクトの内容を格納するバイト配列を作成します。 System.IO.FileStreamオブジェクトのLengthプロパティを取得することで、バイト配列のサイズを判断できます。
    • System.IO.FileStreamオブジェクトのReadメソッドを呼び出して、バイト配列にストリームデータを入力します。 読み取るバイト配列、開始位置、ストリーム長を渡します。
    • BLOBオブジェクトのMTOMフィールドにバイト配列の内容を割り当てて、オブジェクトを設定します。
    • MyMapOf_xsd_string_To_xsd_anyTypeオブジェクトを作成します。 このコレクションオブジェクトは、入力PDFドキュメントの保存に使用されます。
    • 入力PDFドキュメントごとに、MyMapOf_xsd_string_To_xsd_anyType_Itemオブジェクトを作成します。 例えば、2つの入力PDFドキュメントを使用する場合、2つのMyMapOf_xsd_string_To_xsd_anyType_Itemオブジェクトを作成します。
    • MyMapOf_xsd_string_To_xsd_anyType_Itemオブジェクトのkeyフィールドに、キー名を表すstring値を割り当てます。 この値は、DDXドキュメントで指定されたPDFソース要素の値と一致する必要があります。 (このタスクは、入力PDFドキュメントごとに実行します)。
    • PDFドキュメントを格納するBLOBオブジェクトをMyMapOf_xsd_string_To_xsd_anyType_Itemオブジェクトのvalueフィールドに割り当てます。 (このタスクは、入力PDFドキュメントごとに実行します)。
    • MyMapOf_xsd_string_To_xsd_anyType_ItemオブジェクトをMyMapOf_xsd_string_To_xsd_anyTypeオブジェクトに追加します。 MyMapOf_xsd_string_To_xsd_anyTypeオブジェクトのAddメソッドを呼び出して、MyMapOf_xsd_string_To_xsd_anyTypeオブジェクトを渡します。 (このタスクは、入力PDFドキュメントごとに実行します)。
  5. 実行時オプションを設定します。

    • コンストラクターを使用して、実行時オプションを格納するAssemblerOptionSpecオブジェクトを作成します。
    • AssemblerOptionSpecオブジェクトに属するデータメンバーに値を割り当てて、ビジネス要件に合った実行時オプションを設定します。 例えば、エラーが発生したときにジョブの処理を続行するようにAssemblerサービスに指示するには、falseAssemblerOptionSpecオブジェクトのfailOnErrorデータメンバーに割り当てます。
  6. 入力PDFドキュメントをアセンブリします。

    AssemblerServiceClientオブジェクトのinvokeメソッドを呼び出し、次の値を渡します。

    • DDXドキュメントを表すBLOBオブジェクト。
    • 入力PDFドキュメントを含むmapItem配列。 キーはPDFソースファイルの名前と一致する必要があり、値はそれらのファイルに対応するBLOBオブジェクトである必要があります。
    • 実行時オプションを指定するAssemblerOptionSpecオブジェクト。

    invokeメソッドは、ジョブの結果と発生した可能性のある例外を含むAssemblerResultオブジェクトを返します。

  7. 結果を抽出します。

    新しく作成したPDFドキュメントを取得するには、次の操作を実行します。

    • AssemblerResultオブジェクトのdocumentsフィールド(結果のPDFドキュメントを含むMapオブジェクト)にアクセスします。
    • 結果のドキュメントの名前と一致するキーが見つかるまで、Mapオブジェクトを繰り返し処理します。 次に、配列メンバのvalueBLOBにキャストします。
    • BLOBオブジェクトのMTOMプロパティにアクセスして、PDFドキュメントを表すバイナリデータを抽出します。 PDFファイルに書き出すことができるバイトの配列を返します。
    メモ

    LOG_LEVELがログを生成するように設定されている場合は、AssemblerResultオブジェクトのjobLogデータメンバの値を取得してログを抽出できます。

関連トピック

MTOMを使用したAEM Formsの呼び出し

このページ