Administración programática de puntos de conexión programmatically-managing-endpoints

Agregar un extremo EJB mediante la API de Java adding-an-ejb-endpoint-using-the-java-api

Agregar un extremo de EJB mediante la API de Java:

Incluir archivos de proyecto.

Incluya archivos JAR de cliente, como adobe-livecycle-client.jar, en la ruta de clase del proyecto Java. (
Cree un objeto EndpointRegistry Client.
- Cree un objeto ServiceClientFactory que contenga propiedades de conexión.
- Cree un objeto EndpointRegistryClient utilizando su constructor y pasando el objeto ServiceClientFactory.
Establecer atributos de extremo de EJB.
- Crear un objeto CreateEndpointInfo mediante su constructor.
- Especifique el valor del identificador del conector invocando el método setConnectorId del objeto CreateEndpointInfo y pasando el valor de cadena EJB.
- Especifique la descripción del extremo invocando el método setDescription del objeto CreateEndpointInfo y pasando un valor de cadena que describe el extremo.
- Especifique el nombre del extremo invocando el método setName del objeto CreateEndpointInfo y pasando un valor de cadena que especifique el nombre.
- Especifique el servicio al que pertenece el extremo invocando el método setServiceId del objeto CreateEndpointInfo y pasando un valor de cadena que especifica el nombre del servicio.
- Especifique la operación que se invoca invocando el método setOperationName del objeto CreateEndpointInfo y pase un valor de cadena que especifique el nombre de la operación. SOAP Para los extremos de EJB y de la, especifique un carácter comodín ( *), que implica todas las operaciones.
Cree un extremo de EJB.

Cree el extremo invocando el método createEndpoint del objeto EndpointRegistryClient y pasando el objeto CreateEndpointInfo. Este método devuelve un objeto Endpoint que representa el nuevo extremo de EJB.
Habilite el extremo.

Habilite el extremo invocando el método enable del objeto EndpointRegistryClient y pasando el objeto Endpoint devuelto por el método createEndpoint.

Consulte también

Inicio rápido: Agregar un extremo EJB mediante la API de Java

SOAP Añadir un extremo de la mediante la API de Java

SOAP Adición de extremos de adding-soap-endpoints

SOAP Mediante programación, puede agregar un extremo de a un servicio mediante la API de Java de AEM Forms. SOAP SOAP Al agregar un punto final de, habilita una aplicación cliente para invocar el servicio mediante el modo de. Es decir, al establecer las propiedades de conexión necesarias para invocar AEM Forms SOAP, puede seleccionar el modo de.

NOTE

SOAP No se puede agregar un extremo de mediante los servicios web.

NOTE

SOAP SOAP SOAP Normalmente, se agrega un punto de conexión de la a un servicio de forma predeterminada. Sin embargo, se puede agregar un punto de conexión de la distribución a un proceso que se implementa mediante programación o cuando se quita un punto de conexión de la distribución de la distribución y debe agregarse de nuevo.

Resumen de los pasos summary_of_steps-1

SOAP Para agregar un punto final de a un servicio, realice las siguientes tareas:

Incluir archivos de proyecto.
Crear un objeto EndpointRegistryClient.
SOAP Establezca atributos de extremo de la.
SOAP Cree un punto final de.
Habilite el extremo.

Incluir archivos de proyecto

Incluya los archivos necesarios en el proyecto de desarrollo. Si está creando una aplicación cliente con Java, incluya los archivos JAR necesarios. Si utiliza servicios web, asegúrese de incluir los archivos proxy.

Los siguientes archivos JAR deben agregarse a la ruta de clase del proyecto:

adobe-livecycle-client.jar
adobe-usermanager-client.jar
adobe-utilities.jar (requerido si AEM Forms está implementado en el servidor de aplicaciones JBoss)
jbossall-client.jar (requerido si AEM Forms está implementado en el servidor de aplicaciones JBoss)

SOAP Estos archivos JAR son necesarios para crear un punto final de. SOAP Sin embargo, necesita archivos JAR adicionales si utiliza el extremo de la para invocar el servicio. Para obtener información sobre los archivos JAR de AEM Forms, consulte Inclusión de archivos de biblioteca Java de AEM Forms.

Crear un objeto cliente EndpointRegistry

SOAP Para agregar mediante programación un punto final de un servicio, debe crear un objeto EndpointRegistryClient.

SOAP Establecer atributos de punto de conexión de

SOAP Para agregar un extremo de la a un servicio, especifique los siguientes valores:

Valor del identificador del conector: Especifica el tipo de extremo que se va a crear. SOAP Para crear un extremo de la, especifique SOAP.
Descripción: especifica la descripción del extremo.
Nombre: especifica el nombre del extremo.
Valor del identificador de servicio: Especifica el servicio al que pertenece el extremo.
Nombre de operación: especifica el nombre de la operación que se invoca mediante el extremo. SOAP Al crear un extremo de la, especifique un carácter comodín ( *). Sin embargo, si desea especificar una operación específica en lugar de invocar todas las operaciones de servicio, especifique el nombre de la operación en lugar de utilizar el carácter comodín ( *).

SOAP Crear un punto de conexión de

SOAP SOAP Después de establecer los atributos del extremo de la, puede crear un extremo de la misma.

Habilitar el extremo

Después de crear un extremo, debe habilitarlo. Cuando el punto de conexión está habilitado, se puede utilizar para invocar el servicio. Después de habilitar el punto de conexión, puede verlo en la consola de administración.

Consulte también

SOAP Añadir un extremo de la mediante la API de Java add-a-soap-endpoint-using-the-java-api

SOAP Añadir un extremo de la a un servicio mediante la API de Java:

Incluir archivos de proyecto.

Incluya archivos JAR de cliente, como adobe-livecycle-client.jar, en la ruta de clase del proyecto Java.
Cree un objeto EndpointRegistry Client.
- Cree un objeto ServiceClientFactory que contenga propiedades de conexión.
- Cree un objeto EndpointRegistryClient utilizando su constructor y pasando el objeto ServiceClientFactory.
SOAP Establezca atributos de extremo de la.
- Crear un objeto CreateEndpointInfo mediante su constructor.
- Especifique el valor del identificador del conector invocando el método setConnectorId del objeto CreateEndpointInfo y pasando el valor de cadena SOAP.
- Especifique la descripción del extremo invocando el método setDescription del objeto CreateEndpointInfo y pasando un valor de cadena que describe el extremo.
- Especifique el nombre del extremo invocando el método setName del objeto CreateEndpointInfo y pasando un valor de cadena que especifique el nombre.
- Especifique el servicio al que pertenece el extremo invocando el método setServiceId del objeto CreateEndpointInfo y pasando un valor de cadena que especifica el nombre del servicio.
- Especifique la operación que se invoca invocando el método setOperationName del objeto CreateEndpointInfo y pasando un valor de cadena que especifica el nombre de la operación. SOAP Para los extremos de EJB y de la, especifique un carácter comodín ( *), que implica todas las operaciones.
SOAP Cree un punto final de.

Cree el extremo invocando el método createEndpoint del objeto EndpointRegistryClient y pasando el objeto CreateEndpointInfo. SOAP Este método devuelve un objeto Endpoint que representa el nuevo extremo de la.
Habilite el extremo.

Habilite el extremo invocando el método enable del objeto EndpointRegistryClient y pase el objeto Endpoint devuelto por el método createEndpoint.

Consulte también

SOAP Inicio rápido: Añadir un extremo de la mediante la API de Java

Añadir un punto final de carpeta inspeccionada mediante la API de Java

Adición de extremos de carpeta inspeccionada adding-watched-folder-endpoints

Puede agregar mediante programación un punto final de carpeta inspeccionada a un servicio mediante la API de Java de AEM Forms. Al agregar un punto final de carpeta inspeccionada, permite a los usuarios colocar un archivo (como un archivo de PDF) en una carpeta. Cuando el archivo se coloca en la carpeta, el servicio configurado se invoca y manipula el archivo. Una vez que el servicio realiza la operación especificada, guarda el archivo modificado en una carpeta de salida especificada. Una carpeta vigilada está configurada para analizarse a un intervalo de tasa fija o con una programación cron, como todos los lunes, miércoles y viernes al mediodía.

Para agregar mediante programación un extremo de carpeta inspeccionada a un servicio, considere el siguiente proceso de corta duración denominado EncryptDocument. (Consulte Explicación de los procesos de AEM Forms.)

aw_aw_encryptdocumentprocess

Este proceso acepta un documento de PDF no protegido como valor de entrada y, a continuación, pasa el documento de PDF no protegido a la operación EncryptPDFUsingPassword del servicio Encryption. El documento de PDF se cifra con una contraseña y el documento de PDF cifrado con contraseña es el valor de salida de este proceso. El nombre del valor de entrada (el documento de PDF no protegido) es InDoc y el tipo de datos es com.adobe.idp.Document. El nombre del valor de salida (el documento de PDF cifrado con contraseña) es SecuredDoc y el tipo de datos es com.adobe.idp.Document.

NOTE

No puede agregar un punto final de carpeta inspeccionada mediante los servicios web.

Resumen de los pasos summary_of_steps-2

Para agregar un punto final de carpeta inspeccionada a un servicio, realice las siguientes tareas:

Incluir archivos de proyecto.
Crear un objeto EndpointRegistryClient.
Establezca los atributos del punto final de la carpeta inspeccionada.
Especifique los valores de configuración.
Defina los valores de parámetros de entrada.
Defina un valor de parámetro de salida.
Cree un punto final de carpeta inspeccionada.
Habilite el extremo.

Incluir archivos de proyecto

Los siguientes archivos JAR deben agregarse a la ruta de clase del proyecto:

adobe-livecycle-client.jar
adobe-usermanager-client.jar
adobe-utilities.jar (requerido si AEM Forms está implementado en el servidor de aplicaciones JBoss)
jbossall-client.jar (requerido si AEM Forms está implementado en el servidor de aplicaciones JBoss)

Para obtener información sobre la ubicación de estos archivos JAR, consulte Inclusión de archivos de biblioteca Java de AEM Forms.

Crear un objeto cliente EndpointRegistry

Para agregar mediante programación un extremo de carpeta inspeccionada, debe crear un objeto EndpointRegistryClient.

Establecer atributos de extremo de carpeta inspeccionada

Para crear un punto final de carpeta inspeccionada para un servicio, especifique los siguientes valores:

Identificador de conector: especifica el tipo de extremo que se crea. Para crear un punto final de carpeta inspeccionada, especifique WatchedFolder.
Descripción: especifica la descripción del extremo.
Nombre: especifica el nombre del extremo.
Identificador de servicio: Especifica el servicio al que pertenece el extremo. Por ejemplo, para agregar un extremo de carpeta inspeccionada al proceso introducido en esta sección (un proceso se convierte en servicio cuando se activa mediante Workbench), especifique EncryptDocument.
Nombre de operación: especifica el nombre de la operación que se invoca mediante el extremo. Normalmente, cuando se crea un extremo de carpeta inspeccionada para un servicio que se originó a partir de un proceso creado en Workbench, el nombre de la operación es invoke.

Especificar valores de configuración

Especifique valores de configuración para un punto final de carpeta inspeccionada al agregar mediante programación un punto final de carpeta inspeccionada a un servicio. Un administrador especifica estos valores de configuración si se agrega un punto final de carpeta inspeccionada mediante la consola de administración.

La siguiente lista especifica los valores de configuración que se establecen al agregar mediante programación un punto final de carpeta inspeccionada a un servicio:

url: especifica la ubicación de la carpeta vigilada. En un entorno agrupado, este valor debe apuntar a una carpeta de red compartida a la que se pueda acceder desde todos los equipos del clúster.
asincrónico: Identifica el tipo de invocación como asincrónico o sincrónico. Los procesos transitorios y sincrónicos solo se pueden invocar sincrónicamente. El valor predeterminado es True. Se recomienda asincrónico.
cronExpression: Quartz lo usa para programar el sondeo del directorio de entrada.
purgeDuration: Este es un atributo obligatorio. Los archivos y carpetas de la carpeta de resultados se depuran cuando son anteriores a este valor. Este valor se mide en días. Este atributo es útil para garantizar que la carpeta de resultados no se llene. El valor de -1 días indica que nunca se eliminará la carpeta de resultados. El valor predeterminado es -1.
repeatInterval: Intervalo, en segundos, para analizar la carpeta inspeccionada para obtener información. A menos que la restricción esté habilitada, este valor debe ser mayor que el tiempo para procesar un trabajo promedio; de lo contrario, el sistema puede sobrecargarse. El valor predeterminado es 5.
repeatCount: El número de veces que una carpeta inspeccionada analiza la carpeta o directorio. El valor -1 indica un escaneo indefinido. El valor predeterminado es -1.
throttleOn: Limita el número de trabajos de carpetas inspeccionadas que se pueden procesar en un momento dado. El número máximo de trabajos está determinado por el valor batchSize.
userName: nombre de usuario utilizado al invocar un servicio de destino desde la carpeta inspeccionada. Este valor es obligatorio. El valor predeterminado es SuperAdmin.
domainName: el dominio del usuario. Este valor es obligatorio. El valor predeterminado es DefaultDom.
batchSize: número de archivos o carpetas que se van a recoger por análisis. Utilice este valor para evitar sobrecargas en el sistema; el análisis de demasiados archivos al mismo tiempo puede provocar un bloqueo. El valor predeterminado es 2.
waitTime: tiempo, en milisegundos, a esperar antes de analizar una carpeta o archivo después de crearlo. Por ejemplo, si el tiempo de espera es de 36 000 000 milisegundos (una hora) y el archivo se creó hace un minuto, el archivo se recopilará después de que hayan transcurrido 59 minutos o más. Este atributo es útil para asegurarse de que un archivo o carpeta se copia completamente en la carpeta de entrada. Por ejemplo, si tiene un archivo grande para procesar y tarda diez minutos en descargarse, establezca el tiempo de espera en 10*60 *1000 milisegundos. Esta configuración evita que la carpeta vigilada analice el archivo si no ha estado esperando durante diez minutos. El valor predeterminado es 0.
excludeFilePattern: El patrón que usa una carpeta vigilada para determinar qué archivos y carpetas analizar y recoger. Ningún archivo o carpeta que tenga este patrón se analizará para su procesamiento. Esta configuración es útil cuando la entrada es una carpeta que contiene varios archivos. El contenido de la carpeta se puede copiar en una carpeta que tenga un nombre que recogerá la carpeta vigilada. Este paso evita que la carpeta inspeccionada recoja una carpeta para procesarla antes de que la carpeta se copie completamente en la carpeta de entrada. Por ejemplo, si el valor excludeFilePattern es data*, no se recogen todos los archivos y carpetas que coinciden con data*. Esto incluye archivos y carpetas con los nombres data1, data2, etc. Además, el patrón se puede complementar con patrones de comodines para especificar patrones de archivo. La carpeta vigilada modifica la expresión regular para admitir patrones de comodines como *.* y *.pdf. Estas expresiones regulares no admiten estos patrones comodín.
includeFilePattern: El patrón que usa la carpeta vigilada para determinar qué carpetas y archivos analizar y recoger. Por ejemplo, si este valor es *, se recogerán todos los archivos y carpetas que coincidan con input*. Esto incluye archivos y carpetas con los nombres input1, input2, etc. El valor predeterminado es *. Este valor indica todos los archivos y carpetas. Además, el patrón se puede complementar con patrones de comodines para especificar patrones de archivo. La carpeta vigilada modifica la expresión regular para admitir patrones de comodines como *.* y *.pdf. Estas expresiones regulares no admiten estos patrones comodín. Este valor es obligatorio.
resultFolderName: La carpeta donde se almacenan los resultados guardados. Esta ubicación puede ser una ruta de acceso de directorio absoluta o relativa. Si los resultados no aparecen en esta carpeta, compruebe la carpeta de errores. Los archivos de solo lectura no se procesan y se guardan en la carpeta de errores. El valor predeterminado es result/%Y/%M/%D/. Esta es la carpeta de resultados dentro de la carpeta vigilada.
preserveFolderName: ubicación donde se almacenan los archivos después de realizar el análisis y la recogida correctamente. Esta ubicación puede ser una ruta de directorio absoluta, relativa o nula. El valor predeterminado es preserve/%Y/%M/%D/.
failureFolderName: Carpeta donde se guardan los archivos de error. Esta ubicación siempre es relativa a la carpeta vigilada. Los archivos de solo lectura no se procesan y se guardan en la carpeta de errores. El valor predeterminado es failure/%Y/%M/%D/.
preserveOnFailure: Conservar archivos de entrada si no se puede ejecutar la operación en un servicio. El valor predeterminado es True.
overwriteDuplicateFilename: Cuando se establece en true, los archivos de la carpeta de resultados y de la carpeta de conservación se sobrescriben. Cuando se establece en false, los archivos y carpetas que tienen un sufijo de índice numérico se utilizan para el nombre. El valor predeterminado es False.

Definir valores de parámetros de entrada

Al crear un punto final de carpeta inspeccionada, debe definir los valores de parámetro de entrada. Es decir, debe describir los valores de entrada que se pasan a la operación que invoca la carpeta vigilada. Por ejemplo, considere el proceso introducido en este tema. Tiene un valor de entrada denominado InDoc y su tipo de datos es com.adobe.idp.Document. Al crear un punto final de carpeta inspeccionada para este proceso (una vez activado un proceso, se convierte en un servicio), debe definir el valor del parámetro de entrada.

Para definir los valores de parámetro de entrada necesarios para un punto final de carpeta inspeccionada, especifique los siguientes valores:

Nombre del parámetro de entrada: El nombre del parámetro de entrada. El nombre de un valor de entrada se especifica en Workbench para un proceso. Si el valor de entrada pertenece a una operación de servicio (un servicio que no es un proceso creado en Workbench), el nombre de entrada se especifica en el archivo component.xml. Por ejemplo, el nombre del parámetro de entrada para el proceso introducido en esta sección es InDoc.

Tipo de asignación: se usa para configurar los valores de entrada necesarios para invocar la operación de servicio. Existen dos tipos de asignación:

Literal: el extremo de la carpeta inspeccionada utiliza el valor introducido en el campo tal como se muestra. Se admiten todos los tipos básicos de Java. Por ejemplo, si una API utiliza entradas como String, long, int y Boolean, la cadena se convierte en el tipo adecuado y se invoca el servicio.
Variable: el valor introducido es un patrón de archivo que la carpeta vigilada utiliza para elegir la entrada. Por ejemplo, si selecciona Variable para el tipo de asignación y el documento de entrada debe ser un archivo de PDF, puede especificar *.pdf como valor de asignación.

Valor de asignación: especifica el valor del tipo de asignación. Por ejemplo, si selecciona un tipo de asignación Variable, puede especificar *.pdf como patrón de archivo.

Tipo de datos: Especifica el tipo de datos de los valores de entrada. Por ejemplo, el tipo de datos del valor de entrada del proceso introducido en esta sección es com.adobe.idp.Document.

Definir un valor de parámetro de salida

Al crear un punto final de carpeta inspeccionada, debe definir un valor de parámetro de salida. Es decir, debe describir el valor de salida que devuelve el servicio que invoca el punto final de la carpeta inspeccionada. Por ejemplo, considere el proceso introducido en este tema. Tiene un valor de salida denominado SecuredDoc y su tipo de datos es com.adobe.idp.Document. Al crear un punto final de carpeta inspeccionada para este proceso (una vez activado un proceso, se convierte en un servicio), debe definir el valor del parámetro de salida.

Para definir un valor de parámetro de salida necesario para un punto final de carpeta inspeccionada, especifique los siguientes valores:

Nombre del parámetro de salida: El nombre del parámetro de salida. El nombre de un valor de salida de proceso se especifica en Workbench. Si el valor de salida pertenece a una operación de servicio (un servicio que no es un proceso creado en Workbench), el nombre de salida se especifica en el archivo component.xml. Por ejemplo, el nombre del parámetro de salida para el proceso introducido en esta sección es SecuredDoc.

Tipo de asignación: se usa para configurar la salida del servicio y la operación. Las opciones disponibles son las siguientes:

Si el servicio devuelve un solo objeto (un solo documento), el patrón es %F.pdf y el destino de origen es sourcefilename.pdf. Por ejemplo, el proceso introducido en esta sección devuelve un solo documento. Como resultado, el tipo de asignación puede definirse como %F.pdf ( %F significa que debe usar el nombre de archivo dado). El patrón %E especifica la extensión del documento de entrada.
Si el servicio devuelve una lista, el patrón es Result\%F\ y el destino de origen es Result\sourcefilename\source1 (salida 1) y Result\sourcefilename\source2 (salida 2).
Si el servicio devuelve un mapa, el patrón es Result\%F\ y el destino de origen es Result\sourcefilename\file1 y Result\sourcefilename\file2. Si la asignación tiene más de un objeto, el patrón es Result\%F.pdf y el destino de origen es Result\sourcefilename1.pdf (salida 1), Result\sourcefilenam2.pdf (salida 2), etc.

Tipo de datos: Especifica el tipo de datos del valor devuelto. Por ejemplo, el tipo de datos del valor devuelto del proceso introducido en esta sección es com.adobe.idp.Document.

Crear un extremo de carpeta inspeccionada

Después de establecer los atributos del punto de conexión, los valores de configuración y definir los valores de parámetros de entrada y salida, debe crear el punto de conexión de la carpeta inspeccionada.

Habilitar el extremo

Después de crear un punto final de carpeta inspeccionada, debe habilitarlo. Cuando el punto de conexión está habilitado, se puede utilizar para invocar el servicio. Después de habilitar el punto de conexión, puede verlo en la consola de administración.

Consulte también

Añadir un punto final de carpeta inspeccionada mediante la API de Java add-a-watched-folder-endpoint-using-the-java-api

Añada un punto final de carpeta inspeccionada mediante la API de Java de AEM Forms:

Incluir archivos de proyecto.

Incluya archivos JAR de cliente, como adobe-livecycle-client.jar, en la ruta de clase del proyecto Java.
Cree un objeto EndpointRegistry Client.
- Cree un objeto ServiceClientFactory que contenga propiedades de conexión.
- Cree un objeto EndpointRegistryClient utilizando su constructor y pasando el objeto ServiceClientFactory.
Establezca los atributos del punto final de la carpeta inspeccionada.
- Crear un objeto CreateEndpointInfo mediante su constructor.
- Especifique el valor del identificador del conector invocando el método setConnectorId del objeto CreateEndpointInfo y pasando el valor de cadena WatchedFolder.
- Especifique la descripción del extremo invocando el método setDescription del objeto CreateEndpointInfo y pasando un valor de cadena que describe el extremo.
- Especifique el nombre del extremo invocando el método setName del objeto CreateEndpointInfo y pasando un valor de cadena que especifique el nombre.
- Especifique el servicio al que pertenece el extremo invocando el método setServiceId del objeto CreateEndpointInfo y pasando un valor de cadena que especifica el nombre del servicio.
- Especifique la operación que se invoca invocando el método setOperationName del objeto CreateEndpointInfo y pasando un valor de cadena que especifica el nombre de la operación. Normalmente, al crear un punto final de carpeta inspeccionada para un servicio que se originó a partir de un proceso creado en Workbench, se invoca el nombre de la operación.

Especifique los valores de configuración.

Para que cada valor de configuración se establezca para el extremo de la carpeta inspeccionada, debe invocar el método setConfigParameterAsText del objeto CreateEndpointInfo. Por ejemplo, para establecer el valor de configuración url, invoque el método setConfigParameterAsText del objeto CreateEndpointInfo y pase los siguientes valores de cadena:

Un valor de cadena que especifica el nombre del valor de configuración. Al establecer el valor de configuración url, especifique url.
Un valor de cadena que especifica el valor del valor de configuración. Al establecer el valor de configuración url, especifique la ubicación de la carpeta vigilada.

note note
NOTE
Para ver todos los valores de configuración establecidos para el servicio EncryptDocument, consulte el ejemplo de código Java ubicado en QuickStart: Agregar un extremo de carpeta inspeccionada mediante la API de Java.

Defina los valores de parámetros de entrada.

Defina un valor de parámetro de entrada invocando el método setInputParameterMapping del objeto CreateEndpointInfo y pase los siguientes valores:

Valor de cadena que especifica el nombre del parámetro de entrada. Por ejemplo, el nombre del parámetro de entrada para el servicio EncryptDocument es InDoc.
Valor de cadena que especifica el tipo de datos del parámetro de entrada. Por ejemplo, el tipo de datos del parámetro de entrada InDoc es com.adobe.idp.Document.
Valor de cadena que especifica el tipo de asignación. Por ejemplo, puede especificar variable.
Valor de cadena que especifica el valor del tipo de asignación. Por ejemplo, puede especificar *.pdf como patrón de archivo.

note note
NOTE
Invoque el método `setInputParameterMapping` para cada valor de parámetro de entrada que desee definir. Dado que el proceso EncryptDocument sólo tiene un parámetro de entrada, es necesario invocar este método una vez.

Defina un valor de parámetro de salida.

Defina un valor de parámetro de salida invocando el método setOutputParameterMapping del objeto CreateEndpointInfo y pase los siguientes valores:
- Valor de cadena que especifica el nombre del parámetro de salida. Por ejemplo, el nombre del parámetro de salida para el servicio EncryptDocument es SecuredDoc.
- Valor de cadena que especifica el tipo de datos del parámetro de salida. Por ejemplo, el tipo de datos del parámetro de salida SecuredDoc es com.adobe.idp.Document.
- Valor de cadena que especifica el tipo de asignación. Por ejemplo, puede especificar %F.pdf.
Cree un punto final de carpeta inspeccionada.

Cree el extremo invocando el método createEndpoint del objeto EndpointRegistryClient y pasando el objeto CreateEndpointInfo. Este método devuelve un objeto Endpoint que representa el extremo de la carpeta inspeccionada.
Habilite el extremo.

Habilite el extremo invocando el método enable del objeto EndpointRegistryClient y pasando el objeto Endpoint devuelto por el método createEndpoint.

Consulte también

Inicio rápido: Agregar un punto final de carpeta inspeccionada mediante la API de Java

Añadir un extremo de correo electrónico mediante la API de Java

Archivo constante de valores de configuración de carpeta inspeccionada watched-folder-configuration-values-constant-file

QuickStart: al agregar un extremo de carpeta inspeccionada mediante la API de Java, se usa un archivo constante que debe formar parte del proyecto Java para compilar el inicio rápido. Este archivo constante representa los valores de configuración que deben establecerse al agregar un punto final de carpeta inspeccionada. El siguiente código Java representa el archivo constante.

 /**
     * This class contains constants that can be used when setting Watched Folder
     * configuration values
     */

 public final class WatchedFolderEndpointConfigConstants {

         public static final String PROPERTY_FILEPROVIDER_URL = "url";
         public static final String PROPERTY_PROPERTY_ASYNCHRONOUS = "asynchronous";
         public static final String PROPERTY_CRON_EXPRESSION = "cronExpression";
         public static final String PROPERTY_PURGE_DURATION = "purgeDuration";
         public static final String PROPERTY_REPEAT_INTERVAL = "repeatInterval";
         public static final String PROPERTY_REPEAT_COUNT = "repeatCount";
         public static final String PROPERTY_THROTTLE = "throttleOn";
         public static final String PROPERTY_USERNAMER = "userName";
         public static final String PROPERTY_DOMAINNAME = "domainName";
         public static final String PROPERTY_FILEPROVIDER_BATCH_SIZE = "batchSize";
         public static final String PROPERTY_FILEPROVIDER_WAIT_TIME = "waitTime";
         public static final String PROPERTY_EXCLUDE_FILE_PATTERN = "excludeFilePattern";
         public static final String PROPERTY_INCLUDE_FILE_PATTERN = "excludeFilePattern";
         public static final String PROPERTY_FILEPROVIDER_RESULT_FOLDER_NAME =  "resultFolderName";
         public static final String PROPERTY_FILEPROVIDER_PRESERVE_FOLDER_NAME = "preserveFolderName";
         public static final String PROPERTY_FILEPROVIDER_FAILURE_FOLDER_NAME = "failureFolderName";
         public static final String PROPERTY_FILEPROVIDER_PRESERVE_ON_FAILURE = "preserveOnFailure";
         public static final String PROPERTY_FILEPROVIDER_OVERWRITE_DUPLICATE_FILENAME = "overwriteDuplicateFilename";
        }

Añadir extremos de correo electrónico adding-email-endpoints

Puede agregar mediante programación un extremo de correo electrónico a un servicio mediante la API de Java de AEM Forms. Al agregar un punto final de correo electrónico, permite a los usuarios enviar un mensaje de correo electrónico con uno o más archivos adjuntos a una cuenta de correo electrónico especificada. A continuación, se invoca la operación de configuración del servicio y se manipulan los archivos. Una vez que el servicio realiza la operación especificada, envía un mensaje de correo electrónico al remitente con los archivos modificados como archivos adjuntos.

Para agregar mediante programación un extremo de correo electrónico a un servicio, considere el siguiente proceso de corta duración denominado MyApplication\EncryptDocument. Para obtener información acerca de los procesos de corta duración, vea Explicación de los procesos de AEM Forms.

ae_ae_encryptdocumentprocess

Este proceso acepta un documento de PDF no protegido como valor de entrada y, a continuación, pasa el documento de PDF no protegido a la operación EncryptPDFUsingPassword del servicio Encryption. Este proceso cifra el documento de PDF con una contraseña y devuelve el documento de PDF cifrado con contraseña como valor de salida. El nombre del valor de entrada (el documento de PDF no protegido) es InDoc y el tipo de datos es com.adobe.idp.Document. El nombre del valor de salida (el documento de PDF cifrado con contraseña) es SecuredDoc y el tipo de datos es com.adobe.idp.Document.

NOTE

No puede agregar un extremo de correo electrónico mediante los servicios web.

Resumen de los pasos summary_of_steps-3

Para agregar un extremo de correo electrónico a un servicio, realice las siguientes tareas:

Incluir archivos de proyecto.
Crear un objeto EndpointRegistryClient.
Definir atributos de extremo de correo electrónico.
Especifique los valores de configuración.
Defina los valores de parámetros de entrada.
Defina un valor de parámetro de salida.
Cree el extremo de correo electrónico.
Habilite el extremo.

Incluir archivos de proyecto

Los siguientes archivos JAR deben agregarse a la ruta de clase del proyecto:

adobe-livecycle-client.jar
adobe-usermanager-client.jar
adobe-utilities.jar (requerido si AEM Forms está implementado en el servidor de aplicaciones JBoss)
jbossall-client.jar (requerido si AEM Forms está implementado en el servidor de aplicaciones JBoss)

Para obtener información sobre la ubicación de estos archivos JAR, consulte Inclusión de archivos de biblioteca Java de AEM Forms.

Crear un objeto cliente EndpointRegistry

Para poder agregar mediante programación un extremo de correo electrónico, debe crear un objeto EndpointRegistryClient.

Establecer atributos de extremo de correo electrónico

Para crear un extremo de correo electrónico para un servicio, especifique los siguientes valores:

Valor del identificador del conector: Especifica el tipo de extremo que se crea. Para crear un extremo de correo electrónico, especifique Email.
Descripción: especifica una descripción para el extremo.
Nombre: especifica el nombre del extremo.
Valor del identificador de servicio: Especifica el servicio al que pertenece el extremo. Por ejemplo, para agregar un extremo de correo electrónico al proceso introducido en esta sección (un proceso se convierte en servicio cuando se activa mediante Workbench), especifique EncryptDocument.
Nombre de operación: especifica el nombre de la operación que se invoca mediante el extremo. Normalmente, al crear un extremo de correo electrónico para un servicio originado a partir de un proceso creado en Workbench, el nombre de la operación es invoke.

Especificar valores de configuración

Especifique valores de configuración para un extremo de correo electrónico al agregar mediante programación un extremo de correo electrónico a un servicio. Estos valores de configuración los especifica un administrador si se agrega un extremo de correo electrónico mediante la consola de administración.

NOTE

La cuenta de correo electrónico monitorizada es una cuenta especial que solo se utiliza para el punto final de correo electrónico. Esta cuenta no es una cuenta de correo electrónico de un usuario normal. La cuenta de correo electrónico de un usuario normal no debe configurarse como la cuenta que utiliza el proveedor de correo electrónico, ya que este elimina los mensajes de correo electrónico de la bandeja de entrada una vez que ha finalizado con ellos.

Los siguientes valores de configuración se establecen al agregar mediante programación un extremo de correo electrónico a un servicio:

cronExpression: una expresión cron si el correo electrónico debe programarse mediante una expresión cron.
repeatCount: número de veces que el extremo de correo electrónico analiza la carpeta o el directorio. El valor -1 indica un escaneo indefinido. El valor predeterminado es -1.
repeatInterval: Velocidad de análisis en segundos que usa el receptor para comprobar el correo entrante. El valor predeterminado es 10.
startDelay: tiempo de espera para analizar después de que se inicie el planificador. La hora predeterminada es 0.
batchSize: Número de mensajes de correo electrónico que el receptor procesa por análisis para obtener un rendimiento óptimo. El valor -1 indica todos los correos electrónicos. El valor predeterminado es 2.
userName: nombre de usuario utilizado al invocar un servicio de destino desde el correo electrónico. El valor predeterminado es SuperAdmin.
domainName: un valor de configuración obligatorio. El valor predeterminado es DefaultDom.
domainPattern: Especifica los patrones de dominio del correo electrónico entrante que acepta el proveedor. Por ejemplo, si se usa adobe.com, solo se procesa el correo electrónico de adobe.com y se omite el correo electrónico de otros dominios.
filePattern: especifica los patrones de archivos adjuntos entrantes que acepta el proveedor. Esto incluye archivos que tienen extensiones de nombre de archivo específicas (*.dat, *.xml), archivos que tienen nombres específicos (data) y archivos que tienen expresiones compuestas en el nombre y la extensión (*).[dD][aA]'port'). El valor predeterminado es *.
recipientSuccessfulJob: dirección de correo electrónico a la que se envían mensajes para indicar que los trabajos se han realizado correctamente. De forma predeterminada, siempre se envía un mensaje de trabajo correcto al remitente. Si escribe sender, los resultados del correo electrónico se envían al remitente. Se admiten hasta 100 destinatarios. Especifique destinatarios adicionales con direcciones de correo electrónico, cada uno separado por una coma. Para desactivar esta opción, deje este valor en blanco. En algunos casos, es posible que desee almacenar en déclencheur un proceso y no desee recibir una notificación del resultado por correo electrónico. El valor predeterminado es sender.
recipientFailedJob: dirección de correo electrónico a la que se envían mensajes para indicar trabajos con errores. De forma predeterminada, siempre se envía un mensaje de trabajo con errores al remitente. Si escribe sender, los resultados del correo electrónico se envían al remitente. Se admiten hasta 100 destinatarios. Especifique destinatarios adicionales con direcciones de correo electrónico, cada uno separado por una coma. Para desactivar esta opción, deje este valor en blanco. El valor predeterminado es sender.
inboxHost: El nombre de host de la bandeja de entrada o la dirección IP para que el proveedor de correo electrónico analice.
inboxPort: el puerto que usa el servidor de correo electrónico. El valor predeterminado de POP3 es 110 y el de IMAP es 143. Si SSL está habilitado, el valor predeterminado para POP3 es 995 y para IMAP es 993.
inboxProtocol: Protocolo de correo electrónico que el extremo de correo electrónico debe usar para analizar la bandeja de entrada. Las opciones son IMAP o POP3. El servidor de correo host de bandeja de entrada debe admitir estos protocolos.
inboxTimeOut: tiempo de espera en segundos para que el proveedor de correo electrónico espere las respuestas de la bandeja de entrada. El valor predeterminado es 60.
inboxUser: El nombre de usuario necesario para iniciar sesión en la cuenta de correo electrónico. Según el servidor de correo electrónico y la configuración, puede que solo sea la parte del nombre de usuario del correo electrónico o puede ser la dirección de correo electrónico completa.
inboxPassword: La contraseña del usuario de la bandeja de entrada.
inboxSSLEnabled: establezca este valor para forzar al proveedor de correo electrónico a utilizar SSL al enviar mensajes de notificación de resultados o errores. Asegúrese de que el host IMAP o POP3 admita SSL.
smtpHost: El nombre de host del servidor de correo al que el proveedor de correo electrónico envía los resultados y los mensajes de error.
smtpPort: el valor predeterminado del puerto SMTP es 25.
smtpUser: La cuenta de usuario que el proveedor de correo electrónico debe usar cuando envíe notificaciones por correo electrónico de resultados y errores.
smtpPassword: La contraseña de la cuenta SMTP. Algunos servidores de correo no requieren una contraseña SMTP.
charSet: conjunto de caracteres utilizado por el proveedor de correo electrónico. El valor predeterminado es UTF-8.
smtpSSLEnabled: establezca este valor para forzar al proveedor de correo electrónico a utilizar SSL al enviar mensajes de notificación de resultados o errores. Asegúrese de que el host SMTP admita SSL.
failedJobFolder: Especifica un directorio en el que almacenar los resultados cuando el servidor de correo SMTP no está operativo.
asincrónico: cuando se establece en sincrónico, se procesan todos los documentos de entrada y se devuelve una sola respuesta. Cuando se establece en asíncrono, se envía una respuesta para cada documento de entrada que se procesa. Por ejemplo, se crea un extremo de correo electrónico para el proceso que se describe en este tema y se envía un mensaje de correo electrónico a la bandeja de entrada del extremo que contiene varios documentos de PDF no protegidos. Cuando todos los documentos del PDF se cifran con una contraseña y el punto de conexión se configura como sincrónico, se envía un único mensaje de correo electrónico de respuesta con todos los documentos del PDF protegidos adjuntos. Si el extremo está configurado como asincrónico, se envía un mensaje de correo electrónico de respuesta independiente para cada documento de PDF protegido. Cada mensaje de correo electrónico contiene un solo documento de PDF como datos adjuntos. El valor predeterminado es asíncrono.

Definir valores de parámetros de entrada

Al crear un extremo de correo electrónico, debe definir los valores de parámetros de entrada. Es decir, debe describir los valores de entrada que se pasan a la operación que invoca el extremo de correo electrónico. Por ejemplo, considere el proceso introducido en este tema. Tiene un valor de entrada denominado InDoc y su tipo de datos es com.adobe.idp.Document. Al crear un extremo de correo electrónico para este proceso (una vez activado un proceso, se convierte en un servicio), debe definir el valor del parámetro de entrada.

Para definir los valores de parámetro de entrada necesarios para un extremo de correo electrónico, especifique los siguientes valores:

Nombre del parámetro de entrada: El nombre del parámetro de entrada. El nombre de un valor de entrada se especifica en Workbench para un proceso. Si el valor de entrada pertenece a una operación de servicio (un servicio de Forms que no es un proceso creado en Workbench), el nombre de entrada se especifica en el archivo component.xml. Por ejemplo, el nombre del parámetro de entrada para el proceso introducido en esta sección es InDoc.

Tipo de asignación: se usa para configurar los valores de entrada necesarios para invocar la operación de servicio. A continuación se indican dos tipos de asignación:

Literal: el extremo de correo electrónico utiliza el valor introducido en el campo tal como se muestra. Se admiten todos los tipos básicos de Java. Por ejemplo, si una API utiliza entradas como String, long, int y Boolean, la cadena se convierte al tipo adecuado y se invoca el servicio.
Variable: el valor introducido es un patrón de archivo que el extremo de correo electrónico utiliza para elegir la entrada. Por ejemplo, si selecciona Variable para el tipo de asignación y el documento de entrada debe ser un archivo de PDF, puede especificar *.pdf como valor de asignación.

Valor de asignación: especifica el valor del tipo de asignación. Por ejemplo, si selecciona un tipo de asignación Variable, puede especificar *.pdf como patrón de archivo.

Tipo de datos: Especifica el tipo de datos de los valores de entrada. Por ejemplo, el tipo de datos del valor de entrada del proceso introducido en esta sección es com.adobe.idp.Document.

Definir un valor de parámetro de salida

Al crear un extremo de correo electrónico, debe definir un valor de parámetro de salida. Es decir, debe describir el valor de salida que devuelve el servicio que invoca el extremo de correo electrónico. Por ejemplo, considere el proceso introducido en este tema. Tiene un valor de salida denominado SecuredDoc y su tipo de datos es com.adobe.idp.Document. Al crear un extremo de correo electrónico para este proceso (una vez activado un proceso, se convierte en un servicio), debe definir el valor del parámetro de salida.

Para definir un valor de parámetro de salida necesario para un extremo de correo electrónico, especifique los siguientes valores:

Tipo de asignación: se usa para configurar la salida del servicio y la operación. Las opciones disponibles son las siguientes:

Si el servicio devuelve un solo objeto (un solo documento), el patrón es %F.pdf y el destino de origen es sourcefilename.pdf. Por ejemplo, el proceso introducido en esta sección devuelve un solo documento. Como resultado, el tipo de asignación puede definirse como %F.pdf ( %F significa que debe usar el nombre de archivo dado). El patrón %E especifica la extensión del documento de entrada.
Si el servicio devuelve una lista, el patrón es Result\%F\ y el destino de origen es Result\sourcefilename\source1 (salida 1) y Result\sourcefilename\source2 (salida 2).
Si el servicio devuelve un mapa, el patrón es Result\%F\ y el destino de origen es Result\sourcefilename\file1 y Result\sourcefilename\file2. Si la asignación tiene más de un objeto, el patrón es Result\%F.pdf y el destino de origen es Result\sourcefilename1.pdf (salida 1), Result\sourcefilenam2.pdf (salida 2), etc.

Tipo de datos: Especifica el tipo de datos del valor devuelto. Por ejemplo, el tipo de datos del valor devuelto del proceso introducido en esta sección es com.adobe.idp.Document.

Crear el extremo de correo electrónico

Después de establecer los atributos de punto de conexión de correo electrónico y los valores de configuración, y definir los valores de parámetros de entrada y salida, debe crear el punto de conexión de correo electrónico.

Habilitar el extremo

Después de crear un extremo de correo electrónico, debe habilitarlo. Cuando el punto de conexión está habilitado, se puede utilizar para invocar el servicio. Después de habilitar el punto de conexión, puede verlo en la consola de administración.

Consulte también

Añadir un extremo de correo electrónico mediante la API de Java add-an-email-endpoint-using-the-java-api

Añadir un extremo de correo electrónico mediante la API de Java:

Incluir archivos de proyecto.

Incluya archivos JAR de cliente, como adobe-livecycle-client.jar, en la ruta de clase del proyecto Java.
Cree un objeto EndpointRegistry Client.
- Cree un objeto ServiceClientFactory que contenga propiedades de conexión.
- Cree un objeto EndpointRegistryClient utilizando su constructor y pasando el objeto ServiceClientFactory.
Definir atributos de extremo de correo electrónico.
- Crear un objeto CreateEndpointInfo mediante su constructor.
- Especifique el valor del identificador del conector invocando el método setConnectorId del objeto CreateEndpointInfo y pasando el valor de cadena Email.
- Especifique la descripción del extremo invocando el método setDescription del objeto CreateEndpointInfo y pasando un valor de cadena que describe el extremo.
- Especifique el nombre del extremo invocando el método setName del objeto CreateEndpointInfo y pasando un valor de cadena que especifique el nombre.
- Especifique el servicio al que pertenece el extremo invocando el método setServiceId del objeto CreateEndpointInfo y pasando un valor de cadena que especifica el nombre del servicio.
- Especifique la operación que se invoca invocando el método setOperationName del objeto CreateEndpointInfo y pasando un valor de cadena que especifica el nombre de la operación. Normalmente, al crear un extremo de correo electrónico para un servicio originado a partir de un proceso creado en Workbench, se invoca el nombre de la operación.

Especifique los valores de configuración.

Para que cada valor de configuración se establezca para el extremo de correo electrónico, debe invocar el método setConfigParameterAsText del objeto CreateEndpointInfo. Por ejemplo, para establecer el valor de configuración smtpHost, invoque el método setConfigParameterAsText del objeto CreateEndpointInfo y pase los siguientes valores:

Un valor de cadena que especifica el nombre del valor de configuración. Al establecer el valor de configuración smtpHost, especifique smtpHost.
Un valor de cadena que especifica el valor del valor de configuración. Al establecer el valor de configuración smtpHost, especifique un valor de cadena que especifique el nombre del servidor SMTP.

note note
NOTE
Para ver todos los valores de configuración establecidos para el servicio EncryptDocument introducidos en esta sección, vea el ejemplo de código Java ubicado en QuickStart: Agregar un extremo de correo electrónico mediante la API de Java.

Defina los valores de parámetros de entrada.

Defina un valor de parámetro de entrada invocando el método setInputParameterMapping del objeto CreateEndpointInfo y pase los siguientes valores:

Valor de cadena que especifica el nombre del parámetro de entrada. Por ejemplo, el nombre del parámetro de entrada para el servicio EncryptDocument es InDoc.
Valor de cadena que especifica el tipo de datos del parámetro de entrada. Por ejemplo, el tipo de datos del parámetro de entrada InDoc es com.adobe.idp.Document.
Valor de cadena que especifica el tipo de asignación. Por ejemplo, puede especificar variable.
Valor de cadena que especifica el valor del tipo de asignación. Por ejemplo, puede especificar *.pdf como patrón de archivo.

note note
NOTE
Invoque el método `setInputParameterMapping` para cada valor de parámetro de entrada que desee definir. Dado que el proceso EncryptDocument sólo tiene un parámetro de entrada, es necesario invocar este método una vez.

Defina un valor de parámetro de salida.

Defina un valor de parámetro de salida invocando el método setOutputParameterMapping del objeto CreateEndpointInfo y pasando los siguientes valores:
- Valor de cadena que especifica el nombre del parámetro de salida. Por ejemplo, el nombre del parámetro de salida para el servicio EncryptDocument es SecuredDoc.
- Valor de cadena que especifica el tipo de datos del parámetro de salida. Por ejemplo, el tipo de datos del parámetro de salida SecuredDoc es com.adobe.idp.Document.
- Valor de cadena que especifica el tipo de asignación. Por ejemplo, puede especificar %F.pdf.
Cree el extremo de correo electrónico.

Cree el extremo invocando el método createEndpoint del objeto EndpointRegistryClient y pasando el objeto CreateEndpointInfo. Este método devuelve un objeto Endpoint que representa el extremo de correo electrónico.
Habilite el extremo.

Habilite el extremo invocando el método enable del objeto EndpointRegistryClient y pasando el objeto Endpoint devuelto por el método createEndpoint.

Consulte también

Inicio rápido: Agregar un punto final de carpeta inspeccionada mediante la API de Java

Agregar un extremo remoto mediante la API de Java

Archivo constante de valores de configuración de correo electrónico email-configuration-values-constant-file

QuickStart: al agregar un extremo de correo electrónico mediante la API de Java, se usa un archivo constante que debe formar parte del proyecto Java para compilar el inicio rápido. Este archivo constante representa los valores de configuración que deben establecerse al agregar un extremo de correo electrónico. El siguiente código Java representa el archivo constante.

 /**
     * This class contains constants that can be used when setting email endpoint
     * configuration values
     */
 public class EmailEndpointConfigConstants {

     public static final String PROPERTY_EMAILPROVIDER_CRON_EXPRESSION = "cronExpression";
     public static final String PROPERTY_EMAILPROVIDER_REPREAT_COUNT = "repeatCount";
     public static final String PROPERTY_EMAILPROVIDER_REPREAT_INTERVAL = "repeatInterval";
     public static final String PROPERTY_EMAILPROVIDER_START_DELAY = "startDelay";
     public static final String PROPERTY_EMAILPROVIDER_BATCH_SIZE = "batchSize";
     public static final String PROPERTY_EMAILPROVIDER_USERNAME = "userName";
     public static final String PROPERTY_EMAILPROVIDER_DOMAINNAME = "domainName";
     public static final String PROPERTY_EMAILPROVIDER_DOMAINPATTERN = "domainPattern";
     public static final String PROPERTY_EMAILPROVIDER_FILEPATTERN = "filePattern";
     public static final String PROPERTY_EMAILPROVIDER_RECIPIENT_SUCCESSFUL_JOB = "recipientSuccessfulJob";
     public static final String PROPERTY_EMAILPROVIDER_RECIPIENT_FAILED_JOB = "recipientFailedJob";
     public static final String PROPERTY_EMAILPROVIDER_INBOX_HOST = "inboxHost";
     public static final String PROPERTY_EMAILPROVIDER_INBOX_PORT = "inboxPort";
     public static final String PROPERTY_EMAILPROVIDER_PROTOCOL = "inboxProtocol";
     public static final String PROPERTY_EMAILPROVIDER_INBOX_TIMEOUT = "inboxTimeOut";
     public static final String PROPERTY_EMAILPROVIDER_INBOX_USER = "inboxUser";
     public static final String PROPERTY_EMAILPROVIDER_INBOX_PASSWORD = "inboxPassword";
     public static final String PROPERTY_EMAILPROVIDER_INBOX_SSL = "inboxSSLEnabled";
     public static final String PROPERTY_EMAILPROVIDER_SMTP_HOST = "smtpHost";
     public static final String PROPERTY_EMAILPROVIDER_SMTP_PORT = "smtpPort";
     public static final String PROPERTY_EMAILPROVIDER_SMTP_USER = "smtpUser";
     public static final String PROPERTY_EMAILPROVIDER_SMTP_PASSWORD = "smtpPassword";
     public static final String PROPERTY_EMAILPROVIDER_CHARSET = "charSet";
     public static final String PROPERTY_EMAILPROVIDER_SMTP_SSL = "smtpSSLEnabled";
     public static final String PROPERTY_EMAILPROVIDER_FAILED_FOLDER = "failedJobFolder";
     public static final String PROPERTY_EMAILPROVIDER_ASYNCHRONOUS = "asynchronous";
 }

Agregar extremos remotos adding-remoting-endpoints

NOTE

Las API de LiveCycle Remoting AEM están en desuso para los formularios de en JEE.

Puede agregar mediante programación un extremo de Remoting a un servicio mediante la API de Java de AEM Forms. Al agregar un extremo de Remoting, habilita una aplicación de Flex para invocar el servicio mediante Remoting. (Consulte Invocación de AEM Forms AEM mediante (obsoleto para formularios en forma de) AEM Forms Remoting).

Para agregar mediante programación un extremo de Remoting a un servicio, considere el siguiente proceso de corta duración denominado EncryptDocument.

ar_ar_encryptdocumentprocess

Para mostrar cómo agregar un extremo de Remoting a un servicio, esta sección agrega un extremo de Remoting a un servicio denominado EncryptDocument.

NOTE

No se puede agregar un extremo de Remoting mediante los servicios Web.

Resumen de los pasos summary_of_steps-4

Para quitar un extremo de un servicio, realice las siguientes tareas:

Incluir archivos de proyecto.
Crear un objeto EndpointRegistryClient.
Establecer atributos de extremo remoto.
Cree un extremo remoto.
Habilite el extremo.

Incluir archivos de proyecto

Los siguientes archivos JAR deben agregarse a la ruta de clase del proyecto:

adobe-livecycle-client.jar
adobe-usermanager-client.jar
adobe-utilities.jar (requerido si AEM Forms está implementado en el servidor de aplicaciones JBoss)
jbossall-client.jar (requerido si AEM Forms está implementado en el servidor de aplicaciones JBoss)

Para obtener información sobre la ubicación de estos archivos JAR, consulte Inclusión de archivos de biblioteca Java de AEM Forms.

Crear un objeto cliente EndpointRegistry

Para agregar mediante programación un extremo Remoting, debe crear un objeto EndpointRegistryClient.

Establecer atributos de extremo remoto

Para crear un extremo remoto para un servicio, especifique los siguientes valores:

Valor del identificador del conector: Especifica el tipo de extremo que se crea. Para crear un extremo remoto, especifique Remoting.
Descripción: especifica la descripción del extremo.
Nombre: especifica el nombre del extremo.
Valor del identificador de servicio: Especifica el servicio al que pertenece el extremo. Por ejemplo, para agregar un extremo remoto al proceso introducido en esta sección (un proceso se convierte en un servicio cuando se activa en Workbench), especifique EncryptDocument.
Nombre de operación: especifica el nombre de la operación que se invoca mediante el extremo. Al crear un extremo Remoting, especifique un carácter comodín (*).

Crear un extremo remoto

Después de establecer los atributos de extremo remoto, puede crear un extremo remoto para un servicio.

Habilitar el extremo

Después de crear un extremo, debe habilitarlo. Cuando se habilita un extremo de Remoting, permite a un cliente de Flex invocar el servicio.

Consulte también

Agregar un extremo remoto mediante la API de Java add-a-remoting-endpoint-using-the-java-api

Agregar un extremo remoto mediante la API de Java:

Incluir archivos de proyecto.

Incluya archivos JAR de cliente, como adobe-livecycle-client.jar, en la ruta de clase del proyecto Java.
Cree un objeto EndpointRegistry Client.
- Cree un objeto ServiceClientFactory que contenga propiedades de conexión.
- Cree un objeto EndpointRegistryClient utilizando su constructor y pasando el objeto ServiceClientFactory.
Establecer atributos de extremo remoto.
- Crear un objeto CreateEndpointInfo mediante su constructor.
- Especifique el valor del identificador del conector invocando el método setConnectorId del objeto CreateEndpointInfo y pasando el valor de cadena Remoting.
- Especifique la descripción del extremo invocando el método setDescription del objeto CreateEndpointInfo y pasando un valor de cadena que describe el extremo.
- Especifique el nombre del extremo invocando el método setName del objeto CreateEndpointInfo y pasando un valor de cadena que especifique el nombre.
- Especifique el servicio al que pertenece el extremo invocando el método setServiceId del objeto CreateEndpointInfo y pasando un valor de cadena que especifica el nombre del servicio.
- Especifique la operación que invoca el método setOperationName del objeto CreateEndpointInfo y pase un valor de cadena que especifique el nombre de la operación. Para un extremo Remoting, especifique un carácter comodín (*).
Cree un extremo remoto.

Cree el extremo invocando el método createEndpoint del objeto EndpointRegistryClient y pasando el objeto CreateEndpointInfo. Este método devuelve un objeto Endpoint que representa el nuevo extremo remoto.
Habilite el extremo.

Habilite el extremo invocando el método enable del objeto EndpointRegistryClient y pasando el objeto Endpoint devuelto por el método createEndpoint.

Consulte también

Inicio rápido: Agregar un extremo remoto mediante la API de Java

Agregar un extremo de TaskManager mediante la API de Java

Agregar extremos de TaskManager adding-taskmanager-endpoints

Puede agregar mediante programación un extremo de TaskManager a un servicio mediante la API de Java de AEM Forms. Al agregar un extremo de TaskManager a un servicio, habilita a un usuario de Workspace para que invoque el servicio. Es decir, un usuario que trabaje en Workspace puede invocar un proceso que tenga un punto final de TaskManager correspondiente.

NOTE

No se puede agregar un extremo de TaskManager mediante los servicios web.

Resumen de los pasos summary_of_steps-5

Para agregar un extremo de TaskManager a un servicio, realice las siguientes tareas:

Incluir archivos de proyecto.
Crear un objeto EndpointRegistryClient.
Cree una categoría para el extremo.
Establecer atributos de extremo de TaskManager.
Cree un extremo de TaskManager.
Habilite el extremo.

Incluir archivos de proyecto

Los siguientes archivos JAR deben agregarse a la ruta de clase del proyecto:

adobe-livecycle-client.jar
adobe-usermanager-client.jar
adobe-utilities.jar (requerido si AEM Forms está implementado en el servidor de aplicaciones JBoss)
jbossall-client.jar (requerido si AEM Forms está implementado en el servidor de aplicaciones JBoss)

Para obtener información sobre la ubicación de estos archivos JAR, consulte Inclusión de archivos de biblioteca Java de AEM Forms.

Crear un objeto cliente EndpointRegistry

Para poder agregar mediante programación un extremo de TaskManager, debe crear un objeto EndpointRegistryClient.

Crear una categoría para el extremo

Las categorías se utilizan para organizar los servicios en Workspace. Es decir, un usuario de Workspace puede invocar un servicio que tiene un extremo de TaskManager seleccionando una categoría dentro de Workspace. Al crear un extremo de TaskManager, puede hacer referencia a una categoría existente o crear una categoría mediante programación.

NOTE

Esta sección crea una nueva categoría como parte de la adición de un extremo de TaskManager a un servicio.

Establecer atributos de extremo de TaskManager

Para crear un extremo de TaskManager para un servicio, especifique los siguientes valores:

Identificador de conector: especifica el tipo de extremo que se crea. Para crear un extremo de TaskManager, especifique TaskManagerConnector.
Descripción: especifica la descripción del extremo.
Nombre: especifica el nombre del extremo.
Identificador de servicio: Especifica el servicio al que pertenece el extremo.
Categoría: especifica un valor de identificador de categoría asociado al extremo de TaskManager.
Nombre de operación: normalmente, cuando se crea un extremo de TaskManager para un servicio que se originó a partir de un proceso creado en Workbench, el nombre de la operación es invoke.

Crear un extremo de TaskManager

Después de establecer los atributos de extremo de TaskManager, puede crear un extremo de TaskManager para un servicio.

Habilitar el extremo

Después de crear un extremo, debe habilitarlo. Cuando el punto de conexión está habilitado, se puede utilizar para invocar el servicio desde Workspace. Después de habilitar el punto de conexión, puede verlo en la consola de administración.

Consulte también

Agregar un extremo de TaskManager mediante la API de Java add-a-taskmanager-endpoint-using-the-java-api

Agregar un extremo de TaskManager mediante la API de Java:

Incluir archivos de proyecto.

Incluya archivos JAR de cliente, como adobe-livecycle-client.jar, en la ruta de clase del proyecto Java.
Cree un objeto EndpointRegistry Client.
- Cree un objeto ServiceClientFactory que contenga propiedades de conexión.
- Cree un objeto EndpointRegistryClient utilizando su constructor y pasando el objeto ServiceClientFactory.
Cree una categoría para el extremo.
- Cree un objeto CreateEndpointCategoryInfo utilizando su constructor y pasando los siguientes valores:
  - Un valor de cadena que especifica el valor de identificador de la categoría
  - Valor de cadena que especifica la descripción de la categoría
- Cree la categoría invocando el método createEndpointCategory del objeto EndpointRegistryClient y pasando el objeto CreateEndpointCategoryInfo. Este método devuelve un objeto EndpointCategory que representa la nueva categoría.
Establecer atributos de extremo de TaskManager.
- Crear un objeto CreateEndpointInfo mediante su constructor.
- Especifique el valor del identificador del conector invocando el método setConnectorId del objeto CreateEndpointInfo y pasando el valor de cadena TaskManagerConnector.
- Especifique la descripción del extremo invocando el método setDescription del objeto CreateEndpointInfo y pasando un valor de cadena que describe el extremo.
- Especifique el nombre del extremo invocando el método setName del objeto CreateEndpointInfo y pasando un valor de cadena que especifique el nombre.
- Especifique el servicio al que pertenece el extremo invocando el método setServiceId del objeto CreateEndpointInfo y pasando un valor de cadena que especifica el nombre del servicio.
- Especifique la categoría a la que pertenece el extremo invocando el método setCategoryId del objeto CreateEndpointInfo y pasando un valor de cadena que especifica el valor del identificador de categoría. Puede invocar el método getId del objeto EndpointCategory para obtener el valor del identificador de esta categoría.
- Especifique la operación que se invoca invocando el método setOperationName del objeto CreateEndpointInfo y pasando un valor de cadena que especifica el nombre de la operación. Normalmente, cuando se crea un extremo TaskManager para un servicio que se originó a partir de un proceso creado en Workbench, el nombre de la operación es invoke.
Cree un extremo de TaskManager.

Cree el extremo invocando el método createEndpoint del objeto EndpointRegistryClient y pasando el objeto CreateEndpointInfo. Este método devuelve un objeto Endpoint que representa el nuevo extremo de TaskManager.
Habilite el extremo.

Habilite el extremo invocando el método enable del objeto EndpointRegistryClient y pasando el objeto Endpoint devuelto por el método createEndpoint.

Consulte también

Inicio rápido: Agregar un punto final de TaskManager mediante la API de Java

Modificación de un extremo mediante la API de Java

Modificación de puntos finales modifying-endpoints

Puede modificar mediante programación un extremo existente mediante la API de Java de AEM Forms. Al modificar un extremo, puede cambiar el comportamiento del extremo. Considere, por ejemplo, un punto final de carpeta inspeccionada que especifique una carpeta que se utilice como carpeta inspeccionada. Puede modificar mediante programación los valores de configuración que pertenecen al punto final de la carpeta inspeccionada, lo que da como resultado que otra carpeta funcione como carpeta inspeccionada. Para obtener información sobre los valores de configuración que pertenecen a un extremo de carpeta inspeccionada, consulte Agregar extremos de carpeta inspeccionada.

Para mostrar cómo modificar un extremo, esta sección modifica un extremo de carpeta inspeccionada al cambiar la carpeta que se comporta como la carpeta inspeccionada.

NOTE

No se puede modificar un extremo mediante los servicios web.

Resumen de los pasos summary_of_steps-6

Para modificar un extremo, realice las siguientes tareas:

Incluir archivos de proyecto.
Crear un objeto EndpointRegistryClient.
Recupere el punto final.
Especifique nuevos valores de configuración.

Incluir archivos de proyecto

Los siguientes archivos JAR deben agregarse a la ruta de clase del proyecto:

adobe-livecycle-client.jar
adobe-usermanager-client.jar
adobe-utilities.jar (requerido si AEM Forms está implementado en el servidor de aplicaciones JBoss)
jbossall-client.jar (requerido si AEM Forms está implementado en el servidor de aplicaciones JBoss)

Para obtener información sobre la ubicación de estos archivos JAR, consulte Inclusión de archivos de biblioteca Java de AEM Forms.

Crear un objeto cliente EndpointRegistry

Para modificar un extremo mediante programación, debe crear un objeto EndpointRegistryClient.

Recupere el extremo que desea modificar

Para poder modificar un extremo, debe recuperarlo. Para recuperar un extremo, debe conectarse como un usuario que puede acceder a un extremo. Se recomienda que se conecte como administrador. (Consulte Establecimiento de propiedades de conexión).

Puede recuperar un extremo recuperando una lista de extremos. A continuación, puede iterar por la lista buscando el extremo específico que desea quitar. Por ejemplo, puede localizar un extremo determinando el servicio que corresponde al extremo y el tipo de extremo. Cuando encuentre el punto de conexión, podrá modificarlo.

Especificar nuevos valores de configuración

Al modificar un punto de conexión, especifique nuevos valores de configuración. Por ejemplo, para modificar un punto final de carpeta inspeccionada, restablezca todos los valores de configuración de punto final de carpeta inspeccionada, no solo los que desee modificar. Para obtener información sobre los valores de configuración que pertenecen a un extremo de carpeta inspeccionada, consulte Agregar extremos de carpeta inspeccionada.

NOTE

Para obtener información sobre los valores de configuración que pertenecen a un extremo de correo electrónico, consulte Agregar extremos de correo electrónico.

NOTE

No puede modificar el servicio que invoca el extremo. Si intenta modificar el servicio, se generará una excepción. Para modificar el servicio asociado a un extremo determinado, elimine el extremo y cree uno. (Consulte Eliminación de extremos.)

Consulte también

Modificación de un extremo mediante la API de Java modifying-an-endpoint-using-the-java-api

Modifique un extremo mediante la API de Java:

Incluir archivos de proyecto.

Incluya archivos JAR de cliente, como adobe-livecycle-client.jar, en la ruta de clase del proyecto Java.
Cree un objeto EndpointRegistry Client.
- Cree un objeto ServiceClientFactory que contenga propiedades de conexión.
- Cree un objeto EndpointRegistryClient utilizando su constructor y pasando el objeto ServiceClientFactory.
Recupere el extremo que desea modificar.
- Recupere una lista de todos los extremos a los que puede tener acceso el usuario actual (especificado en las propiedades de conexión) invocando el método getEndpoints del objeto EndpointRegistryClient y pasando un objeto PagingFilter que actúa como filtro. Puede pasar un valor (PagingFilter)null para que devuelva todos los extremos. Este método devuelve un objeto java.util.List donde cada elemento es un objeto Endpoint. Para obtener información acerca de un objeto PagingFilter, vea Referencia de la API de AEM Forms.
- Recorra en iteración el objeto java.util.List para determinar si tiene puntos finales. Si existen extremos, cada elemento es una instancia de EndPoint.
- Determine el servicio que corresponde a un extremo invocando el método getServiceId del objeto EndPoint. Este método devuelve un valor de cadena que especifica el nombre del servicio.
- Determine el tipo de extremo invocando el método getConnectorId del objeto EndPoint. Este método devuelve un valor de cadena que especifica el tipo de extremo. Por ejemplo, si el extremo es un extremo de carpeta inspeccionada, este método devuelve WatchedFolder.
Especifique nuevos valores de configuración.
- Cree un objeto ModifyEndpointInfo invocando su constructor.
- Para que se establezca cada valor de configuración, invoque el método setConfigParameterAsText del objeto ModifyEndpointInfo. Por ejemplo, para establecer el valor de configuración de la dirección URL, invoque el método setConfigParameterAsText del objeto ModifyEndpointInfo y pase los valores siguientes:
  - Un valor de cadena que especifica el nombre del valor de configuración. Por ejemplo, para establecer el valor de configuración url, especifique url.
  - Un valor de cadena que especifica el valor del valor de configuración. Para definir un valor para el valor de configuración url, especifique la ubicación de la carpeta vigilada.
- Invoque el método modifyEndpoint del objeto EndpointRegistryClient y pase el objeto ModifyEndpointInfo.

Consulte también

Inicio rápido: Modificación de un punto final mediante la API de Java

Eliminación de un extremo mediante la API de Java

Eliminación de extremos removing-endpoints

Puede quitar un extremo de un servicio mediante programación utilizando la API de Java de AEM Forms. Después de quitar un extremo, el servicio no se puede invocar mediante el método de invocación que habilita el extremo. SOAP SOAP Por ejemplo, si quita un extremo de la de un servicio, no puede invocarlo mediante el modo de.

Para mostrar cómo quitar un extremo de un servicio, esta sección quita un extremo EJB de un servicio denominado EncryptDocument.

NOTE

No se puede quitar un extremo mediante los servicios web.

Resumen de los pasos summary_of_steps-7

Para quitar un extremo de un servicio, realice las siguientes tareas:

Incluir archivos de proyecto.
Crear un objeto EndpointRegistryClient.
Recupere el punto final.
Elimine el punto final.

Incluir archivos de proyecto

Los siguientes archivos JAR deben agregarse a la ruta de clase del proyecto:

adobe-livecycle-client.jar
adobe-usermanager-client.jar
adobe-utilities.jar (requerido si AEM Forms está implementado en el servidor de aplicaciones JBoss)
jbossall-client.jar (requerido si AEM Forms está implementado en el servidor de aplicaciones JBoss)

Para obtener información sobre la ubicación de estos archivos JAR, consulte Inclusión de archivos de biblioteca Java de AEM Forms.

Crear un objeto cliente EndpointRegistry

Para quitar un extremo mediante programación, debe crear un objeto EndpointRegistryClient.

Recupere el extremo que desea eliminar

Para poder quitar un extremo, debe recuperarlo. Para recuperar un extremo, debe conectarse como un usuario que puede acceder a un extremo. Se recomienda que se conecte como administrador. (Consulte Establecimiento de propiedades de conexión).

Quitar extremo

Consulte también

Eliminación de un extremo mediante la API de Java removing-an-endpoint-using-the-java-api

Elimine un extremo mediante la API de Java:

Incluir archivos de proyecto.

Incluya archivos JAR de cliente, como adobe-livecycle-client.jar, en la ruta de clase del proyecto Java.
Cree un objeto EndpointRegistry Client.
- Cree un objeto ServiceClientFactory que contenga propiedades de conexión.
- Cree un objeto EndpointRegistryClient utilizando su constructor y pasando el objeto ServiceClientFactory.
Recupere el extremo que desea eliminar.
- Recupere una lista de todos los extremos a los que tiene acceso el usuario actual (especificado en las propiedades de conexión) invocando el método getEndpoints del objeto EndpointRegistryClient y pasando un objeto PagingFilter que actúa como filtro. Puede pasar (PagingFilter)null para que devuelva todos los extremos. Este método devuelve un objeto java.util.List donde cada elemento es un objeto Endpoint.
- Recorra en iteración el objeto java.util.List para determinar si tiene puntos finales. Si existen extremos, cada elemento es una instancia de EndPoint.
- Determine el servicio que corresponde a un extremo invocando el método getServiceId del objeto EndPoint. Este método devuelve un valor de cadena que especifica el nombre del servicio.
- Determine el tipo de extremo invocando el método getConnectorId del objeto EndPoint. Este método devuelve un valor de cadena que especifica el tipo de extremo. Por ejemplo, si el extremo es un extremo de EJB, este método devuelve EJB.
Elimine el punto final.

Quite el extremo invocando el método remove del objeto EndpointRegistryClient y pasando el objeto EndPoint que representa el extremo que se va a quitar.

Consulte también

Inicio rápido: Eliminación de un extremo mediante la API de Java

Recuperar información del conector de extremo mediante la API de Java

Recuperando información del conector de extremo retrieving-endpoint-connector-information

Puede recuperar información mediante programación sobre los conectores de extremos mediante la API de AEM Forms. Un conector permite que un extremo invoque un servicio mediante varios métodos de invocación. Por ejemplo, un conector de carpeta inspeccionada permite que un extremo invoque un servicio mediante carpetas inspeccionadas. Mediante la recuperación mediante programación de información acerca de los conectores de extremo, puede recuperar los valores de configuración asociados a un conector, como los valores de configuración necesarios y los opcionales.

Para demostrar cómo recuperar información sobre los conectores de extremo, esta sección recupera información sobre un conector de carpeta inspeccionada. (Consulte Agregar extremos de carpeta inspeccionada.)

NOTE

No se puede recuperar información sobre los extremos mediante los servicios web.

NOTE

En este tema se utiliza la API ConnectorRegistryClient para recuperar información acerca de conectores de extremo. (Consulte Referencia de la API de AEM Forms.)

Resumen de los pasos summary_of_steps-8

Para recuperar la información del conector de extremo, realice las siguientes tareas:

Incluir archivos de proyecto.
Crear un objeto ConnectorRegistryClient.
Especifique el tipo de conector.
Recupere los valores de configuración.

Incluir archivos de proyecto

Los siguientes archivos JAR deben agregarse a la ruta de clase del proyecto:

adobe-livecycle-client.jar
adobe-usermanager-client.jar
adobe-utilities.jar (requerido si AEM Forms está implementado en el servidor de aplicaciones JBoss)
jbossall-client.jar (requerido si AEM Forms está implementado en el servidor de aplicaciones JBoss)

Si AEM Forms se implementa en un servidor de aplicaciones J2EE compatible que no sea JBoss, sustituya adobe-utilities.jar y jbossall-client.jar por archivos JAR específicos del servidor de aplicaciones J2EE en el que AEM Forms está implementado. Para obtener información sobre la ubicación de todos los archivos JAR de AEM Forms, consulte Incluyendo los archivos de la biblioteca Java de AEM Forms.

Crear un objeto de cliente ConnectorRegistry

Para recuperar mediante programación la información del conector de extremo, cree un objeto ConnectorRegistryClient.

Especifique el tipo de conector

Especifique el tipo de conector desde el que desea recuperar la información. Existen los siguientes tipos de conectores:

EJB: habilita una aplicación cliente para invocar un servicio mediante el modo EJB.
SOAP SOAP : habilita una aplicación cliente para invocar un servicio mediante el modo de.
Carpeta inspeccionada: permite que las carpetas inspeccionadas invoquen un servicio.
Correo electrónico: permite que los mensajes de correo electrónico invoquen un servicio.
Remoting: habilita una aplicación cliente de Flex para invocar un servicio.
TaskManagerConnector: permite que un usuario de Workspace invoque un servicio desde Workspace.

Recuperar valores de configuración

Una vez especificado el tipo de conector, se puede recuperar información sobre el conector, como el valor de configuración admitido. Por ejemplo, para cualquier conector, puede determinar qué valores de configuración son necesarios y cuáles son opcionales.

Consulte también

Recuperar información del conector de extremo mediante la API de Java retrieve-endpoint-connector-information-using-the-java-api

Recupere información del conector de extremo mediante la API de Java:

Incluir archivos de proyecto.

Incluya archivos JAR de cliente, como adobe-livecycle-client.jar, en la ruta de clase del proyecto Java.
Cree un objeto ConnectorRegistry Client.
- Cree un objeto ServiceClientFactory que contenga propiedades de conexión.
- Cree un objeto ConnectorRegistryClient utilizando su constructor y pasando el objeto ServiceClientFactory.
Especifique el tipo de conector.

Especifique el tipo de conector invocando el método getEndpointDefinition del objeto ConnectorRegistryClient y pasando un valor de cadena que especifica el tipo de conector. Por ejemplo, para especificar el tipo de conector de la carpeta inspeccionada, pase el valor de cadena WatchedFolder. Este método devuelve un objeto Endpoint que corresponde al tipo de conector.
Recupere los valores de configuración.
- Recupere los valores de configuración asociados en este extremo invocando el método getConfigParameters del objeto Endpoint. Este método devuelve una matriz de ConfigParameter objetos.
- Recupere información sobre cada valor de configuración recuperando cada elemento dentro de la matriz. Cada elemento es un objeto ConfigParameter. Por ejemplo, puede determinar si el valor de configuración es obligatorio u opcional invocando el método isRequired del objeto ConfigParameter. Si el valor de configuración es necesario, este método devuelve true.

Consulte también

Inicio rápido: Recuperación de información del conector de extremo mediante la API de Java