Invocar AEM Forms mediante la API de Java invoking-aem-forms-using-the-javaapi

Las muestras y los ejemplos de este documento solo son para AEM Forms en un entorno JEE.

AEM Forms se puede invocar mediante la API de Java de AEM Forms. Al utilizar la API de Java de AEM Forms, puede utilizar la API de invocación o las bibliotecas de cliente de Java. Las bibliotecas de cliente Java están disponibles para servicios como el servicio Rights Management. Estas API con establecimiento inflexible de tipos le permiten desarrollar aplicaciones Java que invocan AEM Forms.

La API de invocación son clases que se encuentran en el paquete com.adobe.idp.dsc. Con estas clases, se puede enviar una solicitud de invocación directamente a un servicio y controlar una respuesta de invocación que se devuelve. Utilice la API de invocación para invocar procesos de corta o larga duración creados con Workbench.

La forma recomendada de invocar un servicio mediante programación es utilizar una biblioteca de cliente Java que corresponda al servicio en lugar de la API de invocación. Por ejemplo, para invocar el servicio Encryption, utilice la biblioteca de cliente del servicio Encryption. Para realizar una operación del servicio Encryption, invoque un método que pertenezca al objeto de cliente del servicio Encryption. Puede cifrar un documento de PDF con una contraseña invocando el método encryptPDFUsingPassword del objeto EncryptionServiceClient.

La API de Java admite las siguientes funciones:

Incluir archivos de biblioteca Java de AEM Forms

Invocar procesos de larga duración centrados en el ser humano

Invocar AEM Forms mediante servicios web

Estableciendo propiedades de conexión

Pasar datos a servicios de AEM Forms mediante la API de Java

Invocar un servicio mediante una biblioteca de cliente Java

Invocación de un proceso de corta duración mediante la API de invocación

Creación de una aplicación web Java que invoque un proceso de larga duración centrado en humanos

Incluir archivos de biblioteca Java de AEM Forms including-aem-forms-java-library-files

Para invocar mediante programación un servicio de AEM Forms mediante la API de Java, incluya los archivos de biblioteca necesarios (archivos JAR) en la ruta de clase del proyecto Java. Los archivos JAR que se incluyen en la ruta de clase de la aplicación cliente dependen de varios factores:

Archivos JAR específicos del servicio service-specific-jar-files

En la tabla siguiente se enumeran los archivos JAR necesarios para invocar los servicios de AEM Forms.

Modo de conexión y archivos JAR de la aplicación J2EE connection-mode-and-j2ee-application-jar-files

En la tabla siguiente se enumeran los archivos JAR que dependen del modo de conexión y del servidor de aplicaciones J2EE en el que AEM Forms está implementado.

Invocación de escenarios invoking-scenarios

La siguiente tabla especifica la invocación de escenarios y enumera los archivos JAR necesarios para invocar correctamente AEM Forms.

Actualización de archivos JAR upgrading-jar-files

Si está actualizando desde la LiveCycle a AEM Forms, se recomienda incluir los archivos JAR de AEM Forms en la ruta de clase del proyecto Java. Por ejemplo, si utiliza servicios como el servicio Rights Management, encontrará un problema de compatibilidad si no incluye archivos JAR de AEM Forms en la ruta de clase.

Suponiendo que está actualizando a AEM Forms. Para utilizar una aplicación Java que invoque el servicio de Rights Management, incluya las versiones de AEM Forms de los siguientes archivos JAR:

Consulte también

Invocar AEM Forms mediante la API de Java

Estableciendo propiedades de conexión

Pasar datos a servicios de AEM Forms mediante la API de Java

Invocar un servicio mediante una biblioteca de cliente Java

Estableciendo propiedades de conexión setting-connection-properties

Las propiedades de conexión se establecen para invocar AEM Forms al utilizar la API de Java. Al establecer las propiedades de conexión, especifique si desea invocar los servicios de forma remota o local, así como el modo de conexión y los valores de autenticación. Se requieren valores de autenticación si la seguridad del servicio está habilitada. Sin embargo, si la seguridad del servicio está deshabilitada, no es necesario especificar los valores de autenticación.

SOAP El modo de conexión puede ser modo de conexión o modo de EJB de tipo. SOAP El modo EJB utiliza el protocolo RMI/IIOP, y el rendimiento del modo EJB es mejor que el rendimiento del modo de. SOAP El modo de la aplicación se utiliza para eliminar una dependencia del servidor de aplicaciones J2EE o cuando se encuentra un cortafuegos entre AEM Forms y la aplicación cliente. SOAP El modo de utiliza el protocolo https como transporte subyacente y puede comunicarse entre los límites del cortafuegos. Si no existe ninguna dependencia del servidor de aplicaciones J2EE o un cortafuegos, se recomienda utilizar el modo EJB.

Para invocar correctamente un servicio de AEM Forms, establezca las siguientes propiedades de conexión:

Para establecer las propiedades de conexión, realice las siguientes tareas:

Estableciendo el modo de conexión de EJB para JBoss

El siguiente ejemplo de código Java establece las propiedades de conexión para invocar AEM Forms implementado en JBoss y utilizar el modo de conexión EJB.

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

Estableciendo el modo de conexión de EJB para WebLogic

En el siguiente ejemplo de código Java se establecen las propiedades de conexión para invocar AEM Forms implementado en WebLogic y utilizar el modo de conexión EJB.

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

Estableciendo el modo de conexión de EJB para WebSphere

El siguiente ejemplo de código Java establece las propiedades de conexión para invocar AEM Forms implementado en WebSphere y utilizar el modo de conexión EJB.

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

SOAP Estableciendo el modo de conexión de la

SOAP En el siguiente ejemplo de código Java se establecen las propiedades de conexión en modo de para invocar el AEM Forms implementado en JBoss.

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

Estableciendo propiedades de conexión cuando la seguridad del servicio está deshabilitada

El siguiente ejemplo de código Java establece las propiedades de conexión necesarias para invocar AEM Forms implementado en el servidor de aplicaciones JBoss y cuando la seguridad del servicio está deshabilitada.

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

SOAP Estableciendo el modo de conexión con el tiempo de espera de solicitud personalizado

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

Usar un objeto de contexto para invocar AEM Forms

Puede usar un objeto com.adobe.idp.Context para invocar un servicio de AEM Forms con un usuario autenticado (el objeto com.adobe.idp.Context representa un usuario autenticado). Al utilizar un objeto com.adobe.idp.Context, no es necesario establecer las propiedades DSC_CREDENTIAL_USERNAME o DSC_CREDENTIAL_PASSWORD. Puede obtener un objeto com.adobe.idp.Context al autenticar usuarios mediante el método authenticate del objeto AuthenticationManagerServiceClient.

El método authenticate devuelve un objeto AuthResult que contiene los resultados de la autenticación. Puede crear un objeto com.adobe.idp.Context invocando su constructor. A continuación, invoque el método initPrincipal del objeto com.adobe.idp.Context y pase el objeto AuthResult, como se muestra en el código siguiente:

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

En lugar de establecer las propiedades DSC_CREDENTIAL_USERNAME o DSC_CREDENTIAL_PASSWORD, puede invocar el método setContext del objeto ServiceClientFactory y pasar el objeto com.adobe.idp.Context. AEM Cuando utilice un usuario de formularios de la para invocar un servicio, asegúrese de que tiene el rol denominado Services User que es necesario para invocar un servicio de AEM Forms.

En el ejemplo de código siguiente se muestra cómo utilizar un objeto com.adobe.idp.Context en la configuración de conexión utilizada para crear un objeto EncryptionServiceClient.

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

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

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


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

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

Invocación de escenarios invoking_scenarios-1

Los siguientes escenarios de invocación se analizan en esta sección:

Aplicación cliente que invoca una instancia de AEM Forms independiente client-application-invoking-a-stand-alone-aem-forms-instance

El diagrama siguiente muestra una aplicación cliente ejecutándose en su propia JVM e invocando una instancia de AEM Forms independiente.

En esta situación, una aplicación cliente se está ejecutando en su propia JVM e invoca los servicios de AEM Forms.

Aplicación cliente que invoca instancias de AEM Forms agrupadas client-application-invoking-clustered-aem-forms-instances

En el diagrama siguiente se muestra una aplicación cliente ejecutándose en su propia JVM e invocando instancias de AEM Forms en un clúster.

Este escenario es similar a una aplicación cliente que invoca una instancia de AEM Forms independiente. Sin embargo, la dirección URL del proveedor es diferente. Si una aplicación cliente desea conectarse a un servidor de aplicaciones J2EE específico, la aplicación debe cambiar la URL para hacer referencia al servidor de aplicaciones J2EE específico.

No se recomienda hacer referencia a un servidor de aplicaciones J2EE específico porque la conexión entre la aplicación cliente y AEM Forms finaliza si el servidor de aplicaciones se detiene. Se recomienda que la dirección URL del proveedor haga referencia a un administrador JNDI de nivel de celda, en lugar de a un servidor de aplicaciones J2EE específico.

SOAP Las aplicaciones cliente que utilizan el modo de conexión de la red de distribución pueden utilizar el puerto del equilibrador de carga HTTP para el clúster. Las aplicaciones cliente que utilizan el modo de conexión EJB pueden conectarse al puerto EJB de un servidor de aplicaciones J2EE específico. Esta acción administra el equilibrio de carga entre los nodos del clúster.

WebSphere

En el ejemplo siguiente se muestra el contenido de un archivo jndi.properties que se utiliza para conectarse a AEM Forms implementado en WebSphere.

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

Lógica web

El ejemplo siguiente muestra el contenido de un archivo jndi.properties que se utiliza para conectarse a AEM Forms que se implementa en WebLogic.

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

JBoss

El ejemplo siguiente muestra el contenido de un archivo jndi.properties que se utiliza para conectarse a AEM Forms que se despliega en JBoss.

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

Consulte también

Inclusión AEM Forms archivos de biblioteca Java

Transmisión de datos a servicios de AEM Forms mediante la API de Java

Llamada a un servicio mediante un biblioteca de cliente Java

Transmisión de datos a servicios de AEM Forms mediante la API de Java passing-data-to-aem-forms-services-using-the-java-api

Las operaciones del servicio AEM Forms suelen consumir o producir documentos de PDF. Al invocar un servicio, a veces es necesario pasar un documento de PDF (u otros tipos de documento como datos XML) al servicio. Del mismo modo, a veces es necesario gestionar un documento de PDF que se devuelve desde el servicio. La clase Java que le permite pasar datos desde y hacia los servicios de AEM Forms es com.adobe.idp.Document.

Los servicios de AEM Forms no aceptan un documento de PDF como otros tipos de datos, como un objeto java.io.InputStream o una matriz de bytes. Un objeto com.adobe.idp.Document también se puede usar para pasar otros tipos de datos, como datos XML, a los servicios.

Un objeto com.adobe.idp.Document es un tipo serializable de Java, por lo que se puede pasar a través de una llamada RMI. El lado receptor puede estar ubicado (el mismo host, el mismo cargador de clase), ser local (el mismo host, un cargador de clase diferente) o remoto (un host diferente). La transferencia del contenido del documento está optimizada para cada caso. Por ejemplo, si el remitente y el destinatario se encuentran en el mismo host, el contenido se pasa a través de un sistema de archivos local. (En algunos casos, los documentos se pueden pasar en la memoria).

Según el tamaño del objeto com.adobe.idp.Document, los datos se transportan dentro del objeto com.adobe.idp.Document o se almacenan en el sistema de archivos del servidor. Cualquier recurso de almacenamiento temporal ocupado por el objeto com.adobe.idp.Document se quitará automáticamente al eliminar com.adobe.idp.Document. (Consulte Disponer objetos de documento.)

A veces es necesario conocer el tipo de contenido de un objeto com.adobe.idp.Document antes de poder pasarlo a un servicio. Por ejemplo, si una operación requiere un tipo de contenido específico, como application/pdf, se recomienda determinar el tipo de contenido. (Consulte Determinar el tipo de contenido de un documento.)

El objeto com.adobe.idp.Document intenta determinar el tipo de contenido mediante los datos proporcionados. Si no se puede recuperar el tipo de contenido de los datos suministrados (por ejemplo, cuando los datos se suministraron como una matriz de bytes), establezca el tipo de contenido. Para establecer el tipo de contenido, invoque el método setContentType del objeto com.adobe.idp.Document. (Consulte Determinar el tipo de contenido de un documento)

Si los archivos auxiliares residen en el mismo sistema de archivos, la creación de un objeto com.adobe.idp.Document es más rápida. Si los archivos auxiliares residen en sistemas de archivos remotos, se debe realizar una operación de copia, lo que afecta al rendimiento.

Una aplicación puede contener com.adobe.idp.Document y org.w3c.dom.Document tipos de datos. Sin embargo, asegúrese de que califica completamente el tipo de datos org.w3c.dom.Document. Para obtener información sobre la conversión de un objeto org.w3c.dom.Document en un objeto com.adobe.idp.Document, consulte Inicio rápido (modo EJB): rellenar previamente Forms con diseños flexibles mediante la API de Java.

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

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

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

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

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

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

            }

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

        }

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

Consulte también

Invocar AEM Forms mediante la API de Java

Estableciendo propiedades de conexión

Creación de documentos creating-documents

Cree un objeto com.adobe.idp.Document antes de invocar una operación de servicio que requiera un documento de PDF (u otros tipos de documento) como valor de entrada. La clase com.adobe.idp.Document proporciona constructores que permiten crear un documento a partir de los siguientes tipos de contenido:

Creación de un documento basado en una matriz de bytes creating-a-document-based-on-a-byte-array

En el ejemplo de código siguiente se crea un objeto com.adobe.idp.Document basado en una matriz de bytes.

Creando un objeto de documento basado en una matriz de bytes

 Document myPDFDocument = new Document(myByteArray);

Creación de un documento basado en otro documento creating-a-document-based-on-another-document

En el ejemplo de código siguiente se crea un objeto com.adobe.idp.Document basado en otro objeto com.adobe.idp.Document.

Creando un objeto de documento basado en otro documento

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

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

Creación de un documento basado en un archivo creating-a-document-based-on-a-file

En el ejemplo de código siguiente se crea un objeto com.adobe.idp.Document basado en un archivo de PDF denominado map.pdf. Este archivo se encuentra en la raíz del disco duro C. Este constructor intenta establecer el tipo de contenido MIME del objeto com.adobe.idp.Document mediante la extensión de nombre de archivo.

El constructor com.adobe.idp.Document que acepta un objeto java.io.File también acepta un parámetro Boolean. Al establecer este parámetro en true, el objeto com.adobe.idp.Document elimina el archivo. Esta acción significa que no tiene que quitar el archivo después de pasarlo al constructor com.adobe.idp.Document.

Establecer este parámetro en false significa que usted conserva la propiedad de este archivo. Establecer este parámetro en true es más eficaz. El motivo es que el objeto com.adobe.idp.Document puede mover el archivo directamente al área administrada local en lugar de copiarlo (lo que es más lento).

Creando un objeto de documento basado en un archivo de PDF

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

Crear un documento basado en un objeto InputStream creating-a-document-based-on-an-inputstream-object

El siguiente ejemplo de código Java crea un objeto com.adobe.idp.Document basado en un objeto java.io.InputStream.

Creando un documento basado en un objeto InputStream

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

Creación de un documento basado en contenido accesible desde una dirección URL creating-a-document-based-on-content-accessible-from-an-url

El siguiente ejemplo de código Java crea un objeto com.adobe.idp.Document basado en un archivo de PDF denominado map.pdf. Este archivo se encuentra dentro de una aplicación web denominada WebApp que se está ejecutando en localhost. Este constructor intenta establecer el tipo de contenido MIME del objeto com.adobe.idp.Document mediante el tipo de contenido devuelto con el protocolo URL.

La dirección URL proporcionada al objeto com.adobe.idp.Document siempre se lee en el lado donde se crea el objeto com.adobe.idp.Document original, como se muestra en este ejemplo:

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

El archivo c:/temp/input.pdf debe estar ubicado en el equipo cliente (no en el equipo servidor). El equipo cliente es donde se lee el URL y donde se crea el com.adobe.idp.Document objeto.

Creación de una documento basada en contenido accesible desde una URL

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

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

Consulte también

Invocar AEM Forms mediante la API de Java

Estableciendo propiedades de conexión

Gestión de documentos devueltos handling-returned-documents

Las operaciones de servicio que devuelven una documento PDF (u otros tipos de datos, como datos XML) como un valor de salida, devuelven un com.adobe.idp.Document objeto. Una vez recibido un com.adobe.idp.Document objeto, puede convertir a los formatos siguientes:

La siguiente línea de código convierte un objeto com.adobe.idp.Document en un objeto java.io.InputStream. Supongamos que myPDFDocument representa un objeto com.adobe.idp.Document:

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

Del mismo modo, puede copiar el contenido de un(a) com.adobe.idp.Document en un archivo local realizando las siguientes tareas:

En el ejemplo de código siguiente se copia el contenido de un objeto com.adobe.idp.Document en un archivo denominado AnotherMap.pdf.

Copiando el contenido de un objeto de documento en un archivo

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

Consulte también

Invocar AEM Forms mediante la API de Java

Estableciendo propiedades de conexión

Determinación del tipo de contenido de un documento determining-the-content-type-of-a-document

Determine el tipo MIME de un objeto com.adobe.idp.Document invocando el método getContentType del objeto com.adobe.idp.Document. Este método devuelve un valor de cadena que especifica el tipo de contenido del objeto com.adobe.idp.Document. En la tabla siguiente se describen los diferentes tipos de contenido que devuelve AEM Forms.

En el ejemplo de código siguiente se determina el tipo de contenido de un objeto com.adobe.idp.Document.

Determinar el tipo de contenido de un objeto Document

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

Consulte también

Invocar AEM Forms mediante la API de Java

Estableciendo propiedades de conexión

Desechar objetos de documento disposing-document-objects

Cuando ya no necesite un objeto Document, es recomendable que lo elimine invocando su método dispose. Cada objeto Document consume un descriptor de archivo y hasta 75 MB de espacio en RAM en la plataforma host de la aplicación. Si un objeto Document no está desechado, el proceso de recopilación del garaje Java lo desecha. Sin embargo, si lo elimina antes con el método dispose, puede liberar la memoria ocupada por el objeto Document.

Consulte también

Invocar AEM Forms mediante la API de Java

Incluir archivos de biblioteca Java de AEM Forms

Invocar un servicio mediante una biblioteca de cliente Java

Invocar un servicio mediante una biblioteca de cliente Java invoking-a-service-using-a-java-client-library

Las operaciones del servicio AEM Forms se pueden invocar mediante la API con establecimiento inflexible de tipos de un servicio, que se conoce como biblioteca de cliente Java. Una biblioteca de cliente Java es un conjunto de clases concretas que proporcionan acceso a los servicios implementados en el contenedor de servicios. Cree una instancia de un objeto Java que represente el servicio que se va a invocar en lugar de crear un objeto InvocationRequest mediante la API de invocación. La API de invocación se utiliza para invocar procesos, como procesos de larga duración, creados en Workbench. (Consulte Invocar procesos de larga duración centrados en el ser humano.)

Para realizar una operación de servicio, invoque un método que pertenezca al objeto Java. Una biblioteca de cliente Java contiene métodos que generalmente se asignan de uno a uno con operaciones de servicio. Cuando utilice una biblioteca de cliente Java, establezca las propiedades de conexión necesarias. (Consulte Establecimiento de propiedades de conexión.)

Después de establecer las propiedades de conexión, cree un objeto ServiceClientFactory que se use para crear una instancia de un objeto Java que le permita invocar un servicio. Cada servicio que tiene una biblioteca de cliente Java tiene un objeto de cliente correspondiente. Por ejemplo, para invocar el servicio Repositorio, cree un objeto ResourceRepositoryClient utilizando su constructor y pasando el objeto ServiceClientFactory. El objeto ServiceClientFactory es responsable de mantener la configuración de conexión necesaria para invocar los servicios de AEM Forms.

Aunque la obtención de ServiceClientFactory suele ser rápida, se requiere cierta sobrecarga cuando se utiliza la fábrica por primera vez. Este objeto está optimizado para su reutilización y, por lo tanto, cuando sea posible, utilice el mismo objeto ServiceClientFactory cuando esté creando varios objetos de cliente Java. Es decir, no cree un objeto ServiceClientFactory independiente para cada objeto de biblioteca de cliente que cree.

Hay una configuración del Administrador de usuarios que controla la duración de la aserción de SAML que se encuentra dentro del objeto com.adobe.idp.Context que afecta al objeto ServiceClientFactory. Esta opción controla todas las duraciones del contexto de autenticación a través de AEM Forms, incluidas todas las invocaciones realizadas mediante la API de Java. De manera predeterminada, el período de tiempo en el que se puede usar un objeto ServiceCleintFactory es de dos horas.

Puede invocar el servicio de repositorio utilizando un biblioteca de cliente Java y realizando los pasos siguientes:

Consulte también

Inicio rápido (modo EJB): Escritura de un recurso mediante la API de Java

Invocar AEM Forms mediante la API de Java

Incluir archivos de biblioteca Java de AEM Forms

Invocación de un proceso de corta duración mediante la API de invocación invoking-a-short-lived-process-using-the-invocation-api

Puede invocar un proceso de corta duración mediante la API de invocación de Java. Cuando invoca un proceso de corta duración mediante la API de invocación, pasa los valores de parámetro necesarios mediante un objeto java.util.HashMap. Para que cada parámetro pase a un servicio, invoque el método put del objeto java.util.HashMap y especifique el par nombre-valor que requiere el servicio para realizar la operación especificada. Especifique el nombre exacto de los parámetros que pertenecen al proceso de corta duración.

La discusión aquí trata sobre el uso de la API de invocación para invocar el siguiente proceso de corta duración de AEM Forms denominado MyApplication/EncryptDocument.

Cuando se invoca este proceso, realiza las siguientes acciones:

Invocar el proceso de corta duración MyApplication/EncryptDocument mediante la API de invocación de Java invoke-the-myapplication-encryptdocument-short-lived-process-using-the-java-invocation-api

Invocar el proceso de corta duración MyApplication/EncryptDocument mediante la API de invocación de Java:

Consulte también

Inicio rápido: invocación de un proceso de corta duración mediante la API de invocación

Invocar procesos de larga duración centrados en el ser humano

Incluir archivos de biblioteca Java de AEM Forms