Validação de documentos DDX validating-ddx-documents
Você pode validar programaticamente um documento DDX usado pelo serviço Assembler. Ou seja, usando a API do serviço Assembler, é possível determinar se um documento DDX é válido ou não. Por exemplo, se você atualizou de uma versão anterior do AEM Forms e quiser garantir que seu documento DDX seja válido, poderá validá-lo usando a API do serviço Assembler.
Resumo das etapas summary-of-steps
Para validar um documento DDX, execute as seguintes tarefas:
- Inclua arquivos de projeto.
- Crie um cliente Assembler.
- Faça referência a um documento DDX existente.
- Defina opções de tempo de execução para validar o documento DDX.
- Execute a validação.
- Salve os resultados de validação em um arquivo de log.
Incluir arquivos de projeto
Inclua os arquivos necessários no projeto de desenvolvimento. Se você estiver criando um aplicativo cliente usando Java, inclua os arquivos JAR necessários. Se você estiver usando serviços da Web, certifique-se de incluir os arquivos proxy.
Os seguintes arquivos JAR devem ser adicionados ao caminho de classe do seu projeto:
- adobe-livecycle-client.jar
- adobe-usermanager-client.jar
- adobe-assembler-client.jar
- adobe-utilities.jar (necessário se o AEM Forms estiver implantado no JBoss)
- jbossall-client.jar (obrigatório se o AEM Forms for implantado no JBoss)
se o AEM Forms for implantado em um servidor de aplicativos J2EE compatível diferente do JBoss, você deverá substituir os arquivos adobe-utilities.jar e jbossall-client.jar por arquivos JAR específicos do servidor de aplicativos J2EE no qual o AEM Forms é implantado.
Criar um cliente do Assembler do PDF
Antes de poder executar programaticamente uma operação Assembler, é necessário criar um cliente de serviço Assembler.
Referência a um documento DDX existente
Para validar um documento DDX, você deve referenciar um documento DDX existente.
Definir opções de tempo de execução para validar o documento DDX
Ao validar um documento DDX, você deve definir opções específicas de tempo de execução que instruam o serviço Assembler a validar o documento DDX em vez de executá-lo. Além disso, você pode aumentar a quantidade de informações que o serviço Assembler grava no arquivo de log.
Executar a validação
Depois de criar o cliente do serviço Assembler, fazer referência ao documento DDX e definir as opções de tempo de execução, você pode invocar o invokeDDX
para validar o documento DDX. Ao validar o documento DDX, você pode passar null
como parâmetro de mapa (esse parâmetro geralmente armazena documentos de PDF que o Assembler requer para executar a(s) operação(ões) especificada(s) no documento DDX).
Se a validação falhar, uma exceção será lançada e o arquivo de log conterá detalhes que explicam por que o documento DDX é inválido poderá ser obtido do OperationException
instância. Depois de passar a análise básica do XML e a verificação do esquema, a validação em relação à especificação do DDX é executada. Todos os erros localizados no documento DDX são especificados no log.
Salve os resultados de validação em um arquivo de log
O serviço Assembler retorna os resultados de validação que você pode gravar em um arquivo de log XML. A quantidade de detalhes que o serviço Assembler grava no arquivo de log depende da opção de tempo de execução que você definiu.
Consulte também
Validar um documento DDX usando a API Java
Validar um documento DDX usando a API do serviço da Web
Inclusão de arquivos da biblioteca Java do AEM Forms
Configuração das propriedades de conexão
Montagem programática de documentos do PDF
Validar um documento DDX usando a API Java validate-a-ddx-document-using-the-java-api
Valide um documento DDX usando a API do Serviço de Assembler (Java):
-
Inclua arquivos de projeto.
Inclua arquivos JAR do cliente, como adobe-assembler-client.jar, no caminho de classe do seu projeto Java.
-
Crie um cliente Assembler PDF.
- Crie um
ServiceClientFactory
objeto que contém propriedades de conexão. - Crie um
AssemblerServiceClient
usando seu construtor e passando oServiceClientFactory
objeto.
- Crie um
-
Faça referência a um documento DDX existente.
- Crie um
java.io.FileInputStream
objeto que representa o documento DDX usando seu construtor e passando um valor de string que especifica o local do arquivo DX. - Crie um
com.adobe.idp.Document
usando seu construtor e passando ojava.io.FileInputStream
objeto.
- Crie um
-
Defina opções de tempo de execução para validar o documento DDX.
- Crie um
AssemblerOptionSpec
que armazena opções de tempo de execução usando seu construtor. - Defina a opção de tempo de execução que instrui o serviço Assembler a validar o documento DDX chamando o
AssemblerOptionSpec
método setValidateOnly do objeto e aprovaçãotrue
. - Defina a quantidade de informações que o serviço Assembler grava no arquivo de log chamando o
AssemblerOptionSpec
do objetogetLogLevel
e passar um valor de string atende aos seus requisitos. Ao validar um documento DDX, você deseja que mais informações sejam gravadas no arquivo de log que ajudará no processo de validação. Como resultado, você pode passar o valorFINE
ouFINER
.
- Crie um
-
Execute a validação.
Chame o
AssemblerServiceClient
do objetoinvokeDDX
e transmita os seguintes valores:- A
com.adobe.idp.Document
objeto que representa o documento DDX. - O valor
null
para o objeto java.io.Map que geralmente armazena documentos PDF. - A
com.adobe.livecycle.assembler.client.AssemblerOptionSpec
que especifica as opções de tempo de execução.
O
invokeDDX
retorna um métodoAssemblerResult
objeto que contém informações que especificam se o documento DDX é válido. - A
-
Salve os resultados de validação em um arquivo de log.
- Crie um
java.io.File
e verifique se a extensão do nome do arquivo é .xml. - Chame o
AssemblerResult
do objetogetJobLog
método . Esse método retorna umcom.adobe.idp.Document
instância que contém informações de validação. - Chame o
com.adobe.idp.Document
do objetocopyToFile
para copiar o conteúdo dacom.adobe.idp.Document
ao arquivo.
note note NOTE Se o documento DDX for inválido, um OperationException
é jogada. Na declaração catch, você pode chamar a variávelOperationException
do objetogetJobLog
método . - Crie um
Consulte também
Início rápido (modo SOAP): Validação de documentos DDX usando a API Java (Modo SOAP)
Inclusão de arquivos da biblioteca Java do AEM Forms
Configuração das propriedades de conexão
Validar um documento DDX usando a API do serviço da Web validate-a-ddx-document-using-the-web-service-api
Valide um documento DDX usando a API do Serviço de Assembler (serviço da Web):
-
Inclua arquivos de projeto.
Crie um projeto Microsoft .NET que use MTOM. Certifique-se de usar a seguinte definição de WSDL:
http://localhost:8080/soap/services/AssemblerService?WSDL&lc_version=9.0.1
.note note NOTE Substitua localhost pelo endereço IP do servidor de formulários. -
Crie um cliente Assembler PDF.
-
Crie um
AssemblerServiceClient
usando seu construtor padrão. -
Crie um
AssemblerServiceClient.Endpoint.Address
usando oSystem.ServiceModel.EndpointAddress
construtor. Passe um valor de string que especifica o WSDL para o serviço do AEM Forms (por exemplo,http://localhost:8080/soap/services/AssemblerService?blob=mtom
). Não é necessário usar a variávellc_version
atributo. Esse atributo é usado ao criar uma referência de serviço. -
Crie um
System.ServiceModel.BasicHttpBinding
obtendo o valor da variávelAssemblerServiceClient.Endpoint.Binding
campo. Converta o valor de retorno paraBasicHttpBinding
. -
Defina as
System.ServiceModel.BasicHttpBinding
do objetoMessageEncoding
campo paraWSMessageEncoding.Mtom
. Esse valor garante que o MTOM seja usado. -
Ative a autenticação HTTP básica executando as seguintes tarefas:
- Atribuir o nome de usuário dos formulários AEM ao campo
AssemblerServiceClient.ClientCredentials.UserName.UserName
. - Atribua o valor correspondente da senha ao campo
AssemblerServiceClient.ClientCredentials.UserName.Password
. - Atribuir o valor constante
HttpClientCredentialType.Basic
ao campoBasicHttpBindingSecurity.Transport.ClientCredentialType
. - Atribuir o valor constante
BasicHttpSecurityMode.TransportCredentialOnly
ao campoBasicHttpBindingSecurity.Security.Mode
.
- Atribuir o nome de usuário dos formulários AEM ao campo
-
-
Faça referência a um documento DDX existente.
- Crie um
BLOB
usando seu construtor. OBLOB
é usado para armazenar o documento DDX. - Crie um
System.IO.FileStream
chamando seu construtor e passando um valor de string que representa o local do arquivo do documento DX e o modo para abrir o arquivo no. - Crie uma matriz de bytes que armazene o conteúdo da variável
System.IO.FileStream
objeto. Você pode determinar o tamanho da matriz de bytes obtendo a variávelSystem.IO.FileStream
do objetoLength
propriedade. - Preencha a matriz de bytes com dados de fluxo chamando a variável
System.IO.FileStream
do objetoRead
e transmitindo a matriz de bytes, a posição inicial e o comprimento do fluxo a ser lido. - Preencha o
BLOB
ao atribuir seuMTOM
com o conteúdo da matriz de bytes.
- Crie um
-
Defina opções de tempo de execução para validar o documento DDX.
- Crie um
AssemblerOptionSpec
que armazena opções de tempo de execução usando seu construtor. - Defina a opção de tempo de execução que instrui o serviço Assembler a validar o documento DDX atribuindo o valor true ao
AssemblerOptionSpec
do objetovalidateOnly
membro de dados. - Defina a quantidade de informações que o serviço Assembler grava no arquivo de log atribuindo um valor de string à variável
AssemblerOptionSpec
do objetologLevel
membro de dados. método Ao validar um documento DDX, você deseja que mais informações sejam gravadas no arquivo de log que ajudará no processo de validação. Como resultado, é possível especificar o valorFINE
ouFINER
. Para obter informações sobre as opções de tempo de execução que podem ser definidas, consulte oAssemblerOptionSpec
referência de classe em Referência da API do AEM Forms.
- Crie um
-
Execute a validação.
Chame o
AssemblerServiceClient
do objetoinvokeDDX
e transmita os seguintes valores:- A
BLOB
objeto que representa o documento DDX. - O valor
null
paraMap
objeto que geralmente armazena documentos PDF. - Um
AssemblerOptionSpec
que especifica as opções de tempo de execução.
O
invokeDDX
retorna um métodoAssemblerResult
objeto que contém informações que especificam se o documento DDX é válido. - A
-
Salve os resultados de validação em um arquivo de log.
- Crie um
System.IO.FileStream
chamando seu construtor e passando um valor de string que representa o local do arquivo de log e o modo no qual o arquivo será aberto. Certifique-se de que a extensão do nome de arquivo seja .xml. - Crie um
BLOB
objeto que armazena informações de log obtendo o valor da variávelAssemblerResult
do objetojobLog
membro de dados. - Crie uma matriz de bytes que armazene o conteúdo da variável
BLOB
objeto. Preencha a matriz de bytes obtendo o valor da variávelBLOB
do objetoMTOM
campo. - Crie um
System.IO.BinaryWriter
chamando seu construtor e passando oSystem.IO.FileStream
objeto. - Escreva o conteúdo da matriz de bytes em um arquivo PDF chamando o
System.IO.BinaryWriter
do objetoWrite
e transmitindo a matriz de bytes.
note note NOTE Se o documento DDX for inválido, um OperationException
é jogada. Na declaração catch, é possível obter o valor da variávelOperationException
do objetojobLog
membro. - Crie um
Consulte também
Chamar o AEM Forms usando MTOM