Java API を使用した AEM Forms の呼び出し invoking-aem-forms-using-the-javaapi

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

AEM Forms Java API を使用して AEM Forms を呼び出すことができます。AEM Forms Java API を使用している場合、呼び出し API または Java クライアントライブラリを使用できます。Java クライアントライブラリは、Rights Management サービスなどのサービスで使用できます。これらの厳密に型指定された API を使用することによって、AEM Forms を呼び出す Java アプリケーションを開発できます。

呼び出し API は、com.adobe.idp.dsc パッケージに含まれるクラスです。これらのクラスを使用して、呼び出しリクエストをサービスに直接送信し、返される呼び出し応答を処理することができます。Workbench を使用して作成された長期間有効なプロセスまたは短時間のみ有効なプロセスを、呼び出し API を使用して呼び出します。

プログラムでサービスを呼び出すには、呼び出し API ではなくサービスに対応する Java クライアントライブラリを使用することをお勧めします。例えば、Encryption サービスを呼び出すには、Encryption サービスのクライアントライブラリを使用します。Encryption サービスの操作を実行するには、Encryption サービスクライアントオブジェクトに属するメソッドを呼び出します。EncryptionServiceClient オブジェクトの encryptPDFUsingPassword メソッドを使用して、PDF ドキュメントをパスワードで暗号化することができます。

Java API は次の機能をサポートしています。

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

人間中心の長期間有効なプロセスの呼び出し

Web サービスを使用した AEM Forms の呼び出し

接続プロパティの設定

Java API を使用した AEM Forms サービスへのデータの引き渡し

Java クライアントライブラリを使用したサービスの呼び出し

呼び出し API を使用した短時間のみ有効なプロセスの呼び出し

人間中心の長期間有効なプロセスを呼び出す Java Web アプリケーションの作成

AEM Forms の Java ライブラリファイルを含める including-aem-forms-java-library-files

Java API を使用してプログラムで AEM Forms サービスを呼び出すには、Java プロジェクトのクラスパスに必要なライブラリファイル（JAR ファイル）を含めます。クライアントアプリケーションのクラスパスに含める JAR ファイルは、以下のいくつかの要因によって異なります。

サービス固有の JAR ファイル service-specific-jar-files

次の表に、AEM Forms サービスを呼び出すために必要な JAR ファイルを示します。

接続モードと J2EE アプリケーション JAR ファイル connection-mode-and-j2ee-application-jar-files

次の表に、接続モードと AEM Forms のデプロイ先 J2EE アプリケーションサーバーに依存する JAR ファイルを示します。

</thead align="left">

呼び出しシナリオ invoking-scenarios

次の表に、呼び出しシナリオと、AEM Forms を正常に呼び出すために必要な JAR ファイルを示します。

</thead align="left"> xmp-uti

JAR ファイルのアップグレード upgrading-jar-files

LiveCycle から AEM Forms にアップグレードする場合は、Java プロジェクトのクラスパスに AEM Forms JAR ファイルを含めることをお勧めします。例えば、Rights Management サービスなどのサービスを使用している場合、クラスパスに AEM Forms JAR ファイルを含めないと、互換性の問題が発生します。

AEM Forms にアップグレードするとします。Rights Management サービスを呼び出す Java アプリケーションを使用するには、次の JAR ファイルの AEM Forms バージョンを含めます。

関連トピック

Java API を使用した AEM Forms の呼び出し

接続プロパティの設定

Java API を使用した AEM Forms サービスへのデータの引き渡し

Java クライアントライブラリを使用したサービスの呼び出し

接続プロパティの設定 setting-connection-properties

Java API を使用している場合、AEM Forms を呼び出すためには接続プロパティを設定します。接続プロパティを設定する場合は、サービスをリモートとローカルのどちらで呼び出すかどうかを指定し、接続モードと認証値も指定します。サービスセキュリティが有効な場合は、認証値が必要です。ただし、サービスセキュリティが無効の場合は、認証値を指定する必要はありません。

接続モードは、SOAP モードまたは EJB モードです。EJB モードは RMI/IIOP プロトコルを使用し、EJB モードのパフォーマンスは SOAP モードのパフォーマンスよりも優れています。SOAP モードは、J2EE アプリケーションサーバーの依存関係を解消するため、または AEM Forms とクライアントアプリケーションの間にファイアウォールが設定されている場合に使用されます。SOAP モードでは、基礎のトランスポートとして https プロトコルを使用するので、ファイアウォールの境界を越えて通信できます。J2EE アプリケーションサーバーの依存関係もファイアウォールも問題でない場合は、EJB モードを使用することをお勧めします。

AEM Forms サービスを正常に呼び出すには、次の接続プロパティを設定します。

接続プロパティを設定するには、次のタスクを実行します。

JBoss 用の EJB 接続モードの設定

次の Java コードの例では、JBoss にデプロイされ EJB 接続モードを使用している AEM Forms を呼び出すための接続プロパティを設定しています。

 Properties ConnectionProps = new Properties();
 ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_DEFAULT_EJB_ENDPOINT, "https://<hostname>:8080");
 ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_TRANSPORT_PROTOCOL,ServiceClientFactoryProperties.DSC_EJB_PROTOCOL);
 ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_SERVER_TYPE, "JBoss");
 ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_CREDENTIAL_USERNAME, "administrator");
 ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_CREDENTIAL_PASSWORD, "password");
 ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_DOCUMENT_HTTP_ENDPOINT,"https://<hostname>:8080");

WebLogic 用の EJB 接続モードの設定

次の Java コードの例では、WebLogic にデプロイされ EJB 接続モードを使用している AEM Forms を呼び出すための接続プロパティを設定しています。

 Properties ConnectionProps = new Properties();
 ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_DEFAULT_EJB_ENDPOINT, "t3://localhost:7001");
 ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_TRANSPORT_PROTOCOL,ServiceClientFactoryProperties.DSC_EJB_PROTOCOL);
 ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_SERVER_TYPE, "WebLogic");
 ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_CREDENTIAL_USERNAME, "administrator");
 ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_CREDENTIAL_PASSWORD, "password");

WebSphere 用の EJB 接続モードの設定

次の Java コードの例では、WebSphere にデプロイされ EJB 接続モードを使用している AEM Forms を呼び出すための接続プロパティを設定しています。

 Properties ConnectionProps = new Properties();
 ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_DEFAULT_EJB_ENDPOINT, "iiop://localhost:2809");
 ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_TRANSPORT_PROTOCOL,ServiceClientFactoryProperties.DSC_EJB_PROTOCOL);
 ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_SERVER_TYPE, "WebSphere");
 ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_CREDENTIAL_USERNAME, "administrator");
 ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_CREDENTIAL_PASSWORD, "password");

SOAP 接続モードの設定

次の Java コードの例では、SOAP モードで接続プロパティを設定して、JBoss にデプロイされた AEM Forms を呼び出します。

 Properties ConnectionProps = new Properties();
 ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_DEFAULT_SOAP_ENDPOINT, "http://localhost:8080");
 ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_TRANSPORT_PROTOCOL,ServiceClientFactoryProperties.DSC_SOAP_PROTOCOL);
 ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_SERVER_TYPE, "JBoss");
 ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_CREDENTIAL_USERNAME, "administrator");
 ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_CREDENTIAL_PASSWORD, "password");

サービスセキュリティが無効な場合の接続プロパティの設定

次の Java コードの例では、サービスセキュリティが無効な場合に JBoss Application Server にデプロイされた AEM Forms を呼び出すために必要な接続プロパティを設定します。

 Properties ConnectionProps = new Properties();
 ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_DEFAULT_EJB_ENDPOINT, "jnp://localhost:1099");
 ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_TRANSPORT_PROTOCOL,ServiceClientFactoryProperties.DSC_EJB_PROTOCOL);
 ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_SERVER_TYPE, "JBoss");

カスタムリクエストタイムアウト制限を含む SOAP 接続モードの設定

 Properties ConnectionProps = new Properties();
 ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_DEFAULT_SOAP_ENDPOINT, "http://localhost:8080");
 ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_TRANSPORT_PROTOCOL,ServiceClientFactoryProperties.DSC_SOAP_PROTOCOL);
 ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_SERVER_TYPE, "JBoss");
 ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_CREDENTIAL_USERNAME, "administrator");
 ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_CREDENTIAL_PASSWORD, "password");
ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_REQUEST_TIMEOUT, "1800000"); // Request timeout limit 30 Minutes

Context オブジェクトを使用した AEM Forms の呼び出し

com.adobe.idp.Context オブジェクトを使用して、認証されたユーザーで AEM Forms サービスを呼び出すことができます（com.adobe.idp.Context オブジェクトが認証されたユーザーを表します）。com.adobe.idp.Context オブジェクトを使用している場合は、DSC_CREDENTIAL_USERNAME または DSC_CREDENTIAL_PASSWORD プロパティを設定する必要はありません。AuthenticationManagerServiceClient オブジェクトの authenticate メソッドを使用してユーザーを認証するときは、com.adobe.idp.Context オブジェクトを取得できます。

authenticate メソッドは、認証の結果を含む AuthResult オブジェクトを返します。コンストラクタを呼び出すことによって、com.adobe.idp.Context オブジェクトを作成できます。次に、次のコードに示すように、com.adobe.idp.Context オブジェクトの initPrincipal メソッドを呼び出し、AuthResult オブジェクトを渡します。

 Context myCtx = new Context();
 myCtx.initPrincipal(authResult);

DSC_CREDENTIAL_USERNAME または DSC_CREDENTIAL_PASSWORD プロパティを設定する代わりに、ServiceClientFactory オブジェクトの setContext メソッドを呼び出して、com.adobe.idp.Context オブジェクトを渡すことができます。AEM Forms ユーザーを使用してサービスを呼び出す場合は、AEM Forms サービスを呼び出すために必要な Services User という名前の役割がこのユーザーに割り当てられていることを確認します。

次のコードの例では、EncryptionServiceClient オブジェクトを作成するために使用される接続設定内で com.adobe.idp.Context オブジェクトを使用する方法を示します。

 //Authenticate a user and use the Context object within connection settings
 // Authenticate the user
 String username = "wblue";
 String password = "password";
 AuthResult authResult = authClient.authenticate(username, password.getBytes());

 //Set a Content object that represents the authenticated user
 //Use the Context object to invoke the Encryption service
 Context myCtx = new Context();
 myCtx.initPrincipal(authResult);

 //Set connection settings
 Properties connectionProps = new Properties();
 connectionProps.setProperty(ServiceClientFactoryProperties.DSC_DEFAULT_EJB_ENDPOINT, "jnp://<server>:1099");
 connectionProps.setProperty(ServiceClientFactoryProperties.DSC_TRANSPORT_PROTOCOL, ServiceClientFactoryProperties.DSC_EJB_PROTOCOL);
 connectionProps.setProperty(ServiceClientFactoryProperties.DSC_SERVER_TYPE, ServiceClientFactoryProperties.DSC_JBOSS_SERVER_TYPE);
 connectionProps.setProperty(ServiceClientFactoryProperties.DSC_DOCUMENT_HTTP_ENDPOINT,"jnp://<server>:1099");


 //Create a ServiceClientFactory object
 ServiceClientFactory myFactory = ServiceClientFactory.createInstance(connectionProps);
 myFactory.setContext(myCtx);

 //Create an EncryptionServiceClient object
 EncryptionServiceClient encryptClient  = new EncryptionServiceClient(myFactory);

呼び出しシナリオ invoking_scenarios-1

この節では、以下の呼び出しシナリオについて説明します。

スタンドアロン AEM Forms インスタンスを呼び出すクライアントアプリケーション client-application-invoking-a-stand-alone-aem-forms-instance

次の図は、独自の JVM で実行され、スタンドアロン AEM Forms インスタンスを呼び出すクライアントアプリケーションを示しています。

このシナリオでは、クライアントアプリケーションが独自の JVM で実行され、AEM Forms サービスを呼び出します。

クラスター化された AEM Forms インスタンスを呼び出すクライアントアプリケーション client-application-invoking-clustered-aem-forms-instances

次の図は、アプリケーション自体の JVM で実行され、クラスター内にある AEM Forms インスタンスを呼び出すクライアントアプリケーションを示しています。

このシナリオは、スタンドアロン AEM Forms インスタンスを呼び出すクライアントアプリケーションに似ています。ただし、プロバイダーの URL が異なります。クライアントアプリケーションが特定の J2EE アプリケーションサーバーに接続する場合、アプリケーションはその特定の J2EE アプリケーションサーバーを参照するように URL を変更する必要があります。

特定の J2EE アプリケーションサーバーを参照することは推奨されません。これは、アプリケーションサーバーが停止すると、クライアントアプリケーションと AEM Forms との間の接続が終了するためです。プロバイダー URL では、特定の J2EE アプリケーションサーバーではなく、セルレベルの JNDI マネージャーを参照することをお勧めします。

SOAP 接続モードを使用するクライアントアプリケーションは、クラスター用に HTTP ロードバランサーポートを使用できます。EJB 接続モードを使用するクライアントアプリケーションは、特定の J2EE アプリケーションサーバーの EJB ポートに接続できます。このアクションは、クラスターノード間の負荷分散を処理します。

WebSphere

次の例は、WebSphere にデプロイされた AEM Forms に接続するために使用される jndi.properties ファイルの内容を示しています。

 java.naming.factory.initial=com.ibm.websphere.naming.
 WsnInitialContextFactory
 java.naming.provider.url=corbaloc::appserver1:9810,:appserver2:9810

WebLogic

次の例は、WebLogic にデプロイされた AEM Forms に接続するために使用される jndi.properties ファイルの内容を示しています。

 java.naming.factory.initial=weblogic.jndi.WLInitialContextFactory
 java.naming.provider.url=t3://appserver1:8001, appserver2:8001

JBoss

次の例は、JBoss にデプロイされている AEM Forms に接続するために使用される jndi.properties ファイルの内容を示しています。

 java.naming.factory.initial= org.jnp.interfaces.NamingContextFactory
 java.naming.provider.url= jnp://appserver1:1099, appserver2:1099,
 appserver3:1099

関連トピック

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

Java API を使用した AEM Forms サービスへのデータの引き渡し

Java クライアントライブラリを使用したサービスの呼び出し

Java API を使用した AEM Forms サービスへのデータの引き渡し passing-data-to-aem-forms-services-using-the-java-api

AEM Forms サービス操作では、通常、PDF ドキュメントを使用または生成します。サービスを呼び出すときに、PDF ドキュメント（または XML データなどの他のドキュメントタイプ）をサービスに渡す必要がある場合があります。同様に、サービスから返される PDF ドキュメントを処理する必要があることもあります。AEM Forms サービスとの間でデータをやりとりできるようにする Java クラスは、com.adobe.idp.Document です。

AEM Forms サービスは、PDF ドキュメントを java.io.InputStream オブジェクトやバイト配列などの他のデータ型としては受け入れません。com.adobe.idp.Document オブジェクトを使用して、XML データなどの他のタイプのデータをサービスに渡すこともできます。

com.adobe.idp.Document オブジェクトは Java のシリアライズ可能な型であるため、RMI 呼び出しで渡すことができます。受信側は、同時配置（同じホスト、同じクラスローダー）することも、ローカル（同じホスト、別のクラスローダー）またはリモート（別のホスト）に配置することもできます。ドキュメントコンテンツの引き渡しは、それぞれの場合に最適化されます。例えば、送信者と受信者が同じホスト上にある場合、コンテンツはローカルファイルシステムを介して渡されます（ドキュメントがメモリ内で渡される場合もあります）。

com.adobe.idp.Document オブジェクトのサイズに応じて、データは com.adobe.idp.Document オブジェクト内に保持されるか、サーバーのファイルシステムに格納されます。com.adobe.idp.Document オブジェクトが占有していた一時的なストレージリソースは、com.adobe.idp.Document の破棄時に自動的に削除されます（Document オブジェクトの廃棄を参照）。

場合により、サービスに渡す前に、com.adobe.idp.Document オブジェクトのコンテンツタイプを知っておく必要があります。たとえば、操作で application/pdf などの特定のコンテンツタイプが必要な場合は、コンテンツタイプを確認することをお勧めします（ドキュメントのコンテンツタイプの確認を参照）。

com.adobe.idp.Document オブジェクトは、提示されたデータを使用してコンテンツタイプの判別を試行します。提示されたデータからコンテンツタイプを取得できない場合（例えば、データがバイト配列として提示された場合）は、コンテンツタイプを設定します。コンテンツタイプを設定するには、com.adobe.idp.Document オブジェクトの setContentType メソッドを呼び出します。（ドキュメントのコンテンツタイプの確認を参照。）

コラテラルファイルが同じファイルシステム上にある場合は、com.adobe.idp.Document オブジェクトを作成する方が効率的です。コラテラルファイルがリモートファイルシステム上に格納されていると、コピー操作を実行する必要があり、パフォーマンスに影響します。

アプリケーションには、com.adobe.idp.Document と org.w3c.dom.Document データタイプの両方を含めることができます。ただし、org.w3c.dom.Document データタイプの条件を完全に満たすようにしてください。org.w3c.dom.Document オブジェクトを com.adobe.idp.Document オブジェクトに変換する方法については、クイックスタート（EJB モード）：Java API を使用した流動レイアウトによるフォームの事前入力を参照してください。

        // Set up the chunk size to prevent a potential memory leak
        int buffSize = 2048;

        // Determine the total number of bytes to read
        int docLength = (int) inDoc.length();
        byte [] byteDoc = new byte[docLength];

        // Set up the reading position
        int pos = 0;

        // Loop through the document information, 2048 bytes at a time
        while (docLength > 0) {
      // Read the next chunk of information
            int toRead = Math.min(buffSize, docLength);
            int bytesRead = inDoc.read(pos, byteDoc, pos, toRead);

            // Handle the exception in case data retrieval failed
            if (bytesRead == -1) {

                inDoc.doneReading();
                inDoc.dispose();
                throw new RuntimeException("Data retrieval failed!");

            }

             // Update the reading position and number of bytes remaining
             pos += bytesRead;
             docLength -= bytesRead;

        }

        // The document information has been successfully read
        inDoc.doneReading();
        inDoc.dispose();

関連トピック

Java API を使用した AEM Forms の呼び出し

接続プロパティの設定

ドキュメントの作成 creating-documents

入力値として PDF ドキュメント（または他のドキュメントタイプ）を必要とするサービス操作を呼び出す前に、com.adobe.idp.Document オブジェクトを作成します。com.adobe.idp.Document クラスは、次のコンテンツタイプからドキュメントを作成できるコンストラクターを提供します。

バイト配列に基づいたドキュメントの作成 creating-a-document-based-on-a-byte-array

次のコードの例では、バイト配列に基づいた com.adobe.idp.Document オブジェクトを作成します。

バイト配列に基づいた Document オブジェクトの作成

 Document myPDFDocument = new Document(myByteArray);

別のドキュメントに基づいたドキュメントの作成 creating-a-document-based-on-another-document

次のコードの例では、別の com.adobe.idp.Document オブジェクトに基づいた com.adobe.idp.Document オブジェクトを作成します。

別のドキュメントに基づいた Document オブジェクトの作成

 //Create a Document object based on a byte array
 InputStream is = new FileInputStream("C:\\Map.pdf");
 int len = is.available();
 byte [] myByteArray = new byte[len];
 int i = 0;
 while (i < len) {
       i += is.read(myByteArray, i, len);
 }
 Document myPDFDocument = new Document(myByteArray);

 //Create another Document object
 Document anotherDocument = new Document(myPDFDocument);

ファイルに基づいたドキュメントの作成 creating-a-document-based-on-a-file

次のコードの例では、map.pdf という名前の PDF ファイルに基づいた com.adobe.idp.Document オブジェクトを作成します。このファイルは C ハードドライブのルートにあります。このコンストラクターは、ファイル拡張子を使用して com.adobe.idp.Document オブジェクトの MIME コンテンツタイプの設定を試行します。

com.adobe.idp.Document オブジェクトを受け入れる java.io.File コンストラクターは、ブール型パラメーターも受け入れます。このパラメーターを true に設定すると、com.adobe.idp.Document オブジェクトによってファイルが削除されます。このアクションは、ファイルを com.adobe.idp.Document コンストラクターに渡した後にファイルを削除する必要がないことを意味します。

このパラメーターを false に設定すると、このファイルの所有権が保持されます。このパラメーターを true に設定する方が効率的です。理由は、com.adobe.idp.Document オブジェクトがファイルをコピーする（この処理はより時間がかかる）のではなくローカルの管理対象領域に直接移動できるためです。

PDF ファイルに基づいた Document オブジェクトの作成

 //Create a Document object based on the map.pdf source file
 File mySourceMap = new File("C:\\map.pdf");
 Document myPDFDocument = new Document(mySourceMap,true);

InputStream オブジェクトに基づいたドキュメントの作成 creating-a-document-based-on-an-inputstream-object

次の Java コードの例では、java.io.InputStream オブジェクトに基づいた com.adobe.idp.Document オブジェクトを作成します。

InputStream オブジェクトに基づいたドキュメントの作成

 //Create a Document object based on an InputStream object
 InputStream is = new FileInputStream("C:\\Map.pdf");
 Document myPDFDocument = new Document(is);

URL からアクセス可能なコンテンツに基づいたドキュメントの作成 creating-a-document-based-on-content-accessible-from-an-url

次の Java コードの例では、map.pdf という名前の PDF ファイルに基づいた com.adobe.idp.Document オブジェクトを作成します。このファイルは、localhost で実行されている WebApp という名前の web アプリケーション内にあります。このコンストラクタは、URL プロトコルで返されるコンテンツタイプを使用して com.adobe.idp.Document オブジェクトの MIME コンテンツタイプの設定を試行します。

次の例に示すように、com.adobe.idp.Document オブジェクトに提供される URL は、元の com.adobe.idp.Document オブジェクトが作成されるのに伴って必ず読み取られます。

     Document doc = new Document(new java.net.URL("file:c:/temp/input.pdf"));

C:/temp/input.pdf ファイルは、（サーバーコンピューターではなく）クライアントコンピューター上に置く必要があります。クライアントコンピューター上で URL が読み取られ、com.adobe.idp.Document オブジェクトが作成されます。

URL からアクセス可能なコンテンツに基づいたドキュメントの作成

 //Create a Document object based on a java.net.URL object
 URL myURL = new URL("http", "localhost", 8080,"/WebApp/map.pdf");

 //Create another Document object
 Document myPDFDocument = new Document(myURL);

関連トピック：

Java API を使用した AEM Forms の呼び出し

接続プロパティの設定

返されたドキュメントの処理 handling-returned-documents

PDF ドキュメント（または XML データなどの他のデータ型）を出力値として返すサービス操作では、com.adobe.idp.Document オブジェクトが返されます。受け取った com.adobe.idp.Document オブジェクトは、次の形式に変換できます。

次のコード行では、com.adobe.idp.Document オブジェクトを java.io.InputStream オブジェクトに変換します。myPDFDocument が com.adobe.idp.Document オブジェクトを表すものとします。

     java.io.InputStream resultStream = myDocument.getInputStream();

同様に、次のタスクを実行することによって、com.adobe.idp.Document の内容をローカルファイルにコピーできます。

次のコードの例では、com.adobe.idp.Document オブジェクトの内容を AnotherMap.pdf という名前のファイルにコピーします。

Document オブジェクトの内容のファイルへのコピー

 File outFile = new File("C:\\AnotherMap.pdf");
 myDocument.copyToFile (outFile);

関連トピック：

Java API を使用した AEM Forms の呼び出し

接続プロパティの設定

ドキュメントのコンテンツタイプの確認 determining-the-content-type-of-a-document

com.adobe.idp.Document オブジェクトの getContentType メソッドを呼び出すことによって、com.adobe.idp.Document オブジェクトの MIME タイプを判別します。このメソッドは、com.adobe.idp.Document オブジェクトのコンテンツタイプを指定する文字列値を返します。次の表で、AEM Forms が返す様々なコンテンツタイプについて説明します。

次のコードの例では、com.adobe.idp.Document オブジェクトのコンテンツタイプを確認します。

Document オブジェクトのコンテンツタイプの確認

 //Determine the content type of the Document object
 String ct = myDocument.getContentType();
 System.out.println("The content type of the Document object is " +ct);

関連トピック：

Java API を使用した AEM Forms の呼び出し

接続プロパティの設定

Document オブジェクトの廃棄 disposing-document-objects

Document オブジェクトが不要になったら、その dispose メソッドを呼び出すことで破棄することをお勧めします。各 Document オブジェクトは、アプリケーションのホストプラットフォーム上でファイル記述子と最大 75 MB の RAM 領域を消費します。Document オブジェクトが破棄されていない場合、Java のガベージコレクションプロセスによって破棄されます。ただし、dispose メソッドを使用してより早く廃棄することによって、Document オブジェクトが占有するメモリを解放することができます。

関連トピック：

Java API を使用した AEM Forms の呼び出し

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

Java クライアントライブラリを使用したサービスの呼び出し

Java クライアントライブラリを使用したサービスの呼び出し invoking-a-service-using-a-java-client-library

AEM Forms サービス操作は、サービスの厳密に型指定された API である Java クライアントライブラリを使用して呼び出すことができます。Java クライアントライブラリ ​は、サービスコンテナにデプロイされたサービスへのアクセスを提供する具象クラスのセットです。呼び出し API を使用して InvocationRequest オブジェクトを作成する代わりに、呼び出すサービスを表す Java オブジェクトをインスタンス化します。呼び出し API は、Workbench で作成された長期間有効なプロセスなどのプロセスを呼び出すために使用されます。（人間中心の長期間有効なプロセスの呼び出しを参照。）

サービス操作を実行するには、Java オブジェクトに属するメソッドを呼び出します。通常、Java クライアントライブラリにはサービス操作に 1 対 1 で対応するメソッドが含まれています。Java クライアントライブラリを使用している場合は、必要な接続プロパティを設定します。（接続プロパティの設定を参照）

接続プロパティを設定したら、サービスを呼び出すための Java オブジェクトをインスタンス化するために使用される ServiceClientFactory オブジェクトを作成します。Java クライアントライブラリを持つ各サービスには、対応するクライアントオブジェクトがあります。例えば、Repository サービスを呼び出すには、コンストラクターを使用して ResourceRepositoryClient オブジェクトを渡すことによって ServiceClientFactory オブジェクトを作成します。ServiceClientFactory オブジェクトは、AEM Forms サービスを呼び出すために必要な接続設定を維持する役割を果たします。

ServiceClientFactory の取得は通常は高速ですが、ファクトリを初めて使用するときにはオーバーヘッドが発生します。このオブジェクトは再利用のために最適化されているため、複数の Java クライアントオブジェクトを作成する場合は、可能であれば同じ ServiceClientFactory オブジェクトを使用してください。つまり、作成するクライアントライブラリオブジェクトごとに個別の ServiceClientFactory オブジェクトを作成しないでください。

ServiceClientFactory オブジェクトに影響を与える com.adobe.idp.Context オブジェクト内部の SAML アサーションの有効期間を制御する User Manager 設定があります。この設定は、Java API を使用して実行されるすべての呼び出しを含む、AEM Forms 全体のすべての認証コンテキストの有効期間を制御します。デフォルトでは、ServiceCleintFactory オブジェクトを使用できる期間は 2 時間です。

Java クライアントライブラリを使用して次の手順を実行することにより、Repository サービスを呼び出すことができます。

関連トピック

クイックスタート（EJB モード）：Java API を使用したリソースの書き込み

Java API を使用した AEM Forms の呼び出し

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

呼び出し API を使用した短時間のみ有効なプロセスの呼び出し invoking-a-short-lived-process-using-the-invocation-api

Java 呼び出し API を使用して、短時間のみ有効なプロセスを呼び出すことができます。Invocation API を使用して短期間有効なプロセスを呼び出す場合は、java.util.HashMap オブジェクトを使用して必須のパラメーター値を渡します。各パラメーターをサービスに渡すには、java.util.HashMap オブジェクトの put メソッドを呼び出し、指定された操作を実行するためにサービスで必要となる、名前と値のペアを指定します。短時間のみ有効なプロセスに属するパラメーターの正確な名前を指定します。

ここでは、Invocation API を使用して、MyApplication/EncryptDocument という名前の次の AEM Forms（短期間有効のプロセス）を呼び出す方法について説明します。

このプロセスを呼び出すと、次のアクションが実行されます。

Java invocation API を使用した MyApplication/EncryptDocument（短期間有効なプロセス）の呼び出し invoke-the-myapplication-encryptdocument-short-lived-process-using-the-java-invocation-api

Java invocation API を使用して短期間有効なプロセスの MyApplication/EncryptDocument を呼び出します。

関連トピック

クイックスタート：Invocation API を使用した短期間有効なプロセスの呼び出し

人間中心の長期間有効なプロセスの呼び出し

AEM Forms Java ライブラリファイルの組み込み