Sie können ein DDX-Dokumen, das vom Assembler-Service verwendet wird, programmgesteuert validieren. Mit der Assembler-Service-API können Sie also feststellen, ob ein DDX-Dokument gültig ist. Wenn Sie beispielsweise ein Upgrade von einer früheren AEM Forms-Version durchgeführt haben und sicherstellen möchten, dass Ihr DDX-Dokument gültig ist, können Sie es mithilfe der Assembler-Service-API überprüfen.
Weitere Informationen zum Assembler-Service finden Sie in der Service-Referenz für AEM Forms.
Weitere Informationen zu einem DDX-Dokument finden Sie in der Referenz für Assembler-Service und DDX.
Führen Sie die folgenden Aufgaben aus, um ein DDX-Dokument zu validieren:
Projektdateien einbeziehen
Schließen Sie die erforderlichen Dateien in Ihr Entwicklungsprojekt ein. Wenn Sie eine Clientanwendung mit Java erstellen, schließen Sie die erforderlichen JAR-Dateien ein. Wenn Sie Webdienste verwenden, stellen Sie sicher, dass Sie die Proxy-Dateien einschließen.
Die folgenden JAR-Dateien müssen zum Klassenpfad Ihres Projekts hinzugefügt werden:
Wenn AEM Forms auf einem anderen unterstützten J2EE-Anwendungsserver als JBoss bereitgestellt wird, müssen Sie die Dateien adobe-utilities.jar- und jbossall-client.jar-Dateien durch JAR-Dateien ersetzen, die für den J2EE-Anwendungsserver spezifisch sind, auf dem AEM Forms bereitgestellt wird.
PDF Assembler-Client erstellen
Bevor Sie einen Assembler-Vorgang programmgesteuert ausführen können, müssen Sie einen Assembler-Dienst-Client erstellen.
Vorhandenes DDX-Dokument referenzieren
Um ein DDX-Dokument zu validieren, müssen Sie auf ein vorhandenes DDX-Dokument verweisen.
Laufzeitoptionen zum Validieren des DDX-Dokuments festlegen
Wenn Sie ein DDX-Dokument validieren möchten, müssen Sie bestimmte Laufzeitoptionen festlegen, die den Assembler-Service anweisen, das DDX-Dokument zu validieren, anstatt es auszuführen. Außerdem können Sie die Informationsmenge erhöhen, die der Assembler-Service in die Protokolldatei schreibt.
Validierung durchführen
Nachdem Sie den Assembler-Service-Client erstellt, auf das DDX-Dokument verwiesen und Laufzeitoptionen festgelegt haben, können Sie den invokeDDX
-Vorgang zum Überprüfen des DDX-Dokuments aufrufen. Bei der Validierung des DDX-Dokuments können Sie null
als map-Parameter übergeben (dieser Parameter speichert in der Regel PDF-Dokumente, die der Assembler benötigt, um die im DDX-Dokument angegebenen Vorgänge auszuführen).
Wenn die Validierung fehlschlägt, wird eine Ausnahme ausgelöst und die Protokolldatei enthält Details, die erklären, warum das DDX-Dokument ungültig ist. Diese Details können Sie von der OperationException
-Instanz abgerufen werden. Nach der grundlegenden XML-Analyse und Schemaprüfung wird die Validierung anhand der DDX-Spezifikation durchgeführt. Alle im DDX-Dokument enthaltenen Fehler werden im Protokoll angegeben.
Die Prüfergebnisse in einer Protokolldatei speichern
Der Assembler-Service gibt die Validierungsergebnisse zurück, die Sie in eine XML-Protokolldatei schreiben können. Die Menge der Details, die der Assembler-Service in die Protokolldatei schreibt, hängt von der von Ihnen festgelegten Laufzeitoption ab.
Siehe auch
Überprüfen eines DDX-Dokuments mit der Java-API
Validieren eines DDX-Dokuments mithilfe der Webservice-API
Einbeziehung von AEM Forms Java-Bibliotheksdateien
Verbindungseigenschaften festlegen
Programmatisches Zusammenstellen von PDF-Dokumenten
Validieren Sie ein DDX-Dokument mithilfe der Assembler Service-API (Java):
Schließen Sie Projektdateien ein.
Fügen Sie Client-JAR-Dateien wie „adobe-assembler-client.jar“ in den Klassenpfad Ihres Java-Projekts ein.
Erstellen Sie einen PDF Assembler-Client.
ServiceClientFactory
-Objekt, das Verbindungseigenschaften enthält.AssemblerServiceClient
-Objekt, indem Sie seinen Konstruktor verwenden und das ServiceClientFactory
-Objekt übergeben.Referenzieren Sie ein vorhandenes DDX-Dokument.
java.io.FileInputStream
-Objekt, das das DDX-Dokument darstellt, indem Sie seinen Konstruktor verwenden und einen Zeichenfolgenwert übergeben, der den Speicherort der DDX-Datei angibt.com.adobe.idp.Document
-Objekt, indem Sie seinen Konstruktor verwenden und das java.io.FileInputStream
-Objekt übergeben.Legen Sie Laufzeitoptionen fest, um das DDX-Dokument zu validieren.
AssemblerOptionSpec
-Objekt, das Laufzeitoptionen mithilfe seines Konstruktors speichert.AssemblerOptionSpec
-Objekts aufrufen und true
übergeben.getLogLevel
-Methode des AssemblerOptionSpec
-Objekts und den Zeichenfolgenwert übergeben, der Ihre Anforderungen erfüllt. Beim Validieren eines DDX-Dokuments sollten weitere Informationen in die Protokolldatei geschrieben werden, die für den Validierungsprozess hilfreich sind. Folglich können Sie den Wert FINE
oder FINER
übergeben.Führen Sie die Überprüfung durch.
Rufen Sie die Methode invokeDDX
des AssemblerServiceClient
-Objekts auf und übergeben Sie die folgenden Werte:
com.adobe.idp.Document
-Objekt, das das DDX-Dokument darstellt.null
für das java.io.Map-Objekt, das normalerweise PDF-Dokumente speichert.com.adobe.livecycle.assembler.client.AssemblerOptionSpec
-Objekt, das die Laufzeitoptionen angibt.Die Methode invokeDDX
gibt ein AssemblerResult
-Objekt zurück, das Informationen darüber enthält, ob das DDX-Dokument gültig ist.
Speichern Sie die Validierungsergebnisse in einer Protokolldatei.
java.io.File
-Objekt und stellen Sie sicher, dass die Dateinamenerweiterung .xml lautet.getJobLog
des AssemblerResult
-Objekts auf. Diese Methode gibt eine com.adobe.idp.Document
-Instanz zurück, die Validierungsinformationen enthält.copyToFile
des com.adobe.idp.Document
-Objekts auf, um den Inhalt des com.adobe.idp.Document
-Objekts in die Datei zu kopieren.Wenn das DDX-Dokument ungültig ist, wird eine OperationException
ausgelöst. Innerhalb der catch-Anweisung können Sie die Methode getJobLog
des OperationException
-Objekts aufrufen.
Siehe auch
Kurzanleitung (SOAP-Modus): Validieren von DDX-Dokumenten mithilfe der Java-API (SOAP-Modus)
Einbeziehung von AEM Forms Java-Bibliotheksdateien
Verbindungseigenschaften festlegen
So validieren Sie ein DDX-Dokument mithilfe der Assembler Service-API (Webservice):
Schließen Sie Projektdateien ein.
Erstellen Sie ein Microsoft .NET-Projekt, das MTOM verwendet. Stellen Sie sicher, dass Sie die folgende WSDL-Definition verwenden: http://localhost:8080/soap/services/AssemblerService?WSDL&lc_version=9.0.1
.
Ersetzen Sie localhost durch die IP-Adresse des Formularservers.
Erstellen Sie einen PDF Assembler-Client.
Erstellen Sie ein AssemblerServiceClient
-Objekt, indem Sie seinen standardmäßigen Konstruktor verwenden.
Erstellen Sie ein AssemblerServiceClient.Endpoint.Address
-Objekt mithilfe des System.ServiceModel.EndpointAddress
-Konstruktors. Übergeben Sie einen Zeichenfolgenwert mit der WSDL an den AEM Forms-Service (z. B. http://localhost:8080/soap/services/AssemblerService?blob=mtom
). Sie müssen das lc_version
-Attribut nicht verwenden. Dieses Attribut wird verwendet, wenn Sie einen Service-Verweis erstellen.
Erstellen Sie ein System.ServiceModel.BasicHttpBinding
-Objekr, indem Sie den Wert des Felds AssemblerServiceClient.Endpoint.Binding
abrufen. Wandeln Sie den Rückgabewert in BasicHttpBinding
um.
Legen Sie das MessageEncoding
-Feld des System.ServiceModel.BasicHttpBinding
-Objekts auf WSMessageEncoding.Mtom
fest. Dieser Wert stellt sicher, dass MTOM verwendet wird.
Aktivieren Sie die einfache HTTP-Authentifizierung, indem Sie die folgenden Schritte ausführen:
AssemblerServiceClient.ClientCredentials.UserName.UserName
den AEM Forms-Benutzernamen zu.AssemblerServiceClient.ClientCredentials.UserName.Password
den entsprechenden Passwortwert zu.BasicHttpBindingSecurity.Transport.ClientCredentialType
den konstanten Wert HttpClientCredentialType.Basic
zu.BasicHttpBindingSecurity.Security.Mode
den Konstantenwert BasicHttpSecurityMode.TransportCredentialOnly
zu.Referenzieren Sie ein vorhandenes DDX-Dokument.
BLOB
, indem Sie den Konstruktor verwenden. Das BLOB
-Objekt wird zum Speichern des DDX-Dokuments verwendet.System.IO.FileStream
, indem Sie den Konstruktor aufrufen und einen String-Wert übergeben, der den Dateispeicherort des DDX-Dokuments und den Modus, in dem die Datei geöffnet werden soll, repräsentiert.System.IO.FileStream
-Objekts speichert. Sie können die Größe des Byte-Arrays bestimmen, indem Sie die Length
-Eigenschaft des System.IO.FileStream
-Objekts abrufen.Read
-Methode des System.IO.FileStream
-Objekts aufrufen und das Byte-Array, die Startposition und die zu lesende Stream-Länge übergeben.BLOB
-Objekt, indem Sie seiner MTOM
-Eigenschaft den Inhalt des Byte-Arrays zuweisen.Legen Sie Laufzeitoptionen fest, um das DDX-Dokument zu validieren.
AssemblerOptionSpec
-Objekt, das Laufzeitoptionen speichert, indem Sie seinen Konstruktor verwenden.validateOnly
des AssemblerOptionSpec
-Objekts den Wert „true“ zuweisen.logLevel
des AssemblerOptionSpec
-Objekts einen Zeichenfolgenwert zuweisen. Bei der Validierung eines DDX-Dokuments sollten mehr Informationen in die Protokolldatei geschrieben werden, um den Validierungsprozess zu unterstützen. Daher können Sie den Wert FINE
oder FINER
angeben. Weitere Informationen zu den Laufzeitoptionen, die Sie festlegen können, finden Sie in der AssemblerOptionSpec
-Klassenreferenz in der AEM Forms-API-Referenz.Führen Sie die Überprüfung durch.
Rufen Sie die Methode invokeDDX
des AssemblerServiceClient
-Objekts auf und übergeben Sie die folgenden Werte:
BLOB
-Objekt, das das DDX-Dokument darstellt.null
für das Map
-Objekt, das normalerweise PDF-Dokumente speichert.AssemblerOptionSpec
-Objekt, das Laufzeitoptionen angibt.Die invokeDDX
-Methode gibt ein AssemblerResult
-Objekt zurück, das Informationen enthält, die angeben, ob das DDX-Dokument gültig ist.
Speichern Sie die Validierungsergebnisse in einer Protokolldatei.
System.IO.FileStream
-Objekt, indem Sie seinen Konstruktor aufrufen und ihm einen Zeichenfolgenwert übergeben, der den Dateispeicherort der Protokolldatei und den Modus zum Öffnen der Datei darstellt. Stellen Sie sicher, dass die Dateinamenerweiterung .xml lautet.BLOB
-Objekt, das Protokollinformationen speichert, indem Sie den Wert des jobLog
-Datenelements des AssemblerResult
-Objekts abrufen.BLOB
-Objekts gespeichert wird. Füllen Sie das Byte-Array, indem Sie den Wert aus dem MTOM
-Feld des BLOB
-Objekts abrufen.System.IO.BinaryWriter
-Objekt, indem Sie seinen Konstruktor verwenden und das System.IO.FileStream
-Objekt übergeben.Write
-Methode des System.IO.BinaryWriter
-Objekts aufrufen und ihr das Byte-Array übergeben.Wenn das DDX-Dokument ungültig ist, wird eine OperationException
ausgelöst. Innerhalb der catch-Anweisung können Sie den Wert des jobLog
-Elements des OperationException
-Objekts abrufen.
Siehe auch
AEM Forms mithilfe von MTOM aufrufen