Los ejemplos y ejemplos de este documento son solo para AEM Forms en un entorno JEE.
La mayoría de los servicios de AEM Forms del contenedor de servicios están configurados para exponer un servicio web, con compatibilidad total con la generación de lenguaje de definición de servicio web (WSDL). Es decir, puede crear objetos proxy que consuman la pila nativa SOAP de un servicio AEM Forms. Como resultado, los servicios de AEM Forms pueden intercambiar y procesar los siguientes mensajes SOAP:
Con los servicios web, puede realizar las mismas operaciones de servicios de AEM Forms que con la API de Java. Una ventaja de utilizar servicios web para invocar servicios de AEM Forms es que puede crear una aplicación cliente en un entorno de desarrollo que admita SOAP. Una aplicación cliente no está vinculada a un entorno de desarrollo o a un lenguaje de programación específicos. Por ejemplo, puede crear una aplicación cliente utilizando Microsoft Visual Studio .NET y C# como lenguaje de programación.
Los servicios de AEM Forms se exponen a través del protocolo SOAP y son compatibles con WSI Basic Profile 1.1. La interoperabilidad de los servicios web (WSI) es una organización de estándares abiertos que promueve la interoperabilidad de los servicios web en todas las plataformas. Para obtener más información, consulte https://www.ws-i.org/.
AEM Forms es compatible con los siguientes estándares de servicio web:
Para invocar servicios de AEM Forms mediante un servicio web, normalmente se crea una biblioteca proxy que consume el servicio WSDL. La sección Invocación de AEM Forms mediante Servicios Web utiliza JAX-WS para crear clases de proxy Java e invocar servicios. (Consulte Creación de clases de proxy Java mediante JAX-WS).
Puede recuperar un WDSL de servicio especificando la siguiente definición de URL (los elementos entre corchetes son opcionales):
https://<your_serverhost>:<your_port>/soap/services/<service_name>?wsdl[&version=<version>][&async=true|false][lc_version=<lc_version>]
donde:
async
especifica el valor true
para habilitar operaciones adicionales para invocación asincrónica ( false
de forma predeterminada).En la tabla siguiente se enumeran las definiciones de WSDL de servicio (suponiendo que AEM Forms se implementa en el host local y el anuncio es 8080).
Servicio |
Definición WSDL |
---|---|
Ensamblador |
|
Atrás y restaurar |
|
formularios con códigos de barras |
|
Convertir PDF |
|
Distiller |
|
DocConverter |
|
Gestión de documentos |
|
Cifrado |
|
Forms |
|
Integración de datos de formulario |
|
Generar PDF |
|
Generar PDF 3D |
|
Salida |
|
Utilidades de PDF |
|
Extensiones de Acrobat Reader DC |
|
Repositorio |
|
Rights Management |
|
Firma |
|
XMP Utilidades |
|
Definiciones de WSDL del proceso de AEM Forms
Debe especificar el nombre de la aplicación y el nombre del proceso en la definición WSDL para acceder a un WSDL que pertenece a un proceso creado en Workbench. Supongamos que el nombre de la aplicación es MyApplication
y el nombre del proceso es EncryptDocument
. En este caso, especifique la siguiente definición WSDL:
http://localhost:8080/soap/services/MyApplication/EncryptDocument?wsdl
Para obtener información sobre el ejemplo del proceso de corta duración MyApplication/EncryptDocument
, consulte Ejemplo de proceso de corta duración.
Una aplicación puede contener carpetas. En este caso, especifique los nombres de carpeta en la definición WSDL:
http://localhost:8080/soap/services/MyApplication/[<folderA>/.../<folderZ>/]EncryptDocument?wsdl
Acceso a la nueva funcionalidad mediante servicios web
Se puede acceder a la nueva funcionalidad del servicio AEM Forms mediante los servicios web. Por ejemplo, en AEM Forms, se introduce la capacidad de codificar archivos adjuntos mediante MTOM. (Consulte Invocación de AEM Forms mediante MTOM).
Para acceder a las nuevas funciones introducidas en AEM Forms, especifique el atributo lc_version
en la definición WSDL. Por ejemplo, para acceder a la nueva funcionalidad de servicio (incluida la compatibilidad con MTOM), especifique la siguiente definición de WSDL:
http://localhost:8080/soap/services/MyApplication/EncryptDocument?wsdl&lc_version=9.0.1
Al configurar el atributo lc_version
, asegúrese de utilizar tres dígitos. Por ejemplo, 9.0.1 es igual a la versión 9.0.
Tipo de datos BLOB del servicio web
Los WSDL del servicio AEM Forms definen muchos tipos de datos. Uno de los tipos de datos más importantes expuestos en un servicio web es un tipo BLOB
. Este tipo de datos se asigna a la clase com.adobe.idp.Document
al trabajar con las API de Java de AEM Forms. (Consulte Pasar datos a servicios de AEM Forms mediante la API de Java).
Un objeto BLOB
envía y recupera datos binarios (por ejemplo, archivos PDF, datos XML, etc.) desde y hacia los servicios de AEM Forms. El tipo BLOB
se define en un WSDL de servicio de la siguiente manera:
<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>
Los campos MTOM
y swaRef
solo son compatibles con AEM Forms. Solo puede utilizar estos campos nuevos si especifica una dirección URL que incluya la propiedad lc_version
.
Suministro de objetos BLOB en solicitudes de servicio
Si una operación de servicio de AEM Forms requiere un tipo BLOB
como valor de entrada, cree una instancia del tipo BLOB
en la lógica de la aplicación. (Muchos de los inicios rápidos del servicio web ubicados en Programación con formularios AEM muestran cómo trabajar con un tipo de datos BLOB).
Asigne valores a los campos que pertenecen a la instancia BLOB
de la siguiente manera:
BLOB.binaryData
campo y establezca el tipo de datos en el formato MIME (por ejemplo application/pdf
) en el BLOB.contentType
campo . (Consulte Invocación de AEM Forms mediante la codificación Base64).BLOB.MTOM
campo . Esta configuración adjunta los datos a la solicitud SOAP mediante el marco Java JAX-WS o la API nativa del marco SOAP. (Consulte Invocación de AEM Forms mediante MTOM).BLOB.swaRef
campo . Esta configuración adjunta los datos a la solicitud SOAP mediante el marco Java JAX-WS. (Consulte Invocación de AEM Forms mediante SwaRef).BLOB.attachmentID
. (Consulte Invocación de AEM Forms mediante la codificación Base64).BLOB.remoteURL
campo . (Consulte Invocación de AEM Forms mediante datos BLOB a través de HTTP).Acceso a datos en objetos BLOB devueltos por servicios
El protocolo de transmisión para los objetos BLOB
devueltos depende de varios factores, que se tienen en cuenta en el siguiente orden y se detienen cuando se cumple la condición principal:
La dirección URL de destino especifica el protocolo de transmisión. Si la dirección URL de destino especificada en la invocación SOAP contiene el parámetro blob="
BLOB_TYPE", BLOB_TYPE determina el protocolo de transmisión. BLOB_ TYPEes un marcador de posición para base64, centavo, mime, http, mtom o swaref.
El extremo SOAP del servicio es inteligente. Si las siguientes condiciones son verdaderas, los documentos de salida se devuelven utilizando el mismo protocolo de transmisión que los documentos de entrada:
El parámetro de extremo SOAP del servicio Default Protocol For Output Blob Objects está establecido en Smart.
Para cada servicio con un extremo SOAP, la consola de administración permite especificar el protocolo de transmisión para cualquier blobs devuelto. (Consulte ayuda de administración).
El servicio AEM Forms toma uno o más documentos como entrada.
El extremo SOAP del servicio no es inteligente. El protocolo configurado determina el protocolo de transmisión del documento y los datos se devuelven en el campo BLOB
correspondiente. Por ejemplo, si el extremo SOAP está establecido en DIME, el blob devuelto se encuentra en el campo blob.attachmentID
independientemente del protocolo de transmisión de cualquier documento de entrada.
De lo contrario. Si un servicio no toma el tipo de documento como entrada, los documentos de salida se devuelven en el campo BLOB.remoteURL
sobre el protocolo HTTP.
Como se describe en la primera condición, puede garantizar el tipo de transmisión de cualquier documento devuelto ampliando la URL del extremo SOAP con un sufijo como se indica a continuación:
https://<your_serverhost>:<your_port>/soap/services/<service
name>?blob=base64|dime|mime|http|mtom|swaref
Esta es la correlación entre los tipos de transmisión y el campo desde el cual se obtienen los datos:
blob
sufijo en base64
para devolver los datos del BLOB.binaryData
campo .blob
sufijo en DIME
o MIME
para que devuelva los datos como un tipo de archivo adjunto correspondiente con el identificador de archivo adjunto devuelto en el BLOB.attachmentID
campo. Utilice la API propietaria del marco SOAP para leer los datos del archivo adjunto.blob
sufijo en http
para mantener los datos en el servidor de aplicaciones y devuelva la URL que señala a los datos del BLOB.remoteURL
campo.blob
sufijo en mtom
o swaref
para que devuelva los datos como un tipo de archivo adjunto correspondiente con el identificador de archivo adjunto devuelto en los BLOB.MTOM
campos o BLOB.swaRef
. Utilice la API nativa del marco SOAP para leer los datos del archivo adjunto.Se recomienda no superar los 30 MB al rellenar un objeto BLOB
invocando su método setBinaryData
. De lo contrario, existe la posibilidad de que se produzca una excepción OutOfMemory
.
Las aplicaciones basadas en JAX WS que utilizan el protocolo de transmisión MTOM están limitadas a 25 MB de datos enviados y recibidos. Esta limitación se debe a un error en JAX-WS. Si el tamaño combinado de los archivos enviados y recibidos supera los 25 MB, utilice el protocolo de transmisión SwaRef en lugar del MTOM. De lo contrario, existe la posibilidad de una excepción OutOfMemory
.
Transmisión MTOM de matrices de bytes codificadas en base64
Además del objeto BLOB
, el protocolo MTOM admite cualquier parámetro de matriz de bytes o campo de matriz de bytes de un tipo complejo. Esto significa que los marcos de SOAP de cliente que admiten MTOM pueden enviar cualquier elemento xsd:base64Binary
como datos adjuntos MTOM (en lugar de un texto codificado en base64). Los extremos SOAP de AEM Forms pueden leer este tipo de codificación de matriz de bytes. Sin embargo, el servicio AEM Forms siempre devuelve un tipo de matriz de bytes como texto codificado en base64. Los parámetros de matriz de bytes de salida no admiten MTOM.
Los servicios de AEM Forms que devuelven una gran cantidad de datos binarios utilizan el tipo Document/BLOB en lugar del tipo de matriz de bytes. El tipo de documento es mucho más eficaz para transmitir grandes cantidades de datos.
En la tabla siguiente se enumeran los tipos de datos Java y se muestra el tipo de datos correspondiente del servicio Web.
Tipo de datos Java |
Tipo de datos de servicio web |
---|---|
|
|
|
|
|
El tipo
Si una operación de servicio de AEM Forms toma un valor |
|
El tipo
Si una operación de servicio de AEM Forms toma un valor |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
El
El mapa se representa como una secuencia de pares clave/valor. |
|
|
|
|
|
|
|
El tipo XML, que se define en un WSDL de servicio de la siguiente manera:
Si una operación de servicio de AEM Forms acepta un valor La configuración del campo |
|
El tipo XML, que se define en un WSDL de servicio de la siguiente manera:
Si una operación de servicio de AEM Forms toma La configuración del campo |
Sitio web del desarrollador de Adobes
El sitio web de Desarrollador de Adobe contiene el siguiente artículo que trata sobre la invocación de servicios de AEM Forms mediante la API de servicio web:
Creación de aplicaciones ASP.NET de renderización de formularios
Invocación de servicios web mediante componentes personalizados
Al invocar servicios web mediante componentes personalizados, se describe cómo crear un componente de AEM Forms que invoque servicios web de terceros.
Puede utilizar JAX-WS para convertir un servicio WSDL de Forms a clases proxy de Java. Estas clases permiten invocar operaciones de servicios de AEM Forms. Apache Ant permite crear una secuencia de comandos de compilación que genere clases proxy de Java haciendo referencia a un WSDL de servicio de AEM Forms. Puede generar archivos proxy JAX-WS realizando los siguientes pasos:
Instale Apache Ant en el equipo cliente. (Consulte https://ant.apache.org/bindownload.cgi).
ANT_HOME
en el directorio donde instaló Ant.Instale JDK 1.6 o posterior.
[JDK_INSTALL_LOCATION]/jre
.JAVA_HOME
en el directorio donde instaló el JDK.JDK 1.6 incluye el programa wsimport utilizado en el archivo build.xml. JDK 1.5 no incluye ese programa.
Instale JAX-WS en el equipo cliente. (Consulte API de Java para servicios Web XML).
Utilice JAX-WS y Apache Ant para generar clases proxy de Java. Cree una secuencia de comandos de creación de Ant para realizar esta tarea. El siguiente script es un script de compilación de Ant de ejemplo llamado 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>
Dentro de este script de compilación de Ant, observe que la propiedad url
está establecida para hacer referencia al WSDL del servicio de cifrado que se ejecuta en localhost. Las propiedades username
y password
deben establecerse en un nombre de usuario y contraseña válidos para los formularios AEM. Observe que la dirección URL contiene el atributo lc_version
. Sin especificar la opción lc_version
, no puede invocar nuevas operaciones de servicio de AEM Forms.
Reemplace EncryptionService
por el nombre de servicio de AEM Forms que desea invocar mediante las clases proxy de Java. Por ejemplo, para crear clases proxy de Java para el servicio de Rights Management, especifique:
http://localhost:8080/soap/services/RightsManagementService?WSDL&lc_version=9.0.1
Cree un archivo BAT para ejecutar el script de compilación de Ant. El siguiente comando puede encontrarse dentro de un archivo BAT responsable de ejecutar el script de compilación de Ant:
ant -buildfile "build.xml" wsdl
Coloque el script de compilación ANT en C:\Program Files\Java\jaxws-ri\bin directory. El script escribe los archivos JAVA en .carpeta /classes. La secuencia de comandos genera archivos JAVA que pueden invocar el servicio.
Empaquete los archivos JAVA en un archivo JAR. Si está trabajando en Eclipse, siga estos pasos:
com.adobe.idp.services
en la carpeta Source .com.adobe.idp.services
y, a continuación, importe los archivos JAVA de la carpeta adobe/idp/services en el paquete.org/apache/xml/xmlsoap
en la carpeta Source.Todos los inicios rápidos del servicio web Java (excepto el servicio Forms) ubicados en Programación con formularios AEM crean archivos proxy Java usando JAX-WS. Además, todos los inicios rápidos del servicio web de Java, utilizan SwaRef. (Consulte Invocación de AEM Forms mediante SwaRef).
Consulte también
Creación de clases de proxy Java mediante el eje Apache
Invocación de AEM Forms mediante la codificación Base64
Invocación de AEM Forms mediante datos BLOB a través de HTTP
Invocación de AEM Forms mediante SwaRef
Puede utilizar la herramienta Java WSDL2del eje Apache para convertir un servicio Forms en clases proxy de Java. Estas clases permiten invocar operaciones de servicio de Forms. Con Apache Ant, puede generar archivos de biblioteca Axis a partir de un WSDL de servicio. Puede descargar el eje Apache en la dirección URL https://ws.apache.org/axis/.
Los inicios rápidos del servicio web asociados con el servicio Forms utilizan las clases proxy de Java creadas mediante el eje Apache. Los inicios rápidos del servicio web de Forms también utilizan Base64 como tipo de codificación. (Consulte Inicio rápido de la API de servicio de Forms).
Puede generar archivos de biblioteca Java del eje siguiendo estos pasos:
Instale Apache Ant en el equipo cliente. Está disponible en https://ant.apache.org/bindownload.cgi.
ANT_HOME
en el directorio donde instaló Ant.Instale Apache Axis 1.4 en el equipo cliente. Está disponible en https://ws.apache.org/axis/.
Configure la ruta de clase para utilizar los archivos JAR del eje en su cliente de servicio web, tal como se describe en las instrucciones de instalación del eje en https://ws.apache.org/axis/java/install.html.
Utilice la herramienta Apache WSDL2Java en Axis para generar clases proxy de Java. Cree una secuencia de comandos de creación de Ant para realizar esta tarea. El siguiente script es un script de compilación de Ant de ejemplo llamado 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>
Dentro de este script de compilación de Ant, observe que la propiedad url
está establecida para hacer referencia al WSDL del servicio de cifrado que se ejecuta en localhost. Las propiedades username
y password
deben establecerse en un nombre de usuario y contraseña válidos para los formularios AEM.
Cree un archivo BAT para ejecutar el script de compilación de Ant. El siguiente comando puede encontrarse dentro de un archivo BAT responsable de ejecutar el script de compilación de Ant:
ant -buildfile "build.xml" encryption-wsdl2java-client
Los archivos JAVA se escriben en la propiedad C:\JavaFiles folder as specified by the output
. Para invocar correctamente el servicio Forms, importe estos archivos JAVA en la ruta de la clase.
De forma predeterminada, estos archivos pertenecen a un paquete Java denominado com.adobe.idp.services
. Se recomienda colocar estos archivos JAVA en un archivo JAR. A continuación, importe el archivo JAR en la ruta de clase de la aplicación cliente.
Existen diferentes maneras de colocar archivos .JAVA en un JAR. Una forma es usar un IDE de Java como Eclipse. Cree un proyecto Java y un paquete com.adobe.idp.services
(todos los archivos .JAVA pertenecen a este paquete). A continuación, importe todos los archivos .JAVA en el paquete. Finalmente, exporte el proyecto como archivo JAR.
Modifique la URL en la clase EncryptionServiceLocator
para especificar el tipo de codificación. Por ejemplo, para utilizar base64, especifique ?blob=base64
para asegurarse de que el objeto BLOB
devuelve datos binarios. Es decir, en la clase EncryptionServiceLocator
, busque la siguiente línea de código:
http://localhost:8080/soap/services/EncryptionService;
y cambie a:
http://localhost:8080/soap/services/EncryptionService?blob=base64;
Agregue los siguientes archivos JAR de eje a la ruta de clase de su proyecto Java:
Estos archivos JAR están en el directorio [install directory]/Adobe/Adobe Experience Manager Forms/sdk/lib/thirdparty
.
Consulte también
Creación de clases de proxy Java mediante JAX-WS
Invocación de AEM Forms mediante la codificación Base64
Invocación de AEM Forms mediante datos BLOB a través de HTTP
Puede invocar un servicio de AEM Forms utilizando la codificación Base64. La codificación Base64 codifica los archivos adjuntos que se envían con una solicitud de invocación de servicio Web. Es decir, BLOB
los datos están codificados en Base64, no en el mensaje SOAP completo.
"Invocación de AEM Forms mediante la codificación Base64" analiza la invocación del siguiente proceso breve de AEM Forms denominado MyApplication/EncryptDocument
mediante el uso de la codificación Base64.
Este proceso no se basa en un proceso de AEM Forms existente. Para seguir con el ejemplo de código, cree un proceso denominado MyApplication/EncryptDocument
con Workbench. (Consulte Uso de Workbench).
Cuando se invoca este proceso, realiza las siguientes acciones:
SetValue
. El parámetro de entrada para este proceso es una variable de proceso document
denominada inDoc
.PasswordEncryptPDF
. El documento PDF cifrado con contraseña se devuelve en una variable de proceso denominada outDoc
.Puede crear un ensamblado de cliente .NET para invocar un servicio Forms desde un proyecto .NET de Microsoft Visual Studio. Para crear un ensamblado de cliente .NET que utilice la codificación base64, realice los siguientes pasos:
Creación de una clase proxy
Puede crear una clase proxy que se utilice para crear el ensamblado de cliente .NET utilizando una herramienta que acompañe a Microsoft Visual Studio. El nombre de la herramienta es wsdl.exe y se encuentra en la carpeta de instalación de Microsoft Visual Studio. Para crear una clase proxy, abra el símbolo del sistema y vaya a la carpeta que contiene el archivo wsdl.exe. Para obtener más información acerca de la herramienta wsdl.exe, consulte la Ayuda de MSDN.
Introduzca el siguiente comando en el símbolo del sistema:
wsdl https://hiro-xp:8080/soap/services/MyApplication/EncryptDocument?WSDL&lc_version=9.0.1
De forma predeterminada, esta herramienta crea un archivo CS en la misma carpeta que se basa en el nombre del WSDL. En esta situación, crea un archivo CS llamado EncryptDocumentService.cs. Utilice este archivo CS para crear un objeto proxy que le permita invocar el servicio especificado en la URL de invocación.
Modifique la URL en la clase proxy para incluir ?blob=base64
para asegurarse de que el objeto BLOB
devuelve datos binarios. En la clase proxy, busque la siguiente línea de código:
"https://hiro-xp:8080/soap/services/MyApplication/EncryptDocument";
y cambie a:
"https://hiro-xp:8080/soap/services/MyApplication/EncryptDocument?blob=base64";
La sección Invocación de AEM Forms mediante la codificación Base64 utiliza MyApplication/EncryptDocument
como ejemplo. Si está creando un ensamblado de cliente .NET para otro servicio de Forms, asegúrese de reemplazar MyApplication/EncryptDocument
por el nombre del servicio.
Desarrollo del ensamblado del cliente .NET
Cree un proyecto de Biblioteca de clases de Visual Studio que produzca un ensamblado de cliente .NET. El archivo CS que ha creado con wsdl.exe se puede importar en este proyecto. Este proyecto genera un archivo DLL (el ensamblado cliente .NET) que puede usar en otros proyectos de Visual Studio .NET para invocar un servicio.
Este procedimiento crea un ensamblado de cliente .NET llamado DocumentService.dll que puede utilizar para enviar solicitudes SOAP al servicio MyApplication/EncryptDocument
.
Asegúrese de agregar ?blob=base64
a la URL en la clase de proxy que se usa para crear el ensamblado de cliente .NET. De lo contrario, no se pueden recuperar datos binarios del objeto BLOB
.
Referencia al ensamblado de cliente .NET
Coloque el ensamblado de cliente .NET recién creado en el equipo donde esté desarrollando la aplicación cliente. Después de colocar el ensamblado de cliente .NET en un directorio, puede hacer referencia a él desde un proyecto. También haga referencia a la biblioteca System.Web.Services
del proyecto. Si no hace referencia a esta biblioteca, no puede utilizar el ensamblado cliente .NET para invocar un servicio.
Invocación de un servicio mediante un ensamblado cliente .NET que utiliza la codificación Base64
Puede invocar el servicio MyApplication/EncryptDocument
(que se creó en Workbench) utilizando un ensamblado de cliente .NET que utiliza la codificación Base64. Para invocar el servicio MyApplication/EncryptDocument
, realice los siguientes pasos:
MyApplication/EncryptDocument
.System.Web.Services
.MyApplication_EncryptDocumentService
invocando su constructor predeterminado.MyApplication_EncryptDocumentService
del objeto Credentials
con un objeto System.Net.NetworkCredential
. Dentro del constructor System.Net.NetworkCredential
, especifique un nombre de usuario de formularios AEM y la contraseña correspondiente. Establezca valores de autenticación para permitir que la aplicación cliente .NET intercambie correctamente mensajes SOAP con AEM Forms.BLOB
utilizando su constructor. El objeto BLOB
se utiliza para almacenar un pase de documento PDF al proceso MyApplication/EncryptDocument
.System.IO.FileStream
invocando su constructor. Pase un valor de cadena que represente la ubicación del archivo del documento PDF y el modo en que se abre el archivo.System.IO.FileStream
. Puede determinar el tamaño de la matriz de bytes obteniendo la propiedad System.IO.FileStream
del objeto Length
.System.IO.FileStream
del objeto Read
. Pase la matriz de bytes, la posición de inicio y la longitud del flujo para leerlos.BLOB
asignando su propiedad binaryData
con el contenido de la matriz de bytes.MyApplication/EncryptDocument
invocando el método MyApplication_EncryptDocumentService
del objeto invoke
y pasando el objeto BLOB
que contiene el documento PDF. Este proceso devuelve un documento PDF cifrado dentro de un objeto BLOB
.System.IO.FileStream
invocando su constructor y pasando un valor de cadena que represente la ubicación del archivo del documento cifrado con contraseña.BLOB
devuelto por el método MyApplicationEncryptDocumentService
del objeto invoke
. Rellene la matriz de bytes obteniendo el valor del miembro de datos BLOB
del objeto binaryData
.System.IO.BinaryWriter
invocando su constructor y pasando el objeto System.IO.FileStream
.System.IO.BinaryWriter
del objeto Write
y pasando la matriz de bytes.Puede invocar un servicio de AEM Forms utilizando las clases proxy de Java y Base64. Para invocar el servicio MyApplication/EncryptDocument
utilizando las clases proxy de Java, realice los siguientes pasos:
Cree clases de proxy Java usando JAX-WS que consuma el servicio WSDL MyApplication/EncryptDocument
. Utilice el siguiente extremo WSDL:
https://hiro-xp:8080/soap/services/MyApplication/EncryptDocument?WSDL&lc_version=9.0.1
Sustituya hiro-xp
por la dirección IP del servidor de aplicaciones J2EE que hospeda AEM Forms.
Empaquete las clases de proxy Java creadas usando JAX-WS en un archivo JAR.
Incluya el archivo JAR del proxy Java y los archivos JAR ubicados en la siguiente ruta:
<install Directory="">\Adobe\Adobe_Experience_Manager_forms\sdk\client-libs\thirdparty
en la ruta de clase de su proyecto cliente Java.
Cree un objeto MyApplicationEncryptDocumentService
utilizando su constructor.
Cree un objeto MyApplicationEncryptDocument
invocando el método MyApplicationEncryptDocumentService
del objeto getEncryptDocument
.
Defina los valores de conexión necesarios para invocar AEM Forms asignando valores a los siguientes miembros de datos:
Asigne el extremo WSDL y el tipo de codificación al campo javax.xml.ws.BindingProvider
del objeto ENDPOINT_ADDRESS_PROPERTY
. Para invocar el servicio MyApplication/EncryptDocument
utilizando la codificación Base64, especifique el siguiente valor de URL:
https://hiro-xp:8080/soap/services/MyApplication/EncryptDocument?blob=base64
Asigne el usuario de AEM formularios al campo javax.xml.ws.BindingProvider
del objeto USERNAME_PROPERTY
.
Asigne el valor de contraseña correspondiente al campo javax.xml.ws.BindingProvider
del objeto PASSWORD_PROPERTY
.
El siguiente ejemplo de código muestra esta lógica de aplicación:
//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);
Recupere el documento PDF para enviarlo al proceso MyApplication/EncryptDocument
creando un objeto java.io.FileInputStream
utilizando su constructor. Pase un valor de cadena que especifique la ubicación del documento PDF.
Cree una matriz de bytes y rellénela con el contenido del objeto java.io.FileInputStream
.
Cree un objeto BLOB
utilizando su constructor.
Rellene el objeto BLOB
invocando su método setBinaryData
y pasando la matriz de bytes. El BLOB
objeto setBinaryData
es el método al que se llama cuando se utiliza la codificación Base64. Consulte Suministro de objetos BLOB en solicitudes de servicio.
Invoque el proceso MyApplication/EncryptDocument
invocando el método MyApplicationEncryptDocument
del objeto invoke
. Pase el objeto BLOB
que contiene el documento PDF. El método invoke devuelve un objeto BLOB
que contiene el documento PDF cifrado.
Cree una matriz de bytes que contenga el documento PDF cifrado invocando el método BLOB
del objeto getBinaryData
.
Guarde el documento PDF cifrado como archivo PDF. Escriba la matriz de bytes en un archivo.
Consulte también
Inicio rápido: Invocación de un servicio mediante archivos proxy Java y codificación Base64
Creación de un ensamblado de cliente .NET que utilice la codificación Base64
Puede invocar los servicios de AEM Forms utilizando el MTOM estándar del servicio web. Este estándar define cómo se transmiten los datos binarios, como un documento PDF, a través de Internet o intranet. Una función de MTOM es el uso del elemento XOP:Include
. Este elemento se define en la especificación XML Binary Optimized Packaging (XOP) para hacer referencia a los archivos adjuntos binarios de un mensaje SOAP.
La discusión aquí es sobre el uso de MTOM para invocar el siguiente proceso de corta duración de AEM Forms llamado MyApplication/EncryptDocument
.
Este proceso no se basa en un proceso de AEM Forms existente. Para seguir con el ejemplo de código, cree un proceso denominado MyApplication/EncryptDocument
con Workbench. (Consulte Uso de Workbench).
Cuando se invoca este proceso, realiza las siguientes acciones:
SetValue
. El parámetro de entrada para este proceso es una variable de proceso document
denominada inDoc
.PasswordEncryptPDF
. El documento PDF cifrado con contraseña se devuelve en una variable de proceso denominada outDoc
.Se agregó compatibilidad con MTOM en AEM Forms, versión 9.
Las aplicaciones basadas en JAX WS que utilizan el protocolo de transmisión MTOM están limitadas a 25 MB de datos enviados y recibidos. Esta limitación se debe a un error en JAX-WS. Si el tamaño combinado de los archivos enviados y recibidos supera los 25 MB, utilice el protocolo de transmisión SwaRef en lugar del MTOM. De lo contrario, existe la posibilidad de una excepción OutOfMemory
.
La discusión aquí es sobre el uso de MTOM dentro de un proyecto de Microsoft .NET para invocar servicios de AEM Forms. El .NET framework utilizado es 3.5 y el entorno de desarrollo es Visual Studio 2008. Si tiene instalado Web Service Enhances (WSE) en el equipo de desarrollo, elimínelo. El marco de trabajo de .NET 3.5 es compatible con un marco SOAP denominado Windows Communication Foundation (WCF). Al invocar AEM Forms utilizando MTOM, solo se admite WCF (no WSE).
Puede crear un proyecto de Microsoft .NET que pueda invocar un servicio de AEM Forms mediante servicios Web. En primer lugar, cree un proyecto de Microsoft .NET utilizando Visual Studio 2008. Para invocar un servicio de AEM Forms, cree una referencia de servicio al servicio de AEM Forms que desee invocar en el proyecto. Cuando cree una referencia de servicio, especifique una URL para el servicio de AEM Forms:
http://localhost:8080/soap/services/MyApplication/EncryptDocument?WSDL&lc_version=9.0.1
Sustituya localhost
por la dirección IP del servidor de aplicaciones J2EE que aloja AEM Forms. Sustituya MyApplication/EncryptDocument
por el nombre del servicio de AEM Forms que desea invocar. Por ejemplo, para invocar una operación de Rights Management, especifique:
http://localhost:8080/soap/services/RightsManagementService?WSDL&lc_version=9.0.1
La opción lc_version
garantiza que la funcionalidad de AEM Forms, como MTOM, esté disponible. Sin especificar la opción lc_version
, no puede invocar AEM Forms mediante MTOM.
Después de crear una referencia de servicio, los tipos de datos asociados con el servicio AEM Forms están disponibles para su uso en el proyecto .NET. Para crear un proyecto de .NET que invoque un servicio de AEM Forms, realice los pasos siguientes:
Cree un proyecto .NET con Microsoft Visual Studio 2008.
En el menú Proyecto, seleccione Agregar referencia de servicio.
En el cuadro de diálogo Address, especifique el WSDL al servicio de AEM Forms. Por ejemplo,
http://localhost:8080/soap/services/MyApplication/EncryptDocument?WSDL&lc_version=9.0.1
Haga clic en Go y, a continuación, haga clic en OK.
Considere el proceso MyApplication/EncryptDocument
que acepta un documento PDF no protegido y devuelve un documento PDF cifrado con contraseña. Para invocar el proceso MyApplication/EncryptDocument
(que se creó en Workbench) mediante MTOM, realice los siguientes pasos:
Cree un proyecto de Microsoft .NET.
Cree un objeto MyApplication_EncryptDocumentClient
utilizando su constructor predeterminado.
Cree un objeto MyApplication_EncryptDocumentClient.Endpoint.Address
utilizando el constructor System.ServiceModel.EndpointAddress
. Pase un valor de cadena que especifique el WSDL al servicio de AEM Forms y el tipo de codificación:
https://hiro-xp:8080/soap/services/MyApplication/EncryptDocument?blob=mtom
No es necesario utilizar el atributo lc_version
. Este atributo se utiliza al crear una referencia de servicio. Sin embargo, asegúrese de especificar ?blob=mtom
.
Sustituya hiro-xp
por la dirección IP del servidor de aplicaciones J2EE que hospeda AEM Forms.
Cree un objeto System.ServiceModel.BasicHttpBinding
obteniendo el valor del miembro de datos EncryptDocumentClient.Endpoint.Binding
. Establezca el valor devuelto en BasicHttpBinding
.
Establezca el miembro de datos System.ServiceModel.BasicHttpBinding
del objeto MessageEncoding
en WSMessageEncoding.Mtom
. Este valor garantiza que se utilice MTOM.
Habilite la autenticación HTTP básica realizando las siguientes tareas:
MyApplication_EncryptDocumentClient.ClientCredentials.UserName.UserName
.MyApplication_EncryptDocumentClient.ClientCredentials.UserName.Password
.HttpClientCredentialType.Basic
al miembro de datos BasicHttpBindingSecurity.Transport.ClientCredentialType
.BasicHttpSecurityMode.TransportCredentialOnly
al miembro de datos BasicHttpBindingSecurity.Security.Mode
.El siguiente ejemplo de código muestra estas tareas.
//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;
Cree un objeto BLOB
utilizando su constructor. El objeto BLOB
se utiliza para almacenar un documento PDF y pasarlo al proceso MyApplication/EncryptDocument
.
Cree un objeto System.IO.FileStream
invocando su constructor. Pase un valor de cadena que represente la ubicación del archivo del documento PDF y el modo en que se abre el archivo.
Cree una matriz de bytes que almacene el contenido del objeto System.IO.FileStream
. Puede determinar el tamaño de la matriz de bytes obteniendo la propiedad System.IO.FileStream
del objeto Length
.
Rellene la matriz de bytes con datos de flujo invocando el método System.IO.FileStream
del objeto Read
. Pase la matriz de bytes, la posición de inicio y la longitud del flujo para leerlos.
Rellene el objeto BLOB
asignando su miembro de datos MTOM
con el contenido de la matriz de bytes.
Invoque el proceso MyApplication/EncryptDocument
invocando el método MyApplication_EncryptDocumentClient
del objeto invoke
. Pase el objeto BLOB
que contiene el documento PDF. Este proceso devuelve un documento PDF cifrado dentro de un objeto BLOB
.
Cree un objeto System.IO.FileStream
invocando su constructor y pasando un valor de cadena que represente la ubicación del archivo del documento PDF protegido.
Cree una matriz de bytes que almacene el contenido de datos del objeto BLOB
que el método invoke
devolvió. Rellene la matriz de bytes obteniendo el valor del miembro de datos BLOB
del objeto MTOM
.
Cree un objeto System.IO.BinaryWriter
invocando su constructor y pasando el objeto System.IO.FileStream
.
Escriba el contenido de la matriz de bytes en un archivo PDF invocando el método System.IO.BinaryWriter
del objeto Write
y pasando la matriz de bytes.
La mayoría de las operaciones de servicio de AEM Forms tienen un inicio rápido MTOM. Puede ver estos inicios rápidos en la sección de inicio rápido correspondiente de un servicio. Por ejemplo, para ver la sección Salida de inicio rápido, consulte Inicio rápido de API de servicio de salida.
Consulte también
Inicio rápido: Invocación de un servicio mediante MTOM en un proyecto .NET
Acceso a varios servicios mediante servicios web
Creación de una aplicación web ASP.NET que invoque un proceso prolongado centrado en el ser humano
Puede invocar los servicios de AEM Forms mediante SwaRef. El contenido del elemento XML wsi:swaRef
se envía como archivo adjunto dentro de un cuerpo SOAP que almacena la referencia al archivo adjunto. Al invocar un servicio de Forms mediante SwaRef, cree clases de proxy de Java utilizando la API de Java para los servicios web XML (JAX-WS). (Consulte API de Java para servicios Web XML).
La discusión aquí es sobre invocar el siguiente proceso de corta duración de Forms llamado MyApplication/EncryptDocument
usando SwaRef.
Este proceso no se basa en un proceso de AEM Forms existente. Para seguir con el ejemplo de código, cree un proceso denominado MyApplication/EncryptDocument
con Workbench. (Consulte Uso de Workbench).
Cuando se invoca este proceso, realiza las siguientes acciones:
SetValue
. El parámetro de entrada para este proceso es una variable de proceso document
denominada inDoc
.PasswordEncryptPDF
. El documento PDF cifrado con contraseña se devuelve en una variable de proceso denominada outDoc
.Se agregó compatibilidad con SwaRef en AEM Forms
La siguiente discusión es sobre cómo invocar los servicios de Forms usando SwaRef dentro de una aplicación cliente Java. La aplicación Java utiliza clases proxy creadas mediante JAX-WS.
Para invocar el proceso MyApplication/EncryptDocument
utilizando los archivos proxy de Java creados con JAX-WS y SwaRef, realice los siguientes pasos:
Cree clases de proxy Java usando JAX-WS que consuma el servicio WSDL MyApplication/EncryptDocument
. Utilice el siguiente extremo WSDL:
https://hiro-xp:8080/soap/services/MyApplication/EncryptDocument?WSDL&lc_version=9.0.1
Para obtener más información, consulte Creación de clases de proxy Java mediante JAX-WS.
Sustituya hiro-xp
por la dirección IP del servidor de aplicaciones J2EE que hospeda AEM Forms.
Empaquete las clases de proxy Java creadas usando JAX-WS en un archivo JAR.
Incluya el archivo JAR del proxy Java y los archivos JAR ubicados en la siguiente ruta:
<install Directory="">\Adobe\Adobe_Experience_Manager_forms\sdk\client-libs\thirdparty
en la ruta de clase de su proyecto cliente Java.
Cree un objeto MyApplicationEncryptDocumentService
utilizando su constructor.
Cree un objeto MyApplicationEncryptDocument
invocando el método MyApplicationEncryptDocumentService
del objeto getEncryptDocument
.
Defina los valores de conexión necesarios para invocar AEM Forms asignando valores a los siguientes miembros de datos:
Asigne el extremo WSDL y el tipo de codificación al campo javax.xml.ws.BindingProvider
del objeto ENDPOINT_ADDRESS_PROPERTY
. Para invocar el servicio MyApplication/EncryptDocument
utilizando la codificación SwaRef, especifique el siguiente valor URL:
https://hiro-xp:8080/soap/services/MyApplication/EncryptDocument?blob=swaref
Asigne el usuario de AEM formularios al campo javax.xml.ws.BindingProvider
del objeto USERNAME_PROPERTY
.
Asigne el valor de contraseña correspondiente al campo javax.xml.ws.BindingProvider
del objeto PASSWORD_PROPERTY
.
El siguiente ejemplo de código muestra esta lógica de aplicación:
//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);
Recupere el documento PDF para enviarlo al proceso MyApplication/EncryptDocument
creando un objeto java.io.File
utilizando su constructor. Pase un valor de cadena que especifique la ubicación del documento PDF.
Cree un objeto javax.activation.DataSource
utilizando el constructor FileDataSource
. Pase el objeto java.io.File
.
Cree un objeto javax.activation.DataHandler
utilizando su constructor y pasando el objeto javax.activation.DataSource
.
Cree un objeto BLOB
utilizando su constructor.
Rellene el objeto BLOB
invocando su método setSwaRef
y pasando el objeto javax.activation.DataHandler
.
Invoque el proceso MyApplication/EncryptDocument
invocando el método MyApplicationEncryptDocument
del objeto invoke
y pasando el objeto BLOB
que contiene el documento PDF. El método invoke devuelve un objeto BLOB
que contiene un documento PDF cifrado.
Rellene un objeto javax.activation.DataHandler
invocando el método BLOB
del objeto getSwaRef
.
Convierta el objeto javax.activation.DataHandler
en una instancia java.io.InputSteam
invocando el método javax.activation.DataHandler
del objeto getInputStream
.
Escriba la instancia java.io.InputSteam
en un archivo PDF que represente el documento PDF cifrado.
La mayoría de las operaciones de servicio de AEM Forms tienen un inicio rápido de SwaRef. Puede ver estos inicios rápidos en la sección de inicio rápido correspondiente de un servicio. Por ejemplo, para ver la sección Salida de inicio rápido, consulte Inicio rápido de API de servicio de salida.
Consulte también
Inicio rápido: Invocación de un servicio mediante SwaRef en un proyecto Java
Puede invocar los servicios de AEM Forms mediante servicios web y pasando datos BLOB a través de HTTP. Pasar datos BLOB a través de HTTP es una técnica alternativa en lugar de usar codificación base64, DIME o MIME. Por ejemplo, puede pasar datos a través de HTTP en un proyecto de Microsoft .NET que utilice la mejora del servicio web 3.0, que no admite DIME ni MIME. Al utilizar datos BLOB a través de HTTP, los datos de entrada se cargan antes de que se invoque el servicio AEM Forms .
"Invocando AEM Forms usando datos de BLOB sobre HTTP" discute invocar el siguiente proceso de corta duración de AEM Forms llamado MyApplication/EncryptDocument
pasando datos de BLOB a través de HTTP.
Este proceso no se basa en un proceso de AEM Forms existente. Para seguir con el ejemplo de código, cree un proceso denominado MyApplication/EncryptDocument
con Workbench. (Consulte Uso de Workbench).
Cuando se invoca este proceso, realiza las siguientes acciones:
SetValue
. El parámetro de entrada para este proceso es una variable de proceso document
denominada inDoc
.PasswordEncryptPDF
. El documento PDF cifrado con contraseña se devuelve en una variable de proceso denominada outDoc
.Se recomienda que esté familiarizado con la invocación de AEM Forms mediante SOAP. (Consulte Invocación de AEM Forms mediante servicios Web).
Para crear un ensamblado de cliente que utilice datos sobre HTTP, siga el proceso especificado en Invocación de AEM Forms mediante la codificación Base64. Sin embargo, modifique la URL en la clase proxy para incluir ?blob=http
en lugar de ?blob=base64
. Esta acción garantiza que los datos se pasen a través de HTTP. En la clase proxy, busque la siguiente línea de código:
"http://localhost:8080/soap/services/MyApplication/EncryptDocument";
y cambie a:
"http://localhost:8080/soap/services/MyApplication/EncryptDocument?blob=http";
Referencia al ensamblado de .NET clienMyApplication/EncryptDocumentt
Coloque el nuevo ensamblado de cliente .NET en el equipo donde esté desarrollando la aplicación cliente. Después de colocar el ensamblado de cliente .NET en un directorio, puede hacer referencia a él desde un proyecto. Haga referencia a la biblioteca System.Web.Services
del proyecto. Si no hace referencia a esta biblioteca, no puede utilizar el ensamblado cliente .NET para invocar un servicio.
Invocación de un servicio mediante un ensamblado de cliente .NET que utiliza datos BLOB a través de HTTP
Puede invocar el servicio MyApplication/EncryptDocument
(que se creó en Workbench) utilizando un ensamblado de cliente .NET que utiliza datos a través de HTTP. Para invocar el servicio MyApplication/EncryptDocument
, realice los siguientes pasos:
System.Web.Services
.MyApplication_EncryptDocumentService
invocando su constructor predeterminado.MyApplication_EncryptDocumentService
del objeto Credentials
con un objeto System.Net.NetworkCredential
. Dentro del constructor System.Net.NetworkCredential
, especifique un nombre de usuario de formularios AEM y la contraseña correspondiente. Establezca valores de autenticación para permitir que la aplicación cliente .NET intercambie correctamente mensajes SOAP con AEM Forms.BLOB
utilizando su constructor. El objeto BLOB
se utiliza para pasar datos al proceso MyApplication/EncryptDocument
.BLOB
del objeto remoteURL
que especifica la ubicación URI de un documento PDF que se pasará al servicio MyApplication/EncryptDocument
.MyApplication/EncryptDocument
invocando el método MyApplication_EncryptDocumentService
del objeto invoke
y pasando el objeto BLOB
. Este proceso devuelve un documento PDF cifrado dentro de un objeto BLOB
.System.UriBuilder
utilizando su constructor y pasando el valor del miembro de datos remoteURL
del objeto BLOB
devuelto.System.UriBuilder
en un objeto System.IO.Stream
. (El Inicio rápido C# que sigue esta lista ilustra cómo realizar esta tarea).System.IO.Stream
.System.IO.BinaryWriter
invocando su constructor y pasando el objeto System.IO.FileStream
.System.IO.BinaryWriter
del objeto Write
y pasando la matriz de bytes.Puede invocar un servicio de AEM Forms utilizando clases proxy de Java y datos BLOB a través de HTTP. Para invocar el servicio MyApplication/EncryptDocument
utilizando las clases proxy de Java, realice los siguientes pasos:
Cree clases de proxy Java usando JAX-WS que consuma el servicio WSDL MyApplication/EncryptDocument
. Utilice el siguiente extremo WSDL:
https://hiro-xp:8080/soap/services/MyApplication/EncryptDocument?WSDL&lc_version=9.0.1
Para obtener más información, consulte Creación de clases de proxy Java mediante JAX-WS.
Sustituya hiro-xp
por la dirección IP del servidor de aplicaciones J2EE que hospeda AEM Forms.
Empaquete las clases de proxy Java creadas usando JAX-WS en un archivo JAR.
Incluya el archivo JAR del proxy Java y los archivos JAR ubicados en la siguiente ruta:
<install Directory="">\Adobe\Adobe_Experience_Manager_forms\sdk\client-libs\thirdparty
en la ruta de clase de su proyecto cliente Java.
Cree un objeto MyApplicationEncryptDocumentService
utilizando su constructor.
Cree un objeto MyApplicationEncryptDocument
invocando el método MyApplicationEncryptDocumentService
del objeto getEncryptDocument
.
Defina los valores de conexión necesarios para invocar AEM Forms asignando valores a los siguientes miembros de datos:
Asigne el extremo WSDL y el tipo de codificación al campo javax.xml.ws.BindingProvider
del objeto ENDPOINT_ADDRESS_PROPERTY
. Para invocar el servicio MyApplication/EncryptDocument
utilizando la codificación BLOB sobre HTTP, especifique el siguiente valor de URL:
https://hiro-xp:8080/soap/services/MyApplication/EncryptDocument?blob=http
Asigne el usuario de AEM formularios al campo javax.xml.ws.BindingProvider
del objeto USERNAME_PROPERTY
.
Asigne el valor de contraseña correspondiente al campo javax.xml.ws.BindingProvider
del objeto PASSWORD_PROPERTY
.
El siguiente ejemplo de código muestra esta lógica de aplicación:
//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);
Cree un objeto BLOB
utilizando su constructor.
Rellene el objeto BLOB
invocando su método setRemoteURL
. Pase un valor de cadena que especifique la ubicación URI de un documento PDF para pasarlo al servicio MyApplication/EncryptDocument
.
Invoque el proceso MyApplication/EncryptDocument
invocando el método MyApplicationEncryptDocument
del objeto invoke
y pasando el objeto BLOB
que contiene el documento PDF. Este proceso devuelve un documento PDF cifrado dentro de un objeto BLOB
.
Cree una matriz de bytes para almacenar la secuencia de datos que representa el documento PDF cifrado. Invoque el método BLOB
del objeto getRemoteURL
(utilice el objeto BLOB
devuelto por el método invoke
).
Cree un objeto java.io.File
utilizando su constructor. Este objeto representa el documento PDF cifrado.
Cree un objeto java.io.FileOutputStream
utilizando su constructor y pasando el objeto java.io.File
.
Invoque el método java.io.FileOutputStream
del objeto write
. Pase la matriz de bytes que contiene el flujo de datos que representa el documento PDF cifrado.
Puede invocar los servicios de AEM Forms mediante SOAP con archivos adjuntos. AEM Forms admite los estándares de servicio web MIME y DIME. DIME permite enviar archivos adjuntos binarios, como documentos PDF, junto con solicitudes de invocación en lugar de codificar el archivo adjunto. La sección Invocación de AEM Forms mediante DIME trata sobre la invocación del siguiente proceso de corta duración de AEM Forms llamado MyApplication/EncryptDocument
mediante DIME.
Cuando se invoca este proceso, realiza las siguientes acciones:
SetValue
. El parámetro de entrada para este proceso es una variable de proceso document
denominada inDoc
.PasswordEncryptPDF
. El documento PDF cifrado con contraseña se devuelve en una variable de proceso denominada outDoc
.Este proceso no se basa en un proceso de AEM Forms existente. Para seguir los ejemplos de código, cree un proceso denominado MyApplication/EncryptDocument
con Workbench. (Consulte Uso de Workbench).
La invocación de operaciones de servicio de AEM Forms mediante DIME está en desuso. Se recomienda utilizar MTOM. (Consulte Invocación de AEM Forms mediante MTOM).
Para crear un proyecto de .NET que pueda invocar un servicio de Forms mediante DIME, realice las siguientes tareas:
Instalación de mejoras de servicios web 2.0
Instale las mejoras de los servicios web 2.0 en el equipo de desarrollo e inclúyalo con Microsoft Visual Studio .NET. Puede descargar las mejoras de los servicios web 2.0 desde el Centro de descargas de Microsoft.
Desde esta página web, busque Mejoras en los servicios web 2.0 y descárguela en su equipo de desarrollo. Esta descarga coloca un archivo denominado Microsoft WSE 2.0 SPI.msi en el equipo. Ejecute el programa de instalación y siga las instrucciones en línea.
Mejoras en los servicios web 2.0 admite DIME. La versión compatible de Microsoft Visual Studio es 2003 cuando se trabaja con las mejoras de los servicios web 2.0. Las mejoras de los servicios web 3.0 no son compatibles con DIME; sin embargo, es compatible con MTOM.
Creación de una referencia web para un servicio AEM Forms
Después de instalar las mejoras de servicios web 2.0 en el equipo de desarrollo y crear un proyecto de Microsoft .NET, cree una referencia web al servicio Forms. Por ejemplo, para crear una referencia web al proceso MyApplication/EncryptDocument
y suponiendo que Forms esté instalado en el equipo local, especifique la siguiente URL:
http://localhost:8080/soap/services/MyApplication/EncryptDocument?WSDL
Después de crear una referencia web, los dos tipos de datos proxy siguientes están disponibles para usar en el proyecto .NET: EncryptDocumentService
y EncryptDocumentServiceWse
. Para invocar el proceso MyApplication/EncryptDocument
mediante DIME, utilice el tipo EncryptDocumentServiceWse
.
Antes de crear una referencia web al servicio Forms, asegúrese de hacer referencia a las mejoras de los servicios web 2.0 en su proyecto. (Consulte "Instalación de mejoras de servicios web 2.0").
Referencia a la biblioteca WSE
Creación de una referencia web a un servicio de Forms
Asegúrese de habilitar el proyecto .NET para utilizar la biblioteca WSE. Desde el Explorador de proyectos, haga clic con el botón derecho en el nombre del proyecto y seleccione Habilitar WSE 2.0. Asegúrese de que la casilla de verificación del cuadro de diálogo que aparece esté seleccionada.
Invocación de un servicio mediante DIME en un proyecto .NET
Puede invocar un servicio de Forms mediante DIME. Considere el proceso MyApplication/EncryptDocument
que acepta un documento PDF no protegido y devuelve un documento PDF cifrado con contraseña. Para invocar el proceso MyApplication/EncryptDocument
mediante DIME, realice los siguientes pasos:
Cree un proyecto de Microsoft .NET que le permita invocar un servicio de Forms mediante DIME. Asegúrese de incluir las mejoras de los servicios web 2.0 y crear una referencia web al servicio AEM Forms.
Después de establecer una referencia web en el proceso MyApplication/EncryptDocument
, cree un objeto EncryptDocumentServiceWse
utilizando su constructor predeterminado.
Establezca el miembro de datos EncryptDocumentServiceWse
del objeto Credentials
con un valor System.Net.NetworkCredential
que especifica el nombre de usuario y el valor de contraseña de los formularios AEM.
Cree un objeto Microsoft.Web.Services2.Dime.DimeAttachment
utilizando su constructor y pasando los siguientes valores:
System.Guid.NewGuid.ToString
.application/pdf
.TypeFormat
. Especifique TypeFormat.MediaType
.Cree un objeto BLOB
utilizando su constructor.
Agregue el adjunto DIME al objeto BLOB
asignando el valor del miembro de datos Microsoft.Web.Services2.Dime.DimeAttachment
del objeto Id
al miembro de datos BLOB
del objeto attachmentID
.
Invoque el método EncryptDocumentServiceWse.RequestSoapContext.Attachments.Add
y pase el objeto Microsoft.Web.Services2.Dime.DimeAttachment
.
Invoque el proceso MyApplication/EncryptDocument
invocando el método EncryptDocumentServiceWse
del objeto invoke
y pasando el objeto BLOB
que contiene el adjunto DIME. Este proceso devuelve un documento PDF cifrado dentro de un objeto BLOB
.
Obtenga el valor del identificador de datos adjuntos obteniendo el valor del miembro de datos BLOB
del objeto attachmentID
devuelto.
Itere a través de los archivos adjuntos ubicados en EncryptDocumentServiceWse.ResponseSoapContext.Attachments
y utilice el valor del identificador de datos adjuntos para obtener el documento PDF cifrado.
Obtenga un objeto System.IO.Stream
obteniendo el valor del miembro de datos Attachment
del objeto Stream
.
Cree una matriz de bytes y pase dicha matriz de bytes al método System.IO.Stream
del objeto Read
. Este método rellena la matriz de bytes con un flujo de datos que representa el documento PDF cifrado.
Cree un objeto System.IO.FileStream
invocando su constructor y pasando un valor de cadena que represente una ubicación de archivo PDF. Este objeto representa el documento PDF cifrado.
Cree un objeto System.IO.BinaryWriter
invocando su constructor y pasando el objeto System.IO.FileStream
.
Escriba el contenido de la matriz de bytes en el archivo PDF invocando el método System.IO.BinaryWriter
del objeto Write
y pasando la matriz de bytes.
Puede utilizar la herramienta Java WSDL2del eje Apache para convertir un WSDL de servicio en clases proxy de Java, de modo que pueda invocar operaciones de servicio. Con Apache Ant, puede generar archivos de biblioteca Axis desde un WSDL del servicio AEM Forms que le permita invocar el servicio. (Consulte Creación de clases de proxy Java mediante el eje Apache).
La herramienta Java WSDL2del eje Apache genera archivos JAVA que contienen métodos que se utilizan para enviar solicitudes SOAP a un servicio. Las bibliotecas generadas por el eje descodifican las solicitudes SOAP recibidas por un servicio y las vuelven a convertir en métodos y argumentos.
Para invocar el servicio MyApplication/EncryptDocument
(que se creó en Workbench) utilizando archivos de biblioteca generados por el eje y DIME, realice los siguientes pasos:
Cree clases proxy de Java que consuman el WSDL de servicio MyApplication/EncryptDocument
mediante el eje Apache. (Consulte Creación de clases de proxy Java mediante el eje Apache).
Incluya las clases proxy de Java en la ruta de clase.
Cree un objeto MyApplicationEncryptDocumentServiceLocator
utilizando su constructor.
Cree un objeto URL
usando su constructor y pasando un valor de cadena que especifique la definición WSDL del servicio AEM Forms. Asegúrese de especificar ?blob=dime
al final de la dirección URL del extremo SOAP. Por ejemplo, use
https://hiro-xp:8080/soap/services/MyApplication/EncryptDocument?blob=dime.
Cree un objeto EncryptDocumentSoapBindingStub
invocando su constructor y pasando el objeto MyApplicationEncryptDocumentServiceLocator
y el objeto URL
.
Establezca el nombre de usuario y el valor de contraseña de los formularios AEM invocando los métodos EncryptDocumentSoapBindingStub
y setUsername
del objeto setPassword
.
encryptionClientStub.setUsername("administrator");
encryptionClientStub.setPassword("password");
Recupere el documento PDF para enviarlo al servicio MyApplication/EncryptDocument
creando un objeto java.io.File
. Pase un valor de cadena que especifique la ubicación del documento PDF.
Cree un objeto javax.activation.DataHandler
usando su constructor y pasando un objeto javax.activation.FileDataSource
. El objeto javax.activation.FileDataSource
se puede crear utilizando su constructor y pasando el objeto java.io.File
que representa el documento PDF.
Cree un objeto org.apache.axis.attachments.AttachmentPart
utilizando su constructor y pasando el objeto javax.activation.DataHandler
.
Adjunte el archivo adjunto invocando el método EncryptDocumentSoapBindingStub
del objeto addAttachment
y pasando el objeto org.apache.axis.attachments.AttachmentPart
.
Cree un objeto BLOB
utilizando su constructor. Rellene el objeto BLOB
con el valor del identificador de datos adjuntos invocando el método BLOB
del objeto setAttachmentID
y pasando el valor del identificador de datos adjuntos. Este valor se puede obtener invocando el método org.apache.axis.attachments.AttachmentPart
del objeto getContentId
.
Invoque el proceso MyApplication/EncryptDocument
invocando el método EncryptDocumentSoapBindingStub
del objeto invoke
. Pase el objeto BLOB
que contiene el adjunto DIME. Este proceso devuelve un documento PDF cifrado dentro de un objeto BLOB
.
Obtenga el valor del identificador de datos adjuntos invocando el método BLOB
del objeto getAttachmentID
devuelto. Este método devuelve un valor de cadena que representa el valor identificador del archivo adjunto devuelto.
Recupere los archivos adjuntos invocando el método EncryptDocumentSoapBindingStub
del objeto getAttachments
. Este método devuelve una matriz de Objects
que representan los archivos adjuntos.
Itere a través de los archivos adjuntos (la matriz Object
) y utilice el valor del identificador de los archivos adjuntos para obtener el documento PDF cifrado. Cada elemento es un objeto org.apache.axis.attachments.AttachmentPart
.
Obtenga el objeto javax.activation.DataHandler
asociado al archivo adjunto invocando el método org.apache.axis.attachments.AttachmentPart
del objeto getDataHandler
.
Obtenga un objeto java.io.FileStream
invocando el método javax.activation.DataHandler
del objeto getInputStream
.
Cree una matriz de bytes y pase dicha matriz de bytes al método java.io.FileStream
del objeto read
. Este método rellena la matriz de bytes con un flujo de datos que representa el documento PDF cifrado.
Cree un objeto java.io.File
utilizando su constructor. Este objeto representa el documento PDF cifrado.
Cree un objeto java.io.FileOutputStream
utilizando su constructor y pasando el objeto java.io.File
.
Invoque el método java.io.FileOutputStream
del objeto write
y pase la matriz de bytes que contiene el flujo de datos que representa el documento PDF cifrado.
Consulte también
Inicio rápido: Invocación de un servicio mediante DIME en un proyecto Java
AEM Forms admite varios modos de autenticación de servicios web al invocar servicios. Un modo de autenticación especifica un nombre de usuario y un valor de contraseña utilizando un encabezado de autorización básico en la llamada de servicio web. AEM Forms también admite la autenticación basada en afirmaciones SAML. Cuando una aplicación cliente invoca un servicio AEM Forms mediante un servicio Web, la aplicación cliente puede proporcionar información de autenticación de una de las siguientes maneras:
AEM Forms no admite la autenticación basada en certificados estándar, pero sí la autenticación basada en certificados de forma distinta.
El inicio rápido del servicio web en Programación con AEM Forms especifica los valores de nombre de usuario y contraseña para realizar la autorización.
La identidad de AEM usuarios de formularios se puede representar mediante una afirmación SAML firmada con una clave secreta. El siguiente código XML muestra un ejemplo de una afirmación 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>
Este ejemplo de afirmación se emite para un usuario administrador. Esta afirmación contiene los siguientes elementos visibles:
Una aplicación cliente puede recuperar la afirmación de cualquier API de AEM Forms AuthenticationManager que devuelva un objeto AuthResult
. Puede obtener una instancia AuthResult
realizando uno de los dos métodos siguientes:
AuthenticationManager.getAuthResultOnBehalfOfUser
. Este método permite que una aplicación cliente obtenga un objeto AuthResult
para cualquier usuario de formularios AEM.un usuario de AEM forms puede autenticarse utilizando un token SAML obtenido. Esta afirmación SAML (fragmento xml) se puede enviar como parte del encabezado WS-Security con la llamada del servicio web para la autenticación de usuarios. Normalmente, una aplicación cliente ha autenticado a un usuario, pero no ha almacenado las credenciales del usuario. (O el usuario ha iniciado sesión en ese cliente a través de un mecanismo que no sea usar un nombre de usuario y una contraseña). En este caso, la aplicación cliente debe invocar AEM Forms y suplantar a un usuario específico al que se le permite invocar AEM Forms.
Para suplantar a un usuario específico, invoque el método AuthenticationManager.getAuthResultOnBehalfOfUser
utilizando un servicio web. Este método devuelve una instancia AuthResult
que contiene la afirmación SAML para ese usuario.
A continuación, utilice esa afirmación SAML para invocar cualquier servicio que requiera autenticación. Esta acción implica enviar la afirmación como parte del encabezado SOAP. Cuando se realiza una llamada de servicio web con esta afirmación, AEM Forms identifica al usuario como el representado por esa afirmación. Es decir, el usuario especificado en la afirmación es el usuario que invoca el servicio.
Puede invocar un servicio de AEM Forms mediante las clases proxy de Java que se crearon con la biblioteca Axis . (Consulte Creación de clases de proxy Java mediante el eje Apache).
Cuando utilice AXIS que utilice autenticación basada en SAML, registre la solicitud y el controlador de respuesta con Axis. Apache Axis invoca al controlador antes de enviar una solicitud de invocación a AEM Forms. Para registrar un controlador, cree una clase Java que se extienda org.apache.axis.handlers.BasicHandler
.
Creación de un controlador de aserción con eje
La siguiente clase Java, denominada AssertionHandler.java
, muestra un ejemplo de una clase Java que extiende 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);
}
}
}
Registrar el controlador
Para registrar un controlador con Axis, cree un archivo client-config.wsdd. De forma predeterminada, Axis busca un archivo con este nombre. El siguiente código XML es un ejemplo de archivo client-config.wsdd. Consulte la documentación del eje para obtener más información.
<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>
Invocar un servicio de AEM Forms
El siguiente ejemplo de código invoca un servicio de AEM Forms mediante autenticación basada en 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());
}
}
Puede invocar un servicio de Forms utilizando un ensamblado de cliente .NET y una autenticación basada en SAML. Para ello, debe utilizar las mejoras del servicio web 3.0 (WSE). Para obtener información sobre la creación de un ensamblado de cliente .NET que utilice WSE, consulte Creación de un proyecto .NET que utilice DIME.
La sección DIME utiliza WSE 2.0. Para utilizar la autenticación basada en SAML, siga las mismas instrucciones especificadas en el tema DIME. Sin embargo, reemplace WSE 2.0 con WSE 3.0. Instale las mejoras 3.0 de los servicios web en el equipo de desarrollo e inclúyalo con Microsoft Visual Studio .NET. Puede descargar las mejoras de los servicios web 3.0 desde el Centro de descargas de Microsoft.
La arquitectura WSE utiliza los tipos de datos Directivas, Aserciones y SecurityToken. Brevemente, para una llamada de servicio web, especifique una directiva. Una política puede tener varias aserciones. Cada afirmación puede contener filtros. Se invoca un filtro en determinadas etapas de una llamada de servicio web y, en ese momento, puede modificar la solicitud SOAP. Para obtener más información, consulte la documentación sobre las mejoras del servicio web 3.0 .
Crear la aserción y el filtro
El siguiente ejemplo de código C# crea clases de filtro y afirmación. En este ejemplo de código se crea un SamlAssertionOutputFilter. El marco WSE invoca este filtro antes de que la solicitud SOAP se envíe a 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);
}
}
Creación del token SAML
Cree una clase para representar la afirmación SAML. La tarea principal que realiza esta clase es convertir los valores de datos de cadena a xml y conservar el espacio en blanco. Este xml de afirmación se importa posteriormente en la solicitud 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);
}
. . .
}
Invocar un servicio de AEM Forms
El siguiente ejemplo de código C# invoca un servicio de Forms mediante autenticación basada en 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);
}
}
A veces se producen problemas al invocar determinadas operaciones de servicios de AEM Forms mediante servicios web. El objetivo de este debate es determinar esas cuestiones y proporcionar una solución, si se dispone de ellas.
Si intenta invocar asincrónicamente una operación de servicio de AEM Forms, como la operación htmlToPDF
de Generación de PDF, se produce un SoapFaultException
. Para resolver este problema, cree un archivo XML de enlace personalizado que asigne el elemento ExportPDF_Result
y otros elementos a clases diferentes. El siguiente XML representa un archivo de enlace personalizado.
<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>
Utilice este archivo XML al crear archivos proxy Java mediante JAX-WS. (Consulte Creación de clases de proxy Java mediante JAX-WS).
Haga referencia a este archivo XML al ejecutar la herramienta JAX-WS (wsimport.exe) utilizando la opción de línea de comandos - b
. Actualice el elemento wsdlLocation
en el archivo XML de enlace para especificar la URL de AEM Forms.
Para garantizar que la invocación asincrónica funcione, modifique el valor de la URL del punto final y especifique async=true
. Por ejemplo, para los archivos proxy Java creados con JAX-WS, especifique lo siguiente para BindingProvider.ENDPOINT_ADDRESS_PROPERTY
.
https://server:port/soap/services/ServiceName?wsdl&async=true&lc_version=9.0.0
La siguiente lista especifica otros servicios que necesitan un archivo de enlace personalizado cuando se invocan de forma asíncrona:
A veces, una biblioteca proxy creada con un servidor de aplicaciones J2EE específico no invoca correctamente AEM Forms alojado en un servidor de aplicaciones J2EE diferente. Considere una biblioteca proxy que se genera mediante AEM Forms y que se implementa en WebSphere. Esta biblioteca proxy no puede invocar correctamente los servicios de AEM Forms que se implementan en el servidor de aplicaciones JBoss.
Algunos tipos de datos complejos de AEM Forms, como PrincipalReference
, se definen de forma diferente cuando AEM Forms se implementa en WebSphere en comparación con JBoss Application Server. Las diferencias en los JDK utilizados por los diferentes servicios de aplicaciones J2EE son la razón por la que hay diferencias en las definiciones de WSDL. Como resultado, utilice bibliotecas proxy generadas desde el mismo servidor de aplicaciones J2EE.
Debido a conflictos de área de nombres, los objetos de datos no se pueden compartir entre varios WSDL de servicio. Los distintos servicios pueden compartir tipos de datos y, por lo tanto, los servicios comparten la definición de estos tipos en los WSDL. Por ejemplo, no se pueden agregar dos ensamblados de cliente .NET que contengan un tipo de datos BLOB
al mismo proyecto de cliente .NET. Si intenta hacerlo, se producirá un error de compilación.
La siguiente lista especifica los tipos de datos que no se pueden compartir entre varios WSDL de servicio:
User
Principals
PrincipalReference
Groups
Roles
BLOB
Para evitar este problema, se recomienda que califique completamente los tipos de datos. Por ejemplo, considere una aplicación .NET que haga referencia tanto al servicio de Forms como al servicio de firmas mediante una referencia de servicio. Ambas referencias de servicio contendrán una clase BLOB
. Para utilizar una instancia BLOB
, califique completamente el objeto BLOB
cuando lo declare. Este enfoque se muestra en el siguiente ejemplo de código. Para obtener información sobre este ejemplo de código, consulte Firma digital de Forms interactivo.
El siguiente ejemplo de código C# firma un formulario interactivo procesado por el servicio Forms. La aplicación cliente tiene dos referencias de servicio. La instancia BLOB
asociada al servicio de Forms pertenece al espacio de nombres SignInteractiveForm.ServiceReference2
. Del mismo modo, la instancia BLOB
asociada con el servicio de firma pertenece al espacio de nombres SignInteractiveForm.ServiceReference1
. El formulario interactivo firmado se guarda como un archivo PDF denominado 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);
}
}
}
}
El nombre de algunas clases proxy generadas por AEM Forms es incorrecto al usar Microsoft .Net 3.5 y WCF. Este problema se produce cuando se crean clases proxy para IBMFilenetContentRepositoryConnector, IDPSchedulerService o cualquier otro servicio cuyo nombre comience por la letra I. Por ejemplo, el nombre del cliente generado en el caso de IBMFileNetContentRepositoryConnector es BMFileNetContentRepositoryConnectorClient
. Falta la letra I en la clase proxy generada.