Valider les documents DDX validating-ddx-documents
Les exemples et les échantillons de ce document sont réservés à l’environnement AEM Forms sur JEE.
Vous pouvez valider par programme un document DDX utilisé par le service Assembler. En d’autres termes, vous pouvez déterminer si un document DDX est valide ou non à l’aide de l’API du service Assembler. Par exemple, si vous avez effectué une mise à niveau à partir d’une version précédente d’AEM Forms et que vous souhaitez vous assurer que votre document DDX est valide, vous pouvez le valider à l’aide de l’API du service Assembler.
Résumé des étapes summary-of-steps
Pour valider un document DDX, effectuez les tâches suivantes :
- Incluez les fichiers de projet.
- Créez un client Assembler.
- Référencez un document DX existant.
- Définir les options d’exécution pour valider le document DDX
- Effectuer la validation
- Enregistrer les résultats de la validation dans un fichier journal
Inclure les fichiers de projet
Incluez les fichiers nécessaires dans votre projet de développement. Si vous créez une application cliente à l’aide de Java, incluez les fichiers JAR nécessaires. Si vous utilisez des services Web, veillez à inclure les fichiers proxy.
Les fichiers JAR suivants doivent être ajoutés au chemin d’accès aux classes de votre projet :
- adobe-livecycle-client.jar
- adobe-usermanager-client.jar
- adobe-assembler-client.jar
- adobe-utility.jar (obligatoire si AEM Forms est déployé sur JBoss)
- jbossall-client.jar (obligatoire si AEM Forms est déployé sur JBoss)
si AEM Forms est déployé sur un serveur d’applications J2EE pris en charge autre que JBoss, vous devez remplacer les fichiers adobe-utility.jar et jbossall-client.jar par des fichiers JAR spécifiques au serveur d’applications J2EE sur lequel AEM Forms est déployé.
Créer un client Assembler PDF
Avant de pouvoir effectuer une opération Assembler de manière programmée, vous devez créer un client de service Assembler.
Référencer un document DDX existant
Pour valider un document DDX, vous devez référencer un document DDX existant.
Définir des options d’exécution pour valider le document DDX
Lors de la validation d’un document DDX, vous devez définir des options d’exécution spécifiques qui demandent au service Assembler de valider le document DDX plutôt que de l’exécuter. Vous pouvez également augmenter la quantité d’informations que le service Assembler écrit dans le fichier journal.
Effectuer la validation
Après avoir créé le client de service Assembler, référencé le document DDX et défini les options d’exécution, vous pouvez appeler l’opération invokeDDX
pour valider le document DDX. Lors de la validation du document DDX, vous pouvez transmettre null
comme paramètre de mappage (ce paramètre stocke généralement les documents PDF dont Assembler a besoin pour effectuer la ou les opérations spécifiées dans le document DDX).
Si la validation échoue, une exception est renvoyée et le fichier journal qui contient les détails expliquant pourquoi le document DDX n’est pas valide peut être obtenu à partir de l’instance OperationException
. Une fois l’analyse XML de base et la vérification de schéma terminées, la validation de la spécification DDX est effectuée. Toutes les erreurs qui se trouvent dans le document DDX sont spécifiées dans le journal.
Enregistrer les résultats de la validation dans un fichier journal
Le service Assembler renvoie les résultats de validation que vous pouvez écrire dans un fichier journal XML. La quantité de détails que le service Assembler entre dans le fichier journal dépend de l’option d’exécution que vous avez définie.
Voir également
Valider un document DDX à l’aide de l’API Java
Valider un document DDX à l’aide de l’API de service web
Inclusion des fichiers de bibliothèque Java d’AEM Forms
Réglage des propriétés de la connexion
Assembler les documents PDF par programmation
Valider un document DDX à l’aide de l’API Java validate-a-ddx-document-using-the-java-api
Validez un document DDX à l’aide de l’API Assembler Service (Java) :
-
Incluez les fichiers de projet.
Incluez les fichiers JAR clients, tels que adobe-assembler-client.jar, dans le chemin d’accès aux classes de votre projet Java.
-
Créez un client Assembler PDF.
- Créez un objet
ServiceClientFactory
qui contient des propriétés de connexion. - Créez un objet
AssemblerServiceClient
en utilisant son constructeur et en transmettant l’objetServiceClientFactory
.
- Créez un objet
-
Référencez un document DX existant.
- Créez un objet
java.io.FileInputStream
qui représente le document DDX en utilisant son constructeur et en transmettant une valeur de chaîne qui spécifie l’emplacement du fichier DDX. - Créez un objet
com.adobe.idp.Document
en utilisant son constructeur et en transmettant l’objetjava.io.FileInputStream
.
- Créez un objet
-
Définir les options d’exécution pour valider le document DDX
- Créez un objet
AssemblerOptionSpec
qui stocke les options d’exécution en utilisant son constructeur. - Définissez l’option d’exécution qui demande au service Assembler de valider le document DDX en appelant la méthode setValidateOnly de l’objet
AssemblerOptionSpec
et en transmettanttrue
. - Définissez la quantité d’informations que le service Assembler entre dans le fichier journal en appelant la méthode
getLogLevel
de l’objetAssemblerOptionSpec
et en transmettant une valeur de chaîne qui répond à vos besoins. Lors de la validation d’un document DDX, un plus grand nombre d’informations écrites dans le fichier journal facilite le processus de validation. Par conséquent, vous pouvez transmettre la valeurFINE
ouFINER
.
- Créez un objet
-
Effectuer la validation
Appelez la méthode
invokeDDX
de l’objetAssemblerServiceClient
et transmettez les valeurs suivantes :- Un objet
com.adobe.idp.Document
qui représente le document DDX. - La valeur
null
de l’objet java.io.Map qui stocke généralement les documents PDF. - Un objet
com.adobe.livecycle.assembler.client.AssemblerOptionSpec
qui spécifie les options d’exécution.
La méthode
invokeDDX
renvoie un objetAssemblerResult
, lequel contient des informations indiquant si le document DDX est valide. - Un objet
-
Enregistrer les résultats de la validation dans un fichier journal
- Créez un objet
java.io.File
et assurez-vous que l’extension du nom de fichier est .xml. - Appelez la méthode
getJobLog
de l’objetAssemblerResult
. Cette méthode renvoie une instancecom.adobe.idp.Document
qui contient des informations de validation. - Appelez la méthode
copyToFile
de l’objetcom.adobe.idp.Document
pour copier le contenu de l’objetcom.adobe.idp.Document
dans le fichier.
note note NOTE Si le document DDX n’est pas valide, une exception OperationException
est renvoyée. Dans l’instruction catch, vous pouvez appeler la méthodegetJobLog
de l’objetOperationException
. - Créez un objet
Voir également
Démarrage rapide (mode SOAP) : validation des documents DDX à l’aide de l’API Java (mode SOAP)
Inclusion des fichiers de bibliothèque Java d’AEM Forms
Réglage des propriétés de la connexion
Valider un document DDX à l’aide de l’API de service web validate-a-ddx-document-using-the-web-service-api
Pour valider un document DDX à l’aide de l’API Assembler Service (service web), procédez comme suit :
-
Incluez les fichiers de projet.
Créez un projet Microsoft .NET qui utilise MTOM. Veillez à utiliser la définition WSDL suivante :
http://localhost:8080/soap/services/AssemblerService?WSDL&lc_version=9.0.1
.note note NOTE Remplacez localhost par l’adresse IP du serveur Forms. -
Créez un client Assembler PDF.
-
Créez un objet
AssemblerServiceClient
en utilisant son constructeur par défaut. -
Créez un objet
AssemblerServiceClient.Endpoint.Address
en utilisant le constructeurSystem.ServiceModel.EndpointAddress
. Transmettez une valeur de chaîne qui spécifie le WSDL au service AEM Forms (par exemple,http://localhost:8080/soap/services/AssemblerService?blob=mtom
). Vous n’avez pas besoin d’utiliser l’attributlc_version
. Cet attribut est utilisé lorsque vous créez une référence de service. -
Créez un objet
System.ServiceModel.BasicHttpBinding
en récupérant la valeur du champAssemblerServiceClient.Endpoint.Binding
. Convertissez la valeur de retour enBasicHttpBinding
. -
Définissez le champ
MessageEncoding
de l’objetSystem.ServiceModel.BasicHttpBinding
surWSMessageEncoding.Mtom
. Cette valeur garantit l’utilisation de MTOM. -
Activez l’authentification HTTP de base en effectuant les tâches suivantes :
- Attribuez le nom d’utilisateur AEM forms au champ
AssemblerServiceClient.ClientCredentials.UserName.UserName
. - Attribuez la valeur de mot de passe correspondante au champ
AssemblerServiceClient.ClientCredentials.UserName.Password
. - Attribuez la valeur constante
HttpClientCredentialType.Basic
au champBasicHttpBindingSecurity.Transport.ClientCredentialType
. - Attribuez la valeur constante
BasicHttpSecurityMode.TransportCredentialOnly
au champBasicHttpBindingSecurity.Security.Mode
.
- Attribuez le nom d’utilisateur AEM forms au champ
-
-
Référencez un document DX existant.
- Créez un objet
BLOB
en utilisant son constructeur. L’objetBLOB
sert à stocker le document DDX. - Créez un objet
System.IO.FileStream
en appelant son constructeur et en transmettant une valeur de chaîne qui représente l’emplacement du fichier du document DDX et le mode d’ouverture du fichier. - Créez un tableau d’octets qui stocke le contenu de l’objet
System.IO.FileStream
. Vous pouvez déterminer la taille du tableau d’octets en obtenant la propriétéLength
de l’objetSystem.IO.FileStream
. - Renseignez le tableau d’octets avec les données de diffusion en appelant la méthode
Read
de l’objetSystem.IO.FileStream
et en transmettant le tableau d’octets, la position de départ et la longueur du flux à lire. - Renseignez l’objet
BLOB
en attribuant sa propriétéMTOM
avec le contenu du tableau d’octets.
- Créez un objet
-
Définir les options d’exécution pour valider le document DDX
- Créez un objet
AssemblerOptionSpec
qui stocke les options d’exécution en utilisant son constructeur. - Définissez l’option d’exécution qui demande au service Assembler de valider le document DDX en attribuant la valeur true (vrai) au membre de données
validateOnly
de l’objetAssemblerOptionSpec
. - Définissez la quantité d’informations que le service Assembler écrit dans le fichier journal en attribuant une valeur de chaîne au membre de données
logLevel
de l’objetAssemblerOptionSpec
. méthode Lors de la validation d’un document DDX, il convient dʼécrire plus dʼinformations dans le fichier journal pour faciliter le processus de validation. Par conséquent, vous pouvez spécifier la valeurFINE
ouFINER
. Pour plus d’informations sur les options d’exécution que vous pouvez définir, consultez la référence de classeAssemblerOptionSpec
dans la référence de l’API AEM Forms.
- Créez un objet
-
Effectuer la validation
Appelez la méthode
invokeDDX
de l’objetAssemblerServiceClient
et transmettez les valeurs suivantes :- Objet
BLOB
qui représente le document DDX. - Valeur
null
pour l’objetMap
qui stocke généralement des documents PDF. - Objet
AssemblerOptionSpec
qui spécifie les options d’exécution.
La méthode
invokeDDX
renvoie un objetAssemblerResult
qui contient des informations indiquant si le document DDX est valide. - Objet
-
Enregistrer les résultats de la validation dans un fichier journal
- Créez un objet
System.IO.FileStream
en appelant son constructeur et en transmettant une valeur de chaîne qui représente l’emplacement du fichier journal et le mode d’ouverture du fichier. Assurez-vous que l’extension du nom du fichier est .xml. - Créez un objet
BLOB
qui stocke les informations du journal en obtenant la valeur du membre de donnéesjobLog
de l’objetAssemblerResult
. - Créez un tableau d’octets qui stocke le contenu de l’objet
BLOB
. Renseignez le tableau d’octets en obtenant la valeur du champMTOM
de l’objetBLOB
. - Créez un objet
System.IO.BinaryWriter
en utilisant son constructeur et en transmettant l’objetSystem.IO.FileStream
. - Écrivez le contenu du tableau d’octets dans un fichier PDF en appelant la méthode
Write
de l’objetSystem.IO.BinaryWriter
et en transmettant le tableau d’octets.
note note NOTE Si le document DDX n’est pas valide, un élément OperationException
est généré. Dans l’instruction catch, vous pouvez obtenir la valeur du membrejobLog
de l’objetOperationException
. - Créez un objet
Voir également
Appeler AEM Forms en utilisant MTOM