AEM 6.4 a atteint la fin de la prise en charge étendue et cette documentation n’est plus mise à jour. Pour plus d’informations, voir notre période de support technique. Rechercher les versions prises en charge here.
La plupart des services AEM Forms dans le conteneur de services sont configurés pour exposer un service web, avec une prise en charge complète de la génération WSDL (Web Services Definition Language). Cela signifie que vous pouvez créer des objets proxy utilisant la pile SOAP native d’un service AEM Forms. Les services AEM Forms peuvent ainsi échanger et traiter les messages SOAP suivants :
Les services web vous permettent d’effectuer les mêmes opérations de services AEM Forms que l’API Java. Lʼutilisation des services web pour appeler les services AEM Forms offre lʼavantage de pouvoir créer une application client dans un environnement de développement prenant en charge SOAP. Une application client ne dépend pas dʼun environnement de développement ou dʼun langage de programmation spécifique. Par exemple, vous pouvez créer une application client à l’aide de Microsoft Visual Studio .NET, écrite dans le langage de programmation C#.
Les services AEM Forms sont accessibles via le protocole SOAP et sont conformes au profil WSI Basic Profile 1.1. Web Services Interoperability (WSI) est une organisation qui promeut lʼinteropérabilité des services web entre les plateformes au moyen de normes ouvertes. Pour plus d’informations, consultez leur site web https://www.ws-i.org/.
AEM Forms prend en charge les normes de service web suivantes :
En règle générale, pour appeler les services AEM Forms à l’aide d’un service web, vous créez une bibliothèque proxy qui utilise le fichier WSDL du service. La section Appeler AEM Forms à l’aide de services web utilise JAX-WS pour créer des classes proxy Java afin dʼappeler des services. (Consultez la section Créer des classes de proxy Java à l’aide de JAX-WS).
Vous pouvez récupérer le fichier WSDL dʼun service en spécifiant la définition d’URL suivante (les éléments entre crochets sont facultatifs) :
https://<your_serverhost>:<your_port>/soap/services/<service_name>?wsdl[&version=<version>][&async=true|false][lc_version=<lc_version>]
où :
async
spécifie la valeur true
permettant dʼactiver des opérations supplémentaires pour lʼappel asynchrone (false
par défaut).Le tableau suivant répertorie les définitions WSDL de service (en supposant qu’AEM Forms soit déployé sur l’hôte local et que la publication soit 8080).
Service |
Définition WSDL |
---|---|
Assembler |
|
Retour et restauration |
|
Barcoded Forms |
|
Convert PDF |
|
Distiller |
|
DocConverter |
|
DocumentManagement |
|
Encryption (chiffrement) |
|
Formulaires |
|
Form Data Integration |
|
Generate PDF |
|
Générer un PDF 3D |
|
Sortie |
|
PDF Utilities |
|
Acrobat Reader DC Extensions |
|
Référentiel |
|
Gestion des droits |
|
Signature |
|
XMP Utilities |
|
Définitions WSDL du processus AEM Forms
Vous devez spécifier le nom de l’application et le nom du processus dans la définition WSDL pour accéder à une WSDL qui appartient à un processus créé dans Workbench. Supposons que le nom de l’application soit MyApplication
et le nom du processus EncryptDocument
. Dans ce cas, spécifiez la définition WSDL suivante :
http://localhost:8080/soap/services/MyApplication/EncryptDocument?wsdl
Pour plus d’informations sur l’exemple de processus de courte durée MyApplication/EncryptDocument
, voir Exemple de processus de courte durée.
Une application peut contenir un ou plusieurs dossiers. Dans ce cas, indiquez le(s) nom(s) de dossier dans la définition WSDL :
http://localhost:8080/soap/services/MyApplication/[<folderA>/.../<folderZ>/]EncryptDocument?wsdl
Accéder aux nouvelles fonctionnalités à l’aide des services web
Les nouvelles fonctionnalités du service AEM Forms sont accessibles à l’aide des services web. Par exemple, dans AEM Forms, il est désormais possible de coder des pièces jointes à l’aide de MTOM. (Voir Appeler AEM Forms à l’aide de MTOM.)
Pour accéder aux nouvelles fonctionnalités introduites dans AEM Forms, spécifiez l’attribut lc_version
dans la définition WSDL. Par exemple, pour accéder aux nouvelles fonctionnalités de service (y compris la prise en charge de MTOM), spécifiez la définition WSDL suivante :
http://localhost:8080/soap/services/MyApplication/EncryptDocument?wsdl&lc_version=9.0.1
Lors de la définition de l’attribut lc_version
, veillez à utiliser trois chiffres. Par exemple, 9.0.1 équivaut à la version 9.0.
Type de données BLOB de service web
Les WSDL de service AEM Forms définissent plusieurs types de données. L’un des types de données les plus importants exposés dans un service web est le type BLOB
. Ce type de données est mappé à la classe com.adobe.idp.Document
lors de l’utilisation des API Java AEM Forms. (Voir Transmission de données vers les services AEM Forms à l’aide de l’API Java.)
Un objet BLOB
envoie et récupère des données binaires (par exemple, des fichiers PDF, des données XML, etc.) vers et depuis les services AEM Forms. Le type BLOB
est défini dans un WSDL de service comme suit :
<complexType name="BLOB">
<sequence>
<element maxOccurs="1" minOccurs="0" name="contentType"
type="xsd:string"/>
<element maxOccurs="1" minOccurs="0" name="binaryData"
type="xsd:base64Binary"/>
<element maxOccurs="1" minOccurs="0" name="attachmentID"
type="xsd:string"/>
<element maxOccurs="1" minOccurs="0" name="remoteURL"
type="xsd:string"/>
<element maxOccurs="1" minOccurs="0" name="MTOM"
type="xsd:base64Binary"
xmime:expectedContentTypes="*/*"
xmlns:xmime="https://www.w3.org/2005/05/xmlmime"/>
<element maxOccurs="1" minOccurs="0" name="swaRef"
type="tns1:swaRef"/>
<element maxOccurs="1" minOccurs="0" name="attributes"
type="impl:MyMapOf_xsd_string_To_xsd_anyType"/>
</sequence>
</complexType>
Les champs MTOM
et swaRef
ne sont pris en charge que dans AEM Forms. Vous ne pouvez utiliser ces nouveaux champs que si vous spécifiez une URL qui inclut la propriété lc_version
.
Fourniture d’objets BLOB dans des demandes de service
Si une opération de service AEM Forms nécessite un type BLOB
en tant que valeur d’entrée, créez une instance du type BLOB
dans la logique de votre application. (La plupart des démarrages rapides de service web se trouvant dans Programmation avec les AEM forms montrent comment utiliser un type de données BLOB.)
Affectez des valeurs aux champs qui appartiennent à l’instance BLOB
comme suit :
BLOB.binaryData
, puis définissez le type de données au format MIME (par exemple application/pdf
) dans le champ BLOB.contentType
. (Voir Appeler AEM Forms à l’aide du codage Base64.)BLOB.MTOM
. Ce paramètre associe les données à la requête SOAP à l’aide du framework Java JAX-WS ou de l’API native du framework SOAP. (Voir Appeler AEM Forms à l’aide de MTOM.)BLOB.swaRef
. Ce paramètre associe les données à la requête SOAP à l’aide du framework Java JAX-WS. (Voir Appeler AEM Forms à l’aide de SwaRef.)BLOB.attachmentID
. (Voir Appeler AEM Forms à l’aide du codage Base64.)BLOB.remoteURL
. (Voir Appeler AEM Forms à l’aide de données BLOB sur HTTP.)Accéder aux données dans les objets BLOB renvoyés par les services
Le protocole de transmission pour les objets BLOB
renvoyés dépend de plusieurs facteurs, pris en compte dans l’ordre suivant, qui s’arrêtent lorsque la condition principale est remplie :
L’URL cible spécifie le protocole de transmission. Si l’URL cible spécifiée lors de l’appel SOAP contient le paramètre blob="
BLOB_TYPE", alors BLOB_TYPE détermine le protocole de transmission. BLOB_TYPE est un espace réservé pour Base64, DIME, MIME, HTTP, MTOM ou SWAREF.
Le point d’entrée SOAP du service est Smart. Si les conditions suivantes sont vraies, les documents de sortie sont retournés avec le même protocole de transmission que les documents d’entrée :
Le paramètre de point d’entrée SOAP du service Default Protocol for Output Blob Objects est défini sur Smart.
Pour chaque service ayant un point d’entrée SOAP, la console d’administration vous offre la possibilité de spécifier le protocole de transmission pour les objets Blob renvoyés. (Voir Aide d’administration.)
Le service AEM Forms prend un ou plusieurs documents en entrée.
Le point d’entrée SOAP du service n’est pas dynamique. Le protocole configuré détermine le protocole de transmission du document et les données sont renvoyées dans le champ BLOB
. Par exemple, si le point d’entrée SOAP est défini sur DIME, l’objet Blob renvoyé se trouve dans le champ blob.attachmentID
, indépendamment du protocole de transmission d’un document d’entrée.
Dans le cas contraire. Si un service ne prend pas le type de document en entrée, les documents de sortie sont renvoyés dans le champ BLOB.remoteURL
sur le protocole HTTP.
Comme décrit dans la première condition, vous pouvez garantir le type de transmission de tout document renvoyé en étendant l’URL du point d’entrée SOAP avec un suffixe comme suit :
https://<your_serverhost>:<your_port>/soap/services/<service
name>?blob=base64|dime|mime|http|mtom|swaref
Voici la corrélation entre les types de transmission et le champ à partir duquel vous obtenez les données :
blob
sur base64
pour renvoyer les données dans le champ BLOB.binaryData
.blob
sur DIME
ou MIME
pour renvoyer les données sous la forme d’un type de pièce jointe correspondant avec l’identificateur de pièce jointe renvoyé dans le champ BLOB.attachmentID
. Utilisez l’API propriétaire du framework SOAP pour lire les données depuis la pièce jointe.blob
sur http
pour conserver les données sur le serveur applicatif et renvoyer l’URL pointant vers les données du champ BLOB.remoteURL
.blob
sur mtom
ou swaref
pour renvoyer les données sous la forme d’un type de pièce jointe correspondant à l’identificateur de pièce jointe renvoyé dans les champs BLOB.MTOM
ou BLOB.swaRef
. Utilisez l’API native du framework SOAP pour lire les données de la pièce jointe.Il est recommandé de ne pas dépasser 30 Mo lors de la saisie d’un objet BLOB
en appelant sa méthode setBinaryData
. Sinon, il est possible qu’une OutOfMemory
* exception.*
Les applications basées sur JAX-WS qui utilisent le protocole de transmission MTOM sont limitées à 25 Mo de données envoyées et reçues. Cette limitation est due à un bogue survenu dans JAX-WS. Si la taille combinée de vos fichiers envoyés et reçus dépasse 25 Mo, utilisez le protocole de transmission SwaRef au lieu de celui MTOM. Sinon, il est possible qu’une OutOfMemory
* exception.*
Transmission MTOM des tableaux d’octets codés en Base64
En plus de l’objet BLOB
, le protocole MTOM prend en charge tout paramètre de tableau d’octets ou champ de tableau d’octets d’un type complexe. Cela signifie que les frameworks SOAP client prenant en charge MTOM peuvent envoyer n’importe quel élément xsd:base64Binary
en tant que pièce jointe MTOM (au lieu d’un texte codé en Base64). Les points d’entrée SOAP AEM Forms peuvent lire ce type de codage de tableau d’octets. Cependant, le service AEM Forms renvoie toujours un type de tableau d’octets sous forme de texte codé en Base64. Les paramètres du tableau d’octets de sortie ne prennent pas en charge MTOM.
Les services AEM Forms qui renvoient un grand volume de données binaires utilisent le type Document/BLOB plutôt que le type de tableau d’octets. Le type Document est beaucoup plus efficace pour transmettre de grandes quantités de données.
Le tableau suivant répertorie les types de données Java et indique le type de données de service Web correspondant.
Type de données Java |
Type de données de service Web |
---|---|
|
|
|
|
|
Type
Si une opération du service AEM Forms prend une valeur |
|
Type
Si une opération du service AEM Forms prend une valeur |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
La Map est représentée sous la forme d’une séquence de paires clé/valeur. |
|
|
|
|
|
|
|
Type XML, qui est défini comme suit dans le WSDL d’un service :
Si une opération du service AEM Forms accepte une valeur La définition du champ |
|
Type XML, qui est défini comme suit dans le WSDL d’un service :
Si une opération du service AEM Forms prend un élément La définition du champ |
L’appel de services web à l’aide de composants personnalisés explique comment créer un composant AEM Forms qui appelle des services web tiers.
Vous pouvez utiliser JAX-WS pour convertir un WSDL de service Forms en classes proxy Java. Ces classes vous permettent d’appeler les opérations des services AEM Forms. Apache Ant vous permet de créer un script de génération qui génère des classes proxy Java en référençant un WSDL de service AEM Forms. Vous pouvez générer des fichiers proxy JAX-WS en procédant comme suit :
Installez Apache Ant sur l’ordinateur client. (Voir https://ant.apache.org/bindownload.cgi.)
ANT_HOME
sur le répertoire dans lequel vous avez installé Ant.Installez JDK version 1.6 ou ultérieure.
JAVA_HOME
sur le répertoire dans lequel vous avez installé JDK.JDK 1.6 comprend le programme wsimport utilisé dans le fichier build.xml. JDK 1.5 n’inclut pas ce programme.
Installez JAX-WS sur l’ordinateur client. (Voir API Java pour les services Web XML.)
Utilisez JAX-WS et Apache Ant pour générer des classes proxy Java. Pour ce faire, créez un fichier de script de build Ant. Le script suivant est un exemple de script de build Ant nommé build.xml :
<?xml version="1.0" encoding="UTF-8"?>
<project basedir="." default="compile">
<property name="port" value="8080" />
<property name="host" value="localhost" />
<property name="username" value="administrator" />
<property name="password" value="password" />
<property name="tests" value="all" />
<target name="clean" >
<delete dir="classes" />
</target>
<target name="wsdl" depends="clean">
<mkdir dir="classes"/>
<exec executable="wsimport" failifexecutionfails="false" failonerror="true" resultproperty="foundWSIMPORT">
<arg line="-keep -d classes https://${host}:${port}/soap/services/EncryptionService?wsdl&lc_version=9.0.1"/>
</exec>
<fail unless="foundWSIMPORT">
!!! Failed to execute JDK's wsimport tool. Make sure that JDK 1.6 (or later) is on your PATH !!!
</fail>
</target>
<target name="compile" depends="clean, wsdl" >
<javac destdir="./classes" fork="true" debug="true">
<src path="./src"/>
</javac>
</target>
<target name="run">
<java classname="Client" fork="yes" failonerror="true" maxmemory="200M">
<classpath>
<pathelement location="./classes"/>
</classpath>
<arg value="${port}"/>
<arg value="${host}"/>
<arg value="${username}"/>
<arg value="${password}"/>
<arg value="${tests}"/>
</java>
</target>
</project>
Dans ce script de génération Ant, notez que la propriété url
est définie pour référencer le WSDL du service de chiffrement (Encryption) exécuté sur localhost. Les propriétés username
et password
doivent être définies sur un nom d’utilisateur et un mot de passe valides pour AEM Forms. Remarquez que l’URL contient l’attribut lc_version
. Si vous ne spécifiez pas l’option lc_version
, vous ne pouvez pas appeler de nouvelles opérations du service AEM Forms.
Remplacer EncryptionService
* avec le nom du service AEM Forms que vous souhaitez appeler à l’aide des classes proxy Java. Par exemple, pour créer des classes proxy Java pour le service de Rights Management, spécifiez :*
http://localhost:8080/soap/services/RightsManagementService?WSDL&lc_version=9.0.1
Créez un fichier BAT pour exécuter le script de build Ant. La commande suivante peut être localisée dans un fichier BAT responsable de l’exécution du script de build Ant :
ant -buildfile "build.xml" wsdl
Placez le fichier de script de build ANT dans le dossier C:\Program Files\Java\jaxws-ri\bin directory. Le script enregistre les fichiers JAVA dans le dossier./classes. Le script génère des fichiers JAVA pouvant appeler le service.
Compressez les fichiers JAVA dans un fichier JAR. Si vous travaillez sur Eclipse, procédez comme suit :
com.adobe.idp.services
dans le dossier Source.com.adobe.idp.services
, puis importez les fichiers JAVA du dossier adobe/idp/services dans le package.org/apache/xml/xmlsoap
dans le dossier Source.Tous les didacticiels de mise en route des services web Java (à l’exception du service Forms) situés dans la section Programmation avec AEM Forms créent des fichiers proxy Java à l’aide de JAX-WS. En outre, tous les didacticiels de mise en route de services web Java utilisent SwaRef. (Consultez la section Appeler AEM Forms à l’aide de SwaRef).
Voir également
Créer des classes proxy Java à l’aide dʼApache Axis
Appeler AEM Forms en utilisant le codage Base64
Appeler AEM Forms à lʼaide de données BLOB via HTTP
Appel d’AEM Forms à l’aide de SwaRef
Vous pouvez utiliser l’outil WSDL2Java dʼApache Axis pour convertir un service Forms en classes proxy Java. Ces classes vous permettent d’appeler les opérations du service Forms. Grâce à Apache Ant, vous pouvez générer des fichiers de bibliothèque Axis à partir du fichier WSDL dʼun service. Vous pouvez télécharger Apache Axis à l’adresse https://ws.apache.org/axis/.
Les didacticiels de mise en route du service web associés au service Forms utilisent des classes proxy Java créées à l’aide dʼApache Axis. Les didacticiels de mise en route du service web Forms utilisent également le codage Base64. (Consultez la section Didacticiels de mise en route de l’API Forms Service).
Vous pouvez générer des fichiers de bibliothèque Java Axis en procédant comme suit :
Installez Apache Ant sur l’ordinateur client. Le logiciel est disponible à l’adresse https://ant.apache.org/bindownload.cgi.
ANT_HOME
sur le répertoire où vous avez installé Ant.Installez Apache Axis 1.4 sur l’ordinateur client. Le logiciel est disponible à l’adresse https://ws.apache.org/axis/.
Configurez le chemin de classe pour utiliser les fichiers JAR dʼAxis dans votre client de service web, comme décrit dans les instructions d’installation d’Axis à l’adresse https://ws.apache.org/axis/java/install.html.
Utilisez l’outil WSDL2Java dʼApache dans Axis afin de générer des classes proxy Java. Pour ce faire, créez un fichier de script de build Ant. Le script suivant est un exemple de script de build Ant nommé build.xml :
<?xml version="1.0"?>
<project name="axis-wsdl2java">
<path id="axis.classpath">
<fileset dir="C:\axis-1_4\lib" >
<include name="**/*.jar" />
</fileset>
</path>
<taskdef resource="axis-tasks.properties" classpathref="axis.classpath" />
<target name="encryption-wsdl2java-client" description="task">
<axis-wsdl2java
output="C:\JavaFiles"
testcase="false"
serverside="false"
verbose="true"
username="administrator"
password="password"
url="http://localhost:8080/soap/services/EncryptionService?wsdl&lc_version=9.0.1" >
</axis-wsdl2java>
</target>
</project>
Dans ce script de build Ant, remarquez que la propriété url
est définie pour référencer le fichier WSDL du service Encryption s’exécutant sur localhost. Les propriétés username
et password
doivent être définies sur un nom d’utilisateur et un mot de passe AEM Forms valides.
Créez un fichier BAT pour exécuter le script de build Ant. La commande suivante peut être localisée dans un fichier BAT responsable de l’exécution du script de build Ant :
ant -buildfile "build.xml" encryption-wsdl2java-client
Les fichiers JAVA sont écrits dans le dossier C:\JavaFiles tel que spécifié par la propriété output
. Pour réussir à appeler le service Forms, importez ces fichiers JAVA dans votre chemin de classe.
Par défaut, ces fichiers appartiennent à un package Java nommé com.adobe.idp.services
. Il est recommandé de placer ces fichiers JAVA dans un fichier JAR. Importez ensuite le fichier JAR dans le chemin de classe de votre application client.
Pour placer des fichiers .JAVA dans un fichier JAR, plusieurs méthodes sont à votre disposition. Vous pouvez par exemple utiliser un IDE Java, comme Eclipse. Créez un projet Java et créez un com.adobe.idp.services
* package (tous les fichiers .JAVA appartiennent à ce package). Importez ensuite tous les fichiers .JAVA dans le package. Enfin, exportez le projet sous forme de fichier JAR.*
Modifiez l’URL dans la classe EncryptionServiceLocator
pour spécifier le type de codage. Par exemple, pour utiliser le codage base64, spécifiez ?blob=base64
pour vous assurer que lʼobjet BLOB
renvoie des données binaires. De cette manière, dans la classe EncryptionServiceLocator
, localisez la chaîne suivante :
http://localhost:8080/soap/services/EncryptionService;
Localisez la chaîne et attribuez-lui la valeur:
http://localhost:8080/soap/services/EncryptionService?blob=base64;
Ajoutez les fichiers Axis JAR suivants au chemin de classe de votre projet Java :
Ces fichiers JAR se trouvent dans la variable [répertoire d’installation]/Adobe/Adobe Experience Manager Forms/sdk/lib/thirdparty directory.
Voir également
Créer des classes proxy Java à l’aide de JAX-WS
Appeler AEM Forms en utilisant le codage Base64
Appeler AEM Forms à lʼaide de données BLOB via HTTP
Vous pouvez appeler un service AEM Forms en utilisant le codage Base64. Le codage Base64 permet de coder les pièces jointes envoyées avec une demande d’appel de service web. Seules les données BLOB
sont codées en Base64 et non le message SOAP dans son intégralité.
La section « Appeler AEM Forms en utilisant le codage Base64 » traite de l’appel du processus de courte durée dʼAEM Forms suivant nommé MyApplication/EncryptDocument
en utilisant le codage Base64.
Ce processus n’est pas basé sur un processus AEM Forms existant. Pour suivre l’exemple de code, créez un processus désigné par MyApplication/EncryptDocument
à l’aide de Workbench. (Voir Utilisation de Workbench.)
Lorsque ce processus est appelé, il effectue les actions suivantes :
SetValue
. Le paramètre d’entrée pour ce processus est une variable de processus document
désignée par inDoc
.PasswordEncryptPDF
. Le document PDF chiffré avec un mot de passe est retourné dans une variable de processus nommée outDoc
.Vous pouvez créer un assemblage client .NET pour appeler un service Forms depuis un projet Microsoft Visual Studio .NET. Pour créer un assemblage client .NET sous codage base64, procédez comme suit :
Créer une classe proxy
Vous pouvez créer une classe proxy permettant de créer l’assemblage client .NET à l’aide d’un outil inclus dans Microsoft Visual Studio. Le nom de l’outil est wsdl.exe et se trouve dans le dossier d’installation de Microsoft Visual Studio. Pour créer une classe proxy, ouvrez l’invite de commande et accédez au dossier contenant le fichier wsdl.exe. Pour plus d’informations sur l’outil wsdl.exe, consultez la section Aide de MSDN.
Saisissez la commande suivante dans l’invite de commande :
wsdl https://hiro-xp:8080/soap/services/MyApplication/EncryptDocument?WSDL&lc_version=9.0.1
Par défaut, cet outil crée un fichier CS dans le même dossier correspondant au nom du fichier WSDL. Dans cette situation, il crée un fichier CS nommé EncryptDocumentService.cs. Utilisez ce fichier CS pour créer un objet proxy vous permettant d’appeler le service spécifié dans l’URL d’appel.
Modifiez l’URL dans la classe proxy pour inclure ?blob=base64
, afin que lʼobjet BLOB
renvoie des données binaires. Dans la classe proxy, recherchez la ligne de code suivante :
"https://hiro-xp:8080/soap/services/MyApplication/EncryptDocument";
Localisez la chaîne et attribuez-lui la valeur:
"https://hiro-xp:8080/soap/services/MyApplication/EncryptDocument?blob=base64";
La section Appeler AEM Forms en utilisant le codage Base64 utilise MyApplication/EncryptDocument
comme exemple. Si vous créez un assemblage client .NET pour un autre service Forms, assurez-vous de remplacer MyApplication/EncryptDocument
par le nom du service.
Développer l’assemblage client .NET
Créez un projet de bibliothèque de classes Visual Studio qui génère un assemblage client .NET. Le fichier CS que vous avez créé à l’aide de wsdl.exe peut être importé dans ce projet. Ce projet crée un fichier DLL (l’assemblage client .NET) que vous pouvez utiliser dans d’autres projets Visual Studio .NET afin dʼappeler un service.
Cette procédure crée un assemblage client .NET appelé DocumentService.dll, que vous pouvez utiliser pour envoyer des requêtes SOAP au service MyApplication/EncryptDocument
.
Assurez-vous que vous avez ajouté ?blob=base64
à l’URL dans la classe proxy utilisée pour créer l’assemblage client .NET. Dans le cas contraire, vous ne pouvez pas récupérer les données binaires de lʼobjet BLOB
.
Référencer l’assemblage client .NET
Placez l’assemblage client .NET que vous venez de créer sur l’ordinateur où vous développez votre application client. Après avoir placé l’assemblage client .NET dans un répertoire, vous pouvez le référencer à partir d’un projet. Référencez également la bibliothèque System.Web.Services
de votre projet. Si vous ne référencez pas cette bibliothèque, vous ne pouvez pas utiliser l’assemblage client .NET pour appeler un service.
Appeler un service à l’aide d’un assemblage client .NET sous codage Base64
Vous pouvez appeler le service MyApplication/EncryptDocument
(qui a été créé dans Workbench) à l’aide d’un assemblage client .NET qui utilise l’encodage Base64. Pour appeler le service MyApplication/EncryptDocument
, procédez comme suit :
MyApplication/EncryptDocument
.System.Web.Services
.MyApplication_EncryptDocumentService
en appelant son constructeur par défaut.Credentials
de lʼobjet MyApplication_EncryptDocumentService
avec un objet System.Net.NetworkCredential
. Dans le constructeur System.Net.NetworkCredential
, indiquez un nom d’utilisateur AEM Forms et son mot de passe. Définissez les valeurs d’authentification pour permettre à votre application client .NET d’échanger des messages SOAP avec AEM Forms.BLOB
en utilisant son constructeur. Lʼobjet BLOB
sert à stocker un document PDF transmis au processus MyApplication/EncryptDocument
.System.IO.FileStream
en appelant son constructeur. Transmettez une valeur de chaîne qui représente l’emplacement du fichier du document PDF et son mode d’ouverture.System.IO.FileStream
. Vous pouvez déterminer la taille du tableau d’octets en obtenant la propriété Length
de l’objet System.IO.FileStream
.Read
de l’objet System.IO.FileStream
. Transmettez le tableau d’octets, la position de départ et la longueur du flux à lire.BLOB
en assignant à sa propriété binaryData
le contenu du tableau dʼoctets.MyApplication/EncryptDocument
en appelant la méthode invoke
de lʼobjet MyApplication_EncryptDocumentService
et en transmettant lʼobjet BLOB
qui contient le document PDF. Ce processus renvoie un document PDF chiffré dans un objet BLOB
.System.IO.FileStream
en appelant son constructeur et en transmettant une valeur de chaîne qui représente l’emplacement du fichier du document chiffré par mot de passe.BLOB
renvoyé par la méthode invoke
de lʼobjet MyApplicationEncryptDocumentService
. Renseignez le tableau dʼoctets en obtenant la valeur du membre de données binaryData
de lʼobjet BLOB
.System.IO.BinaryWriter
en appelant son constructeur et en transmettant l’objet System.IO.FileStream
.Write
de lʼobjet System.IO.BinaryWriter
et en transmettant le tableau d’octets.Vous pouvez appeler un service AEM Forms à l’aide des classes proxy Java et de Base64. Pour appeler le service MyApplication/EncryptDocument
à l’aide de classes proxy Java, procédez comme suit :
Créez des classes proxy Java à lʼaide de JAX-WS qui utilise le WSDL du service MyApplication/EncryptDocument
. Utilisez le point d’entrée WSDL suivant :
https://hiro-xp:8080/soap/services/MyApplication/EncryptDocument?WSDL&lc_version=9.0.1
Remplacer hiro-xp
* avec l’adresse IP du serveur d’applications J2EE hébergeant AEM Forms. *
Regroupez les classes proxy Java créées à l’aide de JAX-WS dans un fichier JAR.
Incluez le fichier JAR du proxy Java et les fichiers JAR situés dans le chemin d’accès suivant :
<Install Directory>\Adobe\Adobe_Experience_Manager_forms\sdk\client-libs\thirdparty
dans le chemin de classe de votre projet client Java.
Créez un objet MyApplicationEncryptDocumentService
en utilisant son constructeur.
Créez un objet MyApplicationEncryptDocument
en appelant la méthode getEncryptDocument
de lʼobjet MyApplicationEncryptDocumentService
.
Définissez les valeurs de connexion requises pour appeler AEM Forms en affectant des valeurs aux membres de données suivants :
Attribuez le point d’entrée WSDL et le type de codage au champ ENDPOINT_ADDRESS_PROPERTY
de lʼobjet javax.xml.ws.BindingProvider
. Pour appeler le service MyApplication/EncryptDocument
en utilisant le codage Base64, spécifiez la valeur dʼURL suivante :
https://hiro-xp:8080/soap/services/MyApplication/EncryptDocument?blob=base64
Attribuez lʼutilisateur AEM Forms au champ USERNAME_PROPERTY
de lʼobjet javax.xml.ws.BindingProvider
.
Attribuez la valeur du mot de passe correspondant au champ PASSWORD_PROPERTY
de lʼobjet javax.xml.ws.BindingProvider
.
L’exemple de code suivant illustre cette logique d’application :
//Set connection values required to invoke AEM Forms
String url = "https://hiro-xp:8080/soap/services/MyApplication/EncryptDocument?blob=base64";
String username = "administrator";
String password = "password";
((BindingProvider) encryptDocClient).getRequestContext().put(BindingProvider.ENDPOINT_ADDRESS_PROPERTY, url);
((BindingProvider) encryptDocClient).getRequestContext().put(BindingProvider.USERNAME_PROPERTY, username);
((BindingProvider) encryptDocClient).getRequestContext().put(BindingProvider.PASSWORD_PROPERTY, password);
Récupérez le document PDF à envoyer au processus MyApplication/EncryptDocument
en créant un objet java.io.FileInputStream
au moyen de son constructeur. Transmettez une valeur de chaîne qui spécifie l’emplacement du document PDF.
Créez un tableau d’octets et renseignez-le avec le contenu de lʼobjet java.io.FileInputStream
.
Créez un objet BLOB
en utilisant son constructeur.
Renseignez lʼobjet BLOB
en appelant sa méthode setBinaryData
et transmettez le tableau d’octets. La méthode setBinaryData
de lʼobjet BLOB
est celle à appeler lors de l’utilisation du codage Base64. Consultez la section « Fournir des objets BLOB dans les demandes de service ».
Appelez le processus MyApplication/EncryptDocument
en appelant la méthode invoke
de lʼobjet MyApplicationEncryptDocument
. Transmettez lʼobjet BLOB
contenant le document PDF. La méthode invoke renvoie un objet BLOB
contenant le document PDF chiffré.
Créez un tableau d’octets contenant le document PDF chiffré en appelant la méthode getBinaryData
de lʼobjet BLOB
.
Enregistrez le document PDF chiffré en tant que fichier PDF. Enregistrez le tableau d’octets dans un fichier.
Voir également
Créer un assemblage client .NET utilisant le codage Base64
Vous pouvez appeler les services AEM Forms à l’aide du MTOM standard du service web. Cette norme définit la manière dont les données binaires, telles qu’un document PDF, sont transmises sur Internet ou Intranet. MTOM se distingue par l’utilisation de lʼélément XOP:Include
. Cet élément est défini dans la spécification XOP (XML Binary Optimized Packaging) pour référencer les pièces jointes binaires d’un message SOAP.
La discussion ici porte sur l’utilisation de MTOM pour appeler le processus de courte durée AEM Forms suivant, nommé MyApplication/EncryptDocument
.
Ce processus n’est pas basé sur un processus AEM Forms existant. Pour suivre l’exemple de code, créez un processus désigné par MyApplication/EncryptDocument
à l’aide de Workbench. (Voir Utilisation de Workbench.)
Lorsque ce processus est appelé, il effectue les actions suivantes :
SetValue
. Le paramètre d’entrée pour ce processus est une variable de processus document
désignée par inDoc
.PasswordEncryptPDF
. Le document PDF chiffré avec un mot de passe est retourné dans une variable de processus nommée outDoc
.La prise en charge de MTOM a été ajoutée dans AEM Forms version 9.
Les applications basées sur JAX-WS qui utilisent le protocole de transmission MTOM sont limitées à 25 Mo de données envoyées et reçues. Cette limitation est due à un bogue survenu dans JAX-WS. Si la taille combinée de vos fichiers envoyés et reçus dépasse 25 Mo, utilisez le protocole de transmission SwaRef au lieu de celui MTOM. Sinon, il est possible qu’une OutOfMemory
* exception.*
La discussion ici porte sur l’utilisation de MTOM dans un projet Microsoft .NET pour appeler les services AEM Forms. .NET Framework version 3.5 est utilisé et l’environnement de développement est Visual Studio 2008. Si Web Service Enhancements (WSE) est installé sur votre ordinateur de développement, supprimez-le. .NET Framework 3.5 prend en charge un framework SOAP appelé Windows Communication Foundation (WCF). Lorsque vous appelez AEM Forms à l’aide de MTOM, seul WCF (et non WSE) est pris en charge.
Vous pouvez créer un projet Microsoft .NET qui appelle un service AEM Forms à l’aide de services web. Commencez par créer un projet Microsoft .NET à l’aide de Visual Studio 2008. Pour appeler un service AEM Forms, créez une référence de service pour le service AEM Forms que vous souhaitez appeler dans votre projet. Lorsque vous créez une référence de service, spécifiez une URL vers le service AEM Forms :
http://localhost:8080/soap/services/MyApplication/EncryptDocument?WSDL&lc_version=9.0.1
Remplacez localhost
par l’adresse IP du serveur d’applications J2EE hébergeant AEM Forms. Remplacez MyApplication/EncryptDocument
par le nom du service AEM Forms à appeler. Par exemple, pour appeler une opération Rights Management, spécifiez :
http://localhost:8080/soap/services/RightsManagementService?WSDL&lc_version=9.0.1
L’option lc_version
garantit que les fonctionnalités d’AEM Forms, telles que MTOM, sont disponibles. Si vous ne spécifiez pas l’option lc_version
, vous ne pouvez pas appeler AEM Forms à l’aide de MTOM.
Après avoir créé une référence de service, les types de données associés au service AEM Forms peuvent être utilisés dans votre projet .NET. Pour créer un projet .NET qui appelle un service AEM Forms, procédez comme suit :
Créez un projet .NET à l’aide de Microsoft Visual Studio 2008.
Dans le menu Projet, sélectionnez Ajouter une référence de service.
Dans la boîte de dialogue Adresse, spécifiez le WSDL au service AEM Forms. Par exemple,
http://localhost:8080/soap/services/MyApplication/EncryptDocument?WSDL&lc_version=9.0.1
Cliquez sur Aller, puis sur OK.
Prenons lʼexemple dʼun processus MyApplication/EncryptDocument
qui accepte un document PDF non protégé et renvoie un document PDF chiffré par mot de passe. Pour appeler le processus MyApplication/EncryptDocument
(qui a été créé dans Workbench) à l’aide de MTOM, procédez comme suit :
Créez un projet Microsoft .NET.
Créez un objet MyApplication_EncryptDocumentClient
en utilisant son constructeur par défaut.
Créez un objet MyApplication_EncryptDocumentClient.Endpoint.Address
en utilisant le constructeur System.ServiceModel.EndpointAddress
. Transmettez une valeur string qui spécifie le WSDL au service AEM Forms et le type de codage :
https://hiro-xp:8080/soap/services/MyApplication/EncryptDocument?blob=mtom
Vous n’avez pas besoin d’utiliser l’attribut lc_version
. Cet attribut est utilisé lorsque vous créez une référence de service. Toutefois, veillez à indiquer ?blob=mtom
.
Remplacer hiro-xp
* avec l’adresse IP du serveur d’applications J2EE hébergeant AEM Forms. *
Créez un objet System.ServiceModel.BasicHttpBinding
en obtenant la valeur du membre de données EncryptDocumentClient.Endpoint.Binding
. Convertissez la valeur de retour en BasicHttpBinding
.
Définissez le membre de données MessageEncoding
de l’objet System.ServiceModel.BasicHttpBinding
sur WSMessageEncoding.Mtom
. Cette valeur garantit l’utilisation de MTOM.
Activez l’authentification HTTP de base en effectuant les tâches suivantes :
MyApplication_EncryptDocumentClient.ClientCredentials.UserName.UserName
.MyApplication_EncryptDocumentClient.ClientCredentials.UserName.Password
.HttpClientCredentialType.Basic
au membre de données BasicHttpBindingSecurity.Transport.ClientCredentialType
.BasicHttpSecurityMode.TransportCredentialOnly
au membre de données BasicHttpBindingSecurity.Security.Mode
.L’exemple de code ci-après illustre ces tâches.
//Enable BASIC HTTP authentication
encryptProcess.ClientCredentials.UserName.UserName = "administrator";
encryptProcess.ClientCredentials.UserName.Password = "password";
b.Security.Transport.ClientCredentialType = HttpClientCredentialType.Basic;
b.Security.Mode = BasicHttpSecurityMode.TransportCredentialOnly;
b.MaxReceivedMessageSize = 4000000;
b.MaxBufferSize = 4000000;
b.ReaderQuotas.MaxArrayLength = 4000000;
Créez un objet BLOB
en utilisant son constructeur. L’objet BLOB
sert à stocker un document PDF à transmettre au processus MyApplication/EncryptDocument
.
Créez un objet System.IO.FileStream
en appelant son constructeur. Transmettez une valeur de chaîne qui représente l’emplacement du fichier du document PDF et son mode d’ouverture.
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’objet System.IO.FileStream
.
Renseignez le tableau d’octets avec le flux de données en appelant la méthode Read
de l’objet System.IO.FileStream
. Transmettez le tableau d’octets, la position de départ et la longueur du flux à lire.
Renseignez l’objet BLOB
en attribuant à son membre de données MTOM
le contenu du tableau d’octets.
Appelez le processus MyApplication/EncryptDocument
en appelant la méthode invoke
de l’objet MyApplication_EncryptDocumentClient
. Transmettez l’objet BLOB
contenant le document PDF. Ce processus renvoie un document PDF chiffré dans un objet BLOB
.
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 PDF sécurisé.
Créez un tableau d’octets qui stocke le contenu des données de l’objet BLOB
qui a été renvoyé par la méthode invoke
. Renseignez le tableau d’octets en obtenant la valeur du membre de données MTOM
de l’objet BLOB
.
Créez un objet System.IO.BinaryWriter
en utilisant son constructeur et en transmettant l’objet System.IO.FileStream
.
Ecrivez le contenu du tableau d’octets dans un fichier PDF en appelant la méthode Write
de l’objet System.IO.BinaryWriter
et en transmettant le tableau d’octets.
La plupart des opérations de service AEM Forms sont dotés d’un démarrage rapide MTOM. Vous pouvez afficher ces démarrages rapides dans la section de démarrage rapide correspondante d’un service. Par exemple, pour consulter la section Démarrage rapide Output, voir Démarrages rapides de l’API du service Output.
Voir également
Démarrage rapide : appeler un service à l’aide de MTOM dans un projet .NET
Accéder à plusieurs services à l’aide de services web
Vous pouvez appeler les services AEM Forms à l’aide de SwaRef. Le contenu de l’élément XML wsi:swaRef
est envoyé en tant que pièce jointe dans un corps SOAP qui stocke la référence à la pièce jointe. Lors de l’appel d’un service Forms à l’aide de SwaRef, créez des classes proxy Java à l’aide de l’API Java pour les services Web XML (JAX-WS). (Voir API Java pour les services web XML.)
La discussion ici porte sur l’appel du processus de courte durée Forms suivant nommé MyApplication/EncryptDocument
en utilisant SwaRef.
Ce processus n’est pas basé sur un processus AEM Forms existant. Pour suivre l’exemple de code, créez un processus désigné par MyApplication/EncryptDocument
à l’aide de Workbench. (Voir Utilisation de Workbench.)
Lorsque ce processus est appelé, il effectue les actions suivantes :
SetValue
. Le paramètre d’entrée pour ce processus est une variable de processus document
désignée par inDoc
.PasswordEncryptPDF
. Le document PDF chiffré avec un mot de passe est retourné dans une variable de processus nommée outDoc
.Ajout de la prise en charge de SwaRef dans AEM Forms
La discussion ci-dessous porte sur la façon d’appeler les services Forms à l’aide de SwaRef dans une application cliente Java. L’application Java utilise des classes proxy créées à l’aide de JAX-WS.
Pour appeler le processus MyApplication/EncryptDocument
en utilisant des fichiers proxy Java créés à l’aide de JAX-WS et SwaRef, procédez comme suit :
Créez des classes proxy Java à l’aide de JAX-WS qui utilise le WSDL de service MyApplication/EncryptDocument
. Utilisez le point d’entrée WSDL suivant :
https://hiro-xp:8080/soap/services/MyApplication/EncryptDocument?WSDL&lc_version=9.0.1
Pour plus d’informations, voir Création de classes de proxy Java à l’aide de JAX-WS.
Remplacez hiro-xp
* avec l’adresse IP du serveur d’applications J2EE hébergeant AEM Forms. *
Regroupez les classes proxy Java créées à l’aide de JAX-WS dans un fichier JAR.
Incluez le fichier JAR du proxy Java et les fichiers JAR situés dans le chemin d’accès suivant :
<Install Directory>\Adobe\Adobe_Experience_Manager_forms\sdk\client-libs\thirdparty
dans le chemin de classe de votre projet client Java.
Créez un objet MyApplicationEncryptDocumentService
en utilisant son constructeur.
Créez un objet MyApplicationEncryptDocument
en appelant la méthode getEncryptDocument
de lʼobjet MyApplicationEncryptDocumentService
.
Définissez les valeurs de connexion requises pour appeler AEM Forms en affectant des valeurs aux membres de données suivants :
Affectez le point d’entrée WSDL et le type de codage au champ ENDPOINT_ADDRESS_PROPERTY
de l’objet javax.xml.ws.BindingProvider
. Pour appeler le service MyApplication/EncryptDocument
à l’aide du codage SwaRef, spécifiez la valeur d’URL suivante :
https://hiro-xp:8080/soap/services/MyApplication/EncryptDocument?blob=swaref
Affectez l’utilisateur d’AEM forms au champ USERNAME_PROPERTY
de l’objet javax.xml.ws.BindingProvider
.
Attribuez la valeur du mot de passe correspondant au champ PASSWORD_PROPERTY
de lʼobjet javax.xml.ws.BindingProvider
.
L’exemple de code suivant illustre cette logique d’application :
//Set connection values required to invoke AEM Forms
String url = "https://hiro-xp:8080/soap/services/MyApplication/EncryptDocument?blob=swaref";
String username = "administrator";
String password = "password";
((BindingProvider) encryptDocClient).getRequestContext().put(BindingProvider.ENDPOINT_ADDRESS_PROPERTY, url);
((BindingProvider) encryptDocClient).getRequestContext().put(BindingProvider.USERNAME_PROPERTY, username);
((BindingProvider) encryptDocClient).getRequestContext().put(BindingProvider.PASSWORD_PROPERTY, password);
Récupérez le document PDF à envoyer au processus MyApplication/EncryptDocument
en créant un objet java.io.File
au moyen de son constructeur. Transmettez une valeur de chaîne qui spécifie l’emplacement du document PDF.
Créez un objet javax.activation.DataSource
en utilisant le constructeur FileDataSource
. Transmettez l’objet java.io.File
.
Créez un objet javax.activation.DataHandler
en utilisant son constructeur et en transmettant l’objet javax.activation.DataSource
.
Créez un objet BLOB
en utilisant son constructeur.
Renseignez l’objet BLOB
en appelant sa méthode setSwaRef
et en transmettant l’objet javax.activation.DataHandler
.
Appelez le processus MyApplication/EncryptDocument
en appelant la méthode invoke
de l’objet MyApplicationEncryptDocument
et en transmettant l’objet BLOB
contenant le document PDF. La méthode appelée renvoie un objet BLOB
contenant un document PDF chiffré.
Renseignez un objet javax.activation.DataHandler
en appelant la méthode getSwaRef
de l’objet BLOB
.
Convertissez l’objet javax.activation.DataHandler
en une instance java.io.InputSteam
en appelant la méthode getInputStream
de l’objet javax.activation.DataHandler
.
Écrivez l’instance java.io.InputSteam
à un fichier PDF qui représente le document PDF chiffré.
La plupart des opérations de service AEM Forms sont dotés d’un démarrage rapide de SwaRef. Vous pouvez afficher ces démarrages rapides dans la section de démarrage rapide correspondante d’un service. Par exemple, pour consulter la section Démarrage rapide Output, voir Démarrages rapides de l’API du service Output.
Voir également
Démarrage rapide : appeler un service à l’aide de SwaRef dans un projet Java
Vous pouvez appeler des services AEM Forms à l’aide de services web et en transmettant des données BLOB sur HTTP. La transmission de données BLOB sur HTTP est une technique alternative à l’utilisation de l’encodage Base64, DIME ou MIME. Par exemple, vous pouvez transmettre des données via HTTP dans un projet Microsoft .NET qui utilise Web Service Enhancement 3.0 et qui ne prend pas en charge DIME ou MIME. Lors de l’utilisation de données BLOB sur HTTP, les données d’entrée sont chargées avant l’appel du service AEM Forms.
« Appeler AEM Forms à l’aide de données BLOB sur HTTP » traite de l’appel du processus de courte durée AEM Forms suivant désigné MyApplication/EncryptDocument
en transmettant des données BLOB sur HTTP.
Ce processus n’est pas basé sur un processus AEM Forms existant. Pour suivre l’exemple de code, créez un processus désigné par MyApplication/EncryptDocument
à l’aide de Workbench. (Voir Utilisation de Workbench.)
Lorsque ce processus est appelé, il effectue les actions suivantes :
SetValue
. Le paramètre d’entrée pour ce processus est une variable de processus document
désignée par inDoc
.PasswordEncryptPDF
. Le document PDF chiffré avec un mot de passe est retourné dans une variable de processus nommée outDoc
.Il est recommandé de vous familiariser avec l’appel d’AEM Forms à l’aide de SOAP. (Consultez la section Appeler AEM Forms à l’aide de services web).
Pour créer un assemblage client qui utilise des données via HTTP, suivez la procédure indiqué dans la section Appeler AEM Forms à l’aide du codage Base64. Toutefois, modifiez l’URL dans la classe proxy pour inclure ?blob=http
au lieu de ?blob=base64
. Cette action garantit que les données sont transmises via HTTP. Dans la classe proxy, recherchez la ligne de code suivante :
"http://localhost:8080/soap/services/MyApplication/EncryptDocument";
Localisez la chaîne et attribuez-lui la valeur:
"http://localhost:8080/soap/services/MyApplication/EncryptDocument?blob=http";
Référencer l’assemblage .NET clienMyApplication/EncryptDocument
Placez votre nouvel assemblage client .NET sur l’ordinateur où vous développez votre application cliente. Après avoir placé l’assemblage client .NET dans un répertoire, vous pouvez le référencer à partir d’un projet. Référencez la bibliothèque System.Web.Services
à partir de votre projet. Si vous ne référencez pas cette bibliothèque, vous ne pouvez pas utiliser l’assemblage client .NET pour appeler un service.
Appeler un service à l’aide d’un assemblage client .NET qui utilise des données BLOB via HTTP
Vous pouvez appeler le service MyApplication/EncryptDocument
(qui a été créé dans Workbench) à l’aide d’un assemblage client .NET qui utilise des données via HTTP. Pour appeler le service MyApplication/EncryptDocument
, procédez comme suit :
System.Web.Services
.MyApplication_EncryptDocumentService
en appelant son constructeur par défaut.Credentials
de lʼobjet MyApplication_EncryptDocumentService
avec un objet System.Net.NetworkCredential
. Dans le constructeur System.Net.NetworkCredential
, indiquez un nom d’utilisateur AEM Forms et son mot de passe. Définissez les valeurs d’authentification pour permettre à votre application client .NET d’échanger des messages SOAP avec AEM Forms.BLOB
en utilisant son constructeur. L’objet BLOB
est utilisé pour transmettre des données au processus MyApplication/EncryptDocument
.remoteURL
de l’objet BLOB
qui spécifie l’emplacement URI d’un document PDF à transmettre au service MyApplication/EncryptDocument
.MyApplication/EncryptDocument
en appelant la méthode invoke
de l’objet MyApplication_EncryptDocumentService
et en transmettant l’objet BLOB
. Ce processus renvoie un document PDF chiffré dans un objet BLOB
.System.UriBuilder
en utilisant son constructeur et en transmettant la valeur du membre de données remoteURL
de l’objet BLOB
.System.UriBuilder
en un objet System.IO.Stream
. (Le démarrage rapide C# qui suit cette liste illustre la manière d’effectuer cette tâche.)System.IO.Stream
.System.IO.BinaryWriter
en utilisant son constructeur et en transmettant l’objet System.IO.FileStream
.Write
de l’objet System.IO.BinaryWriter
et en transmettant le tableau d’octets.Vous pouvez appeler un service AEM Forms à l’aide de classes proxy Java et de données BLOB via HTTP. Pour appeler le service MyApplication/EncryptDocument
à l’aide des classes proxy Java, procédez comme suit :
Créez des classes proxy Java à lʼaide de JAX-WS qui utilise le WSDL du service MyApplication/EncryptDocument
. Utilisez le point d’entrée WSDL suivant :
https://hiro-xp:8080/soap/services/MyApplication/EncryptDocument?WSDL&lc_version=9.0.1
Pour plus d’informations, voir Création de classes de proxy Java à l’aide de JAX-WS.
Remplacez hiro-xp
* avec l’adresse IP du serveur d’applications J2EE hébergeant AEM Forms. *
Regroupez les classes proxy Java créées à l’aide de JAX-WS dans un fichier JAR.
Incluez le fichier JAR du proxy Java et les fichiers JAR situés dans le chemin d’accès suivant :
<Install Directory>\Adobe\Adobe_Experience_Manager_forms\sdk\client-libs\thirdparty
dans le chemin de classe de votre projet client Java.
Créez un objet MyApplicationEncryptDocumentService
en utilisant son constructeur.
Créez un objet MyApplicationEncryptDocument
en appelant la méthode getEncryptDocument
de lʼobjet MyApplicationEncryptDocumentService
.
Définissez les valeurs de connexion requises pour appeler AEM Forms en affectant des valeurs aux membres de données suivants :
Affectez le point d’entrée WSDL et le type de codage au champ ENDPOINT_ADDRESS_PROPERTY
de l’objet javax.xml.ws.BindingProvider
. Pour appeler le service MyApplication/EncryptDocument
à l’aide de l’encodage BLOB sur HTTP, spécifiez la valeur d’URL suivante :
https://hiro-xp:8080/soap/services/MyApplication/EncryptDocument?blob=http
Affectez l’utilisateur d’AEM forms au champ USERNAME_PROPERTY
de l’objet javax.xml.ws.BindingProvider
.
Attribuez la valeur du mot de passe correspondant au champ PASSWORD_PROPERTY
de lʼobjet javax.xml.ws.BindingProvider
.
L’exemple de code suivant illustre cette logique d’application :
//Set connection values required to invoke AEM Forms
String url = "https://hiro-xp:8080/soap/services/MyApplication/EncryptDocument?blob=http";
String username = "administrator";
String password = "password";
((BindingProvider) encryptDocClient).getRequestContext().put(BindingProvider.ENDPOINT_ADDRESS_PROPERTY, url);
((BindingProvider) encryptDocClient).getRequestContext().put(BindingProvider.USERNAME_PROPERTY, username);
((BindingProvider) encryptDocClient).getRequestContext().put(BindingProvider.PASSWORD_PROPERTY, password);
Créez un objet BLOB
en utilisant son constructeur.
Renseignez l’objet BLOB
en appelant sa méthode setRemoteURL
. Transmettez une valeur de chaîne qui spécifie l’emplacement d’URI d’un document PDF à transmettre au service MyApplication/EncryptDocument
.
Appelez le processus MyApplication/EncryptDocument
en appelant la méthode invoke
de l’objet MyApplicationEncryptDocument
et en transmettant l’objet BLOB
contenant le document PDF. Ce processus renvoie un document PDF chiffré dans un objet BLOB
.
Créez un tableau d’octets pour stocker le flux de données qui représente le document PDF chiffré. Appelez la méthode getRemoteURL
de l’objet BLOB
(utilisez l’objet BLOB
renvoyé par la méthode invoke
).
Créez un objet java.io.File
en utilisant son constructeur. Cet objet représente le document PDF chiffré.
Créez un objet java.io.FileOutputStream
en utilisant son constructeur et en transmettant l’objet java.io.File
.
Appelez la méthode write
de l’objet java.io.FileOutputStream
. Transmettez le tableau d’octets contenant le flux de données qui représente le document PDF chiffré.
Vous pouvez appeler des services AEM Forms à l’aide de SOAP avec des pièces jointes. AEM Forms prend en charge les normes de service web MIME et DIME. DIME vous permet d’envoyer des pièces jointes binaires, telles que des documents PDF, ainsi que des demandes d’appel au lieu de coder la pièce jointe. La section Appeler AEM Forms à l’aide de DIME aborde l’appel du processus de courte durée AEM Forms suivant désigné par MyApplication/EncryptDocument
à l’aide de DIME.
Lorsque ce processus est appelé, il effectue les actions suivantes :
SetValue
. Le paramètre d’entrée pour ce processus est une variable de processus document
désignée par inDoc
.PasswordEncryptPDF
. Le document PDF chiffré avec un mot de passe est retourné dans une variable de processus nommée outDoc
.Ce processus n’est pas basé sur un processus AEM Forms existant. Pour suivre les exemples de code, créez un processus nommé MyApplication/EncryptDocument
**à l’aide de Workbench. (Voir Utilisation de Workbench.)
L’appel des opérations de service AEM Forms à l’aide de DIME est obsolète. Nous vous recommandons d’utiliser MTOM. (Voir Appeler AEM Forms à l’aide de MTOM.)
Pour créer un projet .NET pouvant appeler un service Forms à l’aide de DIME, procédez comme suit :
Installer Web Services Enhancements 2.0
Installez Web Services Enhancements 2.0 sur votre ordinateur de développement et intégrez-le à Microsoft Visual Studio .NET. Vous pouvez télécharger Web Services Enhancements 2.0 à partir du Centre de téléchargement Microsoft.
Sur cette page web, recherchez Web Services Enhancements 2.0 et téléchargez-le sur votre ordinateur de développement. Ce téléchargement place un fichier désigné par Microsoft WSE 2.0 SPI.msi sur votre ordinateur. Exécutez le programme d’installation et suivez les instructions en ligne.
Web Services Enhancements 2.0 prend en charge DIME. La version prise en charge de Microsoft Visual Studio est celle de 2003 lors de l’utilisation de Web Services Enhancements 2.0. Web Services Enhancements 3.0 ne prend pas en charge DIME ; cependant, il prend en charge MTOM.
Créer une référence web à un service AEM Forms
Après avoir installé Web Services Enhancements 2.0 sur votre ordinateur de développement et créé un projet Microsoft .NET, créez une référence web au service Forms. Par exemple, pour créer une référence web au processus MyApplication/EncryptDocument
et en supposant que Forms soit installé sur l’ordinateur local, indiquez l’URL suivante :
http://localhost:8080/soap/services/MyApplication/EncryptDocument?WSDL
Après avoir créé une référence web, vous pouvez utiliser les deux types de données proxy suivants dans votre projet .NET : EncryptDocumentService
et EncryptDocumentServiceWse
. Pour appeler le processus MyApplication/EncryptDocument
à l’aide de DIME, utilisez le type EncryptDocumentServiceWse
.
Avant de créer une référence web au service Forms, veillez à référencer Web Services Enhancements 2.0 dans votre projet. (Voir « Installer Web Services Enhancements 2.0 ».)
Référencer la bibliothèque WSE
Créer une référence web à un service Forms
Assurez-vous d’avoir activé votre projet .NET pour utiliser la bibliothèque WSE. Dans Explorateur de projets, faites un clic droit sur le nom du projet et sélectionnez Activer WSE 2.0. et assurez-vous que la case à cocher de la boîte de dialogue qui s’affiche est cochée.
Appeler un service à l’aide de DIME dans un projet .NET
Vous pouvez appeler un service Forms à l’aide de DIME. Prenez en compte le processus MyApplication/EncryptDocument
qui accepte un document PDF non sécurisé et renvoie un document PDF chiffré par mot de passe. Pour appeler le processus MyApplication/EncryptDocument
à l’aide de DIME, procédez comme suit :
Créez un projet Microsoft .NET qui vous permet d’appeler un service Forms à l’aide de DIME. Veillez à inclure Web Services Enhancements 2.0 et à créer une référence web au service AEM Forms.
Après avoir défini une référence web au processus MyApplication/EncryptDocument
, créez un objet EncryptDocumentServiceWse
en utilisant son constructeur par défaut.
Définissez le membre de données Credentials
de l’objet EncryptDocumentServiceWse
avec une valeur System.Net.NetworkCredential
qui indique le nom d’utilisateur et le mot de passe AEM forms.
Créez un objet Microsoft.Web.Services2.Dime.DimeAttachment
en utilisant son constructeur et en transmettant les valeurs suivantes :
System.Guid.NewGuid.ToString
.application/pdf
.TypeFormat
. Spécifiez TypeFormat.MediaType
.Créez un objet BLOB
en utilisant son constructeur.
Ajoutez la pièce jointe DIME à l’objet BLOB
en attribuant valeur du membre de données Id
de l’objet Microsoft.Web.Services2.Dime.DimeAttachment
au membre de données attachmentID
de l’objet BLOB
.
Appelez la méthode EncryptDocumentServiceWse.RequestSoapContext.Attachments.Add
et transmettez l’objet Microsoft.Web.Services2.Dime.DimeAttachment
.
Appelez le processus MyApplication/EncryptDocument
en appelant la méthode invoke
de l’objet EncryptDocumentServiceWse
et en transmettant l’objet BLOB
contenant la pièce jointe DIME. Ce processus renvoie un document PDF chiffré dans un objet BLOB
.
Obtenez la valeur de l’identificateur de pièce jointe en obtenant la valeur du membre de données attachmentID
de l’objet BLOB
renvoyé.
Effectuez une itération sur les pièces jointes situées dans EncryptDocumentServiceWse.ResponseSoapContext.Attachments
et utilisez la valeur de l’identificateur de pièce jointe pour obtenir le document PDF chiffré.
Obtenez un objet System.IO.Stream
en obtenant la valeur du membre de données Stream
de l’objet Attachment
.
Créez un tableau d’octets et transmettez-le à la méthode Read
de l’objet System.IO.Stream
. Cette méthode renseigne le tableau d’octets avec un flux de données représentant le document PDF chiffré.
Créez un objet System.IO.FileStream
en appelant son constructeur et en transmettant une valeur de chaîne qui représente un emplacement du fichier PDF. Cet objet représente le document PDF chiffré.
Créez un objet System.IO.BinaryWriter
en utilisant son constructeur et en transmettant l’objet System.IO.FileStream
.
Écrivez le contenu du tableau d’octets dans le fichier PDF en appelant la méthode Write
de l’objet System.IO.BinaryWriter
et en transmettant le tableau d’octets.
Vous pouvez utiliser l’outil Apache Axis WSDL2Java pour convertir un WSDL de service en classes proxy Java afin d’appeler des opérations de service. Avec Apache Ant, vous pouvez générer des fichiers de bibliothèque Axis à partir d’un WSDL de service AEM Forms qui vous permet d’appeler le service. (Voir Créer des classes proxy Java à l’aide d’Apache Axis.)
L’outil Apache Axis WSDL2Java génère des fichiers JAVA contenant des méthodes utilisées pour envoyer des requêtes SOAP à un service. Les requêtes SOAP reçues par un service sont décodées par les bibliothèques générées par Axis et transformées en méthodes et arguments.
Pour appeler le service MyApplication/EncryptDocument
(créé dans Workbench) à l’aide de fichiers de bibliothèque générés par Axis et de DIME, procédez comme suit :
Créez des classes proxy Java qui utilisent le WSDL de service MyApplication/EncryptDocument
à l’aide d’Apache Axis. (Voir Créer des classes proxy Java à l’aide d’Apache Axis.)
Incluez les classes proxy Java dans le chemin d’accès de classe.
Créez un objet MyApplicationEncryptDocumentServiceLocator
en utilisant son constructeur.
Créez un objet URL
en utilisant son constructeur et en transmettant une valeur de chaîne qui spécifie la définition de WSDL de service AEM Forms. Assurez-vous de spécifier ?blob=dime
à la fin de l’URL du point d’entrée SOAP. Utilisez par exemple
https://hiro-xp:8080/soap/services/MyApplication/EncryptDocument?blob=dime.
Créez un objet EncryptDocumentSoapBindingStub
en appelant son constructeur et en transmettant les objets MyApplicationEncryptDocumentServiceLocator
et URL
.
Définissez la valeur du nom d’utilisateur et du mot de passe AEM Forms en appelant les méthodes setUsername
et setPassword
de l’objet EncryptDocumentSoapBindingStub
.
encryptionClientStub.setUsername("administrator");
encryptionClientStub.setPassword("password");
Récupérez le document PDF à envoyer au service MyApplication/EncryptDocument
en créant un objet java.io.File
. Transmettez une valeur de chaîne qui indique l’emplacement du document PDF.
Créez un objet javax.activation.DataHandler
en utilisant son constructeur et en transmettant un objet javax.activation.FileDataSource
. L’objet javax.activation.FileDataSource
peut être créé en utilisant son constructeur et en transmettant l’objet java.io.File
qui représente le document PDF.
Créez un objet org.apache.axis.attachments.AttachmentPart
en utilisant son constructeur et en transmettant l’objet javax.activation.DataHandler
.
Ajoutez la pièce jointe en appelant la méthode addAttachment
de l’objet EncryptDocumentSoapBindingStub
et en transmettant l’objet org.apache.axis.attachments.AttachmentPart
.
Créez un objet BLOB
en utilisant son constructeur. Renseignez l’objet BLOB
avec la valeur de l’identificateur de la pièce jointe en appelant la méthode setAttachmentID
de l’objet BLOB
et en transmettant la valeur de l’identificateur de la pièce jointe. Cette valeur peut être obtenue en appelant la méthode getContentId
de l’objet org.apache.axis.attachments.AttachmentPart
.
Appelez le processus MyApplication/EncryptDocument
en appelant la méthode invoke
de lʼobjet EncryptDocumentSoapBindingStub
. Transmettez lʼobjet BLOB
contenant la pièce jointe DIME. Ce processus renvoie un document PDF chiffré dans un objet BLOB
.
Obtenez la valeur de l’identifiant de la pièce jointe en appelant la méthode getAttachmentID
de lʼobjet BLOB
. Cette méthode renvoie une valeur string qui représente la valeur de l’identifiant de la pièce jointe renvoyée.
Récupérez les pièces jointes en appelant la méthode getAttachments
de lʼobjet EncryptDocumentSoapBindingStub
. Cette méthode renvoie un tableau dʼObjects
qui représente les pièces jointes.
Effectuez une itération au sein des pièces jointes (le tableau Object
) et utilisez la valeur de l’identifiant de la pièce jointe pour obtenir le document PDF chiffré. Chaque élément est un objet org.apache.axis.attachments.AttachmentPart
.
Obtenez lʼobjet javax.activation.DataHandler
associé à la pièce jointe en appelant la méthode getDataHandler
de lʼobjet org.apache.axis.attachments.AttachmentPart
.
Obtenez un objet java.io.FileStream
en appelant la méthode getInputStream
de lʼobjet javax.activation.DataHandler
.
Créez un tableau d’octets et transmettez-le à la méthode read
de lʼobjet java.io.FileStream
. Cette méthode renseigne le tableau d’octets avec un flux de données qui représente le document PDF chiffré.
Créez un objet java.io.File
en utilisant son constructeur. Cet objet représente le document PDF chiffré.
Créez un objet java.io.FileOutputStream
en utilisant son constructeur et en transmettant l’objet java.io.File
.
Appelez la méthode write
de lʼobjet java.io.FileOutputStream
et transmettez le tableau dʼoctets qui contient le flux de données représentant le document PDF chiffré.
Voir également
Didacticiel de mise en route : appeler un service à l’aide de DIME dans un projet Java
AEM Forms prend en charge différents modes d’authentification des services web lors de l’appel des services. Un mode d’authentification consiste à spécifier à la fois un nom d’utilisateur et un mot de passe à l’aide d’un en-tête d’autorisation de base dans l’appel du service web. AEM Forms prend également en charge l’authentification basée sur l’assertion SAML. Lorsqu’une application client appelle un service AEM Forms à l’aide d’un service web, l’application client peut fournir des informations d’authentification de l’une des manières suivantes :
AEM Forms ne prend pas en charge l’authentification avec certificat standard, mais il prend en charge l’authentification avec certificat sous une forme différente.
Les didacticiels de mise en route du service web dans la section « Programmation avec AEM Forms » spécifient les valeurs de nom d’utilisateur et de mot de passe pour effectuer l’autorisation.
L’identité des utilisateurs AEM Forms peut être représentée par une assertion SAML signée à l’aide d’une clé secrète. Le code XML suivant illustre un exemple d’assertion SAML.
<Assertion xmlns="urn:oasis:names:tc:SAML:1.0:assertion"
xmlns:saml="urn:oasis:names:tc:SAML:1.0:assertion"
xmlns:samlp="urn:oasis:names:tc:SAML:1.0:protocol"
AssertionID="fd4bd0c87302780e0d9bbfa8726d5bc0" IssueInstant="2008-04-17T13:47:00.720Z" Issuer="LiveCycle"
MajorVersion="1" MinorVersion="1">
<Conditions NotBefore="2008-04-17T13:47:00.720Z" NotOnOrAfter="2008-04-17T15:47:00.720Z">
</Conditions>
<AuthenticationStatement
AuthenticationInstant="2008-04-17T13:47:00.720Z"
AuthenticationMethod="urn:oasis:names:tc:SAML:1.0:am:unspecified">
<Subject>
<NameIdentifier NameQualifier="DefaultDom">administrator</NameIdentifier>
<SubjectConfirmation>
<ConfirmationMethod>urn:oasis:names:tc:SAML:1.0:cm:sender-vouches</ConfirmationMethod>
</SubjectConfirmation>
</Subject>
</AuthenticationStatement>
<ds:Signature >
<ds:SignedInfo>
<ds:CanonicalizationMethod Algorithm="https://www.w3.org/2001/10/xml-exc-c14n#"></ds:CanonicalizationMethod>
<ds:SignatureMethod Algorithm="https://www.w3.org/2000/09/xmldsig#hmac-sha1"></ds:SignatureMethod>
<ds:Reference URI="#fd4bd0c87302780e0d9bbfa8726d5bc0">
<ds:Transforms>
<ds:Transform Algorithm="https://www.w3.org/2000/09/xmldsig#enveloped-signature"></ds:Transform>
<ds:Transform Algorithm="https://www.w3.org/2001/10/xml-exc-c14n#">
<ec:InclusiveNamespaces
PrefixList="code ds kind rw saml samlp typens #default">
</ec:InclusiveNamespaces>
</ds:Transform>
</ds:Transforms>
<ds:DigestMethod Algorithm="https://www.w3.org/2000/09/xmldsig#sha1"></ds:DigestMethod>
<ds:DigestValue>hVrtqjWr+VzaVUIpQx0YI9lIjaY=</ds:DigestValue>
</ds:Reference>
</ds:SignedInfo>
<ds:SignatureValue>UMbBb+cUcPtcWDCIhXes4n4FxfU=</ds:SignatureValue>
</ds:Signature>
</Assertion>
Cet exemple d’assertion se rapporte à un utilisateur administrateur. Cette assertion se caractérise par les éléments suivants :
Une application client peut récupérer l’assertion à partir de toute API AEM Forms AuthenticationManager qui renvoie un objet AuthResult
. Vous pouvez obtenir une instance AuthResult
à lʼaide de l’une des deux méthodes suivantes :
AuthenticationManager.getAuthResultOnBehalfOfUser
. Cette méthode permet à une application client d’obtenir un objet AuthResult
pour tout utilisateur AEM Forms.Un utilisateur AEM Forms peut être authentifié à l’aide d’un jeton SAML obtenu. Cette assertion SAML (fragment xml) peut être envoyée comme partie de l’en-tête WS-Security avec l’appel du service web pour l’authentification de l’utilisateur. En règle générale, une application client authentifie un utilisateur, mais ne stocke pas ses informations d’identification. (Ou l’utilisateur se connecte à ce client via une méthode autre quʼun nom d’utilisateur et un mot de passe.) Dans ce cas, l’application client doit appeler AEM Forms et emprunter l’identité d’un utilisateur spécifique autorisé à appeler AEM Forms.
Pour emprunter l’identité d’un utilisateur spécifique, appelez la méthode AuthenticationManager.getAuthResultOnBehalfOfUser
à l’aide d’un service web. Cette méthode renvoie une instance AuthResult
qui contient l’assertion SAML de cet utilisateur.
Ensuite, utilisez cette assertion SAML pour appeler tout service nécessitant une authentification. Cette action implique l’envoi de l’assertion comme partie de l’en-tête SOAP. Lorsqu’un appel de service web est effectué avec cette assertion, AEM Forms identifie l’utilisateur comme étant celui représenté par cette assertion. Pour AEM Forms, l’utilisateur spécifié dans l’assertion est l’utilisateur qui appelle le service.
Vous pouvez appeler un service AEM Forms par des classes proxy Java créées à l’aide de la bibliothèque Axis. (Consultez la section Créer des classes proxy Java à l’aide dʼApache Axis).
Lors de l’utilisation d’AXIS recourant à l’authentification SAML, enregistrez le gestionnaire de requête et de réponse avec Axis. Apache Axis appelle le gestionnaire avant d’envoyer une demande d’appel à AEM Forms. Pour enregistrer un gestionnaire, créez une classe Java qui étend org.apache.axis.handlers.BasicHandler
.
Créer une classe AssertionHandler avec Axis
La classe Java suivante, nommée AssertionHandler.java
, illustre un exemple de classe Java qui étend org.apache.axis.handlers.BasicHandler
.
public class AssertionHandler extends BasicHandler {
public void invoke(MessageContext ctx) throws AxisFault {
String assertion = (String) ctx.getProperty(LC_ASSERTION);
//no assertion hence nothing to insert
if(assertion == null) return;
try {
MessageElement samlElement = new MessageElement(convertToXML(assertion));
SOAPHeader header = (SOAPHeader) ctx.getRequestMessage().getSOAPHeader();
//Create the wsse:Security element which would contain the SAML element
SOAPElement wsseHeader = header.addChildElement("Security", "wsse", WSSE_NS);
wsseHeader.appendChild(samlElement);
//remove the actor attribute as in LC we do not specify any actor. This would not remove the actor attribute though
//it would only remove it from the soapenv namespace
wsseHeader.getAttributes().removeNamedItem("actor");
} catch (SOAPException e) {
throw new AxisFault("Error occured while adding the assertion to the SOAP Header",e);
}
}
}
Enregistrer le gestionnaire
Pour enregistrer un gestionnaire avec Axis, créez un fichier « client-config.wsdd ». Par défaut, Axis recherche un fichier portant ce nom. Le code XML suivant est un exemple de fichier client-config.wsdd. Pour plus d’informations, consultez la documentation dʼAxis.
<deployment xmlns="https://xml.apache.org/axis/wsdd/" xmlns:java="https://xml.apache.org/axis/wsdd/providers/java">
<transport name="http" pivot="java:org.apache.axis.transport.http.HTTPSender"/>
<globalConfiguration >
<requestFlow >
<handler type="java:com.adobe.idp.um.example.AssertionHandler" />
</requestFlow >
</globalConfiguration >
</deployment>
Appeler un service AEM Forms
L’exemple de code suivant appelle un service AEM Forms à l’aide de l’authentification SAML.
public class ImpersonationExample {
. . .
public void authenticateOnBehalf(String superUsername,String password,
String canonicalName,String domainName) throws UMException, RemoteException{
((org.apache.axis.client.Stub) authenticationManager).setUsername(superUsername);
((org.apache.axis.client.Stub) authenticationManager).setPassword(password);
//Step 1 - Invoke the Auth manager api to get an assertion for the user to be impersonated
AuthResult ar = authenticationManager.getAuthResultOnBehalfOfUser(canonicalName, domainName, null);
String assertion = ar.getAssertion();
//Step 2 - Setting the assertion here to be picked later by the AssertionHandler. Note that stubs are not threadSafe
//hence should not be reused. For this simple example we have made them instance variable but care should be taken
//regarding the thread safety
((javax.xml.rpc.Stub) authorizationManager)._setProperty(AssertionHandler.LC_ASSERTION, assertion);
}
public Role findRole(String roleId) throws UMException, RemoteException{
//This api would be invoked under bob's user rights
return authorizationManager.findRole(roleId);
}
public static void main(String[] args) throws Exception {
ImpersonationExample ie = new ImpersonationExample("http://localhost:5555");
//Get the SAML assertion for the user to impersonate and store it in stub
ie.authenticateOnBehalf(
"administrator", //The Super user which has the required impersonation permission
"password", // Password of the super user as referred above
"bob", //Cannonical name of the user to impersonate
"testdomain" //Domain of the user to impersonate
);
Role r = ie.findRole("BASIC_ROLE_ADMINISTRATOR");
System.out.println("Role "+r.getName());
}
}
Vous pouvez appeler un service Forms à l’aide d’un assemblage client .NET et de lʼauthentification SAML. Pour ce faire, vous devez utiliser Web Service Enhancements 3.0 (WSE). Pour plus d’informations sur la création d’un assemblage client .NET qui utilise WSE, consultez la section Créer un projet .NET utilisant DIME.
La section DIME utilise WSE 2.0. Pour utiliser l’authentification SAML, suivez les instructions similaires décrites dans la section DIME. Veillez cependant à remplacer WSE 2.0 par WSE 3.0 et à lʼinstaller sur votre ordinateur de développement, puis à lʼintégrer à Microsoft Visual Studio .NET. Téléchargez Web Services Enhancements 3.0 depuis le Centre de téléchargement Microsoft.
L’architecture WSE utilise les types de données Policies, Assertions et SecurityToken. En résumé, pour un appel de service web, spécifiez une stratégie. Cette dernière peut avoir plusieurs assertions. Chaque assertion peut contenir des filtres. Un filtre est appelé à certaines étapes d’un appel de service web et, à ce moment-là, il peut modifier la requête SOAP. Pour plus d’informations, consultez la documentation de WSE 3.0.
Créer lʼassertion et le filtre
L’exemple de code C# suivant crée des classes de filtre et d’assertions. Cet exemple de code crée un filtre SamlAssertionOutputFilter. Ce filtre est appelé par le framework WSE avant l’envoi de la requête SOAP à AEM Forms.
class LCSamlPolicyAssertion : Microsoft.Web.ServicES4.Design.PolicyAssertion
{
public override Microsoft.Web.ServicES4.SoapFilter CreateClientOutputFilter(FilterCreationContext context)
{
return new SamlAssertionOutputFilter();
}
. . .
}
class SamlAssertionOutputFilter : SendSecurityFilter
{
public override void SecureMessage(SoapEnvelope envelope, Security security)
{
// Get the SamlToken from the SessionState
SamlToken samlToken = envelope.Context.Credentials.UltimateReceiver.GetClientToken<SamlToken>();
security.Tokens.Add(samlToken);
}
}
Créer le jeton SAML
Créez une classe pour représenter l’assertion SAML. La tâche principale de cette classe consiste à convertir les valeurs de données de la chaîne de caractères au format xml et de préserver les espaces. Ce fichier XML d’assertion est ensuite importé dans la requête SOAP.
class SamlToken : SecurityToken
{
public const string SAMLAssertion = "https://docs.oasis-open.org/wss/oasis-wss-saml-token-profile-1.1#SAMLV1.1";
private XmlElement _assertionElement;
public SamlToken(string assertion)
: base(SAMLAssertion)
{
XmlDocument xmlDoc = new XmlDocument();
//The white space has to be preserved else the digital signature would get broken
xmlDoc.PreserveWhitespace = true;
xmlDoc.LoadXml(assertion);
_assertionElement = xmlDoc.DocumentElement;
}
public override XmlElement GetXml(XmlDocument document)
{
return (XmlElement)document.ImportNode(_assertionElement, true);
}
. . .
}
Appeler un service AEM Forms
L’exemple de code C# suivant appelle un service Forms à l’aide de l’authentification SAML.
public class ImpersonationExample
{
. . .
public void AuthenticateOnBehalf(string superUsername, string password, string canonicalName, string domainName)
{
//Create a policy for UsernamePassword Token
Policy usernamePasswordPolicy = new Policy();
usernamePasswordPolicy.Assertions.Add(new UsernameOverTransportAssertion());
UsernameToken token = new UsernameToken(superUsername, password, PasswordOption.SendPlainText);
authenticationManager.SetClientCredential(token);
authenticationManager.SetPolicy(usernamePasswordPolicy);
//Get the SAML assertion for impersonated user
AuthClient.AuthenticationManagerService.AuthResult ar
= authenticationManager.getAuthResultOnBehalfOfUser(canonicalName, domainName, null);
System.Console.WriteLine("Received assertion " + ar.assertion);
//Create a policy for inserting SAML assertion
Policy samlPolicy = new Policy();
samlPolicy.Assertions.Add(new LCSamlPolicyAssertion());
authorizationManager.SetPolicy(samlPolicy);
//Set the SAML assertion obtained previously as the token
authorizationManager.SetClientCredential(new SamlToken(ar.assertion));
}
public Role findRole(string roleId)
{
return authorizationManager.findRole(roleId);
}
static void Main(string[] args)
{
ImpersonationExample ie = new ImpersonationExample("http://localhost:5555");
ie.AuthenticateOnBehalf(
"administrator", //The Super user which has the required impersonation permission
"password", // Password of the super user as referred above
"bob", //Cannonical name of the user to impersonate
"testdomain" //Domain of the user to impersonate
);
Role r = ie.findRole("BASIC_ROLE_ADMINISTRATOR");
System.Console.WriteLine("Role "+r.name);
}
}
Parfois, des problèmes surviennent lors de l’appel de certaines opérations de services AEM Forms à l’aide de services web. Cette discussion tente dʼidentifier ces problèmes et de fournir une solution, le cas échéant.
Si vous tentez d’appeler de manière asynchrone une opération de service AEM Forms, telle que l’opération htmlToPDF
de Generate PDF, une exception SoapFaultException
survient. Pour résoudre ce problème, créez un fichier XML de liaison personnalisée qui mappe lʼélément ExportPDF_Result
et d’autres éléments dans différentes classes. Le code XML suivant représente un fichier de liaison personnalisée.
<bindings
xmlns:xsd="https://www.w3.org/2001/XMLSchema"
xmlns:jxb="https://java.sun.com/xml/ns/jaxb" jxb:version="1.0"
xmlns:wsdl="https://schemas.xmlsoap.org/wsdl/"
wsdlLocation="http://localhost:8080/soap/services/GeneratePDFService?wsdl&async=true&lc_version=9.0.0"
xmlns="https://java.sun.com/xml/ns/jaxws">
<enableAsyncMapping>false</enableAsyncMapping>
<package name="external_customize.client"/>
<enableWrapperStyle>true</enableWrapperStyle>
<bindings node="/wsdl:definitions/wsdl:types/xsd:schema[@targetNamespace='https://adobe.com/idp/services']/xsd:element[@name='ExportPDF_Result']">
<jxb:class name="ExportPDFAsyncResult">
</jxb:class>
</bindings>
<bindings node="/wsdl:definitions/wsdl:types/xsd:schema[@targetNamespace='https://adobe.com/idp/services']/xsd:element[@name='CreatePDF_Result']">
<jxb:class name="CreatePDFAsyncResult">
</jxb:class>
</bindings>
<bindings node="/wsdl:definitions/wsdl:types/xsd:schema[@targetNamespace='https://adobe.com/idp/services']/xsd:element[@name='HtmlToPDF_Result']">
<jxb:class name="HtmlToPDFAsyncResult">
</jxb:class>
</bindings>
<bindings node="/wsdl:definitions/wsdl:types/xsd:schema[@targetNamespace='https://adobe.com/idp/services']/xsd:element[@name='OptimizePDF_Result']">
<jxb:class name="OptimizePDFAsyncResult">
</jxb:class>
</bindings>
<!--bindings node="//wsdl:portType[@name='GeneratePDFService']/wsdl:operation[@name='HtmlToPDF_Result']">
<jxb:class name="HtmlToPDFAsyncResult"/>
</bindings-->
</bindings>
Utilisez ce fichier XML lors de la création de fichiers proxy Java à l’aide de JAX-WS. (Consultez la section Créer des classes proxy Java à l’aide de JAX-WS).
Référencez ce fichier XML lors de l’exécution de l’outil JAX-WS (wsimport.exe) à l’aide de l’option de ligne de commande - b
. Mettez à jour lʼélément wsdlLocation
dans le fichier XML de liaison pour spécifier l’URL d’AEM Forms.
Pour que l’appel asynchrone fonctionne, modifiez la valeur de l’URL du point de terminaison et spécifiez async=true
. Par exemple, pour les fichiers proxy Java créés avec JAX-WS, spécifiez ce qui suit pour la propriété BindingProvider.ENDPOINT_ADDRESS_PROPERTY
.
https://server:port/soap/services/ServiceName?wsdl&async=true&lc_version=9.0.0
La liste suivante spécifie d’autres services qui ont besoin d’un fichier de liaison personnalisé lorsqu’ils sont appelés de manière asynchrone :
Parfois, une bibliothèque proxy créée à l’aide d’un serveur d’applications J2EE spécifique n’appelle pas correctement AEM Forms hébergé sur un autre serveur d’applications J2EE. Prenons l’exemple d’une bibliothèque proxy générée à l’aide d’AEM Forms déployé sur WebSphere. Cette bibliothèque proxy ne peut pas appeler correctement les services AEM Forms déployés sur le serveur d’applications JBoss.
Certains types de données complexes dʼAEM Forms, tels que PrincipalReference
, sont définis différemment lorsqu’AEM Forms est déployé sur WebSphere au lieu du serveur dʼapplications JBoss. Les différences entre les JDK utilisés par les différents services d’application J2EE sont la raison pour laquelle il existe des différences dans les définitions WSDL. Par conséquent, utilisez des bibliothèques proxy générées à partir du même serveur d’applications J2EE.
En raison de conflits d’espace de noms, les objets de données ne peuvent pas être partagés entre plusieurs WSDL de services. Plusieurs services peuvent partager des types de données et, par conséquent, les services partagent la définition de ces types dans les fichiers WSDL. Par exemple, vous ne pouvez pas ajouter deux assemblages client .NET contenant un type de données BLOB
au même projet client .NET. Si vous tentez de le faire, une erreur de compilation se produit.
La liste suivante spécifie les types de données qui ne peuvent pas être partagés entre plusieurs WSDL de services :
User
Principals
PrincipalReference
Groups
Roles
BLOB
Pour éviter ce problème, il est recommandé que vous soyez complètement admissible pour les types de données. Prenons l’exemple d’une application .NET qui fait référence à la fois au service Forms et au service Signature à l’aide d’une référence de service. Les deux références de service contiennent une classe BLOB
. Pour utiliser une instance BLOB
, vous devez être complètement admissible pour lʼobjet BLOB
lorsque vous le déclarez. Cette approche est illustrée dans l’exemple de code suivant. Pour plus d’informations sur cet exemple de code, consultez la section Signer numériquement un formulaire interactif.
L’exemple de code C# suivant illustre comment signer un formulaire interactif rendu par le service Forms. L’application client contient deux références de service. Lʼinstance BLOB
associée au service Forms appartient à lʼespace de nommage SignInteractiveForm.ServiceReference2
. De même, lʼinstance BLOB
associée au service Signature appartient à lʼespace de nommage SignInteractiveForm.ServiceReference1
. Le formulaire interactif signé est enregistré en tant que fichier PDF, nommé LoanXFASigned.pdf.
???/**
* Ensure that you create a .NET project that uses
* MS Visual Studio 2008 and version 3.5 of the .NET
* framework. This is required to invoke a
* AEM Forms service using MTOM.
*
* For information, see "Invoking AEM Forms using MTOM" in Programming with AEM forms
*/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.ServiceModel;
using System.IO;
//A reference to the Signature service
using SignInteractiveForm.ServiceReference1;
//A reference to the Forms service
using SignInteractiveForm.ServiceReference2;
namespace SignInteractiveForm
{
class Program
{
static void Main(string[] args)
{
try
{
//Because BLOB objects are used in both service references
//it is necessary to fully-qualify the BLOB objects
//Retrieve the form -- invoke the Forms service
SignInteractiveForm.ServiceReference2.BLOB formData = GetForm();
//Create a BLOB object associated with the Signature service
SignInteractiveForm.ServiceReference1.BLOB sigData = new SignInteractiveForm.ServiceReference1.BLOB();
//Transfer the byte stream from one Forms BLOB object to the
//Signature BLOB object
sigData.MTOM = formData.MTOM;
//Sign the Form -- invoke the Signature service
SignForm(sigData);
}
catch (Exception ee)
{
Console.WriteLine(ee.Message);
}
}
//Creates an interactive PDF form based on a XFA form - invoke the Forms service
private static SignInteractiveForm.ServiceReference2.BLOB GetForm()
{
try
{
//Create a FormsServiceClient object
FormsServiceClient formsClient = new FormsServiceClient();
formsClient.Endpoint.Address = new System.ServiceModel.EndpointAddress("https://hiro-xp:8080/soap/services/FormsService?blob=mtom");
//Enable BASIC HTTP authentication
BasicHttpBinding b = (BasicHttpBinding)formsClient.Endpoint.Binding;
b.MessageEncoding = WSMessageEncoding.Mtom;
formsClient.ClientCredentials.UserName.UserName = "administrator";
formsClient.ClientCredentials.UserName.Password = "password";
b.Security.Transport.ClientCredentialType = HttpClientCredentialType.Basic;
b.Security.Mode = BasicHttpSecurityMode.TransportCredentialOnly;
b.MaxReceivedMessageSize = 2000000;
b.MaxBufferSize = 2000000;
b.ReaderQuotas.MaxArrayLength = 2000000;
//Create a BLOB to store form data
SignInteractiveForm.ServiceReference2.BLOB formData = new SignInteractiveForm.ServiceReference2.BLOB();
SignInteractiveForm.ServiceReference2.BLOB pdfForm = new SignInteractiveForm.ServiceReference2.BLOB();
//Specify a XML form data
string path = "C:\\Adobe\Loan.xml";
FileStream fs = new FileStream(path, FileMode.Open);
//Get the length of the file stream
int len = (int)fs.Length;
byte[] ByteArray = new byte[len];
fs.Read(ByteArray, 0, len);
formData.MTOM = ByteArray;
//Specify a XML form data
string path2 = "C:\\Adobe\LoanSigXFA.pdf";
FileStream fs2 = new FileStream(path2, FileMode.Open);
//Get the length of the file stream
int len2 = (int)fs2.Length;
byte[] ByteArray2 = new byte[len2];
fs2.Read(ByteArray2, 0, len2);
pdfForm.MTOM = ByteArray2;
PDFFormRenderSpec renderSpec = new PDFFormRenderSpec();
renderSpec.generateServerAppearance = true;
//Set out parameter values
long pageCount = 1;
String localValue = "en_US";
FormsResult result = new FormsResult();
//Render an interactive PDF form
formsClient.renderPDFForm2(
pdfForm,
formData,
renderSpec,
null,
null,
out pageCount,
out localValue,
out result);
//Write the data stream to the BLOB object
SignInteractiveForm.ServiceReference2.BLOB outForm = result.outputContent;
return outForm;
}
catch (Exception ee)
{
Console.WriteLine(ee.Message);
}
return null;
}
//Sign the form -- invoke the Signature service
private static void SignForm(SignInteractiveForm.ServiceReference1.BLOB inDoc)
{
try
{
//Create a SignatureServiceClient object
SignatureServiceClient signatureClient = new SignatureServiceClient();
signatureClient.Endpoint.Address = new System.ServiceModel.EndpointAddress("https://hiro-xp:8080/soap/services/SignatureService?blob=mtom");
//Enable BASIC HTTP authentication
BasicHttpBinding b = (BasicHttpBinding)signatureClient.Endpoint.Binding;
b.MessageEncoding = WSMessageEncoding.Mtom;
signatureClient.ClientCredentials.UserName.UserName = "administrator";
signatureClient.ClientCredentials.UserName.Password = "password";
b.Security.Transport.ClientCredentialType = HttpClientCredentialType.Basic;
b.Security.Mode = BasicHttpSecurityMode.TransportCredentialOnly;
b.MaxReceivedMessageSize = 2000000;
b.MaxBufferSize = 2000000;
b.ReaderQuotas.MaxArrayLength = 2000000;
//Specify the name of the signature field
string fieldName = "form1[0].grantApplication[0].page1[0].SignatureField1[0]";
//Create a Credential object
Credential myCred = new Credential();
myCred.alias = "secure";
//Specify the reason to sign the document
string reason = "The document was reviewed";
//Specify the location of the signer
string location = "New York HQ";
//Specify contact information
string contactInfo = "Tony Blue";
//Create a PDFSignatureAppearanceOptions object
//and show date information
PDFSignatureAppearanceOptionSpec appear = new PDFSignatureAppearanceOptionSpec();
appear.showDate = true;
//Sign the PDF document
SignInteractiveForm.ServiceReference1.BLOB signedDoc = signatureClient.sign(
inDoc,
fieldName,
myCred,
HashAlgorithm.SHA1,
reason,
location,
contactInfo,
appear,
true,
null,
null,
null);
//Populate a byte array with BLOB data that represents the signed form
byte[] outByteArray = signedDoc.MTOM;
//Save the signed PDF document
string fileName = "C:\\Adobe\LoanXFASigned.pdf";
FileStream fs2 = new FileStream(fileName, FileMode.OpenOrCreate);
//Create a BinaryWriter object
BinaryWriter w = new BinaryWriter(fs2);
w.Write(outByteArray);
w.Close();
fs2.Close();
}
catch (Exception ee)
{
Console.WriteLine(ee.Message);
}
}
}
}
Le nom de certaines classes proxy générées par AEM Forms est incorrect lorsque vous utilisez Microsoft .Net 3.5 et WCF. Ce problème se produit lorsque des classes proxy sont créées pour les services IBMFilenetContentRepositoryConnector, IDPSchedulerService ou tout autre service dont le nom commence par la lettre I. Par exemple, le nom du client généré pour le service IBMFileNetContentRepositoryConnector est BMFileNetContentRepositoryConnectorClient
. La lettre I est manquante dans la classe proxy générée.