Appel d’AEM Forms en utilisant l’API Java invoking-aem-forms-using-the-javaapi

Les exemples et les échantillons de ce document sont réservés à l’environnement AEM Forms sur JEE.

AEM Forms peut être appelé à l’aide de l’API Java d’AEM Forms. Lorsque vous utilisez l’API Java d’AEM Forms, vous pouvez utiliser l’API d’appel ou les bibliothèques client Java. Des bibliothèques client Java sont disponibles pour des services tels que le service Rights Management. Ces API fortement typées vous permettent de développer des applications Java qui appellent AEM Forms.

Les API d’appel sont des classes situées dans le package com.adobe.idp.dsc. À l’aide de ces classes, vous pouvez envoyer une demande d’appel directement à un service et traiter une réponse d’appel retournée. Utilisez l’API d’appel pour appeler des processus à durées de vie courte ou longue créés à l’aide de Workbench.

La méthode recommandée pour appeler un service par programmation consiste à utiliser une bibliothèque cliente Java correspondant au service, par opposition à l’API d’appel. Par exemple, pour appeler le service Encryption, utilisez la bibliothèque cliente du service Encryption. Pour effectuer une opération de service Encryption, appelez une méthode appartenant à l’objet client du service Encryption. Vous pouvez chiffrer un document PDF avec un mot de passe en appelant la méthode encryptPDFUsingPassword de l’objet EncryptionServiceClient.

L’API Java prend en charge les fonctionnalités suivantes :

Inclusion des fichiers de bibliothèque Java d’AEM Forms

Appel de processus pour des intervenants humains de longue durée

Appel d’AEM Forms utilisant des services Web

Réglage des propriétés de la connexion

Transmission de données vers les services AEM Forms à l’aide de l’API Java

Appel d’un service à l’aide d’une bibliothèque client Java

Appel d’un processus de courte durée en utilisant l’API d’appel

Création d’une application Web Java qui appelle un processus pour des intervenants humains de longue durée

Inclusion des fichiers de bibliothèque Java d’AEM Forms including-aem-forms-java-library-files

Pour appeler un service AEM Forms par programmation à l’aide de l’API Java, incluez les fichiers de bibliothèque requis (fichiers JAR) dans le chemin d’accès des classes de votre projet Java. Les fichiers JAR que vous incluez dans le chemin d’accès des classes de votre application cliente dépendent de plusieurs facteurs :

Fichiers JAR spécifiques au service service-specific-jar-files

Le tableau suivant énumère les fichiers JAR nécessaires pour appeler les services AEM Forms.

Mode de connexion et fichiers JAR de l’application J2EE connection-mode-and-j2ee-application-jar-files

Le tableau suivant répertorie les fichiers JAR qui dépendent du mode de connexion et du serveur d’applications J2EE sur lequel AEM Forms est déployé.

</thead align="left">

Appel de scénarios invoking-scenarios

Le tableau suivant indique les scénarios d’appel et répertorie les fichiers JAR requis pour appeler correctement AEM Forms.

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

Mise à niveau des fichiers JAR upgrading-jar-files

Si vous effectuez une mise à niveau de LiveCycle vers AEM Forms, il est recommandé d’inclure les fichiers JAR AEM Forms dans le chemin de classe de votre projet Java. Par exemple, si vous utilisez des services tels que Rights Management, vous rencontrerez un problème de compatibilité si vous n’incluez pas les fichiers JAR AEM Forms dans le chemin de classe.

En supposant que vous effectuiez une mise à niveau vers AEM Forms. Pour utiliser une application Java qui appelle le service Rights Management, incluez les versions AEM Forms des fichiers JAR suivants :

Voir également

Appel d’AEM Forms en utilisant l’API Java

Réglage des propriétés de la connexion

Transmission de données vers les services AEM Forms à l’aide de l’API Java

Appel d’un service à l’aide d’une bibliothèque client Java

Définir les propriétés de connexion setting-connection-properties

Vous définissez les propriétés de connexion pour appeler AEM Forms lorsque vous utilisez l’API Java. Lors de la définition des propriétés de connexion, indiquez si vous souhaitez appeler des services à distance ou localement, ainsi que le mode de connexion et les valeurs d’authentification. Les valeurs d’authentification sont requises si la sécurité du service est activée. Toutefois, si la sécurité du service est désactivée, il n’est pas nécessaire de spécifier des valeurs d’authentification.

Le mode de connexion peut être SOAP ou EJB. Le mode EJB utilise le protocole RMI/IIOP et les performances du mode EJB sont meilleures que celles du mode SOAP. Le mode SOAP permet d’éliminer une dépendance du serveur d’applications J2EE ou lorsqu’un pare-feu se trouve entre AEM Forms et l’application cliente. Le mode SOAP utilise le protocole https comme transport sous-jacent et peut communiquer au-delà des limites du pare-feu. Si aucune dépendance de serveur d’applications J2EE ni aucun pare-feu ne pose problème, il est recommandé d’utiliser le mode EJB.

Pour appeler un service AEM Forms avec succès, définissez les propriétés de connexion suivantes :

Pour définir les propriétés de connexion, effectuez les tâches suivantes :

Régler le mode de connexion EJB pour JBoss

L’exemple de code Java suivant définit les propriétés de connexion pour appeler AEM Forms déployé sur JBoss et utilisant le mode de connexion EJB.

 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");

Réglage du mode de connexion EJB pour WebLogic

L’exemple de code Java suivant définit les propriétés de connexion pour appeler AEM Forms déployé sur WebLogic et utilisant le mode de connexion EJB.

 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");

Réglage du mode de connexion EJB pour WebSphere

L’exemple de code Java suivant définit les propriétés de connexion pour appeler AEM Forms déployé sur WebSphere et utilisant le mode de connexion EJB.

 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");

Réglage du mode de connexion SOAP

L’exemple de code Java suivant définit les propriétés de connexion pour appeler AEM Forms déployé sur JBoss et utilisant le mode 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");

Réglage des propriétés de connexion lorsque la sécurité des services est désactivée

L’exemple de code Java suivant définit les propriétés de connexion requises pour appeler AEM Forms déployé sur le serveur d’applications JBoss et lorsque la sécurité du service est désactivée.

 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");

Réglage du mode de connexion SOAP avec limite personnalisée de délai d’expiration de requête

 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

Utilisation d’un objet de contexte pour appeler AEM Forms

Vous pouvez utiliser un objet com.adobe.idp.Context pour appeler un service AEM Forms avec un utilisateur authentifié (l’objet du com.adobe.idp.Context représente un utilisateur authentifié). Lors de l’utilisation d’un objet com.adobe.idp.Context, vous n’avez pas besoin de définir les propriétés DSC_CREDENTIAL_USERNAME ou DSC_CREDENTIAL_PASSWORD. Vous pouvez obtenir un objet com.adobe.idp.Context lors de l’authentification des utilisateurs et utilisatrices en utilisant la méthode authenticate de l’objet AuthenticationManagerServiceClient.

La méthode authenticate renvoie un objet AuthResult contenant les résultats de l’authentification. Vous pouvez créer un objet com.adobe.idp.Context en appelant son constructeur. Ensuite, appelez la méthode initPrincipal de l’objet com.adobe.idp.Context et transmettez l’objet AuthResult, comme indiqué dans le code suivant :

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

Au lieu de définir les propriétés DSC_CREDENTIAL_USERNAME ou DSC_CREDENTIAL_PASSWORD, vous pouvez appeler la méthode setContext de l’objet ServiceClientFactory et transmettre l’objet com.adobe.idp.Context. Lorsque vous avez recours à un utilisateur ou à une utilisatrice d’AEM Forms pour appeler un service, assurez-vous qu’ils possèdent le rôle Services User requis pour appeler un service AEM Forms.

L’exemple de code suivant montre comment utiliser un objet com.adobe.idp.Context dans les paramètres de connexion qui sont utilisés pour créer un objet EncryptionServiceClient.

 //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);

Appel de scénarios invoking_scenarios-1

Les scénarios d’appel suivants sont abordés dans cette section :

Une application client appelant une instance AEM Forms autonome client-application-invoking-a-stand-alone-aem-forms-instance

Le diagramme suivant montre une application client exécutée dans sa propre JVM et appelant une instance AEM Forms autonome.

Dans ce scénario, une application client est exécutée dans sa propre JVM et appelle les services AEM Forms.

Application client appelant des instances AEM Forms en clusters client-application-invoking-clustered-aem-forms-instances

Le diagramme suivant montre une application client executée dans sa propre JVM et appelant des instances AEM Forms dans un cluster.

Ce scénario est similaire à celui d’une application client appelant une instance AEM Forms autonome. Cependant, l’URL du fournisseur est différente. Si une application client souhaite se connecter à un serveur d’applications J2EE spécifique, l’application doit changer l’URL pour référencer le serveur d’applications J2EE spécifique.

Le référencement d’un serveur d’applications J2EE spécifique n’est pas recommandé car la connexion entre l’application client et AEM Forms s’interrompt si le serveur d’applications s’arrête. Il est recommandé que l’URL du fournisseur fasse référence à un gestionnaire JNDI à l’échelle cellulaire, au lieu d’un serveur d’applications J2EE spécifique.

Les applications clients qui utilisent le mode de connexion SOAP peuvent utiliser le port de répartition de charge HTTP pour le cluster. Les applications clients qui utilisent le mode de connexion EJB peuvent se connecter au port EJB d’un serveur d’applications J2EE spécifique. Cette action gère la répartition de la charge entre les nœuds du cluster.

**WebSphere **

L’exemple suivant montre le contenu d’un fichier jndi.properties utilisé pour se connecter à AEM Forms déployé sur WebSphere.

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

WebLo gic

L’exemple suivant montre le contenu d’un fichier jndi.properties utilisé pour se connecter à AEM Forms déployé sur WebLogic.

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

**JBoss **

L’exemple suivant montre le contenu d’un fichier jndi.properties utilisé pour se connecter à AEM Forms déployé sur JBoss.

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

Voir également

Inclusion des fichiers de bibliothèque Java d’AEM Forms

Transmission de données vers les services AEM Forms à l’aide de l’API Java

Appel d’un service à l’aide d’une bibliothèque client Java

Transmettre des données vers les services AEM Forms à l’aide de l’API Java passing-data-to-aem-forms-services-using-the-java-api

Les opérations des services AEM Forms utilisent ou produisent généralement des documents PDF. Lorsque vous appelez un service, il est parfois nécessaire de lui transmettre un document PDF (ou d’autres types de documents tels que des données XML). De même, il est parfois nécessaire de traiter un document PDF renvoyé par le service. La classe Java qui vous permet de transmettre des données depuis et vers les services AEM Forms est com.adobe.idp.Document.

Les services AEM Forms n’acceptent aucun autre type de données qu’un document PDF, comme un objet java.io.InputStream ou un tableau d’octets. Un objet com.adobe.idp.Document peut également être utilisé pour transmettre d’autres types de données aux services, comme des données XML.

Un objet com.adobe.idp.Document est un type sérialisable Java, donc il peut être passé sur un appel RMI. Le côté récepteur peut être co-localisé (même hôte, même chargeur de classe), local (même hôte, chargeur de classe différent) ou distant (hôte différent). La transmission du contenu des documents est optimisée pour chaque cas. Par exemple, si la personne expéditrice et la personne destinataire se trouvent sur le même hôte, le contenu est transmis via un système de fichiers local. (Dans certains cas, les documents peuvent être passés en mémoire.)

En fonction de la taille de l’objet de com.adobe.idp.Document, les données sont transmises au sein de l’objet com.adobe.idp.Document ou stockées sur le système de fichiers du serveur. Toutes les ressources de stockage temporaires occupées par l’objet du com.adobe.idp.Document sont automatiquement supprimées lors de l’élimination de com.adobe.idp.Document. (Voir Élimination d’objets de document)

Parfois, il est nécessaire de connaître le type de contenu d’un objet com.adobe.idp.Document avant de pouvoir le transmettre à un service. Par exemple, si une opération nécessite un type de contenu spécifique, comme application/pdf, il est recommandé de déterminer le type de contenu. (Voir Détermination du type de contenu d’un document.)

L’objet com.adobe.idp.Document tente de déterminer le type de contenu en utilisant les données fournies. Si le type de contenu ne peut pas être extrait des données fournies (par exemple, lorsque les données ont été fournies sous forme de tableau d’octets), définissez le type de contenu. Pour définir le type de contenu, appelez la méthode setContentType de l’objet com.adobe.idp.Document. (Voir Détermination du type de contenu d’un document)

Si les fichiers de documentation et ressources résident sur le même système de fichiers, cela crée un objet com.adobe.idp.Document plus rapide. Si les fichiers de documentation et ressources résident sur des systèmes de fichiers distants, une opération de copie doit avoir lieu, ce qui affecte les performances.

Une application peut contenir à la fois les types de données com.adobe.idp.Document et org.w3c.dom.Document. Cependant, assurez-vous que vous êtes complètement admissible pour le type de données org.w3c.dom.Document. Pour plus d’informations sur la conversion d’un objet org.w3c.dom.Document à un objet com.adobe.idp.Document, voir le didacticiel de mise en route (mode EJB) : Préremplissage des formulaires avec les mises en page souples à l’aide de l’API Java.

        // 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();

Voir également

Appel d’AEM Forms en utilisant l’API Java

Réglage des propriétés de la connexion

Création de documents creating-documents

Créez un objet com.adobe.idp.Document avant d’appeler une opération de service ayant besoin d’un document PDF (ou d’autres types de documents) comme une valeur d’entrée. La classe com.adobe.idp.Document fournit des constructeurs qui vous permettent de créer un document à partir des types de contenu suivants :

Création d’un document basé sur un tableau d’octets creating-a-document-based-on-a-byte-array

L’exemple de code suivant crée un objet com.adobe.idp.Document basé sur un tableau d’octets.

Création d’un objet Document basé sur un tableau d’octets

 Document myPDFDocument = new Document(myByteArray);

Création d’un document basé sur un autre document creating-a-document-based-on-another-document

L’exemple de code suivant crée un objet com.adobe.idp.Document basé sur un autre objet com.adobe.idp.Document.

Création d’un objet Document basé sur un autre 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);

Création d’un document basé sur un fichier creating-a-document-based-on-a-file

L’exemple de code suivant crée un objet com.adobe.idp.Document basé sur un fichier PDF nommé map.pdf. Ce fichier se trouve dans la racine du disque dur C. Ce constructeur tente de définir le type de contenu MIME de l’objet com.adobe.idp.Document en utilisant l’extension de nom de fichier.

Le constructeur com.adobe.idp.Document qui accepte l’objet java.io.File accepte également un paramètre Boolean. En définissant ce paramètre sur true, l’objet com.adobe.idp.Document supprime le fichier. Cette action signifie que vous n’avez pas besoin de supprimer le fichier après l’avoir passé au constructeur com.adobe.idp.Document.

Définir ce paramètre sur false signifie que vous conservez la propriété de ce fichier. Définir ce paramètre sur true est plus efficace. La raison est que l’objet com.adobe.idp.Document peut déplacer le fichier directement sur la zone gérée locale au lieu de le copier (ce qui est plus lent).

Création d’un objet Document basé sur un fichier PDF

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

Création d’un document basé sur un objet InputStream creating-a-document-based-on-an-inputstream-object

L’exemple de code Java suivant crée un objet com.adobe.idp.Document basé sur un objet java.io.InputStream.

Création d’un document basé sur un objet InputStream

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

Création d’un document basé sur un contenu accessible à partir d’une URL creating-a-document-based-on-content-accessible-from-an-url

L’exemple de code Java suivant crée un objet com.adobe.idp.Document basé sur un fichier PDF nommé map.pdf. Ce fichier se trouve dans une application Web nommée WebApp qui s’exécute sur localhost. Ce constructeur tente de définir le type de contenu MIME de l’objet com.adobe.idp.Document en utilisant le type de contenu retourné avec le protocole URL.

L’URL fournie à l’objet com.adobe.idp.Document est toujours lue du côté où l’objet com.adobe.idp.Document original est créé, comme indiqué dans cet exemple :

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

Le fichier c:/temp/input.pdf doit se trouver sur l’ordinateur client (et non sur l’ordinateur serveur). L’ordinateur client est l’emplacement de lecture de l’URL et de création de l’objet com.adobe.idp.Document.

Création d’un document basé sur un contenu accessible à partir d’une 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);

Voir également

Appel d’AEM Forms en utilisant l’API Java

Réglage des propriétés de la connexion

Traitement des documents retournés handling-returned-documents

Les opérations de service retournant un document PDF (ou d’autres types de données telles que les données XML) comme valeur de sortie retournent l’objet com.adobe.idp.Document. Après avoir reçu un objet com.adobe.idp.Document, vous pouvez le convertir aux formats suivants :

La ligne suivante de code convertit un objet com.adobe.idp.Document à un objet java.io.InputStream. Supposons que myPDFDocument représente un objet com.adobe.idp.Document :

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

De même, vous pouvez copier le contenu d’un fichier com.adobe.idp.Document dans un fichier local en effectuant les tâches suivantes :

L’exemple de code suivant copie le contenu d’un objet com.adobe.idp.Document dans un fichier nommé AnotherMap.pdf.

Copie du contenu d’un objet document dans un fichier

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

Voir également

Appel d’AEM Forms en utilisant l’API Java

Réglage des propriétés de la connexion

Détermination du type de contenu d’un document determining-the-content-type-of-a-document

Déterminez le type MIME d’un objet com.adobe.idp.Document en appelant la méthode getContentType de l’objet com.adobe.idp.Document. Cette méthode renvoie une valeur string qui spécifie le type de contenu de l’objet com.adobe.idp.Document. Le tableau suivant décrit les différents types de contenu renvoyés par AEM Forms.

L’exemple de code suivant détermine le type de contenu d’un objet com.adobe.idp.Document.

Détermination du type de contenu d’un objet 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);

Voir également

Appel d’AEM Forms en utilisant l’API Java

Réglage des propriétés de la connexion

Élimination d’objets de document disposing-document-objects

Lorsque vous n’avez plus besoin d’un objet Document, il est recommandé de l’éliminer en appelant la méthode dispose. Chaque objet Document utilise un descripteur de fichier et jusqu’à 75 Mo d’espace mémoire sur la plateforme de votre application hôte. Si un objet Document n’est pas éliminé, le processus de collecte de Java Garage le supprime. Toutefois, si vous l’éliminez avant en utilisant la méthode dispose, vous pouvez libérer la mémoire occupée par l’objet Document.

Voir également

Appel d’AEM Forms en utilisant l’API Java

Inclusion des fichiers de bibliothèque Java d’AEM Forms

Appel d’un service à l’aide d’une bibliothèque client Java

Appeler un service à l’aide d’une bibliothèque client Java invoking-a-service-using-a-java-client-library

Les opérations des services AEM Forms peuvent être appelées à l’aide de l’API fortement typée d’un service, appelée bibliothèque cliente Java. Une bibliothèque cliente Java est un ensemble de classes concrètes permettant d’accéder aux services déployés dans le conteneur de service. Vous instanciez un objet Java qui représente le service à appeler au lieu de créer l’objet InvocationRequest en utilisant l’API d’appel. L’API d’appel est utilisée pour appeler des processus, tels que des processus de longue durée, créés dans Workbench. (Voir Appel de processus pour des intervenants humains de longue durée.)

Pour effectuer une opération de service, appelez une méthode appartenant à l’objet Java. Une bibliothèque cliente Java contient des méthodes qui correspondent généralement des à des opérations de service. Lorsque vous utilisez une bibliothèque cliente Java, définissez les propriétés de connexion requises. (Voir Réglage des propriétés de la connexion.)

Après avoir défini les propriétés de connexion, créez un objet ServiceClientFactory utilisé pour instancier un objet Java qui vous permet d’appeler un service. Chaque service qui a une bibliothèque client Java a un objet client correspondant. Par exemple, pour appeler le service Repository, créez un objet ResourceRepositoryClient en utilisant son constructeur et en transmettant l’objet ServiceClientFactory. L’objet ServiceClientFactory est responsable de la gestion des paramètres de connexion nécessaires pour appeler les services AEM Forms.

Bien que l’obtention d’un objet ServiceClientFactory soit généralement rapide, des frais généraux sont à prévoir lorsque l’usine est utilisée pour la première fois. Cet objet est optimisé pour la réutilisation et, par conséquent, le cas échéant, utilisez le même objet ServiceClientFactory lorsque vous créez des objets client Java multiples. En d’autres termes, ne créez pas d’objet ServiceClientFactory distinct pour chaque objet de bibliothèque client que vous créez.

Un paramètre User Manager contrôle la durée de vie de l’assertion SAML qui se trouve dans l’objet com.adobe.idp.Context affectant l’objet ServiceClientFactory. Ce paramètre contrôle toutes les durées de vie du contexte d’authentification dans AEM Forms, y compris tous les appels effectués à l’aide de l’API Java. Par défaut, un objet ServiceCleintFactory peut être utilisé pendant une période de deux heures.

Vous pouvez appeler le service Repository en utilisant une bibliothèque cliente Java et en effectuant les étapes suivantes :

Voir également

Didacticiel de mise en route (mode EJB) : écriture d’une ressource en utilisant l’API Java

Appel d’AEM Forms en utilisant l’API Java

Inclusion des fichiers de bibliothèque Java d’AEM Forms

Appeler un processus de courte durée en utilisant l’API d’appel invoking-a-short-lived-process-using-the-invocation-api

Vous pouvez appeler un processus de courte durée à l’aide de l’API d’appel Java. Lorsque vous appelez un processus de courte durée à l’aide de l’API d’appel, vous transmettez les valeurs de paramètre requises à l’aide d’un objet java.util.HashMap. Pour chaque paramètre à transmettre à un service, appelez la méthode put de l’objet java.util.HashMap et spécifiez la paire nom-valeur requise par le service pour effectuer l’opération spécifiée. Spécifiez le nom exact des paramètres appartenant au processus de courte durée.

La discussion ici porte sur l’utilisation de l’API d’appel pour appeler le processus de courte durée AEM Forms suivant, nommé MyApplication/EncryptDocument.

Lorsque ce processus est appelé, il effectue les actions suivantes :

Appelez le processus de courte durée MyApplication/EncryptDocument à l’aide de l’API d’appel Java invoke-the-myapplication-encryptdocument-short-lived-process-using-the-java-invocation-api

Appelez le processus de courte durée MyApplication/EncryptDocument à l’aide de l’API d’appel Java :

Voir également

Didacticiel de mise en route : appel d’un processus de courte durée en utilisant l’API d’appel

Appel de processus pour des intervenants humains de longue durée

Inclusion des fichiers de bibliothèque Java d’AEM Forms