AEM Forms mit Web Services aufrufen invoking-aem-forms-using-web-services
Die Beispiele in diesem Dokument gelten nur für eine AEM Forms on JEE-Umgebung.
Die meisten AEM Forms-Services im Service-Container sind so konfiguriert, dass sie einen Webservice bereitstellen, wobei die Generierung von WSDL (Web Service Definition Language) vollständig unterstützt wird. Das heißt, Sie können Proxy-Objekte erstellen, die den nativen SOAP-Stapel eines AEM Forms-Services verwenden. Daher können AEM Forms-Services die folgenden SOAP-Nachrichten austauschen und verarbeiten:
- SOAP-Anfrage: Wird von einem Client-Programm an einen Forms-Service gesendet und fordert eine Aktion an.
- SOAP-Antwort: Wird von einem Forms-Service an ein Client-Programm gesendet, nachdem eine SOAP-Anfrage verarbeitet wurde.
Mithilfe von Web-Services können Sie dieselben AEM Forms-Service-Vorgänge ausführen, die Sie auch mithilfe der Java-API ausführen können. Ein Vorteil der Verwendung von Web-Services zum Aufrufen von AEM Forms-Services ist, dass Sie ein Client-Programm in einer Entwicklungsumgebung erstellen können, die SOAP unterstützt. Ein Client-Programm ist nicht an eine bestimmte Entwicklungsumgebung oder Programmiersprache gebunden. Sie können beispielsweise ein Client-Programm mit Microsoft Visual Studio .NET und C# als Programmiersprache erstellen.
AEM Forms-Services werden über das SOAP-Protokoll bereitgestellt und sind mit WSI Basic Profile 1.1 kompatibel. Web Services Interoperability (WSI) ist eine Organisation mit offenen Standards, die die Interoperabilität von Web-Services plattformübergreifend fördert. Weitere Informationen finden Sie unter https://www.ws-i.org/.
AEM Forms unterstützt die folgenden Webservice-Standards:
- Codierung: Unterstützt nur Dokumenten- und Literalcodierung (die gemäß WSI Basic Profile die bevorzugte Codierung ist). (Siehe Aufrufen von AEM Forms mithilfe von Base64-Codierung.)
- MTOM: Stellt eine Möglichkeit dar, Anlagen mit SOAP-Anforderungen zu codieren. (Siehe Aufrufen von AEM Forms mithilfe von MTOM.)
- SwaRef: Stellt eine andere Möglichkeit dar, Anlagen mit SOAP-Anforderungen zu codieren. (Siehe Aufrufen von AEM Forms mithilfe von SwaRef.)
- SOAP mit Anlagen: Unterstützt sowohl MIME als auch DIME (Direct Internet Message Encapulation). Diese Protokolle sind Standardmethoden zum Senden von Anhängen über SOAP. Microsoft Visual Studio .NET-Programme verwenden DIME. (Siehe Aufrufen von AEM Forms mithilfe von Base64-Codierung.)
- WS-Sicherheit: Unterstützt ein Token-Profil für Benutzernamen und Kennwort, das eine Standardmethode zum Senden von Benutzernamen und Kennwörtern als Teil der SOAP-Kopfzeile von WS Security ist. AEM Forms unterstützt auch die HTTP-Standardauthentifizierung. Sek.
Um AEM Forms-Services über einen Webservice aufzurufen, erstellen Sie in der Regel eine Proxy-Bibliothek, die die WSDL des Services verwendet. Der Abschnitt Aufrufen von AEM Forms mithilfe von Web Services verwendet JAX-WS, um Java-Proxy-Klassen zum Aufrufen von Services zu erstellen. (Siehe Erstellen von Java-Proxy-Klassen mithilfe von JAX-WS.)
Sie können eine Service-WSDL abrufen, indem Sie die folgende URL-Definition angeben (Elemente in Klammern sind optional):
https://<your_serverhost>:<your_port>/soap/services/<service_name>?wsdl[&version=<version>][&async=true|false][lc_version=<lc_version>]
Hierbei gilt:
- your_serverhost stellt die IP-Adresse des J2EE-Programm-Servers dar, auf dem AEM Forms gehostet wird.
- your_port stellt den HTTP-Anschluss dar, den der J2EE-Programm-Server verwendet.
- service_name stellt den Namen des Services dar.
- version stellt die Zielversion eines Services dar (standardmäßig wird die neueste Version des Services verwendet).
async
gibt den Werttrue
an, um zusätzliche Vorgänge für den asynchronen Aufruf zu aktivieren (standardmäßigfalse
).- lc_version stellt die Version von AEM Forms dar, die Sie aufrufen möchten.
In der folgenden Tabelle sind die WSDL-Definitionen des Services aufgeführt (unter der Annahme, dass AEM Forms auf dem lokalen Host bereitgestellt wird und der Port 8080 ist).
http://localhost:8080/soap/services/ AssemblerService?wsdl
http://localhost:8080/soap/services/BackupService?wsdl
http://localhost:8080/soap/services/ BarcodedFormsService?wsdl
http://localhost:8080/soap/services/ ConvertPDFService?wsdl
http://localhost:8080/soap/services/ DistillerService?wsdl
http://localhost:8080/soap/services/DocConverterService?WSDL
http://localhost:8080/soap/services/DocumentManagementService?WSDL
http://localhost:8080/soap/services/EncryptionService?wsdl
http://localhost:8080/soap/services/FormsService?wsdl
http://localhost:8080/soap/services/FormDataIntegration?wsdl
http://localhost:8080/soap/services/ GeneratePDFService?wsdl
http://localhost:8080/soap/services/Generate3dPDFService?WSDL
http://localhost:8080/soap/services/ OutputService?wsdl
http://localhost:8080/soap/services/ PDFUtilityService?wsdl
http://localhost:8080/soap/services/ ReaderExtensionsService?wsdl
http://localhost:8080/soap/services/ RepositoryService?wsdl
http://localhost:8080/soap/services/ RightsManagementService?wsdl
http://localhost:8080/soap/services/ SignatureService?wsdl
http://localhost:8080/soap/services/ XMPUtilityService?wsdl
WSDL-Definitionen für AEM Forms-Prozesse
Geben Sie den Anwendungsnamen und den Prozessnamen in der WSDL-Definition an, um auf eine WSDL zugreifen zu können, die zu einem in Workbench erstellten Prozess gehört. Angenommen, der Name des Programms lautet MyApplication
und der Name des Prozesses lautet EncryptDocument
. Geben Sie in diesem Fall die folgende WSDL-Definition an:
http://localhost:8080/soap/services/MyApplication/EncryptDocument?wsdl
MyApplication/EncryptDocument
finden Sie unter Beispiel für kurzlebige Prozesse. http://localhost:8080/soap/services/MyApplication/[<folderA>/.../<folderZ>/]EncryptDocument?wsdl
Zugriff auf neue Funktionen mithilfe von Web-Services
Auf neue Service-Funktionen in AEM Forms kann mithilfe von Web-Services zugegriffen werden. In AEM Forms wird beispielsweise die Möglichkeit eingeführt, Anhänge mithilfe von MTOM zu codieren. (Siehe Aufrufen von AEM Forms mithilfe von MTOM.)
Um auf die in AEM Forms eingeführten neuen Funktionen zuzugreifen, geben Sie in der WSDL-Definition das Attribut lc_version
an. Um beispielsweise auf neue Service-Funktionen (einschließlich MTOM-Unterstützung) zuzugreifen, geben Sie die folgende WSDL-Definition an:
http://localhost:8080/soap/services/MyApplication/EncryptDocument?wsdl&lc_version=9.0.1
lc_version
darauf, dass Sie drei Ziffern verwenden. Beispielsweise entspricht 9.0.1 der Version 9.0.Webservice-BLOB-Datentyp
Die WSDLs der AEM Forms-Services definieren viele Datentypen. Einer der wichtigsten Datentypen, die in einem Webservice verfügbar gemacht werden, ist ein BLOB
-Typ. Dieser Datentyp wird beim Arbeiten mit AEM Forms-Java-APIs der Klasse com.adobe.idp.Document
zugeordnet. (Siehe Übergeben von Daten an AEM Forms-Services mithilfe der Java-API).
Ein BLOB
-Objekt sendet Binärdaten (z. B. PDF-Dateien, XML-Daten usw.) an AEM Forms-Services und ruft sie von ihnen ab. Der BLOB
-Typ wird in einer Service-WSDL wie folgt definiert:
<complexType name="BLOB">
<sequence>
<element maxOccurs="1" minOccurs="0" name="contentType"
type="xsd:string"/>
<element maxOccurs="1" minOccurs="0" name="binaryData"
type="xsd:base64Binary"/>
<element maxOccurs="1" minOccurs="0" name="attachmentID"
type="xsd:string"/>
<element maxOccurs="1" minOccurs="0" name="remoteURL"
type="xsd:string"/>
<element maxOccurs="1" minOccurs="0" name="MTOM"
type="xsd:base64Binary"
xmime:expectedContentTypes="*/*"
xmlns:xmime="https://www.w3.org/2005/05/xmlmime"/>
<element maxOccurs="1" minOccurs="0" name="swaRef"
type="tns1:swaRef"/>
<element maxOccurs="1" minOccurs="0" name="attributes"
type="impl:MyMapOf_xsd_string_To_xsd_anyType"/>
</sequence>
</complexType>
Die Felder MTOM
und swaRef
werden nur in AEM Forms unterstützt. Sie können diese neuen Felder nur verwenden, wenn Sie eine URL angeben, die die Eigenschaft lc_version
enthält.
Bereitstellen von BLOB-Objekten in Service-Anforderungen
Wenn ein Service-Vorgang von AEM Forms einen BLOB
-Typ als Eingabewert erfordert, erstellen Sie in Ihrer Anwendungslogik eine Instanz des BLOB
-Typs. (Viele der Webservice-Schnellstartanleitungen unter Programmieren mit AEM Forms zeigen, wie Sie mit einem BLOB-Datentyp arbeiten).
Weisen Sie den Feldern, die zur BLOB
-Instanz gehören, wie folgt Werte zu:
- Base64: Um Daten als im Base64-Format kodierten Text zu übergeben, legen Sie die Daten im Feld
BLOB.binaryData
und den Datentyp im MIME-Format (beispielsweiseapplication/pdf
) im FeldBLOB.contentType
fest. (Siehe Aufrufen von AEM Forms mit Base64-Kodierung.) - MTOM: Um Binärdaten in einer MTOM-Anlage zu übergeben, geben Sie die Daten im Feld
BLOB.MTOM
ein. Mit dieser Einstellung werden die Daten über das Java JAX-WS-Framework oder die native API des SOAP-Frameworks an die SOAP-Anfrage angehängt. (Siehe Aufruf von AEM Forms mit MTOM.) - SwaRef: Um Binärdaten in einem WS-I SwaRef-Anhang zu übergeben, geben Sie die Daten im
BLOB.swaRef
-Feld ein. Mit dieser Einstellung werden die Daten unter Verwendung des Java JAX-WS-Frameworks an die SOAP-Anfrage angehängt. (Siehe Aufruf von AEM Forms mit SwaRef.) - MIME- oder DIME-Anlage: Um Daten in einer MIME- oder DIME-Anlage zu übergeben, fügen Sie die Daten mithilfe der nativen API des SOAP-Frameworks der SOAP-Anfrage hinzu. Legen Sie die Anlagenkennung im
BLOB.attachmentID
-Feld fest. (Siehe Aufruf von AEM Forms mit Base64-Kodierung.) - Remote URL: Wenn die Daten auf einem Webserver gehostet werden und über eine HTTP-URL zugänglich sind, geben Sie die HTTP-URL in das Feld
BLOB.remoteURL
ein. (Siehe Aufruf von AEM Forms mit BLOB-Daten über HTTP.)
Zugriff auf Daten in BLOB-Objekten, die von Diensten zurückgegeben werden
Das Übermittlungsprotokoll für zurückgesendete BLOB
-Objekte hängt von mehreren Faktoren ab, die in der folgenden Reihenfolge berücksichtigt werden und das bei Erfüllung der Hauptbedingung beendet wird:
-
Ziel-URL legt Übertragungsprotokoll fest. Wenn die Ziel-URL, die beim SOAP-Aufruf angegeben wurde, den Parameter
blob="
BLOB_TYPE“ enthält, dann bestimmt BLOB_TYPE das Übertragungsprotokoll. BLOB_TYPE ist ein Platzhalter für base64, dime, mime, http, mtom oder slagerf. -
SOAP-Endpunkt des Dienstes ist Smart. Wenn die folgenden Bedingungen erfüllt sind, werden die Ausgabedokumente unter Verwendung des gleichen Übertragungsprotokolls wie die Eingabedokumente zurückgegeben:
-
Der SOAP-Endpunktparameter des Standardprotokoll-Dienstes für Ausgabe-Blob-Objekte ist auf Smart gesetzt.
Für jeden Dienst mit einem SOAP-Endpunkt können Sie in der Administrationskonsole das Übertragungsprotokoll für alle zurückgegebenen Blobs festlegen. (Siehe Administration-Hilfe.)
-
Der AEM Forms-Dienst akzeptiert ein oder mehrere Dokumente als Eingabe.
-
-
Service SOAP-Endpunkt ist nicht Smart. Das konfigurierte Protokoll bestimmt das Dokumentübertragungsprotokoll, und die Daten werden im entsprechenden
BLOB
-Feld zurückgegeben. Wenn der SOAP-Endpunkt beispielsweise auf DIME gesetzt ist, befindet sich der zurückgegebene Blob imblob.attachmentID
-Feld, unabhängig vom Übertragungsprotokoll eines beliebigen Eingabedokuments. -
Andernfalls. Wenn ein Dienst den Dokumenttyp nicht als Eingabe verwendet, werden die Ausgabedokumente im
BLOB.remoteURL
-Feld über das HTTP-Protokoll zurückgegeben.
Wie in der ersten Bedingung beschrieben, können Sie den Übertragungstyp für alle zurückgegebenen Dokumente sicherstellen, indem Sie die SOAP-Endpunkt-URL wie folgt um ein Suffix erweitern:
https://<your_serverhost>:<your_port>/soap/services/<service
name>?blob=base64|dime|mime|http|mtom|swaref
Im Folgenden wird der Zusammenhang zwischen den Übertragungsarten und dem Feld, aus dem Sie die Daten beziehen, erläutert:
- Base64-Format: Setzen Sie das
blob
-Suffix aufbase64
, um die Daten imBLOB.binaryData
-Feld zurückzugeben. - MIME- oder DIME-Anhang: Setzen Sie das
blob
-Suffix aufDIME
oderMIME
, um die Daten als einen entsprechenden Anlagetyp mit der im FeldBLOB.attachmentID
zurückgegebenen Anlagekennung zurückzugeben. Verwenden Sie die proprietäre API des SOAP-Frameworks, um die Daten aus der Anlage zu lesen. - Remote URL: Setzen Sie das
blob
-Suffix aufhttp
, um die Daten auf dem Anwendungsserver zu speichern und die URL zurückzugeben, die auf die Daten imBLOB.remoteURL
-Feld verweist. - MTOM oder SwaRef: Setzen Sie das
blob
-Suffix aufmtom
oderswaref
, um die Daten als entsprechenden Anlagentyp mit der in den FeldernBLOB.MTOM
oderBLOB.swaRef
zurückgegebenen Anlagenkennung zurückzugeben. Verwenden Sie die native API des SOAP-Frameworks, um die Daten aus der Anlage zu lesen.
BLOB
-Objekt durch Aufruf seiner setBinaryData
-Methode befüllen. Andernfalls besteht die Möglichkeit, dass eine OutOfMemory
-Ausnahme auftritt.OutOfMemory
-Ausnahme.MTOM-Übertragung von base64-kodierten Byte-Arrays
Zusätzlich zum BLOB
-Objekt unterstützt das MTOM-Protokoll sämtliche Byte-Array-Parameter oder Byte-Array-Felder eines komplexen Typs. Dies bedeutet, dass Client-SOAP-Frameworks, die MTOM unterstützen, jedes xsd:base64Binary
-Element als MTOM-Anlage senden können (anstelle eines base64-kodierten Textes). AEM Forms SOAP-Endpunkte können diesen Typ der Byte-Array-Kodierung lesen. Der AEM Forms-Dienst gibt jedoch immer einen Byte-Array-Typ als base64-kodierten Text zurück. Die Parameter für die Ausgabe von Byte-Arrays unterstützen kein MTOM.
AEM Forms-Dienste, die eine große Menge an Binärdaten zurückgeben, verwenden den Typ Dokument/BLOB anstelle des Typs Byte-Array. Der Dokumententyp ist wesentlich effizienter für die Übertragung großer Datenmengen.
Webdienst-Datentypen web-service-data-types
In der folgenden Tabelle sind die Java-Datentypen mit dem entsprechenden Webdienst-Datentyp aufgeführt.
java.lang.byte[]
xsd:base64Binary
java.lang.Boolean
xsd:boolean
java.util.Date
Der DATE
-Typ, der in einer Dienst-WSDL wie folgt definiert ist:
<complexType name="DATE">
<sequence>
<element maxOccurs="1" minOccurs="0" name="date" ``type="xsd:dateTime" />
<element maxOccurs="1" minOccurs="0" name="calendar" ``type="xsd:dateTime" />
</sequence>
</complexType>
Wenn ein AEM Forms-Dienstvorgang einen java.util.Date
-Wert als Eingabe verwendet, muss die SOAP-Client-Anwendung das Datum im Feld DATE.date
übergeben. Das Setzen des DATE.calendar
-Feldes führt in diesem Fall zu einer Laufzeitausnahme. Wenn der Dienst ein java.util.Date
zurückgibt, wird das Datum in das Feld DATE.date
zurückgegeben.
java.util.Calendar
Der DATE
-Typ, der in einer Dienst-WSDL wie folgt definiert ist:
<complexType name="DATE">
<sequence>
<element maxOccurs="1" minOccurs="0" name="date" ``type="xsd:dateTime" />
<element maxOccurs="1" minOccurs="0" name="calendar" ``type="xsd:dateTime" />
</sequence>
</complexType>
Wenn ein AEM Forms-Dienstvorgang einen java.util.Calendar
-Wert als Eingabe verwendet, muss die SOAP-Client-Anwendung das Datum im DATE.caledendar
-Feld übergeben. Das Setzen des DATE.date
-Feldes führt in diesem Fall zu einer Laufzeitausnahme. Wenn der Dienst ein java.util.Calendar
zurückgibt, wird das Datum im DATE.calendar
-Feld zurückgegeben.
java.math.BigDecimal
xsd:decimal
com.adobe.idp.Document
BLOB
java.lang.Double
xsd:double
java.lang.Float
xsd:float
java.lang.Integer
xsd:int
java.util.List
MyArrayOf_xsd_anyType
java.lang.Long
xsd:long
java.util.Map
Die apachesoap:Map
, die in einer Dienst-WSDL wie folgt definiert ist:
<schema elementFormDefault="qualified" targetNamespace="https://xml.apache.org/xml-soap" xmlns="https://www.w3.org/2001/XMLSchema">
<complexType name="mapItem">
<sequence>
<element name="key" nillable="true" type="xsd:anyType"/>
<element name="value" nillable="true" type="xsd:anyType"/>
</sequence>
</complexType>
<complexType name="Map">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="item" ``type="apachesoap:mapItem"/>
</sequence>
</complexType>
</schema>
Die Map wird als Sequenz von Schlüssel/Wert-Paaren dargestellt.
java.lang.Object
$1
java.lang.Short
xsd:short
java.lang.String
xsd:string
org.w3c.dom.Document
Der XML-Typ, der in einer Dienst-WSDL wie folgt definiert ist:
<complexType name="XML">
<sequence>
<element maxOccurs="1" minOccurs="0" name="document" ``type="xsd:string" />
<element maxOccurs="1" minOccurs="0" name="element" ``type="xsd:string" />
</sequence>
</complexType>
Wenn ein AEM Forms-Dienstvorgang einen org.w3c.dom.Document
-Wert annimmt, übergeben Sie die XML-Daten im XML.document
-Feld.
Das Setzen des XML.element
-Feldes führt zu einer Laufzeitausnahme. Wenn der Dienst ein org.w3c.dom.Document
zurückgibt, dann werden die XML-Daten im XML.document
-Feld zurückgegeben.
org.w3c.dom.Element
Der XML-Typ, der in einer Dienst-WSDL wie folgt definiert ist:
<complexType name="XML">
<sequence>
<element maxOccurs="1" minOccurs="0" name="document" ``type="xsd:string" />
<element maxOccurs="1" minOccurs="0" name="element" ``type="xsd:string" />
</sequence>
</complexType>
Wenn ein AEM Forms-Dienstvorgang ein org.w3c.dom.Element
als Eingabe benötigt, übergeben Sie die XML-Daten in das XML.element
-Feld.
Das Setzen des Feldes XML.document
führt zu einer Laufzeitausnahme. Wenn der Dienst ein org.w3c.dom.Element
zurückgibt, werden die XML-Daten im XML.element
-Feld zurückgegeben.
Erstellen von Java-Proxy-Klassen mit JAX-WS creating-java-proxy-classes-using-jax-ws
Sie können JAX-WS verwenden, um eine Forms-Dienst-WSDL in Java-Proxy-Klassen zu konvertieren. Diese Klassen ermöglichen es Ihnen, AEM Forms-Dienstvorgänge aufzurufen. Mit Apache Ant können Sie ein Build-Skript erstellen, das Java-Proxy-Klassen durch Verweisen auf eine AEM Forms-Dienst-WSDL, generiert. Sie können JAX-WS-Proxy-Dateien generieren, indem Sie die folgenden Schritte ausführen:
-
Installieren Sie Apache Ant auf dem Client-Computer. (Siehe https://ant.apache.org/de/bindownload.cgi.)
- Fügen Sie den Ordner „bin“ zu Ihrem Klassenpfad hinzu.
- Setzen Sie die
ANT_HOME
-Umgebungsvariable auf den Ordner, in dem Sie Ant installiert haben.
-
Installieren Sie JDK 1.6 oder höher.
- Fügen Sie den JDK-Bin-Ordner zu Ihrem Klassenpfad hinzu.
- Fügen Sie den JRE-Bin-Ordner zu Ihrem Klassenpfad hinzu. Dieses Bin befindet sich im Verzeichnis
[JDK_INSTALL_LOCATION]/jre
. - Setzen Sie die
JAVA_HOME
-Umgebungsvariable auf den Ordner, in dem Sie das JDK installiert haben.
JDK 1.6 enthält das in der Datei „build.xml“ verwendete Programm wsimport. JDK 1.5 enthält dieses Programm nicht.
-
Installieren Sie JAX-WS auf dem Client-Computer. (Siehe Java-API für XML-Webdienste.)
-
Verwenden Sie JAX-WS und Apache Ant, um Java-Proxy-Klassen zu generieren. Erstellen Sie ein Ant-Build-Skript, um diese Aufgabe durchzuführen. Das folgende Skript ist ein Beispiel für ein Ant-Build-Skript mit dem Namen „build.xml“:
code language-xml <?xml version="1.0" encoding="UTF-8"?> <project basedir="." default="compile"> <property name="port" value="8080" /> <property name="host" value="localhost" /> <property name="username" value="administrator" /> <property name="password" value="password" /> <property name="tests" value="all" /> <target name="clean" > <delete dir="classes" /> </target> <target name="wsdl" depends="clean"> <mkdir dir="classes"/> <exec executable="wsimport" failifexecutionfails="false" failonerror="true" resultproperty="foundWSIMPORT"> <arg line="-keep -d classes https://${host}:${port}/soap/services/EncryptionService?wsdl&lc_version=9.0.1"/> </exec> <fail unless="foundWSIMPORT"> !!! Failed to execute JDK's wsimport tool. Make sure that JDK 1.6 (or later) is on your PATH !!! </fail> </target> <target name="compile" depends="clean, wsdl" > <javac destdir="./classes" fork="true" debug="true"> <src path="./src"/> </javac> </target> <target name="run"> <java classname="Client" fork="yes" failonerror="true" maxmemory="200M"> <classpath> <pathelement location="./classes"/> </classpath> <arg value="${port}"/> <arg value="${host}"/> <arg value="${username}"/> <arg value="${password}"/> <arg value="${tests}"/> </java> </target> </project>
Beachten Sie in diesem Ant-Build-Skript, dass die
url
-Eigenschaft so eingestellt ist, dass sie auf den Verschlüsselungsdienst WSDL verweist, der auf localhost läuft. Die Eigenschaftenusername
undpassword
müssen auf einen gültigen AEM Forms-Benutzernamen und ein -Kennwort festgelegt sein. Beachten Sie, dass die URL daslc_version
-Attribut beinhaltet. Ohne Angabe derlc_version
-Option können Sie keine neuen AEM Forms-Dienstvorgänge aufrufen.note note NOTE Ersetzen Sie EncryptionService
mit dem AEM Forms-Dienstnamen, den Sie mit den Java-Proxy-Klassen aufrufen möchten. Um beispielsweise Java-Proxy-Klassen für den Rights Management-Dienst zu erstellen, geben Sie Folgendes an:code language-java http://localhost:8080/soap/services/RightsManagementService?WSDL&lc_version=9.0.1
-
Erstellen Sie eine BAT-Datei, um das Ant-Build-Skript auszuführen. Der folgende Befehl befindet sich in einer BAT-Datei, die für die Ausführung des Ant-Build-Skripts zuständig ist:
code language-java ant -buildfile "build.xml" wsdl
Speichern Sie das ANT-Build-Skript im Ordner „C:\Program Files\Java\jaxws-ri\bin“. Das Skript schreibt die JAVA-Dateien in denOrdner „./classes“. Das Skript generiert JAVA-Dateien, die den Service aufrufen können.
-
Verpacken Sie die JAVA-Dateien in einer JAR-Datei. Wenn Sie auf Eclipse arbeiten, führen Sie die folgenden Schritte aus:
- Erstellen Sie ein Java-Projekt, das zum Verpacken der JAVA-Proxy-Dateien in eine JAR-Datei verwendet wird.
- Erstellen Sie einen Quellordner im Projekt.
- Erstellen Sie ein
com.adobe.idp.services
-Paket im Quellordner. - Wählen Sie das
com.adobe.idp.services
-Paket und importieren Sie dann die JAVA-Dateien aus dem Ordner „adobe/idp/services“ in das Paket. - Erstellen Sie bei Bedarf ein
org/apache/xml/xmlsoap
-Paket im Quellordner. - Wählen Sie den Quellordner aus und importieren Sie dann die JAVA-Dateien aus dem Ordner „org/apache/xml/xmlsoap“.
- Setzen Sie die Konformitätsstufe des Java-Compilers auf 5.0 oder höher.
- Erstellen Sie das Projekt.
- Exportieren Sie das Projekt als JAR-Datei.
- Importieren Sie diese JAR-Datei in den Klassenpfad eines Client-Projekts. Importieren Sie außerdem alle JAR-Dateien in „<Installationsverzeichnis>\Adobe\Adobe_Experience_Manager_forms\sdk\client-libs\thirdparty“.
note note NOTE In allen Schnellstarts für Java-Web-Dienste (mit Ausnahme des Forms-Dienstes), die sich unter „Programmieren mit AEM Forms“ befinden, werden Java-Proxy-Dateien mit JAX-WS erstellt. Darüber hinaus verwenden alle Kurzanleitungen für Java-Webservices SwaRef. (Siehe Aufrufen von AEM Forms mithilfe von SwaRef.)
Siehe auch
Erstellen von Java-Proxy-Klassen mithilfe von Apache Axis
Aufrufen von AEM Forms mit Base64-Kodierung
Erstellen von Java-Proxy-Klassen mithilfe von Apache Axis creating-java-proxy-classes-using-apache-axis
Sie können das Apache Axis WSDL2Java-Tool verwenden, um einen Forms-Service in Java-Proxy-Klassen zu konvertieren. Diese Klassen ermöglichen es Ihnen, Vorgänge von Forms-Services aufzurufen. Mit Apache Ant können Sie Bibliotheksdateien für Axis aus einer Service-WSDL generieren. Sie können Apache Axis unter der URL https://ws.apache.org/axis/ herunterladen.
Sie können Java-Bibliotheksdateien für Axis generieren, indem Sie die folgenden Schritte ausführen:
-
Installieren Sie Apache Ant auf dem Client-Computer. Es ist unter https://ant.apache.org/bindownload.cgi verfügbar.
- Fügen Sie den Ordner „bin“ zu Ihrem Klassenpfad hinzu.
- Legen Sie die Umgebungsvariable
ANT_HOME
auf das Verzeichnis fest, in dem Sie Ant installiert haben.
-
Installieren Sie Apache Axis 1.4 auf dem Client-Computer. Es ist unter https://ws.apache.org/axis/ verfügbar.
-
Richten Sie den Klassenpfad so ein, dass er die Axis-JAR-Dateien in Ihrem Webservice-Client zu verwendet, wie in den Installationsanweisungen zu Axis unter https://ws.apache.org/axis/java/install.html beschrieben.
-
Verwenden Sie das Apache WSDL2Java-Tool in Axis, um Java-Proxy-Klassen zu generieren. Erstellen Sie ein Ant-Build-Skript, um diese Aufgabe durchzuführen. Das folgende Skript ist ein Beispiel für ein Ant-Build-Skript mit dem Namen „build.xml“:
code language-java <?xml version="1.0"?> <project name="axis-wsdl2java"> <path id="axis.classpath"> <fileset dir="C:\axis-1_4\lib" > <include name="**/*.jar" /> </fileset> </path> <taskdef resource="axis-tasks.properties" classpathref="axis.classpath" /> <target name="encryption-wsdl2java-client" description="task"> <axis-wsdl2java output="C:\JavaFiles" testcase="false" serverside="false" verbose="true" username="administrator" password="password" url="http://localhost:8080/soap/services/EncryptionService?wsdl&lc_version=9.0.1" > </axis-wsdl2java> </target> </project>
Beachten Sie in diesem Ant-Build-Skript, dass die Eigenschaft
url
so eingestellt ist, dass sie auf die WSDL des Verschlüsselungs-Services verweist, der auf localhost läuft. Die Eigenschaftenusername
undpassword
müssen auf einen gültigen Benutzernamen und Kennwort für AEM Forms festgelegt werden. -
Erstellen Sie eine BAT-Datei, um das Ant-Build-Skript auszuführen. Der folgende Befehl ist in einer BAT-Datei zu finden, die für die Ausführung des Ant-Build-Skripts zuständig ist:
code language-java ant -buildfile "build.xml" encryption-wsdl2java-client
Die JAVA-Dateien werden in den Ordner „C:\JavaFiles“ geschrieben, wie in der Eigenschaft
output
angegeben. Um den Forms-Service erfolgreich aufzurufen, importieren Sie diese JAVA-Dateien in Ihren Klassenpfad.Standardmäßig gehören diese Dateien zu einem Java-Paket mit dem Namen
com.adobe.idp.services
. Es wird empfohlen, diese JAVA-Dateien in einer JAR-Datei zu platzieren. Importieren Sie dann die JAR-Datei in den Klassenpfad Ihres Client-Programms.note note NOTE Es gibt verschiedene Möglichkeiten, .JAVA-Dateien in ein JAR zu packen. Eine Möglichkeit ist die Verwendung einer Java-IDE wie Eclipse. Legen Sie ein Java-Projekt an und erstellen Sie ein com.adobe.idp.services
-Paket (alle .JAVA-Dateien gehören zu diesem Paket). Importieren Sie anschließend alle JAVA-Dateien in das Paket. Exportieren Sie das Projekt schließlich als JAR-Datei. -
Ändern Sie die URL in der
EncryptionServiceLocator
-Klasse, um den Kodierungstyp anzugeben. Um beispielsweise base64 zu verwenden, geben Sie?blob=base64
an, um sicherzustellen, dass dasBLOB
-Objekt Binärdaten zurückgibt. Das heißt, suchen Sie in derEncryptionServiceLocator
-Klasse die folgende Codezeile:code language-java http://localhost:8080/soap/services/EncryptionService;
und ändern Sie sie in:
code language-java http://localhost:8080/soap/services/EncryptionService?blob=base64;
-
Fügen Sie die folgenden Axis-JAR-Dateien zum Klassenpfad Ihres Java-Projekts hinzu:
- 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_imageio.jar
- jaxen-1.1-beta-9.jar
- jaxrpc.jar
- log4j.jar
- mail.jar
- saaj.jar
- wsdl4j.jar
- xalan.jar
- xbean.jar
- xercesImpl.jar
Diese JAR-Dateien befinden sich im
[install directory]/Adobe/Adobe Experience Manager Forms/sdk/lib/thirdparty
-Ordner.
Siehe auch
Erstellen von Java-Proxy-Klassen mit JAX-WS
Aufrufen von AEM Forms mit Base64-Kodierung invoking-aem-forms-using-base64-encoding
Sie können einen AEM Forms-Dienst mit Base64-Kodierung aufrufen. Die Base64-Kodierung kodiert Anlagen, die mit einer Webdienst-Aufrufanforderung gesendet werden. Das heißt, BLOB
-Daten sind Base64-kodiert, nicht die gesamte SOAP-Nachricht.
In „Aufrufen von AEM Forms mit Base64-Kodierung“ wird das Aufrufen des folgenden kurzlebigen AEM Forms-Prozesses namens MyApplication/EncryptDocument
mit Base64-Kodierung beschrieben.
MyApplication/EncryptDocument
in Workbench. (Siehe Verwenden von Workbench.)Wenn dieser Prozess aufgerufen wird, führt er die folgenden Aktionen aus:
- Ruft das ungesicherte PDF-Dokument ab, das an den Prozess übergeben wird. Diese Aktion basiert auf dem Vorgang
SetValue
. Der Eingangsparameter für diesen Prozess ist einedocument
-Prozessvariable mit dem NameninDoc
. - Sie verschlüsselt das PDF-Dokument mit einem Kennwort. Diese Aktion basiert auf dem Vorgang
PasswordEncryptPDF
. Das kennwortverschlüsselte PDF-Dokument wird in einer Prozessvariablen namensoutDoc
zurückgegeben.
Erstellen einer .NET-Client-Zusammenführung, die Base64-Kodierung verwendet creating-a-net-client-assembly-that-uses-base64-encoding
Sie können eine .NET-Client-Assembly erstellen, um einen Forms-Dienst aus einem Microsoft Visual Studio .NET-Projekt heraus aufzurufen. Um eine .NET-Client-Assembly zu erstellen, die base64-Kodierung verwendet, führen Sie die folgenden Schritte aus:
- Erstellen Sie eine Proxyklasse, die auf einer AEM Forms-Aufruf-URL basiert.
- Erstellen Sie ein Microsoft Visual Studio .NET-Projekt, das die .NET-Client-Assembly erzeugt.
Proxy-Klasse erstellen
Sie können mithilfe eines Werkzeuges, das zu Microsoft Visual Studio gehört, eine Proxyklasse zur Erstellung der .NET-Client-Assembly erstellen. Dieses Tool trägt den Namen „wsdl.exe“ und befindet sich im Installationsordner von Microsoft Visual Studio. Um eine Proxy-Klasse zu erstellen, öffnen Sie die Eingabeaufforderung und navigieren Sie zu dem Ordner, der die Datei „wsdl.exe“ enthält. Weitere Informationen zum Tool „wsdl.exe“ finden Sie in der MSDN-Hilfe.
Geben Sie an der Eingabeaufforderung den folgenden Befehl ein:
wsdl https://hiro-xp:8080/soap/services/MyApplication/EncryptDocument?WSDL&lc_version=9.0.1
Standardmäßig erstellt dieses Tool eine CS-Datei im selben Ordner, der auf dem Namen der WSDL basiert. In diesem Fall wird eine CS-Datei mit dem Namen EncryptDocumentService.cs erstellt. Mit dieser CS-Datei erstellen Sie ein Proxy-Objekt, mit dem Sie den Service aufrufen können, der in der Aufruf-URL angegeben wurde.
Ändern Sie die URL in der Proxy-Klasse so, dass sie ?blob=base64
enthält, um sicherzustellen, dass das BLOB
-Objekt binäre Daten zurückgibt. Suchen Sie in der Proxy-Klasse die folgende Code-Zeile:
"https://hiro-xp:8080/soap/services/MyApplication/EncryptDocument";
und ändern Sie sie in:
"https://hiro-xp:8080/soap/services/MyApplication/EncryptDocument?blob=base64";
Der Abschnitt Aufrufen von AEM Forms mit Base64-Codierung verwendet MyApplication/EncryptDocument
als Beispiel. Wenn Sie eine .NET-Client-Assembly für einen anderen Forms-Service erstellen, stellen Sie sicher, dass Sie MyApplication/EncryptDocument
durch den Namen des Services ersetzen.
Entwickeln der .NET-Client-Assembly
Erstellen Sie ein Visual Studio-Klassenbibliotheksprojekt, das eine .NET-Client-Assembly erzeugt. Die CS-Datei, die Sie mithilfe von „wsdl.exe“ erstellt haben, kann in dieses Projekt importiert werden. Dieses Projekt erzeugt eine DLL-Datei (die .NET-Client-Assembly), die Sie in anderen Visual Studio .NET-Projekten zum Aufrufen eines Services verwenden können.
- Starten Sie Microsoft Visual Studio .NET.
- Erstellen Sie ein Klassenbibliotheksprojekt und nennen Sie es DocumentService.
- Importieren Sie die CS-Datei, die Sie mit „wsdl.exe“ erstellt haben.
- Wählen Sie im Menü Projekt die Option Verweis hinzufügen.
- Wählen Sie im Dialogfeld „Verweis hinzufügen“ die Option System.Web.Services.dll.
- Klicken Sie auf Auswählen und dann auf OK.
- Kompilieren und erstellen Sie das Projekt.
MyApplication/EncryptDocument
-Service senden können.?blob=base64
zur URL in der Proxy-Klasse hinzugefügt haben, die zur Erstellung der .NET-Client-Assembly verwendet wird. Andernfalls können Sie keine Binärdaten aus dem BLOB
-Objekt abrufen.Referenzieren der .NET-Client-Assembly
Platzieren Sie die neu erstellte .NET-Client-Assembly auf dem Computer, auf dem Sie Ihr Client-Programm entwickeln. Nachdem Sie die .NET-Client-Assembly in einem Verzeichnis platziert haben, können Sie sie von einem Projekt aus referenzieren. Verweisen Sie auch auf die System.Web.Services
-Bibliothek aus Ihrem Projekt. Wenn Sie diese Bibliothek nicht referenzieren, können Sie die .NET-Client-Assembly nicht zum Aufrufen eines Dienstes verwenden.
- Wählen Sie im Projekt-Menü Verweis hinzufügen.
- Klicken Sie auf die Registerkarte .NET.
- Klicken Sie auf Durchsuchen und suchen Sie die Datei „DocumentService.dll“.
- Klicken Sie auf Auswählen und dann auf OK.
Aufrufen eines Services mithilfe einer .NET-Client-Assembly, die die Base64-Codierung verwendet
Sie können den Service MyApplication/EncryptDocument
(der in Workbench erstellt wurde) mithilfe einer .NET-Client-Assembly aufrufen, die die Base64-Codierung verwendet. Um den Service MyApplication/EncryptDocument
aufzurufen, führen Sie die folgenden Schritte aus:
- Erstellen Sie eine Microsoft .NET-Client-Assembly, die die WSDL des Services
MyApplication/EncryptDocument
verwendet. - Erstellen Sie ein Microsoft .NET-Client-Projekt. Verweisen Sie im Client-Projekt auf die Microsoft .NET-Client-Assembly. Verweisen Sie auch auf
System.Web.Services
. - Erstellen Sie mithilfe der Microsoft .NET-Client-Assembly ein
MyApplication_EncryptDocumentService
-Objekt, indem Sie seinen Standardkonstruktor aufrufen. - Legen Sie die Eigenschaft
Credentials
desMyApplication_EncryptDocumentService
-Objekts mit einemSystem.Net.NetworkCredential
-Objekt fest. Geben Sie imSystem.Net.NetworkCredential
-Konstruktor einen AEM Forms-Benutzernamen und das entsprechende Kennwort an. Legen Sie Authentifizierungswerte fest, damit Ihre .NET-Client-Anwendung erfolgreich SOAP-Nachrichten mit AEM Forms austauschen kann. - Erstellen Sie ein Objekt
BLOB
, indem Sie den Konstruktor verwenden. DasBLOB
-Objekt wird verwendet, um ein PDF-Dokument zu speichern, das an den ProzessMyApplication/EncryptDocument
übergeben wird. - Erstellen Sie ein
System.IO.FileStream
-Objekt, indem Sie seinen Konstruktor aufrufen. Übergeben Sie einen Zeichenfolgenwert, der den Dateispeicherort des PDF-Dokuments und den Modus angibt, in dem die Datei geöffnet werden soll. - Erstellen Sie ein Byte-Array, das den Inhalt des
System.IO.FileStream
-Objekts speichert. Sie können die Größe des Byte-Arrays ermitteln, indem Sie die EigenschaftLength
desSystem.IO.FileStream
-Objekts abrufen. - Füllen Sie das Byte-Array mit Stream-Daten auf, indem Sie die Methode
Read
desSystem.IO.FileStream
-Objekts aufrufen. Übergeben Sie das Byte-Array, die Startposition und die zu lesende Datenstromlänge. - Füllen Sie das
BLOB
-Objekt durch Zuweisen seinerbinaryData
-Eigenschaft mit dem Inhalt des Byte-Arrays. - Rufen Sie den Prozess
MyApplication/EncryptDocument
auf, indem Sie die Methodeinvoke
desMyApplication_EncryptDocumentService
-Objekts aufrufen und dasBLOB
-Objekt übergeben, das das PDF-Dokument enthält. Dieser Prozess gibt ein verschlüsseltes PDF-Dokument innerhalb einesBLOB
-Objekts zurück. - Erstellen Sie ein
System.IO.FileStream
-Objekt, indem Sie dessen Konstruktor aufrufen und einen Zeichenfolgenwert übergeben, der den Dateispeicherort des kennwortverschlüsselten Dokuments darstellt. - Erstellen Sie ein Byte-Array, das den Dateninhalt des
BLOB
-Objekts speichert, das von der Methodeinvoke
desMyApplicationEncryptDocumentService
-Objekts zurückgegeben wird. Füllen Sie das Byte-Array, indem Sie den Wert des DatenelementsbinaryData
desBLOB
-Objekts abrufen. - Erstellen Sie ein
System.IO.BinaryWriter
-Objekt, indem Sie seinen Konstruktor aufrufen und dasSystem.IO.FileStream
-Objekt übergeben. - Schreiben Sie den Inhalt des Byte-Arrays in eine PDF-Datei, indem Sie die Methode
Write
desSystem.IO.BinaryWriter
-Objekts aufrufen und das Byte-Array übergeben.
Aufrufen eines Service mit Java-Proxy-Klassen und Base64-Codierung invoking-a-service-using-java-proxy-classes-and-base64-encoding
Sie können einen AEM Forms-Service mithilfe von Java-Proxy-Klassen und Base64 aufrufen. Um den MyApplication/EncryptDocument
-Service mit Java-Proxy-Klassen aufzurufen, führen Sie die folgenden Schritte aus:
-
Erstellen Sie Java-Proxy-Klassen mit JAX-WS, welche die WSDL des
MyApplication/EncryptDocument
-Dienstes verwenden. Verwenden Sie den folgenden WSDL-Endpunkt:https://hiro-xp:8080/soap/services/MyApplication/EncryptDocument?WSDL&lc_version=9.0.1
note note NOTE Ersetzen Sie hiro-xp
durch die IP-Adresse des J2EE-Anwendungsservers, der als Host für AEM Forms dient. -
Packen Sie die mit JAX-WS erstellten Java-Proxy-Klassen in eine JAR-Datei.
-
Schließen Sie die Java-Proxy-JAR-Datei und die JAR-Dateien im folgenden Pfad ein:
<Installationsverzeichnis>\Adobe\Adobe_Experience_Manager_forms\sdk\client-libs\thirdparty
in den Klassenpfad Ihres Java-Client-Projekts ein.
-
Erstellen Sie ein
MyApplicationEncryptDocumentService
-Objekt, indem Sie den Konstruktor verwenden. -
Erstellen Sie ein
MyApplicationEncryptDocument
-Objekt, indem Sie die MethodegetEncryptDocument
desMyApplicationEncryptDocumentService
-Objekts aufrufen. -
Legen Sie die zum Aufrufen von AEM Forms erforderlichen Verbindungswerte fest, indem Sie den folgenden Datenelementen Werte zuweisen:
-
Weisen Sie den WSDL-Endpunkt und den Kodierungstyp dem Feld
ENDPOINT_ADDRESS_PROPERTY
desjavax.xml.ws.BindingProvider
-Objekts zu. Um denMyApplication/EncryptDocument
-Service mit Base64-Kodierung aufzurufen, geben Sie den folgenden URL-Wert an:https://hiro-xp:8080/soap/services/MyApplication/EncryptDocument?blob=base64
-
Weisen Sie die Benutzerin bzw. den Benutzer von AEM Forms dem Feld
USERNAME_PROPERTY
desjavax.xml.ws.BindingProvider
-Objekts zu. -
Weisen Sie dem Feld
PASSWORD_PROPERTY
desjavax.xml.ws.BindingProvider
-Objekts den entsprechenden Kennwortwert zu.
Das folgende Code-Beispiel zeigt diese Programmlogik:
code language-java //Set connection values required to invoke AEM Forms String url = "https://hiro-xp:8080/soap/services/MyApplication/EncryptDocument?blob=base64"; String username = "administrator"; String password = "password"; ((BindingProvider) encryptDocClient).getRequestContext().put(BindingProvider.ENDPOINT_ADDRESS_PROPERTY, url); ((BindingProvider) encryptDocClient).getRequestContext().put(BindingProvider.USERNAME_PROPERTY, username); ((BindingProvider) encryptDocClient).getRequestContext().put(BindingProvider.PASSWORD_PROPERTY, password);
-
-
Rufen Sie das PDF-Dokument ab, das an den
MyApplication/EncryptDocument
-Prozess gesendet werden soll, indem Sie einjava.io.FileInputStream
-Objekt mithilfe seines Konstruktors erstellen. Übergeben Sie einen Zeichenfolgenwert, der den Speicherort des PDF-Dokuments angibt. -
Erstellen Sie ein Byte-Array und füllen Sie es mit dem Inhalt des
java.io.FileInputStream
-Objekts. -
Erstellen Sie ein Objekt
BLOB
, indem Sie den Konstruktor verwenden. -
Füllen Sie das
BLOB
-Objekt durch Aufrufen von dessensetBinaryData
-Methode und Übergeben des Byte-Arrays.setBinaryData
desBLOB
-Objekts ist die Methode, die bei Verwendung der Base64-Kodierung aufzurufen ist. Siehe „Bereitstellen von BLOB-Objekten in Service-Anforderungen“. -
Rufen Sie den Prozess
MyApplication/EncryptDocument
auf, indem Sie die Methodeinvoke
desMyApplicationEncryptDocument
-Objekts aufrufen. Übergeben Sie dasBLOB
-Objekt, das das PDF-Dokument enthält. Die invoke-Methode gibt einBLOB
-Objekt zurück, das das verschlüsselte PDF-Dokument enthält. -
Erstellen Sie ein Byte-Array, das das verschlüsselte PDF-Dokument enthält, indem Sie die Methode
getBinaryData
desBLOB
-Objekts aufrufen. -
Speichern Sie das verschlüsselte PDF-Dokument als PDF-Datei. Schreiben Sie das Byte-Array in eine Datei.
Siehe auch
Schnellstart: Aufrufen eines Services mithilfe von Java-Proxy-Dateien und Base64-Codierung
Erstellen einer .NET-Client-Zusammenführung, die Base64-Kodierung verwendet
AEM Forms mithilfe von MTOM aufrufen invoking-aem-forms-using-mtom
Sie können AEM Forms-Services mithilfe des Webservice-Standards MTOM aufrufen. Dieser Standard definiert, wie binäre Daten, z. B. ein PDF-Dokument, über das Internet oder Intranet übertragen werden. Eine Funktion von MTOM ist die Verwendung des XOP:Include
-Elements. Dieses Element ist in der XOP-Spezifikation (XML-binary Optimized Packaging) definiert, um auf die binären Anhänge einer SOAP-Nachricht zu verweisen.
In dieser Diskussion geht es um die Verwendung von MTOM, um den folgenden kurzlebigen AEM Forms-Prozess namens MyApplication/EncryptDocument
aufzurufen.
MyApplication/EncryptDocument
in Workbench. (Siehe Verwenden von Workbench.)Wenn dieser Prozess aufgerufen wird, führt er die folgenden Aktionen aus:
- Ruft das ungesicherte PDF-Dokument ab, das an den Prozess übergeben wird. Diese Aktion basiert auf dem Vorgang
SetValue
. Der Eingangsparameter für diesen Prozess ist einedocument
-Prozessvariable mit dem NameninDoc
. - Sie verschlüsselt das PDF-Dokument mit einem Kennwort. Diese Aktion basiert auf dem Vorgang
PasswordEncryptPDF
. Das kennwortverschlüsselte PDF-Dokument wird in einer Prozessvariablen namensoutDoc
zurückgegeben.
OutOfMemory
Ausnahme.Hier geht es um die Verwendung von MTOM innerhalb eines Microsoft .NET-Projekts zum Aufrufen von AEM Forms-Diensten. Das verwendete .NET-Framework ist 3.5 und die Entwicklungsumgebung ist Visual Studio 2008. Wenn Sie auf Ihrem Entwicklungscomputer Web Service Enhancements (WSE) installiert haben, entfernen sie. Das .NET 3.5-Framework unterstützt ein SOAP-Framework namens Windows Communication Foundation (WCF). Wenn Sie AEM Forms mithilfe von MTOM aufrufen, wird nur WCF (nicht WSE) unterstützt.
Erstellen eines .NET-Projekts, das einen Dienst mit MTOM aufruft creating-a-net-project-that-invokes-a-service-using-mtom
Sie können ein Microsoft .NET-Projekt erstellen, das einen AEM Forms-Dienst mittels Webdienste aufrufen kann. Erstellen Sie zunächst ein Microsoft .NET-Projekt mit Visual Studio 2008. Um einen AEM Forms-Dienst aufzurufen, erstellen Sie einen Dienstverweis zum AEM Forms-Dienst, den Sie in Ihrem Projekt aufrufen möchten. Wenn Sie einen Dienstverweis erstellen, geben Sie eine URL für den AEM Forms-Dienst an:
http://localhost:8080/soap/services/MyApplication/EncryptDocument?WSDL&lc_version=9.0.1
Ersetzen Sie localhost
mit der IP-Adresse des J2EE-Anwendungsservers, auf dem AEM Forms gehostet wird. Ersetzen Sie MyApplication/EncryptDocument
mit dem Namen des aufzurufenden AEM Forms-Dienstes. Um beispielsweise einen Rights Management-Vorgang aufzurufen, geben Sie Folgendes an:
http://localhost:8080/soap/services/RightsManagementService?WSDL&lc_version=9.0.1
Die Option lc_version
stellt sicher, dass AEM Forms-Funktionen, wie beispielsweise MTOM, verfügbar sind. Ohne Angabe der lc_version
-Option können Sie AEM Forms nicht über MTOM aufrufen.
Nachdem Sie einen Dienstverweis erstellt haben, sind mit dem AEM Forms-Dienst verknüpfte Datentypen für die Verwendung in Ihrem .NET-Projekt verfügbar. Um ein .NET-Projekt zu erstellen, das einen AEM Forms-Dienst aufruft, führen Sie die folgenden Schritte aus:
-
Erstellen Sie ein .NET-Projekt mit Microsoft Visual Studio 2008.
-
Wählen Sie im Projekt Menü Dienstverweis hinzufügen.
-
Geben Sie im Dialogfeld Adresse die WSDL für den AEM Forms-Dienst an. Beispiel:
code language-java http://localhost:8080/soap/services/MyApplication/EncryptDocument?WSDL&lc_version=9.0.1
-
Klicken Sie auf Los und dann auf OK.
Aufrufen eines Dienstes mit MTOM in einem .NET-Projekt invoking-a-service-using-mtom-in-a-net-project
Beachten Sie den MyApplication/EncryptDocument
-Prozess, der ein ungesichertes PDF-Dokument akzeptiert und ein kennwortverschlüsseltes PDF-Dokument zurückgibt. Um den MyApplication/EncryptDocument
Prozess (der in Workbench erstellt wurde) mithilfe von MTOM aufzurufen, führen Sie die folgenden Schritte aus:
-
Erstellen Sie ein Microsoft .NET-Projekt.
-
Erstellen Sie ein
MyApplication_EncryptDocumentClient
-Objekt mithilfe seines Standardkonstruktors. -
Erstellen Sie ein
MyApplication_EncryptDocumentClient.Endpoint.Address
-Objekt mithilfe desSystem.ServiceModel.EndpointAddress
-Konstruktors. Übergeben Sie einen Zeichenfolgenwert, der dem AEM Forms-Service die WSDL und den Typ der Codierung angibt:code language-java https://hiro-xp:8080/soap/services/MyApplication/EncryptDocument?blob=mtom
Sie müssen das
lc_version
-Attribut nicht verwenden. Dieses Attribut wird verwendet, wenn Sie eine Servicereferenz erstellen. Stellen Sie jedoch sicher, dass Sie?blob=mtom
angeben.note note NOTE Ersetzen hiro-xp
mit der IP-Adresse des J2EE-Anwendungsservers, auf dem AEM Forms gehostet wird. -
Erstellen Sie ein
System.ServiceModel.BasicHttpBinding
-Objekt, indem Sie den Wert desEncryptDocumentClient.Endpoint.Binding
-Datenelements abrufen. Wandeln Sie den Rückgabewert inBasicHttpBinding
um. -
Legen Sie das Datenelement
MessageEncoding
desSystem.ServiceModel.BasicHttpBinding
-Objekts aufWSMessageEncoding.Mtom
fest. Dieser Wert stellt sicher, dass MTOM verwendet wird. -
Aktivieren Sie die einfache HTTP-Authentifizierung, indem Sie die folgenden Schritte ausführen:
- Weisen Sie den AEM Forms-Benutzernamen dem Datenelement
MyApplication_EncryptDocumentClient.ClientCredentials.UserName.UserName
zu. - Weisen Sie dem Datenelement
MyApplication_EncryptDocumentClient.ClientCredentials.UserName.Password
den entsprechenden Kennwortwert zu. - Weisen Sie den Konstantenwert
HttpClientCredentialType.Basic
zum DatenelementBasicHttpBindingSecurity.Transport.ClientCredentialType
zu. - Weisen Sie den Konstantenwert
BasicHttpSecurityMode.TransportCredentialOnly
zum DatenelementBasicHttpBindingSecurity.Security.Mode
zu.
Das folgende Code-Beispiel zeigt diese Aufgaben.
code language-java //Enable BASIC HTTP authentication encryptProcess.ClientCredentials.UserName.UserName = "administrator"; encryptProcess.ClientCredentials.UserName.Password = "password"; b.Security.Transport.ClientCredentialType = HttpClientCredentialType.Basic; b.Security.Mode = BasicHttpSecurityMode.TransportCredentialOnly; b.MaxReceivedMessageSize = 4000000; b.MaxBufferSize = 4000000; b.ReaderQuotas.MaxArrayLength = 4000000;
- Weisen Sie den AEM Forms-Benutzernamen dem Datenelement
-
Erstellen Sie ein Objekt
BLOB
, indem Sie den Konstruktor verwenden. DasBLOB
-Objekt wird verwendet, um ein PDF-Dokument zu speichern, das an den ProzessMyApplication/EncryptDocument
übergeben wird. -
Erstellen Sie ein
System.IO.FileStream
-Objekt, indem Sie seinen Konstruktor verwenden. Übergeben Sie einen Zeichenfolgenwert, der den Dateispeicherort des PDF-Dokuments und den Modus angibt, in dem die Datei geöffnet werden soll. -
Erstellen Sie ein Byte-Array, das den Inhalt des
System.IO.FileStream
-Objekts speichert. Sie können die Größe des Byte-Arrays ermitteln, indem Sie die EigenschaftLength
desSystem.IO.FileStream
-Objekts abrufen. -
Füllen Sie das Byte-Array mit Stream-Daten auf, indem Sie die Methode
Read
desSystem.IO.FileStream
-Objekts aufrufen. Übergeben Sie das Byte-Array, die Startposition und die zu lesende Datenstromlänge. -
Füllen Sie das
BLOB
-Objekt, indem Sie seinemMTOM
-Datenelement den Inhalt des Byte-Arrays zuweisen. -
Rufen Sie den Prozess
MyApplication/EncryptDocument
auf, indem Sie die Methodeinvoke
desMyApplication_EncryptDocumentClient
-Objekts aufrufen. Übergeben Sie dasBLOB
-Objekt, welches das PDF-Dokument enthält. Dieser Prozess gibt ein verschlüsseltes PDF-Dokument innerhalb einesBLOB
-Objekts zurück. -
Erstellen Sie ein
System.IO.FileStream
-Objekt, indem Sie seinen Konstruktor aufrufen und einen Zeichenfolgewert übergeben, der den Dateispeicherort des gesicherten PDF-Dokuments darstellt. -
Erstellen Sie ein Byte-Array, das den Dateninhalt des
BLOB
-Objekts speichert, das von der Methodeinvoke
zurückgegeben wurde. Füllen Sie das Byte-Array, indem Sie den Wert des DatenelementsMTOM
desBLOB
-Objekts abrufen. -
Erstellen Sie ein
System.IO.BinaryWriter
-Objekt, indem Sie seinen Konstruktor aufrufen und dasSystem.IO.FileStream
-Objekt übergeben. -
Schreiben Sie den Inhalt des Byte-Arrays in eine PDF-Datei, indem Sie die Methode
Write
desSystem.IO.BinaryWriter
-Objekts aufrufen und das Byte-Array übergeben.
Siehe auch
Kurzanleitung: Aufrufen eines Services mithilfe von MTOM in einem .NET-Projekt
Aufrufen von AEM Forms mithilfe von SwaRef invoking-aem-forms-using-swaref
Sie können AEM Forms-Dienste mit SwaRef aufrufen. Der Inhalt des wsi:swaRef
-XML-Elements wird als Anlage innerhalb eines SOAP-Bodys gesendet, der den Verweis auf die Anlage speichert. Wenn Sie einen Forms-Dienst mit SwaRef aufrufen, erstellen Sie Java-Proxy-Klassen unter Verwendung der Java-API für XML-Webdienste (JAX-WS). (Siehe Java-API für XML-Webdienste.)
Hier geht es um den Aufruf des folgenden kurzlebigen Forms-Prozesses namens MyApplication/EncryptDocument
unter Verwendung von SwaRef.
MyApplication/EncryptDocument
in Workbench. (Siehe Verwenden von Workbench.)Wenn dieser Prozess aufgerufen wird, führt er die folgenden Aktionen aus:
- Ruft das ungesicherte PDF-Dokument ab, das an den Prozess übergeben wird. Diese Aktion basiert auf dem Vorgang
SetValue
. Der Eingangsparameter für diesen Prozess ist einedocument
-Prozessvariable mit dem NameninDoc
. - Sie verschlüsselt das PDF-Dokument mit einem Kennwort. Diese Aktion basiert auf dem Vorgang
PasswordEncryptPDF
. Das kennwortverschlüsselte PDF-Dokument wird in einer Prozessvariablen namensoutDoc
zurückgegeben.
Im Folgenden wird erörtert, wie Forms-Dienste mithilfe von SwaRef innerhalb einer Java-Client-Anwendung aufgerufen werden können. Die Java-Anwendung verwendet Proxy-Klassen, die mithilfe von JAX-WS erstellt wurden.
Aufrufen eines Dienstes mit JAX-WS-Bibliotheksdateien, die SwaRef verwenden invoke-a-service-using-jax-ws-library-files-that-use-swaref
Um den MyApplication/EncryptDocument
-Prozess mithilfe von Java-Proxy-Dateien aufzurufen, die mit JAX-WS und SwaRef erstellt wurden, führen Sie die folgenden Schritte aus:
-
Erstellen Sie Java-Proxy-Klassen mit JAX-WS, welche die WSDL des
MyApplication/EncryptDocument
-Dienstes verwenden. Verwenden Sie den folgenden WSDL-Endpunkt:code language-java https://hiro-xp:8080/soap/services/MyApplication/EncryptDocument?WSDL&lc_version=9.0.1
Weitere Informationen finden Sie unter Erstellen von Java-Proxy-Klassen mit von JAX-WS.
note note NOTE Ersetzen hiro-xp
mit der IP-Adresse des J2EE-Anwendungsservers, auf dem AEM Forms gehostet wird. -
Packen Sie die mit JAX-WS erstellten Java-Proxy-Klassen in eine JAR-Datei.
-
Schließen Sie die Java-Proxy-JAR-Datei und die JAR-Dateien im folgenden Pfad ein:
<Installationsverzeichnis>\Adobe\Adobe_Experience_Manager_forms\sdk\client-libs\thirdparty
in den Klassenpfad Ihres Java-Client-Projekts ein.
-
Erstellen Sie ein
MyApplicationEncryptDocumentService
-Objekt, indem Sie den Konstruktor verwenden. -
Erstellen Sie ein
MyApplicationEncryptDocument
-Objekt, indem Sie die MethodegetEncryptDocument
desMyApplicationEncryptDocumentService
-Objekts aufrufen. -
Legen Sie die zum Aufrufen von AEM Forms erforderlichen Verbindungswerte fest, indem Sie den folgenden Datenelementen Werte zuweisen:
-
Weisen Sie den WSDL-Endpunkt und den Codierungstyp dem Feld
ENDPOINT_ADDRESS_PROPERTY
desjavax.xml.ws.BindingProvider
-Objekts zu. Um denMyApplication/EncryptDocument
-Dienst mit SwaRef-Kodierung aufzurufen, geben Sie den folgenden URL-Wert an:https://hiro-xp:8080/soap/services/MyApplication/EncryptDocument?blob=swaref
-
Weisen Sie die Benutzerin bzw. den Benutzer von AEM Forms dem Feld
USERNAME_PROPERTY
desjavax.xml.ws.BindingProvider
-Objekts zu. -
Weisen Sie dem Feld
PASSWORD_PROPERTY
desjavax.xml.ws.BindingProvider
-Objekts den entsprechenden Kennwortwert zu.
Das folgende Code-Beispiel zeigt diese Programmlogik:
code language-java //Set connection values required to invoke AEM Forms String url = "https://hiro-xp:8080/soap/services/MyApplication/EncryptDocument?blob=swaref"; String username = "administrator"; String password = "password"; ((BindingProvider) encryptDocClient).getRequestContext().put(BindingProvider.ENDPOINT_ADDRESS_PROPERTY, url); ((BindingProvider) encryptDocClient).getRequestContext().put(BindingProvider.USERNAME_PROPERTY, username); ((BindingProvider) encryptDocClient).getRequestContext().put(BindingProvider.PASSWORD_PROPERTY, password);
-
-
Rufen Sie das PDF-Dokument ab, das an den
MyApplication/EncryptDocument
-Prozess gesendet werden soll, indem Sie einjava.io.File
-Objekt mithilfe seines Konstruktors erstellen. Übergeben Sie einen Zeichenfolgenwert, der den Speicherort des PDF-Dokuments angibt. -
Erstellen Sie ein
javax.activation.DataSource
-Objekt mithilfe desFileDataSource
-Konstruktors. Übergeben Sie dasjava.io.File
-Objekt. -
Erstellen Sie ein
javax.activation.DataHandler
-Objekt, indem Sie seinen Konstruktor verwenden und dasjavax.activation.DataSource
-Objekt übergeben. -
Erstellen Sie ein Objekt
BLOB
, indem Sie den Konstruktor verwenden. -
Füllen Sie das
BLOB
-Objekt durch Aufrufen seinersetSwaRef
-Methode und Übergabe desjavax.activation.DataHandler
-Objekts. -
Rufen Sie den Prozess
MyApplication/EncryptDocument
auf, indem Sie die Methodeinvoke
desMyApplicationEncryptDocument
-Objekts aufrufen und dasBLOB
-Objekt übergeben, das das PDF-Dokument enthält. Die Aufrufmethode gibt einBLOB
-Objekt zurück, das ein verschlüsseltes PDF-Dokument enthält. -
Füllen Sie ein
javax.activation.DataHandler
-Objekt auf, indem Sie die MethodegetSwaRef
desBLOB
-Objekts aufrufen. -
Konvertieren Sie das
javax.activation.DataHandler
-Objekt in einejava.io.InputSteam
-Instanz, indem Sie die MethodegetInputStream
desjavax.activation.DataHandler
-Objekts aufrufen. -
Schreiben Sie die
java.io.InputSteam
-Instanz in eine PDF-Datei, die das verschlüsselte PDF-Dokument darstellt.
Siehe auch
Kurzanleitung: Aufrufen eines Services mit SwaRef in einem Java-Projekt
Aufrufen von AEM Forms mithilfe von BLOB-Daten über HTTP invoking-aem-forms-using-blob-data-over-http
Sie können AEM Forms-Dienste über Webdienste aufrufen und BLOB-Daten über HTTP übergeben. Die Übergabe von BLOB-Daten über HTTP ist eine alternative Technik, statt der Verwendung von base64-Kodierung, DIME oder MIME. Beispielsweise können Sie Daten über HTTP in einem Microsoft .NET-Projekt übergeben, das Web Service Enhancement 3.0 verwendet, das DIME oder MIME nicht unterstützt. Bei der Verwendung von BLOB-Daten über HTTP werden die Eingabedaten hochgeladen, bevor der AEM Forms-Dienst aufgerufen wird.
„Aufrufen von AEM Forms mit BLOB-Daten über HTTP“ beschreibt das Aufrufen des folgenden kurzlebigen AEM Forms-Prozesses mit dem Namen MyApplication/EncryptDocument
durch Übergabe von BLOB-Daten über HTTP.
MyApplication/EncryptDocument
in Workbench. (Siehe Verwenden von Workbench.)Wenn dieser Prozess aufgerufen wird, führt er die folgenden Aktionen aus:
- Ruft das ungesicherte PDF-Dokument ab, das an den Prozess übergeben wird. Diese Aktion basiert auf dem Vorgang
SetValue
. Der Eingangsparameter für diesen Prozess ist einedocument
-Prozessvariable mit dem NameninDoc
. - Sie verschlüsselt das PDF-Dokument mit einem Kennwort. Diese Aktion basiert auf dem Vorgang
PasswordEncryptPDF
. Das kennwortverschlüsselte PDF-Dokument wird in einer Prozessvariablen namensoutDoc
zurückgegeben.
Erstellen einer .NET-Client-Assembly, die Daten über HTTP verwendet creating-a-net-client-assembly-that-uses-data-over-http
Um eine Client-Assembly zu erstellen, die Daten über HTTP verwendet, folgen Sie dem unter Aufrufen von AEM Forms mit Base64-Kodierung beschriebenen Prozess. Ändern Sie jedoch die URL in der Proxy-Klasse so, dass sie ?blob=http
anstelle von ?blob=base64
enthält. Diese Aktion stellt sicher, dass Daten über HTTP übergeben werden. Suchen Sie in der Proxy-Klasse die folgende Code-Zeile:
"http://localhost:8080/soap/services/MyApplication/EncryptDocument";
und ändern Sie sie in:
"http://localhost:8080/soap/services/MyApplication/EncryptDocument?blob=http";
Referenzieren der .NET clienMyApplication/EncryptDocument-Assembly
Platzieren Sie die neue .NET-Client-Assembly auf dem Computer, auf dem Sie Ihre Client-Anwendung entwickeln. Nachdem Sie die .NET-Client-Assembly in einem Verzeichnis platziert haben, können Sie sie von einem Projekt aus referenzieren. Verweisen Sie auf die System.Web.Services
-Bibliothek aus Ihrem Projekt. Wenn Sie diese Bibliothek nicht referenzieren, können Sie die .NET-Client-Assembly nicht zum Aufrufen eines Dienstes verwenden.
- Wählen Sie im Projekt-Menü Verweis hinzufügen.
- Klicken Sie auf die Registerkarte .NET.
- Klicken Sie auf Durchsuchen und suchen Sie die Datei „DocumentService.dll“.
- Klicken Sie auf Auswählen und dann auf OK.
Aufrufen eines Dienstes mit einer .NET-Client-Assembly, die BLOB-Daten über HTTP verwendet
Sie können den MyApplication/EncryptDocument
-Dienst (der in Workbench erstellt wurde) mit einer .NET-Client-Assembly, die Daten über HTTP verwendet, aufrufen. Um den MyApplication/EncryptDocument
-Dienst aufzurufen, führen Sie die folgenden Schritte aus:
- Erstellen Sie die .NET-Client-Assembly.
- Referenzieren Sie die Microsoft .NET-Client-Assembly. Erstellen Sie ein Microsoft .NET-Client-Projekt. Verweisen Sie im Client-Projekt auf die Microsoft .NET-Client-Assembly. Verweisen Sie auch auf
System.Web.Services
. - Erstellen Sie mithilfe der Microsoft .NET-Client-Assembly ein
MyApplication_EncryptDocumentService
-Objekt, indem Sie seinen Standardkonstruktor aufrufen. - Legen Sie die Eigenschaft
Credentials
desMyApplication_EncryptDocumentService
-Objekts mit einemSystem.Net.NetworkCredential
-Objekt fest. Geben Sie imSystem.Net.NetworkCredential
-Konstruktor einen AEM Forms-Benutzernamen und das entsprechende Kennwort an. Legen Sie Authentifizierungswerte fest, damit Ihre .NET-Client-Anwendung erfolgreich SOAP-Nachrichten mit AEM Forms austauschen kann. - Erstellen Sie ein Objekt
BLOB
, indem Sie den Konstruktor verwenden. DasBLOB
-Objekt wird verwendet, um Daten an denMyApplication/EncryptDocument
-Prozess zu übergeben. - Weisen Sie dem Datenelement
remoteURL
desBLOB
-Objekts einen String-Wert zu, der den URI-Speicherort eines PDF-Dokuments angibt, das an denMyApplication/EncryptDocument
-Dienst übergeben werden soll. - Rufen Sie den Prozess
MyApplication/EncryptDocument
auf, indem Sie die Methodeinvoke
desMyApplication_EncryptDocumentService
-Objekts aufrufen und dasBLOB
-Objekt übergeben. Dieser Prozess gibt ein verschlüsseltes PDF-Dokument innerhalb einesBLOB
-Objekts zurück. - Erstellen Sie ein
System.UriBuilder
-Objekt, indem Sie seinen Konstruktor verwenden und den Wert des DatenelementsremoteURL
des zurückgegebenenBLOB
-Objekts übergeben. - Konvertieren Sie das
System.UriBuilder
-Objekt zu einemSystem.IO.Stream
-Objekt. (Der C#-Schnellstart, der dieser Liste folgt, veranschaulicht, wie diese Aufgabe ausgeführt wird). - Erstellen Sie ein Byte-Array und füllen Sie es mit den Daten aus dem
System.IO.Stream
-Objekt auf. - Erstellen Sie ein
System.IO.BinaryWriter
-Objekt, indem Sie seinen Konstruktor aufrufen und dasSystem.IO.FileStream
-Objekt übergeben. - Schreiben Sie den Inhalt des Byte-Arrays in eine PDF-Datei, indem Sie die Methode
Write
desSystem.IO.BinaryWriter
-Objekts aufrufen und das Byte-Array übergeben.
Aufrufen eines Dienstes mit Java-Proxy-Klassen und BLOB-Daten über HTTP invoking-a-service-using-java-proxy-classes-and-blob-data-over-http
Sie können einen AEM Forms-Dienst mit Java-Proxy-Klassen und BLOB-Daten über HTTP aufrufen. Um den MyApplication/EncryptDocument
-Dienst mit Java-Proxy-Klassen aufzurufen, führen Sie die folgenden Schritte aus:
-
Erstellen Sie Java-Proxy-Klassen mit JAX-WS, welche die WSDL des
MyApplication/EncryptDocument
-Dienstes verwenden. Verwenden Sie den folgenden WSDL-Endpunkt:code language-java https://hiro-xp:8080/soap/services/MyApplication/EncryptDocument?WSDL&lc_version=9.0.1
Weitere Informationen finden Sie unter Erstellen von Java-Proxy-Klassen mit von JAX-WS.
note note NOTE Ersetzen hiro-xp
mit der IP-Adresse des J2EE-Anwendungsservers, auf dem AEM Forms gehostet wird. -
Packen Sie die mit JAX-WS erstellten Java-Proxy-Klassen in eine JAR-Datei.
-
Schließen Sie die Java-Proxy-JAR-Datei und die JAR-Dateien im folgenden Pfad ein:
<Installationsverzeichnis>\Adobe\Adobe_Experience_Manager_forms\sdk\client-libs\thirdparty
in den Klassenpfad Ihres Java-Client-Projekts ein.
-
Erstellen Sie ein
MyApplicationEncryptDocumentService
-Objekt, indem Sie den Konstruktor verwenden. -
Erstellen Sie ein
MyApplicationEncryptDocument
-Objekt, indem Sie die MethodegetEncryptDocument
desMyApplicationEncryptDocumentService
-Objekts aufrufen. -
Legen Sie die zum Aufrufen von AEM Forms erforderlichen Verbindungswerte fest, indem Sie den folgenden Datenelementen Werte zuweisen:
-
Weisen Sie den WSDL-Endpunkt und den Kodierungstyp dem Feld
ENDPOINT_ADDRESS_PROPERTY
desjavax.xml.ws.BindingProvider
-Objekts zu. Um den DienstMyApplication/EncryptDocument
mit BLOB über HTTP-Kodierung aufzurufen, geben Sie den folgenden URL-Wert an:https://hiro-xp:8080/soap/services/MyApplication/EncryptDocument?blob=http
-
Weisen Sie die Benutzerin bzw. den Benutzer von AEM Forms dem Feld
USERNAME_PROPERTY
desjavax.xml.ws.BindingProvider
-Objekts zu. -
Weisen Sie dem Feld
PASSWORD_PROPERTY
desjavax.xml.ws.BindingProvider
-Objekts den entsprechenden Kennwortwert zu.
Das folgende Code-Beispiel zeigt diese Programmlogik:
code language-java //Set connection values required to invoke AEM Forms String url = "https://hiro-xp:8080/soap/services/MyApplication/EncryptDocument?blob=http"; String username = "administrator"; String password = "password"; ((BindingProvider) encryptDocClient).getRequestContext().put(BindingProvider.ENDPOINT_ADDRESS_PROPERTY, url); ((BindingProvider) encryptDocClient).getRequestContext().put(BindingProvider.USERNAME_PROPERTY, username); ((BindingProvider) encryptDocClient).getRequestContext().put(BindingProvider.PASSWORD_PROPERTY, password);
-
-
Erstellen Sie ein Objekt
BLOB
, indem Sie den Konstruktor verwenden. -
Befüllen Sie das
BLOB
-Objekt, indem Sie seinesetRemoteURL
-Methode aufrufen. Übergeben Sie einen Zeichenfolgewert, der den URI-Speicherort eines PDF-Dokuments angibt, das an denMyApplication/EncryptDocument
-Dienst übergeben werden soll. -
Rufen Sie den Prozess
MyApplication/EncryptDocument
auf, indem Sie die Methodeinvoke
desMyApplicationEncryptDocument
-Objekts aufrufen und dasBLOB
-Objekt übergeben, das das PDF-Dokument enthält. Dieser Prozess gibt ein verschlüsseltes PDF-Dokument innerhalb einesBLOB
-Objekts zurück. -
Erstellen Sie ein Byte-Array, um den Daten-Stream zu speichern, der das verschlüsselte PDF-Dokument darstellt. Rufen Sie die Methode
getRemoteURL
desBLOB
-Objekts auf (verwenden Sie dasBLOB
-Objekt, das von der Methodeinvoke
zurückgegeben wird). -
Erstellen Sie ein Objekt
java.io.File
, indem Sie den Konstruktor verwenden. Dieses Objekt stellt das verschlüsselte PDF-Dokument dar. -
Erstellen Sie ein
java.io.FileOutputStream
-Objekt, indem Sie seinen Konstruktor verwenden und dasjava.io.File
-Objekt übergeben. -
Rufen Sie die Methode
write
desjava.io.FileOutputStream
-Objekts auf. Übergeben Sie das Byte-Array, das den Daten-Stream enthält, der das verschlüsselte PDF-Dokument darstellt.
Aufrufen von AEM Forms mithilfe von DIME invoking-aem-forms-using-dime
Sie können AEM Forms-Services mithilfe von SOAP mit Anhängen aufrufen. AEM Forms unterstützt sowohl MIME- als auch DIME-Webservice-Standards. Mit DIME können Sie binäre Anhänge, wie z. B. PDF-Dokumente, zusammen mit Aufrufanforderungen senden, anstatt den Anhang zu codieren. Der Abschnitt Aufrufen von AEM Forms mithilfe von DIME erläutert das Aufrufen des folgenden kurzlebigen AEM Forms-Prozesses namens MyApplication/EncryptDocument
mithilfe von DIME.
Wenn dieser Prozess aufgerufen wird, führt er die folgenden Aktionen aus:
- Ruft das ungesicherte PDF-Dokument ab, das an den Prozess übergeben wird. Diese Aktion basiert auf dem Vorgang
SetValue
. Der Eingangsparameter für diesen Prozess ist einedocument
-Prozessvariable mit dem NameninDoc
. - Sie verschlüsselt das PDF-Dokument mit einem Kennwort. Diese Aktion basiert auf dem Vorgang
PasswordEncryptPDF
. Das kennwortverschlüsselte PDF-Dokument wird in einer Prozessvariablen namensoutDoc
zurückgegeben.
Dieser Prozess basiert nicht auf einem vorhandenen AEM Forms-Prozess. Um den Code-Beispielen folgen zu können, erstellen Sie mithilfe von Workbench einen Prozess mit dem Namen MyApplication/EncryptDocument
. (Siehe Verwenden von Workbench.)
Erstellen eines .NET-Projekts, das DIME verwendet creating-a-net-project-that-uses-dime
Führen Sie die folgenden Aufgaben aus, um ein .NET-Projekt zu erstellen, das einen Forms-Service mithilfe von DIME aufrufen kann:
- Installieren Sie Web Services Enhancements 2.0 auf Ihrem Entwicklungs-Computer.
- Erstellen Sie in Ihrem .NET-Projekt einen Web-Verweis zum AEM Forms-Service.
Installation von Web Services Enhancements 2.0
Installieren Sie Web Services Enhancements 2.0 auf Ihrem Entwicklungs-Computer und integrieren Sie es in Microsoft Visual Studio .NET. Sie können Web Services Enhancements 2.0 aus dem Microsoft-Download-Center herunterladen.
Suchen Sie auf dieser Web-Seite nach Web Services Enhancements 2.0 und laden Sie es auf Ihren Entwicklungs-Computer herunter. Durch diesen Download wird eine Datei mit dem Namen „Microsoft WSE 2.0 SPI.msi“ auf Ihrem Computer platziert. Führen Sie das Installationsprogramm aus und folgen Sie den Online-Anweisungen.
Erstellen eines Web-Verweises auf einen AEM Forms-Service
Nachdem Sie Web Services Enhancements 2.0 auf Ihrem Entwicklungs-Computer installiert und ein Microsoft .NET-Projekt erstellt haben, erstellen Sie einen Web-Verweis auf den Forms-Service. Um beispielsweise einen Web-Verweis auf den Prozess MyApplication/EncryptDocument
zu erstellen, und unter der Annahme, dass Forms auf dem lokalen Computer installiert ist, geben Sie die folgende URL an:
http://localhost:8080/soap/services/MyApplication/EncryptDocument?WSDL
Nachdem Sie einen Web-Verweis erstellt haben, stehen Ihnen die beiden folgenden Proxy-Datentypen zur Verfügung, die Sie in Ihrem .NET-Projekt verwenden können: EncryptDocumentService
und EncryptDocumentServiceWse
. Um den Prozess MyApplication/EncryptDocument
mithilfe von DIME aufzurufen, verwenden Sie den Typ EncryptDocumentServiceWse
.
Referenzieren der WSE-Bibliothek
- Wählen Sie im Menü „Projekt“ die Option „Verweis hinzufügen“ aus.
- Wählen Sie im Dialogfeld „Verweis hinzufügen“ die Option „Microsoft.Web.Services2.dll“ aus.
- Wählen Sie „System.Web.Services.dll“ aus.
- Klicken Sie auf „Auswählen“ und dann auf „OK“.
Erstellen eines Web-Verweises auf einen Forms-Service
- Wählen Sie im Projektmenü die Option „Webverwei hinzufügen“.
- Geben Sie im Dialogfeld „URL“ die URL zum Forms-Dienst an.
- Klicken Sie auf „Los“ und dann auf „Verweis hinzufügen“.
Aufrufen eines Dienstes mit DIME in einem .NET-Projekt
Sie können einen Forms-Dienst mit DIME aufrufen. Beachten Sie den MyApplication/EncryptDocument
-Prozess, der ein ungesichertes PDF-Dokument akzeptiert und ein kennwortverschlüsseltes PDF-Dokument zurückgibt. Um den MyApplication/EncryptDocument
-Prozess mit DIME aufzurufen, führen Sie die folgenden Schritte aus:
-
Erstellen Sie ein Microsoft .NET-Projekt, mit dem Sie einen Forms-Dienst mit DIME aufrufen können. Stellen Sie sicher, dass Sie Web Services Enhancements 2.0 einbeziehen und einen Webverweis auf den AEM Forms-Dienst erstellen.
-
Nachdem Sie einen Webverweis auf den
MyApplication/EncryptDocument
-Prozess gesetzt haben, erstellen Sie einEncryptDocumentServiceWse
-Objekt, indem Sie dessen Standardkonstruktor verwenden. -
Legen Sie für das Datenelement
Credentials
desEncryptDocumentServiceWse
-Objekts einenSystem.Net.NetworkCredential
-Wert fest, der den Wert von AEM Forms-Benutzernamen und Kennwort angibt. -
Erstellen Sie ein
Microsoft.Web.Services2.Dime.DimeAttachment
-Objekt, indem Sie seinen Konstruktor verwenden und die folgenden Werte übergeben:- Ein Zeichenfolgewert, der einen GUID-Wert angibt. Sie können einen GUID-Wert abrufen, indem Sie die
System.Guid.NewGuid.ToString
-Methode aufrufen. - Ein Zeichenfolgewert, der den Inhaltstyp angibt. Da für diesen Vorgang ein PDF-Dokument erforderlich ist, geben Sie
application/pdf
an. - Ein
TypeFormat
-Auflistungswert. Geben SieTypeFormat.MediaType
. - Ein Zeichenfolgewert, der den Speicherort des PDF-Dokuments angibt, das an den AEM Forms-Prozess übergeben wird.
- Ein Zeichenfolgewert, der einen GUID-Wert angibt. Sie können einen GUID-Wert abrufen, indem Sie die
-
Erstellen Sie ein Objekt
BLOB
, indem Sie den Konstruktor verwenden. -
Fügen Sie die DIME-Anlage zum
BLOB
-Objekt hinzu, indem Sie den DatenelementwertId
desMicrosoft.Web.Services2.Dime.DimeAttachment
-Objekts dem DatenelementattachmentID
desBLOB
-Objekts zuweisen. -
Rufen Sie die Methode
EncryptDocumentServiceWse.RequestSoapContext.Attachments.Add
auf und übergeben Sie dasMicrosoft.Web.Services2.Dime.DimeAttachment
-Objekt. -
Rufen Sie den Prozess
MyApplication/EncryptDocument
auf, indem Sie die Methodeinvoke
desEncryptDocumentServiceWse
-Objekts aufrufen und dasBLOB
-Objekt übergeben, das den DIME-Anhang enthält. Dieser Prozess gibt ein verschlüsseltes PDF-Dokument innerhalb einesBLOB
-Objekts zurück. -
Ermitteln Sie den Anlagenkennungswert, indem Sie den Wert des Datenelements
attachmentID
des zurückgegebenenBLOB
-Objekts abrufen. -
Iterieren Sie durch die Anlagen unter
EncryptDocumentServiceWse.ResponseSoapContext.Attachments
und verwenden Sie den Anlagenkennungswert, um das verschlüsselte PDF-Dokument abzurufen. -
Erhalten Sie ein
System.IO.Stream
-Objekt, indem Sie den Wert des DatenelementsStream
desAttachment
-Objekts abrufen. -
Erstellen Sie ein Byte-Array und übergeben Sie dieses Byte-Array an die Methode
Read
desSystem.IO.Stream
-Objekts. Diese Methode füllt das Byte-Array mit einem Datenstrom, der das verschlüsselte PDF-Dokument darstellt. -
Erstellen Sie ein
System.IO.FileStream
-Objekt durch Aufrufen des Konstruktors und Übergeben eines Zeichenfolgenwerts, der einen Speicherort der PDF-Datei darstellt. Dieses Objekt stellt das verschlüsselte PDF-Dokument dar. -
Erstellen Sie ein
System.IO.BinaryWriter
-Objekt, indem Sie seinen Konstruktor verwenden und dasSystem.IO.FileStream
-Objekt übergeben. -
Schreiben Sie den Inhalt des Byte-Arrays in die PDF-Datei, indem Sie die Methode
Write
desSystem.IO.BinaryWriter
-Objekts aufrufen und das Byte-Array übergeben.
Erstellen von Apache Axis Java-Proxy-Klassen, die DIME verwenden creating-apache-axis-java-proxy-classes-that-use-dime
Sie können das Apache Axis WSDL2Java-Tool verwenden, um eine Dienst-WSDL in Java-Proxyklassen zu konvertieren, damit Sie Dienstvorgänge aufrufen können. Mithilfe von Apache Ant können Sie Bibliotheksdateien für Axis aus einer AEM Forms-Dienst-WSDL generieren, mit der Sie den Dienst aufrufen können. (Siehe Erstellen von Java-Proxy-Klassen mit Apache Axis.)
Das Apache Axis WSDL2Java-Tool generiert JAVA-Dateien, die Methoden enthalten, die zum Senden von SOAP-Anforderungen an einen Dienst verwendet werden. SOAP-Anforderungen, die von einem Dienst empfangen werden, werden von den von Axis generierten Bibliotheken dekodiert und in die Methoden und Argumente zurückumgewandelt.
Zum Aufrufen des MyApplication/EncryptDocument
-Dienstes (der in Workbench erstellt wurde) mit Axis-generierten Bibliotheksdateien und DIME, führen Sie die folgenden Schritte durch:
-
Erstellen Sie Java-Proxy-Klassen, die die
MyApplication/EncryptDocument
-Dienst-WSDL mit Apache Axis nutzen. (Siehe Erstellen von Java-Proxy-Klassen mit Apache Axis.) -
Schließen Sie die Java-Proxy-Klassen in Ihren Klassenpfad ein.
-
Erstellen Sie ein Objekt
MyApplicationEncryptDocumentServiceLocator
, indem Sie den Konstruktor verwenden. -
Erstellen Sie ein
URL
-Objekt, indem Sie seinen Konstruktor verwenden und einen Zeichenfolgenwert übergeben, der die WSDL-Definition des AEM Forms-Dienstes angibt. Stellen Sie sicher, dass Sie?blob=dime
am Ende der SOAP-Endpunkt-URL angeben. Beispielecode language-java https://hiro-xp:8080/soap/services/MyApplication/EncryptDocument?blob=dime.
-
Erstellen Sie ein
EncryptDocumentSoapBindingStub
-Objekt durch Aufrufen des Konstruktors und Übergeben desMyApplicationEncryptDocumentServiceLocator
-Objekts und desURL
-Objekts. -
Legen Sie den Benutzernamen und das Kennwort für AEM Forms fest, indem Sie die Methoden
setUsername
undsetPassword
desEncryptDocumentSoapBindingStub
-Objekts aufrufen.code language-java encryptionClientStub.setUsername("administrator"); encryptionClientStub.setPassword("password");
-
Rufen Sie das PDF-Dokument, das an den
MyApplication/EncryptDocument
-Dienst gesendet werden soll, durch Erstellen einesjava.io.File
-Objekts ab. Übergeben Sie einen Zeichenfolgewert, der den Speicherort des PDF-Dokuments angibt. -
Erstellen Sie ein
javax.activation.DataHandler
-Objekt, indem Sie seinen Konstruktor verwenden und dasjavax.activation.FileDataSource
-Objekt übergeben. Dasjavax.activation.FileDataSource
-Objekt kann mithilfe seines Konstruktors und der Übergabe desjava.io.File
-Objekts, welches das PDF-Dokument darstellt, erstellt werden. -
Erstellen Sie ein
org.apache.axis.attachments.AttachmentPart
-Objekt, indem Sie seinen Konstruktor verwenden und dasjavax.activation.DataHandler
-Objekt übergeben. -
Hängen Sie die Anlage an, indem Sie die Methode
addAttachment
desEncryptDocumentSoapBindingStub
-Objekts aufrufen und dasorg.apache.axis.attachments.AttachmentPart
-Objekt übergeben. -
Erstellen Sie ein
BLOB
-Objekt, indem Sie seinen Konstruktor verwenden. Füllen Sie dasBLOB
-Objekt mit dem Anlagenkennungswert, indem Sie die MethodesetAttachmentID
desBLOB
-Objekts aufrufen und den Anlagenkennungswert übergeben. Dieser Wert kann durch Aufrufen der MethodegetContentId
desorg.apache.axis.attachments.AttachmentPart
-Objekts ermittelt werden. -
Rufen Sie den Prozess
MyApplication/EncryptDocument
auf, indem Sie die Methodeinvoke
desEncryptDocumentSoapBindingStub
-Objekts aufrufen. Übergeben Sie dasBLOB
-Objekt, das die DIME-Anlage enthält. Dieser Prozess gibt ein verschlüsseltes PDF-Dokument innerhalb einesBLOB
-Objekt zurück. -
Ermitteln Sie den Wert der Anlagenkennung, indem Sie die Methode
getAttachmentID
des zurückgegebenenBLOB
-Objekts aufrufen. Diese Methode gibt einen Zeichenfolgenwert zurück, der den Kennungswert der zurückgegebenen Anlage darstellt. -
Rufen Sie die Anlagen ab, indem Sie die Methode
getAttachments
desEncryptDocumentSoapBindingStub
-Objekts aufrufen. Diese Methode gibt ein Array vonObjects
, das die Anlagen darstellt, zurück. -
Iterieren Sie durch die Anlagen (das
Object
-Array) und verwenden Sie den Anlagenkennungswert, um das verschlüsselte PDF-Dokument abzurufen. Jedes Element ist einorg.apache.axis.attachments.AttachmentPart
-Objekt. -
Erhalten Sie das
javax.activation.DataHandler
-Objekt, das mit dem Anhang verbunden ist, indem Sie die MethodegetDataHandler
desorg.apache.axis.attachments.AttachmentPart
-Objekts aufrufen. -
Erhalten Sie ein
java.io.FileStream
-Objekt, indem Sie die MethodegetInputStream
desjavax.activation.DataHandler
-Objekts aufrufen. -
Erstellen Sie ein Byte-Array und übergeben Sie dieses Byte-Array an die Methode
read
desjava.io.FileStream
-Objekts. Diese Methode füllt das Byte-Array mit einem Datenstrom, der das verschlüsselte PDF-Dokument darstellt. -
Erstellen Sie ein Objekt
java.io.File
, indem Sie den Konstruktor verwenden. Dieses Objekt stellt das verschlüsselte PDF-Dokument dar. -
Erstellen Sie ein
java.io.FileOutputStream
-Objekt, indem Sie seinen Konstruktor verwenden und dasjava.io.File
-Objekt übergeben. -
Rufen Sie die Methode
write
desjava.io.FileOutputStream
-Objekts auf und übergeben Sie das Byte-Array, das den Datenstrom enthält, der das verschlüsselte PDF-Dokument darstellt.
Siehe auch
Kurzanleitung: Aufrufen eines Services mithilfe von DIME in einem Java-Projekt
Verwenden der SAML-basierten Authentifizierung using-saml-based-authentication
AEM Forms unterstützt beim Aufrufen von Services verschiedene Authentifizierungsmodi für Web-Services. Ein Authentifizierungsmodus ist die Angabe eines Benutzernamens und eines Kennworts mit Hilfe einer einfachen Autorisierungskopfzeile im Aufruf des Web-Services. AEM Forms unterstützt auch die Authentifizierung, die auf einer SAML-Bestätigung basiert. Wenn ein Client-Programm einen AEM Forms-Service mithilfe eines Web-Services aufruft, kann das Client-Programm Authentifizierungsinformationen auf eine der folgenden Arten bereitstellen:
- Übergeben von Anmeldeinformationen als Teil der grundlegenden Autorisierung
- Übergeben des Benutzernamen-Tokens als Teil der WS-Security-Kopfzeile
- Übergeben einer SAML-Bestätigung als Teil der WS-Security-Kopfzeile
- Übergeben eines Kerberos-Tokens als Teil der WS-Security-Kopfzeile
AEM Forms unterstützt keine standardmäßige zertifikatbasierte Authentifizierung, unterstützt jedoch die zertifikatbasierte Authentifizierung in einer anderen Form.
Die Identität von AEM Forms-Benutzern kann durch eine SAML-Bestätigung dargestellt werden, die mithilfe eines geheimen Schlüssels signiert wird. Der folgende XML-Code zeigt ein Beispiel für eine SAML-Bestätigung.
<Assertion xmlns="urn:oasis:names:tc:SAML:1.0:assertion"
xmlns:saml="urn:oasis:names:tc:SAML:1.0:assertion"
xmlns:samlp="urn:oasis:names:tc:SAML:1.0:protocol"
AssertionID="fd4bd0c87302780e0d9bbfa8726d5bc0" IssueInstant="2008-04-17T13:47:00.720Z" Issuer="LiveCycle"
MajorVersion="1" MinorVersion="1">
<Conditions NotBefore="2008-04-17T13:47:00.720Z" NotOnOrAfter="2008-04-17T15:47:00.720Z">
</Conditions>
<AuthenticationStatement
AuthenticationInstant="2008-04-17T13:47:00.720Z"
AuthenticationMethod="urn:oasis:names:tc:SAML:1.0:am:unspecified">
<Subject>
<NameIdentifier NameQualifier="DefaultDom">administrator</NameIdentifier>
<SubjectConfirmation>
<ConfirmationMethod>urn:oasis:names:tc:SAML:1.0:cm:sender-vouches</ConfirmationMethod>
</SubjectConfirmation>
</Subject>
</AuthenticationStatement>
<ds:Signature >
<ds:SignedInfo>
<ds:CanonicalizationMethod Algorithm="https://www.w3.org/2001/10/xml-exc-c14n#"></ds:CanonicalizationMethod>
<ds:SignatureMethod Algorithm="https://www.w3.org/2000/09/xmldsig#hmac-sha1"></ds:SignatureMethod>
<ds:Reference URI="#fd4bd0c87302780e0d9bbfa8726d5bc0">
<ds:Transforms>
<ds:Transform Algorithm="https://www.w3.org/2000/09/xmldsig#enveloped-signature"></ds:Transform>
<ds:Transform Algorithm="https://www.w3.org/2001/10/xml-exc-c14n#">
<ec:InclusiveNamespaces
PrefixList="code ds kind rw saml samlp typens #default">
</ec:InclusiveNamespaces>
</ds:Transform>
</ds:Transforms>
<ds:DigestMethod Algorithm="https://www.w3.org/2000/09/xmldsig#sha1"></ds:DigestMethod>
<ds:DigestValue>hVrtqjWr+VzaVUIpQx0YI9lIjaY=</ds:DigestValue>
</ds:Reference>
</ds:SignedInfo>
<ds:SignatureValue>UMbBb+cUcPtcWDCIhXes4n4FxfU=</ds:SignatureValue>
</ds:Signature>
</Assertion>
Diese Beispiel-Bestätigung wird für einen Administrator-Benutzer ausgestellt. Diese Bestätigung enthält die folgenden bemerkenswerten Elemente:
- Sie gilt für eine bestimmte Dauer.
- Sie wird für einen bestimmten Benutzer ausgestellt.
- Sie ist digital signiert. Jede daran vorgenommene Änderung würde also die Signatur beschädigen.
- Sie kann für AEM Forms als Token der Benutzeridentität ähnlich wie Benutzername und Kennwort angezeigt werden.
Ein Client-Programm kann die Bestätigung von jeder AuthenticationManager-API in AEM Forms abrufen, die ein AuthResult
-Objekt zurückgibt. Sie können eine AuthResult
-Instanz erhalten, indem Sie eine der beiden folgenden Methoden durchführen:
- Authentifizieren des Benutzers mithilfe einer der Authentifizierungsmethoden, die von der AuthenticationManager-API verfügbar gemacht werden. Normalerweise würden der Benutzername und das Kennwort verwendet. Sie können jedoch auch die Zertifikatauthentifizierung verwenden.
- Mithilfe der Methode
AuthenticationManager.getAuthResultOnBehalfOfUser
. Mithilfe dieser Methode kann ein Client-Programm für einen beliebigen AEM Forms-Benutzer einAuthResult
-Objekt abrufen.
AEM Forms-Benutzende können mithilfe eines SAML-Tokens authentifiziert werden, das abgerufen wird. Diese SAML-Bestätigung (XML-Fragment) kann als Teil der WS-Security-Kopfzeile mit dem Aufruf des Web-Services zur Benutzerauthentifizierung gesendet werden. In der Regel hat ein Client-Programm einen Benutzer authentifiziert, aber die Anmeldeinformationen des Benutzers nicht gespeichert. (Oder der Benutzer hat sich bei diesem Client über einen anderen Mechanismus als die Verwendung eines Benutzernamens und Kennworts angemeldet.) In dieser Situation muss das Client-Programm AEM Forms aufrufen und einen bestimmten Benutzer verkörpern, der berechtigt ist, AEM Forms aufzurufen.
Um einen bestimmten Benutzer zu verkörpern, rufen Sie die Methode AuthenticationManager.getAuthResultOnBehalfOfUser
mithilfe eines Web-Services auf. Diese Methode gibt eine AuthResult
-Instanz zurück, die die SAML-Bestätigung für diesen Benutzer enthält.
Verwenden Sie anschließend diese SAML-Bestätigung, um alle Services aufzurufen, für die eine Authentifizierung erforderlich ist. Diese Aktion umfasst das Senden der Bestätigung als Teil der SOAP-Kopfzeile. Wenn mit dieser Bestätigung ein Aufruf eines Web-Services erfolgt, identifiziert AEM Forms den Benutzer als den Benutzer, der durch diese Bestätigung dargestellt wird. Das heißt, der in der Bestätigung angegebene Benutzer ist der Benutzer, der den Service aufruft.
Verwenden von Apache Axis-Klassen und SAML-basierter Authentifizierung using-apache-axis-classes-and-saml-based-authentication
Sie können einen AEM Forms-Service über Java-Proxy-Klassen aufrufen, die mithilfe der Axis-Bibliothek erstellt wurden. (Siehe Erstellen von Java-Proxy-Klassen mithilfe von Apache Axis.)
Wenn Sie AXIS verwenden, das SAML-basierte Authentifizierung verwendet, registrieren Sie den Anfrage- und Antwort-Handler bei Axis. Apache Axis ruft den Handler auf, bevor eine Aufrufanforderung an AEM Forms gesendet wird. Um einen Handler zu registrieren, erstellen Sie eine Java-Klasse, die org.apache.axis.handlers.BasicHandler
erweitert.
Erstellen eines AssertionHandlers mit Axis
Die folgende Java-Klasse mit dem Namen AssertionHandler.java
zeigt ein Beispiel einer Java-Klasse, die org.apache.axis.handlers.BasicHandler
erweitert.
public class AssertionHandler extends BasicHandler {
public void invoke(MessageContext ctx) throws AxisFault {
String assertion = (String) ctx.getProperty(LC_ASSERTION);
//no assertion hence nothing to insert
if(assertion == null) return;
try {
MessageElement samlElement = new MessageElement(convertToXML(assertion));
SOAPHeader header = (SOAPHeader) ctx.getRequestMessage().getSOAPHeader();
//Create the wsse:Security element which would contain the SAML element
SOAPElement wsseHeader = header.addChildElement("Security", "wsse", WSSE_NS);
wsseHeader.appendChild(samlElement);
//remove the actor attribute as in LC we do not specify any actor. This would not remove the actor attribute though
//it would only remove it from the soapenv namespace
wsseHeader.getAttributes().removeNamedItem("actor");
} catch (SOAPException e) {
throw new AxisFault("Error occured while adding the assertion to the SOAP Header",e);
}
}
}
Registrieren des Handlers
Um einen Handler bei Axis zu registrieren, erstellen Sie eine Datei „client-config.wsdd“. Standardmäßig sucht Axis nach einer Datei mit diesem Namen. Der folgende XML-Code ist ein Beispiel für eine Datei „client-config.wsdd“. Weitere Informationen finden Sie in der Dokumentation zu Axis.
<deployment xmlns="https://xml.apache.org/axis/wsdd/" xmlns:java="https://xml.apache.org/axis/wsdd/providers/java">
<transport name="http" pivot="java:org.apache.axis.transport.http.HTTPSender"/>
<globalConfiguration >
<requestFlow >
<handler type="java:com.adobe.idp.um.example.AssertionHandler" />
</requestFlow >
</globalConfiguration >
</deployment>
Aufrufen eines AEM Forms-Service
Im folgenden Code-Beispiel wird ein AEM Forms-Service mit SAML-basierter Authentifizierung aufgerufen.
public class ImpersonationExample {
. . .
public void authenticateOnBehalf(String superUsername,String password,
String canonicalName,String domainName) throws UMException, RemoteException{
((org.apache.axis.client.Stub) authenticationManager).setUsername(superUsername);
((org.apache.axis.client.Stub) authenticationManager).setPassword(password);
//Step 1 - Invoke the Auth manager api to get an assertion for the user to be impersonated
AuthResult ar = authenticationManager.getAuthResultOnBehalfOfUser(canonicalName, domainName, null);
String assertion = ar.getAssertion();
//Step 2 - Setting the assertion here to be picked later by the AssertionHandler. Note that stubs are not threadSafe
//hence should not be reused. For this simple example we have made them instance variable but care should be taken
//regarding the thread safety
((javax.xml.rpc.Stub) authorizationManager)._setProperty(AssertionHandler.LC_ASSERTION, assertion);
}
public Role findRole(String roleId) throws UMException, RemoteException{
//This api would be invoked under bob's user rights
return authorizationManager.findRole(roleId);
}
public static void main(String[] args) throws Exception {
ImpersonationExample ie = new ImpersonationExample("http://localhost:5555");
//Get the SAML assertion for the user to impersonate and store it in stub
ie.authenticateOnBehalf(
"administrator", //The Super user which has the required impersonation permission
"password", // Password of the super user as referred above
"bob", //Cannonical name of the user to impersonate
"testdomain" //Domain of the user to impersonate
);
Role r = ie.findRole("BASIC_ROLE_ADMINISTRATOR");
System.out.println("Role "+r.getName());
}
}
Verwenden einer .NET-Client-Assembly und einer SAML-basierten Authentifizierung using-a-net-client-assembly-and-saml-based-authentication
Sie können einen Forms-Service mithilfe einer .NET-Client-Assembly und einer SAML-basierten Authentifizierung aufrufen. Dazu müssen Sie Web Service Enhancements 3.0 (WSE) verwenden. Informationen zum Erstellen einer .NET-Client-Assembly, die WSE verwendet, finden Sie unter Erstellen eines .NET-Projekts, das DIME verwendet.
Die WSE-Architektur verwendet die Datentypen Richtlinien, Assertionen und SecurityToken. Für einen Webservice-Aufruf geben Sie eine Richtlinie an. Eine Richtlinie kann über mehrere Assertionen verfügen. Jede Assertion kann Filter enthalten. Ein Filter wird in bestimmten Phasen eines Webservice-Aufrufs aufgerufen und kann zu diesem Zeitpunkt die SOAP-Anforderung ändern. Ausführliche Informationen finden Sie in der Dokumentation zu Web Service Enhancements 3.0.
Erstellen von Assertion und Filter
Im folgenden C#-Code-Beispiel werden Filter- und Assertionsklassen erstellt. In diesem Code-Beispiel wird ein SamlAssertionOutputFilter erstellt. Dieser Filter wird vom WSE-Framework aufgerufen, bevor die SOAP-Anforderung an AEM Forms gesendet wird.
class LCSamlPolicyAssertion : Microsoft.Web.ServicES4.Design.PolicyAssertion
{
public override Microsoft.Web.ServicES4.SoapFilter CreateClientOutputFilter(FilterCreationContext context)
{
return new SamlAssertionOutputFilter();
}
. . .
}
class SamlAssertionOutputFilter : SendSecurityFilter
{
public override void SecureMessage(SoapEnvelope envelope, Security security)
{
// Get the SamlToken from the SessionState
SamlToken samlToken = envelope.Context.Credentials.UltimateReceiver.GetClientToken<SamlToken>();
security.Tokens.Add(samlToken);
}
}
Erstellen des SAML-Tokens
Erstellen Sie eine Klasse, die die SAML-Assertion darstellt. Die Hauptaufgabe dieser Klasse besteht darin, Datenwerte aus der Zeichenfolge in XML zu konvertieren und Leerzeichen beizubehalten. Diese Assertions-XML wird später in die SOAP-Anforderung importiert.
class SamlToken : SecurityToken
{
public const string SAMLAssertion = "https://docs.oasis-open.org/wss/oasis-wss-saml-token-profile-1.1#SAMLV1.1";
private XmlElement _assertionElement;
public SamlToken(string assertion)
: base(SAMLAssertion)
{
XmlDocument xmlDoc = new XmlDocument();
//The white space has to be preserved else the digital signature would get broken
xmlDoc.PreserveWhitespace = true;
xmlDoc.LoadXml(assertion);
_assertionElement = xmlDoc.DocumentElement;
}
public override XmlElement GetXml(XmlDocument document)
{
return (XmlElement)document.ImportNode(_assertionElement, true);
}
. . .
}
Aufrufen eines AEM Forms-Service
Im folgenden C#-Code-Beispiel wird ein Forms-Service mithilfe der SAML-basierten Authentifizierung aufgerufen.
public class ImpersonationExample
{
. . .
public void AuthenticateOnBehalf(string superUsername, string password, string canonicalName, string domainName)
{
//Create a policy for UsernamePassword Token
Policy usernamePasswordPolicy = new Policy();
usernamePasswordPolicy.Assertions.Add(new UsernameOverTransportAssertion());
UsernameToken token = new UsernameToken(superUsername, password, PasswordOption.SendPlainText);
authenticationManager.SetClientCredential(token);
authenticationManager.SetPolicy(usernamePasswordPolicy);
//Get the SAML assertion for impersonated user
AuthClient.AuthenticationManagerService.AuthResult ar
= authenticationManager.getAuthResultOnBehalfOfUser(canonicalName, domainName, null);
System.Console.WriteLine("Received assertion " + ar.assertion);
//Create a policy for inserting SAML assertion
Policy samlPolicy = new Policy();
samlPolicy.Assertions.Add(new LCSamlPolicyAssertion());
authorizationManager.SetPolicy(samlPolicy);
//Set the SAML assertion obtained previously as the token
authorizationManager.SetClientCredential(new SamlToken(ar.assertion));
}
public Role findRole(string roleId)
{
return authorizationManager.findRole(roleId);
}
static void Main(string[] args)
{
ImpersonationExample ie = new ImpersonationExample("http://localhost:5555");
ie.AuthenticateOnBehalf(
"administrator", //The Super user which has the required impersonation permission
"password", // Password of the super user as referred above
"bob", //Cannonical name of the user to impersonate
"testdomain" //Domain of the user to impersonate
);
Role r = ie.findRole("BASIC_ROLE_ADMINISTRATOR");
System.Console.WriteLine("Role "+r.name);
}
}
Überlegungen zur Verwendung von Webservices related-considerations-when-using-web-services
Manchmal treten Probleme beim Aufrufen bestimmter AEM Forms-Service-Vorgänge über Webservices auf. Ziel dieser Diskussion ist es, diese Probleme zu ermitteln und eine Lösung anzubieten, sofern eine Lösung verfügbar ist.
Asynchrones Aufrufen von Service-Vorgängen invoking-service-operations-asynchronously
Wenn Sie versuchen, einen AEM Forms-Dienstvorgang asynchron aufzurufen, z. B. den htmlToPDF
-Vorgang von Generate PDF, tritt eine SoapFaultException
auf. Um dieses Problem zu beheben, erstellen Sie eine XML-Datei mit benutzerdefinierter Bindung, die das ExportPDF_Result
-Element und andere Elemente in verschiedenen Klassen zuordnet. Die folgende XML-Datei stellt eine benutzerdefinierte Bindungsdatei dar.
<bindings
xmlns:xsd="https://www.w3.org/2001/XMLSchema"
xmlns:jxb="https://java.sun.com/xml/ns/jaxb" jxb:version="1.0"
xmlns:wsdl="https://schemas.xmlsoap.org/wsdl/"
wsdlLocation="http://localhost:8080/soap/services/GeneratePDFService?wsdl&async=true&lc_version=9.0.0"
xmlns="https://java.sun.com/xml/ns/jaxws">
<enableAsyncMapping>false</enableAsyncMapping>
<package name="external_customize.client"/>
<enableWrapperStyle>true</enableWrapperStyle>
<bindings node="/wsdl:definitions/wsdl:types/xsd:schema[@targetNamespace='https://adobe.com/idp/services']/xsd:element[@name='ExportPDF_Result']">
<jxb:class name="ExportPDFAsyncResult">
</jxb:class>
</bindings>
<bindings node="/wsdl:definitions/wsdl:types/xsd:schema[@targetNamespace='https://adobe.com/idp/services']/xsd:element[@name='CreatePDF_Result']">
<jxb:class name="CreatePDFAsyncResult">
</jxb:class>
</bindings>
<bindings node="/wsdl:definitions/wsdl:types/xsd:schema[@targetNamespace='https://adobe.com/idp/services']/xsd:element[@name='HtmlToPDF_Result']">
<jxb:class name="HtmlToPDFAsyncResult">
</jxb:class>
</bindings>
<bindings node="/wsdl:definitions/wsdl:types/xsd:schema[@targetNamespace='https://adobe.com/idp/services']/xsd:element[@name='OptimizePDF_Result']">
<jxb:class name="OptimizePDFAsyncResult">
</jxb:class>
</bindings>
<!--bindings node="//wsdl:portType[@name='GeneratePDFService']/wsdl:operation[@name='HtmlToPDF_Result']">
<jxb:class name="HtmlToPDFAsyncResult"/>
</bindings-->
</bindings>
Verwenden Sie diese XML-Datei beim Erstellen von Java-Proxy-Dateien mithilfe von JAX-WS. (Siehe Erstellen von Java-Proxy-Klassen mithilfe von JAX-WS.)
Referenzieren Sie diese XML-Datei beim Ausführen des JAX-WS-Tools („wsimport.exe“) mithilfe der Befehlszeilenoption „- b
“. Aktualisieren Sie das wsdlLocation
-Element in der Bindungs-XML-Datei, um die URL von AEM Forms anzugeben.
Um sicherzustellen, dass der asynchrone Aufruf funktioniert, ändern Sie den Endpunkt-URL-Wert und geben Sie async=true
an. Geben Sie beispielsweise für Java-Proxy-Dateien, die mit JAX-WS erstellt werden, Folgendes für BindingProvider.ENDPOINT_ADDRESS_PROPERTY
an.
https://server:port/soap/services/ServiceName?wsdl&async=true&lc_version=9.0.0
Die folgende Liste gibt andere Services an, die eine benutzerdefinierte Bindungsdatei benötigen, wenn sie asynchron aufgerufen werden:
- PDFG3D
- Task Manager
- Application Manager
- Directory Manager
- Distiller
- Rights Management
- Document Management
Unterschiede bei J2EE-Anwendungsservern differences-in-j2ee-application-servers
Manchmal ruft eine Proxy-Bibliothek, die mit einem bestimmten J2EE-Programm-Server erstellt wurde, nicht erfolgreich AEM Forms auf, das auf einem anderen J2EE-Programm-Server gehostet wird. Stellen Sie sich eine Proxy-Bibliothek vor, die mit AEM Forms generiert wird, das auf WebSphere bereitgestellt wird. Diese Proxy-Bibliothek kann AEM Forms-Services, die auf dem JBoss-Programm-Server bereitgestellt werden, nicht erfolgreich aufrufen.
Einige komplexe AEM Forms-Datentypen, z. B. PrincipalReference
, werden bei der Bereitstellung von AEM Forms auf WebSphere im Vergleich zum JBoss-Programm-Server anders definiert. Der Grund für die Unterschiede in den WSDL-Definitionen liegt in den unterschiedlichen JDKs, die von den verschiedenen J2EE-Programm-Services verwendet werden. Verwenden Sie daher Proxy-Bibliotheken, die vom selben J2EE-Programm-Server generiert werden.
Zugreifen auf mehrere Dienste mithilfe von Webdiensten accessing-multiple-services-using-web-services
Aufgrund von Namespace-Konflikten können Datenobjekte nicht für mehrere Service-WSDLs freigegeben werden. Verschiedene Services können Datentypen gemeinsam nutzen. Daher nutzen die Services die Definition dieser Typen in den WSDLs gemeinsam. Sie können beispielsweise nicht zwei .NET-Client-Assemblys, die einen BLOB
-Datentyp enthalten, zum selben .NET-Client-Projekt hinzufügen. Wenn Sie dies versuchen, tritt ein Kompilierungsfehler auf.
In der folgenden Liste sind Datentypen aufgeführt, die nicht von mehreren Service-WSDLs gemeinsam genutzt werden können:
User
Principals
PrincipalReference
Groups
Roles
BLOB
Um dieses Problem zu vermeiden, wird empfohlen, die Datentypen vollständig zu qualifizieren. Betrachten Sie zum Beispiel ein .NET-Programm, das sowohl auf den Forms-Service als auch auf den Signature-Service mit einem Service-Verweis verweist. Beide Service-Verweise enthalten eine BLOB
-Klasse. Um eine BLOB
-Instanz verwenden zu können, müssen Sie das BLOB
-Objekt bei der Deklaration vollständig qualifizieren. Dieser Ansatz wird im folgenden Code-Beispiel veranschaulicht. Informationen zu diesem Code-Beispiel finden Sie unter Digitales Signieren von interaktiven Formularen.
Im folgenden C#-Code-Beispiel wird ein interaktives Formular signiert, das vom Forms-Service gerendert wird. Das Client-Programm hat zwei Service-Verweise. Die BLOB
-Instanz, die mit dem Forms-Service verbunden ist, gehört zum Namespace SignInteractiveForm.ServiceReference2
. Analog dazu gehört die BLOB
-Instanz, die mit dem Signature-Service verbunden ist, zum Namespace SignInteractiveForm.ServiceReference1
. Das signierte interaktive Formular wird als PDF-Datei mit dem Namen LoanXFASigned.pdf gespeichert.
???/**
* Ensure that you create a .NET project that uses
* MS Visual Studio 2008 and version 3.5 of the .NET
* framework. This is required to invoke a
* AEM Forms service using MTOM.
*
* For information, see "Invoking AEM Forms using MTOM" in Programming with AEM forms
*/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.ServiceModel;
using System.IO;
//A reference to the Signature service
using SignInteractiveForm.ServiceReference1;
//A reference to the Forms service
using SignInteractiveForm.ServiceReference2;
namespace SignInteractiveForm
{
class Program
{
static void Main(string[] args)
{
try
{
//Because BLOB objects are used in both service references
//it is necessary to fully qualify the BLOB objects
//Retrieve the form -- invoke the Forms service
SignInteractiveForm.ServiceReference2.BLOB formData = GetForm();
//Create a BLOB object associated with the Signature service
SignInteractiveForm.ServiceReference1.BLOB sigData = new SignInteractiveForm.ServiceReference1.BLOB();
//Transfer the byte stream from one Forms BLOB object to the
//Signature BLOB object
sigData.MTOM = formData.MTOM;
//Sign the Form -- invoke the Signature service
SignForm(sigData);
}
catch (Exception ee)
{
Console.WriteLine(ee.Message);
}
}
//Creates an interactive PDF form based on a XFA form - invoke the Forms service
private static SignInteractiveForm.ServiceReference2.BLOB GetForm()
{
try
{
//Create a FormsServiceClient object
FormsServiceClient formsClient = new FormsServiceClient();
formsClient.Endpoint.Address = new System.ServiceModel.EndpointAddress("https://hiro-xp:8080/soap/services/FormsService?blob=mtom");
//Enable BASIC HTTP authentication
BasicHttpBinding b = (BasicHttpBinding)formsClient.Endpoint.Binding;
b.MessageEncoding = WSMessageEncoding.Mtom;
formsClient.ClientCredentials.UserName.UserName = "administrator";
formsClient.ClientCredentials.UserName.Password = "password";
b.Security.Transport.ClientCredentialType = HttpClientCredentialType.Basic;
b.Security.Mode = BasicHttpSecurityMode.TransportCredentialOnly;
b.MaxReceivedMessageSize = 2000000;
b.MaxBufferSize = 2000000;
b.ReaderQuotas.MaxArrayLength = 2000000;
//Create a BLOB to store form data
SignInteractiveForm.ServiceReference2.BLOB formData = new SignInteractiveForm.ServiceReference2.BLOB();
SignInteractiveForm.ServiceReference2.BLOB pdfForm = new SignInteractiveForm.ServiceReference2.BLOB();
//Specify an XML form data
string path = "C:\\Adobe\Loan.xml";
FileStream fs = new FileStream(path, FileMode.Open);
//Get the length of the file stream
int len = (int)fs.Length;
byte[] ByteArray = new byte[len];
fs.Read(ByteArray, 0, len);
formData.MTOM = ByteArray;
//Specify an XML form data
string path2 = "C:\\Adobe\LoanSigXFA.pdf";
FileStream fs2 = new FileStream(path2, FileMode.Open);
//Get the length of the file stream
int len2 = (int)fs2.Length;
byte[] ByteArray2 = new byte[len2];
fs2.Read(ByteArray2, 0, len2);
pdfForm.MTOM = ByteArray2;
PDFFormRenderSpec renderSpec = new PDFFormRenderSpec();
renderSpec.generateServerAppearance = true;
//Set out parameter values
long pageCount = 1;
String localValue = "en_US";
FormsResult result = new FormsResult();
//Render an interactive PDF form
formsClient.renderPDFForm2(
pdfForm,
formData,
renderSpec,
null,
null,
out pageCount,
out localValue,
out result);
//Write the data stream to the BLOB object
SignInteractiveForm.ServiceReference2.BLOB outForm = result.outputContent;
return outForm;
}
catch (Exception ee)
{
Console.WriteLine(ee.Message);
}
return null;
}
//Sign the form -- invoke the Signature service
private static void SignForm(SignInteractiveForm.ServiceReference1.BLOB inDoc)
{
try
{
//Create a SignatureServiceClient object
SignatureServiceClient signatureClient = new SignatureServiceClient();
signatureClient.Endpoint.Address = new System.ServiceModel.EndpointAddress("https://hiro-xp:8080/soap/services/SignatureService?blob=mtom");
//Enable BASIC HTTP authentication
BasicHttpBinding b = (BasicHttpBinding)signatureClient.Endpoint.Binding;
b.MessageEncoding = WSMessageEncoding.Mtom;
signatureClient.ClientCredentials.UserName.UserName = "administrator";
signatureClient.ClientCredentials.UserName.Password = "password";
b.Security.Transport.ClientCredentialType = HttpClientCredentialType.Basic;
b.Security.Mode = BasicHttpSecurityMode.TransportCredentialOnly;
b.MaxReceivedMessageSize = 2000000;
b.MaxBufferSize = 2000000;
b.ReaderQuotas.MaxArrayLength = 2000000;
//Specify the name of the signature field
string fieldName = "form1[0].grantApplication[0].page1[0].SignatureField1[0]";
//Create a Credential object
Credential myCred = new Credential();
myCred.alias = "secure";
//Specify the reason to sign the document
string reason = "The document was reviewed";
//Specify the location of the signer
string location = "New York HQ";
//Specify contact information
string contactInfo = "Tony Blue";
//Create a PDFSignatureAppearanceOptions object
//and show date information
PDFSignatureAppearanceOptionSpec appear = new PDFSignatureAppearanceOptionSpec();
appear.showDate = true;
//Sign the PDF document
SignInteractiveForm.ServiceReference1.BLOB signedDoc = signatureClient.sign(
inDoc,
fieldName,
myCred,
HashAlgorithm.SHA1,
reason,
location,
contactInfo,
appear,
true,
null,
null,
null);
//Populate a byte array with BLOB data that represents the signed form
byte[] outByteArray = signedDoc.MTOM;
//Save the signed PDF document
string fileName = "C:\\Adobe\LoanXFASigned.pdf";
FileStream fs2 = new FileStream(fileName, FileMode.OpenOrCreate);
//Create a BinaryWriter object
BinaryWriter w = new BinaryWriter(fs2);
w.Write(outByteArray);
w.Close();
fs2.Close();
}
catch (Exception ee)
{
Console.WriteLine(ee.Message);
}
}
}
}
Services, die mit dem Buchstaben I beginnen, erzeugen ungültige Proxy-Dateien services-starting-with-the-letter-i-produce-invalid-proxy-files
Die Namen einiger von AEM Forms generierter Proxyklassen sind bei Verwendung von Microsoft .Net 3.5 und WCF falsch. Dieses Problem tritt auf, wenn für den IBMFilenetContentRepositoryConnector, IDPSchedulerService oder einen anderen Dienst, dessen Name mit dem Buchstaben I beginnt, Proxy-Klassen erstellt werden. Beispielsweise lautet der Name des generierten Clients im Fall von IBMFileNetContentRepositoryConnector BMFileNetContentRepositoryConnectorClient
. Der Buchstabe I fehlt in der generierten Proxy-Klasse.