Chamar o AEM Forms usando a API do Java

O AEM Forms pode ser chamado usando a API do AEM Forms Java. Ao usar a API Java do AEM Forms, você pode usar a API de chamada ou as bibliotecas de clientes Java. As bibliotecas de clientes Java estão disponíveis para serviços como o serviço Rights Management. Essas APIs altamente digitadas permitem desenvolver aplicativos Java que chamam o AEM Forms.

A API de invocação são classes localizadas no pacote com.adobe.idp.dsc. Usando essas classes, você pode enviar uma solicitação de invocação diretamente a um serviço e manipular uma resposta de invocação que é retornada. Use a API de invocação para invocar processos de duração curta ou longa que foram criados usando o Workbench.

A maneira recomendada de invocar programaticamente um serviço é usar uma biblioteca do cliente Java que corresponda ao serviço, em vez da API de chamada. Por exemplo, para chamar o Serviço de criptografia, use a biblioteca do cliente do Serviço de criptografia. Para executar uma operação do Serviço de criptografia, chame um método que pertence ao objeto do cliente do Serviço de criptografia. Você pode criptografar um documento PDF com uma senha chamando o método EncryptionServiceClient do objeto encryptPDFUsingPassword.

A API Java é compatível com os seguintes recursos:

  • Protocolo de transporte RMI para invocação remota
  • Transporte de VM para invocação local
  • SOAP para invocação remota
  • Autenticação diferente, como nome de usuário e senha
  • Solicitações de invocação síncrona e assíncrona

Consulte também:

Inclusão de arquivos da biblioteca Java do AEM Forms

Invocando processos de longa vida centrados em seres humanos

Chamar o AEM Forms usando serviços da Web

Configuração das propriedades de conexão

Passar dados para serviços da AEM Forms usando a API do Java

Chamar um serviço usando uma biblioteca do cliente Java

Chamada de um processo de duração curta usando a API de chamada

Criação de uma aplicação Web Java que chama um processo de vida longa centrado em humanos

Inclusão de arquivos da biblioteca Java do AEM Forms

Para invocar programaticamente um serviço da AEM Forms usando a API do Java, inclua os arquivos de biblioteca necessários (arquivos JAR) no classpath do seu projeto Java. Os arquivos JAR incluídos no classpath do aplicativo cliente dependem de vários fatores:

  • O serviço AEM Forms a ser chamado. Um aplicativo cliente pode invocar um ou mais serviços.
  • O modo no qual você deseja chamar um serviço AEM Forms. Você pode usar o modo EJB ou SOAP. (Consulte Definindo propriedades de conexão.)
OBSERVAÇÃO

(Somente chave de acesso) Inicie o servidor do AEM Forms com o comando standalone.bat -b <Server IP> -c lc_turnkey.xml para especificar um IP de servidor para EJB.

  • O servidor de aplicativos J2EE no qual o AEM Forms é implantado.

Arquivos JAR específicos do serviço

A tabela a seguir lista os arquivos JAR necessários para chamar os serviços do AEM Forms.

Arquivo

Descrição

Local

adobe-livecycle-client.jar

Deve ser sempre incluído no caminho de classe de um aplicativo cliente Java.

<>diretório de instalação>/sdk/client-libs/common

adobe-usermanager-client.jar

Deve ser sempre incluído no caminho de classe de um aplicativo cliente Java.

<>diretório de instalação>/sdk/client-libs/common

adobe-utilities.jar

Deve ser sempre incluído no caminho de classe de um aplicativo cliente Java.

<>diretório de instalação>/sdk//client-libs/<app server="">

adobe-applicationmanager-client-sdk.jar

Necessário para invocar o serviço Application Manager.

<>diretório de instalação>/sdk/client-libs/common

adobe-assembler-client.jar

Necessário para invocar o serviço Assembler.

<>diretório de instalação>/sdk/client-libs/common

adobe-backup-restore-client-sdk.jar

Necessário para invocar a API do serviço de Backup e Restauração.

<>diretório de instalação>/sdk/client-libs/common

adobe-barcodedforms-client.jar

Necessário para invocar o serviço de formulários com códigos de barras.

<>diretório de instalação>/sdk/client-libs/common

adobe-convertpdf-client.jar

Necessário para chamar o serviço Converter PDF.

<>diretório de instalação>/sdk/client-libs/common

adobe-distiller-client.jar

Necessário para chamar o serviço Distiller.

<>diretório de instalação>/sdk/client-libs/common

adobe-docconverter-client.jar

Necessário para invocar o serviço DocConverter.

<>diretório de instalação>/sdk/client-libs/common

adobe-contentservices-client.jar

Necessário para invocar o serviço Gerenciamento de Documentos.

<>diretório de instalação>/sdk/client-libs/common

adobe-encryption-client.jar

Necessário para chamar o serviço de Criptografia.

<>diretório de instalação>/sdk/client-libs/common

adobe-forms-client.jar

Necessário para chamar o serviço Forms.

<>diretório de instalação>/sdk/client-libs/common

adobe-formdataintegration-client.jar

Necessário para chamar o serviço de Integração de dados de formulário.

<>diretório de instalação>/sdk/client-libs/common

adobe-generatepdf-client.jar

Necessário para chamar o serviço Gerar PDF.

<>diretório de instalação>/sdk/client-libs/common

adobe-generate3dpdf-client.jar

Necessário para chamar o serviço Gerar PDF 3D.

<>diretório de instalação>/sdk/client-libs/common

adobe-jobmanager-client-sdk.jar

Necessário para invocar o serviço Gerenciador de Jobs.

<>diretório de instalação>/sdk/client-libs/common

adobe-output-client.jar

Necessário para chamar o serviço de Saída.

<>diretório de instalação>/sdk/client-libs/common

adobe-pdfutility-client.jar

Necessário para invocar o serviço Utilitários PDF ou Utilitários XMP.

<>diretório de instalação>/sdk/client-libs/common

adobe-reader-extensions-client.jar

Necessário para chamar o serviço de extensões do Acrobat Reader DC.

<>diretório de instalação>/sdk/client-libs/common

adobe-repository-client.jar

commons-codec-1.3.jar

Necessário para invocar o Serviço de Repositório.

<>diretório de instalação>/sdk/client-libs/common

<>diretório de instalação>/sdk/client-libs\thirdparty

  • adobe-rightsmanagement-client.jar

  • namespace.jar

  • jaxb-api.jar

  • jaxb-impl.jar

  • jaxb-libs.jar

  • jaxb-xjc.jar

  • relaxngDatatype.jar

  • xsdlib.jar

Necessário para invocar o serviço Rights Management.

Se o AEM Forms for implantado no JBoss, inclua todos esses arquivos.

<>diretório de instalação>/sdk/client-libs/common

Diretório lib específico do JBoss

adobe-signatures-client.jar

Necessário para invocar o serviço de assinatura.

<>diretório de instalação>/sdk/client-libs/common

adobe-taskmanager-client-sdk.jar

Necessário para invocar o serviço Gerenciador de Tarefas.

<>diretório de instalação>/sdk/client-libs/common

adobe-truststore-client.jar

Necessário para invocar o serviço de Armazenamento de Confiança.

<>diretório de instalação>/sdk/client-libs/common

Modo de conexão e arquivos JAR do aplicativo J2EE

A tabela a seguir lista os arquivos JAR que são dependentes do modo de conexão e do servidor de aplicativos J2EE no qual o AEM Forms é implantado.

</thead align="left">

Arquivo

Descrição

Local

  • activation.jar

  • axis.jar

  • commons-codec-1.3.jar

  • commons-collections-3.1.jar

  • commons-discovery.jar

  • commons-logging.jar

  • dom3-xml-apis-2.5.0.jar

  • jaxen-1.1-beta-9.jar

  • jaxrpc.jar

  • log4j.jar

  • mail.jar

  • saaj.jar

  • wsdl4j.jar

  • xalan.jar

  • xbean.jar

  • xercesImpl.jar
  • commons-httpclient-3.1.jar

se o AEM Forms for chamado usando o modo SOAP, inclua esses arquivos JAR.

<>diretório de instalação>/sdk/client-libs/thirdparty

jboss-client.jar

se o AEM Forms for implantado no JBoss Application Server, inclua esse arquivo JAR.

As classes necessárias não serão encontradas pelo carregador de classe se jboss-client.jar e os jars referenciados não estiverem co-localizados.

Diretório de biblioteca do cliente JBoss

Se você implantar seu aplicativo cliente no mesmo servidor de aplicativos J2EE, não será necessário incluir esse arquivo.

wlclient.jar

se o AEM Forms for implantado no BEA WebLogic Server®, inclua esse arquivo JAR.

Diretório lib específico do WebLogic

Se você implantar seu aplicativo cliente no mesmo servidor de aplicativos J2EE, não será necessário incluir esse arquivo.

  • com.ibm.ws.admin.client_6.1.0.jar

  • com.ibm.ws.webservices.thinclient_6.1.0.jar

  • se o AEM Forms for implantado no WebSphere Application Server, inclua esses arquivos JAR.

  • (com.ibm.ws.webservices.thinclient_6.1.0.jar é necessário para a invocação do serviço da Web).

Diretório lib específico do WebSphere ([WAS_HOME]/runtimes)

Se você implantar seu aplicativo cliente no mesmo servidor de aplicativos J2EE, não será necessário incluir esses arquivos.

Invocar cenários

A tabela a seguir especifica cenários de chamada e lista os arquivos JAR necessários para chamar o AEM Forms com êxito.

</thead align="left"> xmp-uti

Serviços

Modo de invocação

Servidor de aplicativos J2EE

Arquivos JAR necessários

Serviço Forms

EJB

JBoss

  • adobe-livecycle-client.jar

  • adobe-usermanager-client.jar

  • jboss-client.jar
  • adobe-forms-client.jar
  • commons-httpclient-3.1.jar

Serviço Forms

Serviço de extensões da Acrobat Reader DC

Serviço de assinatura

EJB

JBoss

  • adobe-livecycle-client.jar

  • adobe-usermanager-client.jar

  • jboss-client.jar
  • commons-httpclient-3.1.jar
  • adobe-forms-client.jar

  • adobe-reader-extensions-client.jar

  • adobe-signatures-client.jar

Serviço Forms

SOAP

WebLogic

  • adobe-livecycle-client.jar

  • adobe-usermanager-client.jar

  • wlclient.jar

  • activation.jar

  • axis.jar

  • commons-codec-1.3.jar

  • commons-collections-3.1.jar

  • commons-discovery.jar

  • commons-logging.jar

  • dom3-xml-apis-2.5.0.jar

  • jai_imagio.jar

  • jaxen-1.1-beta-9.jar

  • jaxrpc.jar

  • log4j.jar

  • mail.jar

  • saaj.jar

  • wsdl4j.jar

  • xalan.jar

  • xbean.jar

  • xercesImpl.jar

  • adobe-forms-client.jar

Serviço Forms

Serviço de extensões da Acrobat Reader DC

Serviço de assinatura

SOAP

WebLogic

  • adobe-livecycle-client.jar

  • adobe-usermanager-client.jar

  • wlclient.jar

  • activation.jar

  • axis.jar

  • commons-codec-1.3.jar

  • commons-collections-3.1.jar

  • commons-discovery.jar

  • commons-logging.jar

  • dom3-xml-apis-2.5.0.jar

  • jai_imagio.jar

  • jaxen-1.1-beta-9.jar

  • jaxrpc.jar

  • log4j.jar

  • mail.jar

  • saaj.jar

  • wsdl4j.jar

  • xalan.jar

  • xbean.jar

  • xercesImpl.jar

  • adobe-forms-client.jar

  • adobe-reader-extensions-client.jar

  • adobe-signatures-client.jar

Atualização de arquivos JAR

Se estiver atualizando do LiveCycle para o AEM Forms, é recomendável incluir os arquivos JAR do AEM Forms no caminho de classe do seu projeto Java. Por exemplo, se estiver usando serviços como o Rights Management, você encontrará um problema de compatibilidade se não incluir arquivos AEM Forms JAR no caminho da classe.

Supondo que você esteja atualizando para o AEM Forms. Para usar um aplicativo Java que chame o serviço Rights Management, inclua as versões AEM Forms dos seguintes arquivos JAR:

  • adobe-rightsmanagement-client.jar
  • adobe-livecycle-client.jar
  • adobe-usermanager-client.jar

Consulte também:

Chamar o AEM Forms usando a API do Java

Configuração das propriedades de conexão

Passar dados para serviços da AEM Forms usando a API do Java

Chamar um serviço usando uma biblioteca do cliente Java

Configuração das propriedades de conexão

Você define propriedades de conexão para chamar o AEM Forms ao usar a API do Java. Ao definir propriedades de conexão, especifique se os serviços devem ser chamados remotamente ou localmente e também especifique o modo de conexão e os valores de autenticação. Os valores de autenticação são necessários se a segurança de serviço estiver ativada. No entanto, se a segurança de serviço estiver desativada, não será necessário especificar valores de autenticação.

O modo de conexão pode ser o modo SOAP ou EJB. O modo EJB usa o protocolo RMI/IIOP e o desempenho do modo EJB é melhor do que o desempenho do modo SOAP. O modo SOAP é usado para eliminar uma dependência do servidor de aplicativos J2EE ou quando um firewall está localizado entre o AEM Forms e o aplicativo cliente. O modo SOAP usa o protocolo https como o transporte subjacente e pode se comunicar entre os limites do firewall. Se nenhuma dependência de servidor de aplicativos J2EE ou firewall for um problema, é recomendável usar o modo EJB.

Para chamar um serviço AEM Forms com êxito, defina as seguintes propriedades de conexão:

  • DSC_DEFAULT_EJB_ENDPOINT: Se estiver usando o modo de conexão EJB, esse valor representa a URL do servidor de aplicativos J2EE no qual o AEM Forms é implantado. Para chamar o AEM Forms remotamente, especifique o nome do servidor de aplicativos J2EE no qual o AEM Forms é implantado. Se seu aplicativo cliente estiver localizado no mesmo servidor de aplicativos J2EE, você poderá especificar localhost. Dependendo do servidor de aplicativos J2EE em que o AEM Forms é implantado, especifique um dos seguintes valores:

    • JBoss: https://<ServerName>:8080 (default port)
    • WebSphere: iiop://<ServerName>:2809 (default port)
    • WebLogic: t3://<ServerName>:7001 (default port)
  • DSC_DEFAULT_SOAP_ENDPOINT: Se estiver usando o modo de conexão SOAP, esse valor representa o ponto de extremidade para o qual uma solicitação de invocação é enviada. Para chamar o AEM Forms remotamente, especifique o nome do servidor de aplicativos J2EE no qual o AEM Forms é implantado. Se o aplicativo cliente estiver localizado no mesmo servidor de aplicativos J2EE, você pode especificar localhost (por exemplo, http://localhost:8080.)

    • O valor da porta 8080 é aplicável se o aplicativo J2EE for JBoss. Se o servidor de aplicativos J2EE for IBM® WebSphere®, use a porta 9080. Da mesma forma, se o servidor de aplicativos J2EE for WebLogic, use a porta 7001. (Esses valores são valores de porta padrão. Se você alterar o valor da porta, use o número da porta aplicável.)
  • DSC_TRANSPORT_PROTOCOL: Se estiver usando o modo de conexão EJB, especifique ServiceClientFactoryProperties.DSC_EJB_PROTOCOL esse valor. Se estiver usando o modo de conexão SOAP, especifique ServiceClientFactoryProperties.DSC_SOAP_PROTOCOL.

  • DSC_SERVER_TYPE: Especifica o servidor de aplicativos J2EE no qual o AEM Forms é implantado. Os valores válidos são JBoss, WebSphere, WebLogic.

    • Se você definir essa propriedade de conexão como WebSphere, o valor java.naming.factory.initial será definido como com.ibm.ws.naming.util.WsnInitCtxFactory.
    • Se você definir essa propriedade de conexão como WebLogic, o valor java.naming.factory.initial será definido como weblogic.jndi.WLInitialContextFactory.
    • Da mesma forma, se você definir essa propriedade de conexão como JBoss, o valor java.naming.factory.initial será definido como org.jnp.interfaces.NamingContextFactory.
    • Você pode definir a propriedade java.naming.factory.initial como um valor que atenda aos seus requisitos se não quiser usar os valores padrão.
    OBSERVAÇÃO

    Em vez de usar uma string para definir a propriedade de conexão DSC_SERVER_TYPE, você pode usar um membro estático da classe ServiceClientFactoryProperties. Os seguintes valores podem ser usados: ServiceClientFactoryProperties.DSC_WEBSPHERE_SERVER_TYPE, ServiceClientFactoryProperties.DSC_WEBLOGIC_SERVER_TYPE ou ServiceClientFactoryProperties.DSC_JBOSS_SERVER_TYPE.

  • DSC_CREDENTIAL_USERNAME: Especifica o nome de usuário dos formulários AEM. Para que um usuário chame um serviço AEM Forms com êxito, ele precisa da função Usuário de serviços . Um usuário também pode ter outra função que inclui a permissão Service Invoke . Caso contrário, uma exceção será lançada quando eles tentarem invocar um serviço. Se a segurança de serviço estiver desativada, não é necessário especificar essa propriedade de conexão.

  • DSC_CREDENTIAL_PASSWORD: Especifica o valor de senha correspondente. Se a segurança de serviço estiver desativada, não é necessário especificar essa propriedade de conexão.

  • DSC_REQUEST_TIMEOUT: o limite de tempo limite da solicitação padrão para a solicitação SOAP é de 1200000 milissegundos (20 minutos). Às vezes, uma solicitação pode exigir mais tempo para concluir a operação. Por exemplo, uma solicitação SOAP que recupera um grande conjunto de registros pode exigir um tempo limite mais longo. Você pode usar o ServiceClientFactoryProperties.DSC_REQUEST_TIMEOUT para aumentar o tempo limite da chamada de solicitação para as solicitações SOAP.

    OBSERVAÇÃO

    Somente invocações baseadas em SOAP suportam a propriedade DSC_REQUEST_TIMEOUT.

Para definir propriedades de conexão, execute as seguintes tarefas:

  1. Crie um objeto java.util.Properties usando seu construtor.

  2. Para definir a propriedade de conexão DSC_DEFAULT_EJB_ENDPOINT, chame o método java.util.Properties do objeto setProperty e passe os seguintes valores:

    • O valor de enumeração ServiceClientFactoryProperties.DSC_DEFAULT_EJB_ENDPOINT
    • Um valor da string que especifica o URL do servidor de aplicativos J2EE que hospeda o AEM Forms
    OBSERVAÇÃO

    Se estiver usando o modo de conexão SOAP, especifique o valor de enumeração ServiceClientFactoryProperties.DSC_DEFAULT_SOAP_ENDPOINT em vez do valor de enumeração ServiceClientFactoryProperties.DSC_DEFAULT_EJB_ENDPOINT.

  3. Para definir a propriedade de conexão DSC_TRANSPORT_PROTOCOL, chame o método java.util.Properties do objeto setProperty e passe os seguintes valores:

    • O valor de enumeração ServiceClientFactoryProperties.DSC_TRANSPORT_PROTOCOL
    • O valor de enumeração ServiceClientFactoryProperties.DSC_EJB_PROTOCOL
    OBSERVAÇÃO

    Se estiver usando o modo de conexão SOAP, especifique o valor de enumeração ServiceClientFactoryProperties.DSC_SOAP_PROTOCOLem vez do valor de enumeração ServiceClientFactoryProperties.DSC_EJB_PROTOCOL.

  4. Para definir a propriedade de conexão DSC_SERVER_TYPE, chame o método java.util.Properties do objeto setProperty e passe os seguintes valores:

    • O valor de enumeração ServiceClientFactoryProperties.DSC_SERVER_TYPE

    • Um valor de string que especifica o servidor de aplicativos J2EE que hospeda o AEM Forms (por exemplo, se o AEM Forms for implantado no JBoss, especifique JBoss).

      1. Para definir a propriedade de conexão DSC_CREDENTIAL_USERNAME, chame o método java.util.Properties do objeto setProperty e passe os seguintes valores:
    • O valor de enumeração ServiceClientFactoryProperties.DSC_CREDENTIAL_USERNAME

    • Um valor de string que especifica o nome de usuário necessário para chamar o AEM Forms

      1. Para definir a propriedade de conexão DSC_CREDENTIAL_PASSWORD, chame o método java.util.Properties do objeto setProperty e passe os seguintes valores:
    • O valor de enumeração ServiceClientFactoryProperties.DSC_CREDENTIAL_PASSWORD

    • Um valor de string que especifica o valor de senha correspondente

Definindo o modo de conexão EJB para JBoss

O exemplo de código Java a seguir define propriedades de conexão para chamar a AEM Forms implantada no JBoss e usando o modo de conexão 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");

Definindo o modo de conexão EJB para WebLogic

O exemplo de código Java a seguir define propriedades de conexão para chamar o AEM Forms implantado no WebLogic e usando o modo de conexão 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");

Definindo o modo de conexão EJB para WebSphere

O exemplo de código Java a seguir define propriedades de conexão para chamar o AEM Forms implantado no WebSphere e usando o modo de conexão 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");

Configuração do modo de conexão SOAP

O exemplo de código Java a seguir define propriedades de conexão no modo SOAP para chamar a AEM Forms implantada no 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");
OBSERVAÇÃO

Se você selecionar o modo de conexão SOAP, certifique-se de incluir arquivos JAR adicionais no caminho de classe do seu aplicativo cliente.

Definir propriedades de ligação quando a segurança de serviço estiver desativada

O exemplo de código Java a seguir define as propriedades de conexão necessárias para chamar o AEM Forms implantado no JBoss Application Server e quando a segurança de serviço está desativada.

 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");
OBSERVAÇÃO

Todos os Java Quick Starts associados à Programação com o AEM Forms mostram as configurações de conexão EJB e SOAP.

Configuração do modo de conexão SOAP com o limite de tempo limite da solicitação personalizada

 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

Uso de um objeto de contexto para chamar o AEM Forms

Você pode usar um objeto com.adobe.idp.Context para chamar um serviço AEM Forms com um usuário autenticado (o objeto com.adobe.idp.Context representa um usuário autenticado). Ao usar um objeto com.adobe.idp.Context, não é necessário definir as propriedades DSC_CREDENTIAL_USERNAME ou DSC_CREDENTIAL_PASSWORD. Você pode obter um objeto com.adobe.idp.Context ao autenticar usuários usando o método AuthenticationManagerServiceClient do objeto authenticate.

O método authenticate retorna um objeto AuthResult que contém os resultados da autenticação. Você pode criar um objeto com.adobe.idp.Context chamando seu construtor. Em seguida, chame o método com.adobe.idp.Context do objeto e passe o objeto AuthResult, conforme mostrado no código a seguir:initPrincipal

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

Em vez de definir as propriedades DSC_CREDENTIAL_USERNAME ou DSC_CREDENTIAL_PASSWORD, você pode chamar o método ServiceClientFactory do objeto setContext e passar o objeto com.adobe.idp.Context. Ao usar um usuário de formulários AEM para chamar um serviço, verifique se ele tem a função chamada Services User que é necessária para chamar um serviço AEM Forms.

O exemplo de código a seguir mostra como usar um objeto com.adobe.idp.Context nas configurações de conexão usadas para criar um 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);
OBSERVAÇÃO

Para obter detalhes completos sobre a autenticação de um usuário, consulte Autenticando Usuários.

Invocar cenários

Os seguintes cenários de invocação são discutidos nesta seção:

  • Um aplicativo cliente em execução em sua própria máquina virtual Java (JVM) chama uma instância autônoma do AEM Forms.
  • Um aplicativo cliente em execução em sua própria JVM chama instâncias do AEM Forms em cluster.

Aplicativo cliente chamando uma instância autônoma do AEM Forms

O diagrama a seguir mostra um aplicativo cliente em execução em sua própria JVM e chamando uma instância autônoma do AEM Forms.

Neste cenário, um aplicativo cliente está sendo executado em sua própria JVM e chama os serviços da AEM Forms.

OBSERVAÇÃO

Esse cenário é o cenário de chamada no qual todos os Início rápido são baseados.

Aplicativo cliente chamando instâncias do AEM Forms em cluster

O diagrama a seguir mostra um aplicativo cliente em execução em sua própria JVM e chamando as instâncias do AEM Forms localizadas em um cluster.

Esse cenário é semelhante a um aplicativo cliente que chama uma instância autônoma do AEM Forms. No entanto, o URL do provedor é diferente. Se um aplicativo cliente quiser se conectar a um servidor de aplicativos J2EE específico, o aplicativo deverá alterar o URL para fazer referência ao servidor de aplicativos J2EE específico.

Não é recomendado referenciar um servidor de aplicativos J2EE específico porque a conexão entre o aplicativo cliente e o AEM Forms é encerrada se o servidor de aplicativos parar. Recomenda-se que o URL do provedor faça referência a um gerenciador JNDI em nível de célula, em vez de um servidor de aplicativos J2EE específico.

Os aplicativos clientes que usam o modo de conexão SOAP podem usar a porta do balanceador de carga HTTP para o cluster. As aplicações cliente que usam o modo de conexão EJB podem se conectar à porta EJB de um servidor de aplicativos J2EE específico. Esta ação manipula o Balanceamento de Carga entre nós do cluster.

WebSphere

O exemplo a seguir mostra o conteúdo de um arquivo jndi.properties usado para conexão com o AEM Forms implantado no WebSphere.

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

WebLogic

O exemplo a seguir mostra o conteúdo de um arquivo jndi.properties usado para se conectar ao AEM Forms implantado no WebLogic.

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

JBoss

O exemplo a seguir mostra o conteúdo de um arquivo jndi.properties usado para se conectar ao AEM Forms implantado no JBoss.

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

Consulte o administrador para determinar o nome e o número da porta do servidor de aplicativos J2EE.

Consulte também:

Inclusão de arquivos da biblioteca Java do AEM Forms

Passar dados para serviços da AEM Forms usando a API do Java

Chamar um serviço usando uma biblioteca do cliente Java

Passar dados para serviços da AEM Forms usando a API do Java

As operações do serviço AEM Forms normalmente consomem ou produzem documentos PDF. Ao invocar um serviço, às vezes é necessário passar um documento PDF (ou outros tipos de documento, como dados XML) para o serviço. Da mesma forma, às vezes é necessário manipular um documento PDF que é retornado do serviço. A classe Java que permite transmitir dados de e para os serviços da AEM Forms é com.adobe.idp.Document.

Os serviços da AEM Forms não aceitam um documento PDF como outros tipos de dados, como um objeto java.io.InputStream ou uma matriz de bytes. Um objeto com.adobe.idp.Document também pode ser usado para transmitir outros tipos de dados, como dados XML, para serviços.

Um objeto com.adobe.idp.Document é um tipo serializável Java, portanto, pode ser passado por uma chamada RMI. O lado de recebimento pode ser alocado (mesmo host, mesmo carregador de classe), local (mesmo host, carregador de classe diferente) ou remoto (host diferente). O envio do conteúdo do documento é otimizado para cada caso. Por exemplo, se o remetente e o destinatário estiverem localizados no mesmo host, o conteúdo será passado por um sistema de arquivos local. (Em alguns casos, os documentos podem ser passados na memória.)

Dependendo do tamanho do objeto com.adobe.idp.Document, os dados são transportados dentro do objeto com.adobe.idp.Document ou armazenados no sistema de arquivos do servidor. Quaisquer recursos de armazenamento temporário ocupados pelo objeto com.adobe.idp.Document são removidos automaticamente após a eliminação com.adobe.idp.Document. (Consulte Eliminando objetos de documento.)

Às vezes, é necessário saber o tipo de conteúdo de um objeto com.adobe.idp.Document antes de passá-lo para um serviço. Por exemplo, se uma operação exigir um tipo de conteúdo específico, como application/pdf, é recomendável determinar o tipo de conteúdo. (Consulte Determinar o tipo de conteúdo de um documento.)

O objeto com.adobe.idp.Document tenta determinar o tipo de conteúdo usando os dados fornecidos. Se o tipo de conteúdo não puder ser recuperado dos dados fornecidos (por exemplo, quando os dados foram fornecidos como uma matriz de bytes), defina o tipo de conteúdo. Para definir o tipo de conteúdo, chame o método com.adobe.idp.Document do objeto setContentType. (Consulte Determinar o tipo de conteúdo de um documento)

Se os arquivos de garantia residirem no mesmo sistema de arquivos, a criação de um objeto com.adobe.idp.Document será mais rápida. Se os arquivos de garantia residirem em sistemas de arquivos remotos, uma operação de cópia deve ser feita, afetando o desempenho.

Um aplicativo pode conter os tipos de dados com.adobe.idp.Document e org.w3c.dom.Document . No entanto, certifique-se de qualificar totalmente o tipo de dados org.w3c.dom.Document . Para obter informações sobre a conversão de um objeto org.w3c.dom.Document em um objeto com.adobe.idp.Document, consulte Início rápido (modo EJB): Pré-preencher o Forms com layouts flutuantes usando a API Java.

OBSERVAÇÃO

Para evitar um vazamento de memória no WebLogic ao usar um objeto com.adobe.idp.Document, leia as informações do documento em partes de 2048 bytes ou menos. Por exemplo, o código a seguir lê as informações do documento em blocos de 2048 bytes:

        // 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 também:

Chamar o AEM Forms usando a API do Java

Configuração das propriedades de conexão

Criação de documentos

Crie um objeto com.adobe.idp.Document antes de invocar uma operação de serviço que exija um documento PDF (ou outros tipos de documento) como um valor de entrada. A classe com.adobe.idp.Document fornece construtores que permitem criar um documento a partir dos seguintes tipos de conteúdo:

  • Uma matriz de bytes
  • Um objeto com.adobe.idp.Document existente
  • Um objeto java.io.File
  • Um objeto java.io.InputStream
  • Um objeto java.net.URL

Criar um documento com base em uma matriz de bytes

O exemplo de código a seguir cria um objeto com.adobe.idp.Document baseado em uma matriz de bytes.

Criação de um objeto de documento baseado em uma matriz de bytes

 Document myPDFDocument = new Document(myByteArray);

Criação de um documento com base em outro documento

O exemplo de código a seguir cria um objeto com.adobe.idp.Document baseado em outro objeto com.adobe.idp.Document.

Criando um objeto de Documento baseado em outro 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);

Criação de um documento com base em um arquivo

O exemplo de código a seguir cria um objeto com.adobe.idp.Document baseado em um arquivo PDF chamado map.pdf. Esse arquivo está localizado na raiz do disco rígido C. Esse construtor tenta definir o tipo de conteúdo MIME do objeto com.adobe.idp.Document usando a extensão do nome de arquivo.

O construtor com.adobe.idp.Document que aceita um objeto java.io.File também aceita um parâmetro booleano. Ao definir esse parâmetro como true, o objeto com.adobe.idp.Document exclui o arquivo. Essa ação significa que você não precisa remover o arquivo depois de passá-lo para o construtor com.adobe.idp.Document.

Definir esse parâmetro como false significa que você mantém a propriedade desse arquivo. A configuração desse parâmetro para true é mais eficiente. O motivo é que o objeto com.adobe.idp.Document pode mover o arquivo diretamente para a área gerenciada local, em vez de copiá-lo (o que é mais lento).

Criação de um objeto de documento com base em um arquivo 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);

Criação de um documento com base em um objeto InputStream

O exemplo de código Java a seguir cria um objeto com.adobe.idp.Document baseado em um objeto java.io.InputStream.

Criação de um documento com base em um objeto InputStream

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

Criar um documento com base em conteúdo acessível de um URL

O exemplo de código Java a seguir cria um objeto com.adobe.idp.Document baseado em um arquivo PDF chamado map.pdf. Este arquivo está localizado em um aplicativo da Web chamado WebApp que está sendo executado em localhost. Este construtor tenta definir o tipo de conteúdo MIME do objeto com.adobe.idp.Document usando o tipo de conteúdo retornado com o protocolo URL.

O URL fornecido para o objeto com.adobe.idp.Document é sempre lido no lado em que o objeto com.adobe.idp.Document original é criado, como mostrado neste exemplo:

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

O arquivo c:/temp/input.pdf deve estar localizado no computador cliente (não no computador servidor). O computador cliente é onde o URL é lido e onde o objeto com.adobe.idp.Document foi criado.

Criar um documento com base em conteúdo acessível de um 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 também:

Chamar o AEM Forms usando a API do Java

Configuração das propriedades de conexão

Manuseio de documentos retornados

As operações de serviço que retornam um documento PDF (ou outros tipos de dados, como dados XML) como um valor de saída retornam um objeto com.adobe.idp.Document. Depois de receber um objeto com.adobe.idp.Document, é possível convertê-lo nos seguintes formatos:

  • Um objeto java.io.File
  • Um objeto java.io.InputStream
  • Uma matriz de bytes

A linha de código a seguir converte um objeto com.adobe.idp.Document em um objeto java.io.InputStream. Suponha que myPDFDocument represente um objeto com.adobe.idp.Document:

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

Da mesma forma, é possível copiar o conteúdo de um com.adobe.idp.Document para um arquivo local executando as seguintes tarefas:

  1. Crie um objeto java.io.File.
  2. Chame o método com.adobe.idp.Document do objeto copyToFile e passe o objeto java.io.File.

O exemplo de código a seguir copia o conteúdo de um objeto com.adobe.idp.Document para um arquivo chamado OtherMap.pdf.

Copiando o conteúdo de um objeto de documento em um arquivo

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

Consulte também:

Chamar o AEM Forms usando a API do Java

Configuração das propriedades de conexão

Determinar o tipo de conteúdo de um documento

Determine o tipo MIME de um objeto com.adobe.idp.Document chamando o método com.adobe.idp.Document do objeto getContentType. Esse método retorna um valor de string que especifica o tipo de conteúdo do objeto com.adobe.idp.Document. A tabela a seguir descreve os diferentes tipos de conteúdo que o AEM Forms retorna.

Tipo MIME

Descrição

application/pdf

Documento PDF

application/vnd.adobe.xdp+xml

XDP (Pacote de dados XML), que é usado para formulários XML Forms Architecture (XFA) exportados

text/xml

Marcadores, anexos ou outros documentos XML

application/vnd.fdf

Formato de dados Forms (FDF), usado para formulários Acrobat exportados

application/vnd.adobe.xfdf

XML Forms Data Format (XFDF), que é usado para formulários Acrobat exportados

application/rdf+xml

Formato de dados avançado e XML

application/octet-stream

Formato de dados genérico

NULL

Tipo MIME não especificado

O exemplo de código a seguir determina o tipo de conteúdo de um objeto com.adobe.idp.Document.

Determinar o tipo de conteúdo de um objeto de documento

 //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 também:

Chamar o AEM Forms usando a API do Java

Configuração das propriedades de conexão

Eliminando objetos de documento

Quando não precisar mais de um objeto Document, é recomendável que você o descarte chamando seu método dispose. Cada objeto Document consome um descritor de arquivo e até 75 MB de espaço RAM na plataforma de host do seu aplicativo. Se um objeto Document não for descartado, o processo de coleta do Java Garage o eliminará. No entanto, ao descartá-lo mais cedo usando o método dispose, você poderá liberar a memória ocupada pelo objeto Document.

Consulte também:

Chamar o AEM Forms usando a API do Java

Inclusão de arquivos da biblioteca Java do AEM Forms

Chamar um serviço usando uma biblioteca do cliente Java

Chamar um serviço usando uma biblioteca do cliente Java

As operações do serviço AEM Forms podem ser invocadas usando a API altamente digitada de um serviço, conhecida como uma biblioteca cliente Java. Uma biblioteca cliente Java é um conjunto de classes concretas que fornecem acesso a serviços implantados no contêiner de serviço. Instancie um objeto Java que representa o serviço a ser chamado em vez de criar um objeto InvocationRequest usando a API de chamada. A API de invocação é usada para invocar processos, como processos de longa duração, criados no Workbench. (Consulte Invocando processos de vida longa centrados em humanos.)

Para executar uma operação de serviço, chame um método que pertença ao objeto Java. Uma biblioteca do cliente Java contém métodos que normalmente mapeiam um para um com operações de serviço. Ao usar uma biblioteca do cliente Java, defina as propriedades de conexão necessárias. (Consulte Definindo propriedades de conexão.)

Depois de definir as propriedades da conexão, crie um objeto ServiceClientFactory usado para instanciar um objeto Java que permita chamar um serviço. Cada serviço que tem uma biblioteca do cliente Java tem um objeto do cliente correspondente. Por exemplo, para invocar o serviço Repositório, crie um objeto ResourceRepositoryClient usando seu construtor e transmitindo o objeto ServiceClientFactory. O objeto ServiceClientFactory é responsável pela manutenção das configurações de conexão necessárias para chamar os serviços do AEM Forms.

Embora a obtenção de um ServiceClientFactory normalmente seja rápida, algumas despesas gerais estão envolvidas quando a fábrica é usada pela primeira vez. Esse objeto é otimizado para reutilização e, portanto, quando possível, use o mesmo objeto ServiceClientFactory ao criar vários objetos cliente Java. Ou seja, não crie um objeto ServiceClientFactory separado para cada objeto da biblioteca do cliente que você criar.

Há uma configuração do Gerenciador de usuários que controla o tempo de vida da asserção de SAML que está dentro do objeto com.adobe.idp.Context que afeta o objeto ServiceClientFactory. Essa configuração controla todos os tempos de vida do contexto de autenticação em todo o AEM Forms, incluindo todas as invocações executadas usando a API do Java. Por padrão, o período em que um objeto ServiceCleintFactory pode ser usado é de duas horas.

OBSERVAÇÃO

Para explicar como invocar um serviço usando a API Java, a operação writeResource do serviço de Repositório é chamada. Essa operação coloca um novo recurso no repositório.

Você pode chamar o serviço Repositório usando uma biblioteca do cliente Java e executando as seguintes etapas:

  1. Inclua arquivos JAR do cliente, como adobe-repository-client.jar, no caminho de classe do seu projeto Java. Para obter informações sobre a localização desses arquivos, consulte Incluindo arquivos da biblioteca Java do AEM Forms.

  2. Defina as propriedades de conexão necessárias para chamar um serviço.

  3. Crie um objeto ServiceClientFactory chamando o método ServiceClientFactory estático createInstance do objeto e transmitindo o objeto java.util.Properties que contém propriedades de conexão.

  4. Crie um objeto ResourceRepositoryClient usando seu construtor e transmitindo o objeto ServiceClientFactory. Use o objeto ResourceRepositoryClient para chamar operações do serviço Repositório.

  5. Crie um objeto RepositoryInfomodelFactoryBean usando seu construtor e passe null. Esse objeto permite criar um objeto Resource que representa o conteúdo adicionado ao repositório.

  6. Crie um objeto Resource chamando o método RepositoryInfomodelFactoryBean do objeto newImage e passando os seguintes valores:

    • Um valor de ID exclusivo ao especificar new Id().
    • Um valor UUID exclusivo ao especificar new Lid().
    • O nome do recurso. Você pode especificar o nome do arquivo XDP.

    Converta o valor de retorno em Resource.

  7. Crie um objeto ResourceContent chamando o método RepositoryInfomodelFactoryBean do objeto newImage e transmitindo o valor de retorno para ResourceContent. Esse objeto representa o conteúdo adicionado ao repositório.

  8. Crie um objeto com.adobe.idp.Document transmitindo um objeto java.io.FileInputStream que armazena o arquivo XDP a ser adicionado ao repositório. (Consulte Criação de um documento com base em um objeto InputStream.)

  9. Adicione o conteúdo do objeto com.adobe.idp.Document ao objeto ResourceContent chamando o método ResourceContent do objeto setDataDocument. Passe o objeto com.adobe.idp.Document.

  10. Defina o tipo MIME do arquivo XDP para adicionar ao repositório, chamando o método ResourceContent do objeto setMimeType e passando application/vnd.adobe.xdp+xml.

  11. Adicione o conteúdo do objeto ResourceContent ao objeto Resource chamando o método Resource do objeto 's setContent e transmitindo o objeto ResourceContent.

  12. Adicione uma descrição do recurso chamando o método Resource object 's setDescription e passando um valor de string que representa uma descrição do recurso.

  13. Adicione o design de formulário ao repositório, chamando o método ResourceRepositoryClient do objeto writeResource e transmitindo os seguintes valores:

    • Um valor de string que especifica o caminho para a coleção de recursos que contém o novo recurso
    • O objeto Resource que foi criado

Consulte também:

Início rápido (modo EJB): Gravação de um recurso usando a API Java

Chamar o AEM Forms usando a API do Java

Inclusão de arquivos da biblioteca Java do AEM Forms

Chamada de um processo de duração curta usando a API de chamada

Você pode invocar um processo de duração curta usando a API de chamada do Java. Ao invocar um processo de duração curta usando a API de invocação, é possível transmitir os valores de parâmetro necessários usando um objeto java.util.HashMap. Para cada parâmetro ser transmitido a um serviço, chame o método java.util.HashMap do objeto e especifique o par nome-valor necessário para o serviço executar a operação especificada. put Especifique o nome exato dos parâmetros que pertencem ao processo de curta duração.

OBSERVAÇÃO

Para obter informações sobre como invocar um processo de longa duração, consulte Invocando processos de longa vida centrados em humanos.

A discussão aqui é sobre o uso da API de invocação para chamar o seguinte processo de curta duração do AEM Forms chamado MyApplication/EncryptDocument.

OBSERVAÇÃO

Esse processo não se baseia em um processo AEM Forms existente. Para seguir junto com o exemplo de código, crie um processo chamado MyApplication/EncryptDocument usando o Workbench. (Consulte Usando Workbench.)

Quando esse processo é chamado, ele executa as seguintes ações:

  1. Obtém o documento PDF não seguro passado para o processo. Esta ação é baseada na operação SetValue. O parâmetro de entrada desse processo é uma variável de processo document chamada inDoc.
  2. Criptografa o documento PDF com uma senha. Esta ação é baseada na operação PasswordEncryptPDF. O documento PDF criptografado por senha é retornado em uma variável de processo chamada outDoc.

Chame o processo de curta duração MyApplication/EncryptDocument usando a API de invocação Java

Chame o processo MyApplication/EncryptDocument de curta duração usando a API de invocação do Java:

  1. Inclua arquivos JAR do cliente, como o adobe-livecycle-client.jar, no caminho da classe do seu projeto Java. (Consulte Incluindo arquivos da biblioteca Java do AEM Forms.)

  2. Crie um objeto ServiceClientFactory que contenha propriedades de conexão. (Consulte Definindo propriedades de conexão.)

  3. Crie um objeto ServiceClient usando seu construtor e transmitindo o objeto ServiceClientFactory. Um objeto ServiceClient permite invocar uma operação de serviço. Ele lida com tarefas como localizar, despachar e rotear solicitações de invocação.

  4. Crie um objeto java.util.HashMap usando seu construtor.

  5. Chame o método java.util.HashMap do objeto put para cada parâmetro de entrada para passar ao processo de duração longa. Como o processo MyApplication/EncryptDocument de curta duração requer um parâmetro de entrada do tipo Document, é necessário chamar o método put apenas uma vez, como mostrado no exemplo a seguir.

     //Create a Map object to store the parameter value for inDoc
     Map params = new HashMap();
     InputStream inFile = new FileInputStream("C:\\Adobe\Loan.pdf");
     Document inDoc = new Document(inFile);
     params.put("inDoc", inDoc);
    
  6. Crie um objeto InvocationRequest chamando o método ServiceClientFactory do objeto createInvocationRequest e passando os seguintes valores:

    • Um valor de string que especifica o nome do processo de longa duração a ser chamado. Para invocar o processo MyApplication/EncryptDocument, especifique MyApplication/EncryptDocument.
    • Um valor de string que representa o nome da operação do processo. Normalmente, o nome de uma operação de processo de duração curta é invoke.
    • O objeto java.util.HashMap que contém os valores de parâmetro necessários para a operação de serviço.
    • Um valor booleano que especifica true, que cria uma solicitação síncrona (esse valor é aplicável para invocar um processo de duração curta).
  7. Envie a solicitação de invocação para o serviço, chamando o método ServiceClient do objeto e transmitindo o objeto InvocationRequest. invoke O método invoke retorna um objeto InvocationReponse.

    OBSERVAÇÃO

    Um processo de longa duração pode ser chamado transmitindo o valor falsecomo o quarto parâmetro do método createInvocationRequest. Passar o valor falsecria uma solicitação assíncrona.

  8. Recupere o valor de retorno do processo, chamando o método InvocationReponse do objeto getOutputParameter e passando um valor de string que especifica o nome do parâmetro de saída. Nessa situação, especifique outDoc ( outDoc é o nome do parâmetro de saída para o processo MyApplication/EncryptDocument). Converta o valor de retorno em Document, conforme mostrado no exemplo a seguir.

     InvocationResponse response = myServiceClient.invoke(request);
     Document encryptDoc = (Document) response.getOutputParameter("outDoc");
    
  9. Crie um objeto java.io.File e verifique se a extensão de arquivo é .pdf.

  10. Chame o método com.adobe.idp.Document do objeto copyToFile para copiar o conteúdo do objeto com.adobe.idp.Document para o arquivo. Certifique-se de usar o objeto com.adobe.idp.Document retornado pelo método getOutputParameter.

Consulte também:

Início rápido: Chamada de um processo de duração curta usando a API de chamada

Invocando processos de longa vida centrados em seres humanos

Inclusão de arquivos da biblioteca Java do AEM Forms

Nesta página