Convalida dei documenti DDX validating-ddx-documents
Gli esempi e gli esempi contenuti in questo documento sono solo per AEM Forms in ambiente JEE.
È possibile convalidare a livello di programmazione un documento DDX utilizzato dal servizio Assembler. In altre parole, utilizzando l'API del servizio Assembler, è possibile determinare se un documento DDX è valido o meno. Se ad esempio si è eseguito l'aggiornamento da una versione precedente di AEM Forms e si desidera verificare che il documento DDX sia valido, è possibile convalidarlo utilizzando l'API del servizio Assembler.
Riepilogo dei passaggi summary-of-steps
Per convalidare un documento DDX, eseguire le operazioni seguenti:
- Includi file di progetto.
- Creare un client Assembler.
- Fare riferimento a un documento DDX esistente.
- Impostare le opzioni di runtime per convalidare il documento DDX.
- Eseguire la convalida.
- Salvare i risultati della convalida in un file di registro.
Includi file di progetto
Includi i file necessari nel progetto di sviluppo. Se stai creando un’applicazione client utilizzando Java, includi i file JAR necessari. Se utilizzi i servizi web, accertati di includere i file proxy.
I seguenti file JAR devono essere aggiunti al percorso della classe del progetto:
- adobe-livecycle-client.jar
- adobe-usermanager-client.jar
- adobe-assembler-client.jar
- adobe-utilities.jar (richiesto se AEM Forms è implementato su JBoss)
- jbossall-client.jar (obbligatorio se AEM Forms è distribuito su JBoss)
se AEM Forms viene distribuito su un server applicazioni J2EE supportato diverso da JBoss, è necessario sostituire i file adobe-utilities.jar e jbossall-client.jar con file JAR specifici per il server applicazioni J2EE su cui è distribuito AEM Forms.
Creare un client Assembler PDF
Prima di poter eseguire un'operazione Assembler a livello di programmazione, è necessario creare un client del servizio Assembler.
Riferimento a un documento DDX esistente
Per convalidare un documento DDX, è necessario fare riferimento a un documento DDX esistente.
Impostare le opzioni di runtime per convalidare il documento DDX
Durante la convalida di un documento DDX, è necessario impostare opzioni di runtime specifiche che indichino al servizio Assembler di convalidare il documento DDX anziché eseguirlo. È inoltre possibile aumentare la quantità di informazioni che il servizio Assembler scrive nel file di registro.
Esegui la convalida
Dopo aver creato il client del servizio Assembler, aver fatto riferimento al documento DDX e aver impostato le opzioni di runtime, è possibile richiamare l'operazione invokeDDX
per convalidare il documento DDX. Durante la convalida del documento DDX, è possibile passare null
come parametro di mappa (questo parametro in genere memorizza i documenti PDF necessari all'Assembler per eseguire le operazioni specificate nel documento DDX).
Se la convalida non riesce, viene generata un'eccezione e il file di log contiene dettagli che spiegano perché il documento DDX non è valido. È possibile ottenerlo dall'istanza OperationException
. Dopo aver superato l'analisi XML di base e il controllo dello schema, viene eseguita la convalida in base alla specifica DDX. Tutti gli errori presenti nel documento DDX vengono specificati nel registro.
Salvare i risultati della convalida in un file di registro
Il servizio Assembler restituisce i risultati della convalida che è possibile scrivere in un file di log XML. La quantità di dettagli che il servizio Assembler scrive nel file di log dipende dall'opzione di runtime impostata.
Consulta anche
Convalidare un documento DDX utilizzando l’API Java
Convalidare un documento DDX utilizzando l’API del servizio web
Inclusione dei file della libreria Java di AEM Forms
Convalidare un documento DDX utilizzando l’API Java validate-a-ddx-document-using-the-java-api
Convalidare un documento DDX utilizzando l'API del servizio Assembler (Java):
-
Includi file di progetto.
Includi i file JAR client, come adobe-assembler-client.jar, nel percorso di classe del progetto Java.
-
Creare un client PDF Assembler.
- Creare un oggetto
ServiceClientFactory
contenente le proprietà di connessione. - Creare un oggetto
AssemblerServiceClient
utilizzando il relativo costruttore e passando l'oggettoServiceClientFactory
.
- Creare un oggetto
-
Fare riferimento a un documento DDX esistente.
- Creare un oggetto
java.io.FileInputStream
che rappresenta il documento DDX utilizzando il relativo costruttore e passando un valore stringa che specifica la posizione del file DDX. - Creare un oggetto
com.adobe.idp.Document
utilizzando il relativo costruttore e passando l'oggettojava.io.FileInputStream
.
- Creare un oggetto
-
Impostare le opzioni di runtime per convalidare il documento DDX.
- Creare un oggetto
AssemblerOptionSpec
che memorizza le opzioni di runtime utilizzando il relativo costruttore. - Impostare l'opzione di runtime che indica al servizio Assembler di convalidare il documento DDX richiamando il metodo setValidateOnly dell'oggetto
AssemblerOptionSpec
e passandotrue
. - Impostare la quantità di informazioni che il servizio Assembler scrive nel file di log richiamando il metodo
getLogLevel
dell'oggettoAssemblerOptionSpec
e fornendo un valore stringa che soddisfi i requisiti. Durante la convalida di un documento DDX, è necessario disporre di ulteriori informazioni scritte nel file di registro che possano essere utili per il processo di convalida. È quindi possibile passare il valoreFINE
oFINER
.
- Creare un oggetto
-
Eseguire la convalida.
Richiama il metodo
invokeDDX
dell'oggettoAssemblerServiceClient
e passa i seguenti valori:- Oggetto
com.adobe.idp.Document
che rappresenta il documento DDX. - Valore
null
per l'oggetto java.io.Map che in genere memorizza i documenti PDF. - Oggetto
com.adobe.livecycle.assembler.client.AssemblerOptionSpec
che specifica le opzioni di runtime.
Il metodo
invokeDDX
restituisce un oggettoAssemblerResult
che contiene informazioni che specificano se il documento DDX è valido. - Oggetto
-
Salvare i risultati della convalida in un file di registro.
- Creare un oggetto
java.io.File
e verificare che l'estensione del nome file sia .xml. - Richiama il metodo
getJobLog
dell'oggettoAssemblerResult
. Questo metodo restituisce un'istanzacom.adobe.idp.Document
che contiene informazioni di convalida. - Richiama il metodo
copyToFile
dell'oggettocom.adobe.idp.Document
per copiare il contenuto dell'oggettocom.adobe.idp.Document
nel file.
note note NOTE Se il documento DDX non è valido, viene generato un OperationException
. Nell'istruzione catch è possibile richiamare il metodogetJobLog
dell'oggettoOperationException
. - Creare un oggetto
Consulta anche
Guida rapida (modalità SOAP): convalida dei documenti DDX tramite l'API Java (modalità SOAP)
Convalidare un documento DDX utilizzando l’API del servizio web validate-a-ddx-document-using-the-web-service-api
Convalidare un documento DDX utilizzando l'API del servizio Assembler (servizio Web):
-
Includi file di progetto.
Creare un progetto Microsoft .NET che utilizza MTOM. Assicurarsi di utilizzare la seguente definizione WSDL:
http://localhost:8080/soap/services/AssemblerService?WSDL&lc_version=9.0.1
.note note NOTE Sostituire localhost con l'indirizzo IP di Forms Server. -
Creare un client PDF Assembler.
-
Creare un oggetto
AssemblerServiceClient
utilizzando il relativo costruttore predefinito. -
Creare un oggetto
AssemblerServiceClient.Endpoint.Address
utilizzando il costruttoreSystem.ServiceModel.EndpointAddress
. Passa un valore stringa che specifica il WSDL al servizio AEM Forms (ad esempio,http://localhost:8080/soap/services/AssemblerService?blob=mtom
). Non è necessario utilizzare l'attributolc_version
. Questo attributo viene utilizzato quando si crea un riferimento a un servizio. -
Creare un oggetto
System.ServiceModel.BasicHttpBinding
ottenendo il valore del campoAssemblerServiceClient.Endpoint.Binding
. Eseguire il cast del valore restituito inBasicHttpBinding
. -
Impostare il campo
MessageEncoding
dell'oggettoSystem.ServiceModel.BasicHttpBinding
suWSMessageEncoding.Mtom
. Questo valore assicura che venga utilizzato MTOM. -
Abilita l’autenticazione HTTP di base eseguendo le seguenti attività:
- Assegnare il nome utente dei moduli AEM al campo
AssemblerServiceClient.ClientCredentials.UserName.UserName
. - Assegnare il valore della password corrispondente al campo
AssemblerServiceClient.ClientCredentials.UserName.Password
. - Assegnare il valore costante
HttpClientCredentialType.Basic
al campoBasicHttpBindingSecurity.Transport.ClientCredentialType
. - Assegnare il valore costante
BasicHttpSecurityMode.TransportCredentialOnly
al campoBasicHttpBindingSecurity.Security.Mode
.
- Assegnare il nome utente dei moduli AEM al campo
-
-
Fare riferimento a un documento DDX esistente.
- Creare un oggetto
BLOB
utilizzando il relativo costruttore. L'oggettoBLOB
viene utilizzato per archiviare il documento DDX. - Creare un oggetto
System.IO.FileStream
richiamandone il costruttore e passando un valore stringa che rappresenta la posizione del file del documento DDX e la modalità di apertura del file in. - Creare una matrice di byte che memorizza il contenuto dell'oggetto
System.IO.FileStream
. È possibile determinare le dimensioni della matrice di byte ottenendo la proprietàLength
dell'oggettoSystem.IO.FileStream
. - Compilare la matrice di byte con i dati di flusso richiamando il metodo
Read
dell'oggettoSystem.IO.FileStream
e passando la matrice di byte, la posizione iniziale e la lunghezza del flusso da leggere. - Compilare l'oggetto
BLOB
assegnando la relativa proprietàMTOM
al contenuto della matrice di byte.
- Creare un oggetto
-
Impostare le opzioni di runtime per convalidare il documento DDX.
- Creare un oggetto
AssemblerOptionSpec
che memorizza le opzioni di runtime utilizzando il relativo costruttore. - Impostare l'opzione di runtime che indica al servizio Assembler di convalidare il documento DDX assegnando il valore true al membro dati
validateOnly
dell'oggettoAssemblerOptionSpec
. - Impostare la quantità di informazioni che il servizio Assembler scrive nel file di log assegnando un valore stringa al membro dati
logLevel
dell'oggettoAssemblerOptionSpec
. Metodo Durante la convalida di un documento DDX, è necessario inserire nel file di registro ulteriori informazioni utili per il processo di convalida. È quindi possibile specificare il valoreFINE
oFINER
. Per informazioni sulle opzioni di runtime che è possibile impostare, vedere il riferimento alla classeAssemblerOptionSpec
in Riferimento API di AEM Forms.
- Creare un oggetto
-
Eseguire la convalida.
Richiama il metodo
invokeDDX
dell'oggettoAssemblerServiceClient
e passa i seguenti valori:- Oggetto
BLOB
che rappresenta il documento DDX. - Valore
null
per l'oggettoMap
che in genere memorizza i documenti PDF. - Oggetto
AssemblerOptionSpec
che specifica le opzioni di runtime.
Il metodo
invokeDDX
restituisce un oggettoAssemblerResult
che contiene informazioni che specificano se il documento DDX è valido. - Oggetto
-
Salvare i risultati della convalida in un file di registro.
- Creare un oggetto
System.IO.FileStream
richiamandone il costruttore e passando un valore stringa che rappresenta la posizione del file di log e la modalità di apertura del file in. Verificare che l'estensione del nome file sia .xml. - Creare un oggetto
BLOB
che memorizza le informazioni di registro ottenendo il valore del membro datijobLog
dell'oggettoAssemblerResult
. - Creare una matrice di byte che memorizza il contenuto dell'oggetto
BLOB
. Compilare la matrice di byte ottenendo il valore del campoMTOM
dell'oggettoBLOB
. - Creare un oggetto
System.IO.BinaryWriter
richiamandone il costruttore e passando l'oggettoSystem.IO.FileStream
. - Scrivere il contenuto della matrice di byte in un file PDF richiamando il metodo
Write
dell'oggettoSystem.IO.BinaryWriter
e passando la matrice di byte.
note note NOTE Se il documento DDX non è valido, viene generato un OperationException
. Nell'istruzione catch è possibile ottenere il valore del membrojobLog
dell'oggettoOperationException
. - Creare un oggetto
Consulta anche
Richiamare AEM Forms tramite MTOM