Die Beispiele in diesem Dokument gelten nur für eine AEM Forms on JEE-Umgebung.
AEM Forms kann mit der AEM Forms Java API aufgerufen werden. Bei Verwendung der AEM Forms-Java-API können Sie entweder die Aufruf-API oder Java-Client-Bibliotheken verwenden. Java-Client-Bibliotheken sind für Dienste wie den Rights Management-Dienst verfügbar. Mit diesen stark typisierten APIs können Sie Java-Anwendungen entwickeln, die AEM Forms aufrufen.
Die Aufruf-API sind Klassen, die sich im Paket com.adobe.idp.dsc
befinden. Mit diesen Klassen können Sie eine Aufrufanforderung direkt an einen Dienst senden und eine zurückgegebene Aufruf-Antwort verarbeiten. Verwenden Sie die Aufruf-API, um kurzlebige oder langlebige Prozesse aufzurufen, die mit Workbench erstellt wurden.
Die empfohlene Methode zum programmgesteuerten Aufrufen eines Dienstes ist die Verwendung einer Java-Client-Bibliothek, die dem Dienst und nicht der Aufruf-API entspricht. Verwenden Sie zum Aufrufen des Verschlüsselungsdienstes beispielsweise die Client-Bibliothek des Verschlüsselungsdiensts. Rufen Sie zum Ausführen eines Verschlüsselungsdienstvorgangs eine Methode auf, die zu dem Client-Objekt des Verschlüsselungsdiensts gehört. Sie können ein PDF-Dokument mit einem Kennwort verschlüsseln, indem Sie die Methode EncryptionServiceClient
des Objekts encryptPDFUsingPassword
aufrufen.
Die Java-API unterstützt die folgenden Funktionen:
Einbeziehung von AEM Forms Java-Bibliotheksdateien
An Menschen orientierte langlebige Prozesse aufrufen
AEM Forms mit Web Services aufrufen
Verbindungseigenschaften festlegen
Übergeben von Daten an AEM Forms-Dienste mithilfe der Java-API
Aufrufen eines Dienstes mithilfe einer Java-Client-Bibliothek
Aufruf eines kurzlebigen Prozesses mithilfe der Aufruf-API
Erstellen einer Java-Web-Anwendung, die einen langlebigen, an Menschen orientierten Prozess aufruft
Um einen AEM Forms-Dienst mithilfe der Java-API programmgesteuert aufzurufen, fügen Sie die erforderlichen Bibliotheksdateien (JAR-Dateien) in den Klassenpfad Ihres Java-Projekts ein. Die JAR-Dateien, die Sie in den Klassenpfad Ihrer Client-Anwendung aufnehmen, hängen von mehreren Faktoren ab:
(Nur Turnkey) Starten Sie den AEM Forms-Server mit dem Befehl standalone.bat -b <Server IP> -c lc_turnkey.xml
zum Angeben einer Server-IP für EJB
In der folgenden Tabelle sind die JAR-Dateien aufgeführt, die zum Aufrufen von AEM Forms-Diensten erforderlich sind.
File |
Beschreibung |
Ort |
---|---|---|
adobe-livecycle-client.jar |
Muss immer im Klassenpfad einer Java-Client-Anwendung enthalten sein. |
<install directory>/sdk/client-libs/common |
adobe-usermanager-client.jar |
Muss immer im Klassenpfad einer Java-Client-Anwendung enthalten sein. |
<install directory>/sdk/client-libs/common |
adobe-utilities.jar |
Muss immer im Klassenpfad einer Java-Client-Anwendung enthalten sein. |
<install directory>/sdk//client-libs/<app server> |
adobe-applicationmanager-client-sdk.jar |
Erforderlich, um den Application Manager-Dienst aufzurufen. |
<install directory>/sdk/client-libs/common |
adobe-assembler-client.jar |
Erforderlich, um den Assembler-Dienst aufzurufen. |
<install directory>/sdk/client-libs/common |
adobe-backup-restore-client-sdk.jar |
Erforderlich zum Aufrufen der Backup- und Wiederherstellungsdienst-API. |
<install directory>/sdk/client-libs/common |
adobe-barcodedforms-client.jar |
Erforderlich, den Barcoded Forms-Dienst aufzurufen. |
<install directory>/sdk/client-libs/common |
adobe-convertpdf-client.jar |
Erforderlich, um den Convert PDF-Dienst aufzurufen. |
<install directory>/sdk/client-libs/common |
adobe-distiller-client.jar |
Erforderlich, um den Distiller-Dienst aufzurufen. |
<install directory>/sdk/client-libs/common |
adobe-docconverter-client.jar |
Erforderlich, um den DocConverter-Dienst aufzurufen. |
<install directory>/sdk/client-libs/common |
adobe-contentservices-client.jar |
Erforderlich, um den Document Management-Dienst aufzurufen. |
<install directory>/sdk/client-libs/common |
adobe-encryption-client.jar |
Erforderlich, um den Verschlüsselungsdienst aufzurufen. |
<install directory>/sdk/client-libs/common |
adobe-forms-client.jar |
Erforderlich, um den Forms-Dienst aufzurufen. |
<install directory>/sdk/client-libs/common |
adobe-formdataintegration-client.jar |
Erforderlich, um den Form Data Integration-Dienst aufzurufen. |
<install directory>/sdk/client-libs/common |
adobe-generatepdf-client.jar |
Erforderlich, um den Generate PDF-Dienst aufzurufen. |
<install directory>/sdk/client-libs/common |
adobe-generate3dpdf-client.jar |
Erforderlich, um den Generate 3D PDF-Dienst aufzurufen. |
<install directory>/sdk/client-libs/common |
adobe-jobmanager-client-sdk.jar |
Erforderlich, um den Job Manager-Dienst aufzurufen. |
<install directory>/sdk/client-libs/common |
adobe-output-client.jar |
Erforderlich, um den Output-Dienst aufzurufen. |
<install directory>/sdk/client-libs/common |
adobe-pdfutility-client.jar |
Erforderlich, um den PDF Utilities- oder XMP Utilities-Dienst aufzurufen. |
<install directory>/sdk/client-libs/common |
adobe-reader-extensions-client.jar |
Erforderlich, um den Acrobat Reader DC Extensions-Dienst aufzurufen. |
<install directory>/sdk/client-libs/common |
adobe-repository-client.jar commons-codec-1.3.jar |
Erforderlich, um den Repository-Dienst aufzurufen. |
<install directory>/sdk/client-libs/common <install directory>/sdk/client-libs\thirdparty |
|
Erforderlich, um den Rights Management-Dienst aufzurufen. Wenn AEM Forms auf JBoss bereitgestellt wird, schließen Sie alle diese Dateien ein. |
<install directory>/sdk/client-libs/common JBoss-spezifisches lib-Verzeichnis |
adobe-signatures-client.jar |
Erforderlich, um den Signaturdienst aufzurufen. |
<install directory>/sdk/client-libs/common |
adobe-taskmanager-client-sdk.jar |
Erforderlich, um den Task Manager-Dienst aufzurufen. |
<install directory>/sdk/client-libs/common |
adobe-truststore-client.jar |
Erforderlich, um den Trust Store-Dienst aufzurufen. |
<install directory>/sdk/client-libs/common |
In der folgenden Tabelle sind die JAR-Dateien aufgeführt, die vom Verbindungsmodus und dem J2EE-Anwendungsserver abhängen, auf dem AEM Forms bereitgestellt wird.
File |
Beschreibung |
Ort |
---|---|---|
|
wenn AEM Forms im SOAP-Modus aufgerufen wird, schließen Sie diese JAR-Dateien ein. |
<install directory>/sdk/client-libs/thirdparty |
jboss-client.jar |
wenn AEM Forms auf JBoss-Anwendungsserver bereitgestellt wird, schließen Sie diese JAR-Datei ein. Erforderliche Klassen werden vom Classloader nicht gefunden, wenn sich jboss-client.jar und die referenzierten Jars nicht an derselben Stelle befinden. |
JBoss-Client-Lib-Verzeichnis Wenn Sie Ihre Clientanwendung auf demselben J2EE-Anwendungsserver bereitstellen, müssen Sie diese Datei nicht einschließen. |
wlclient.jar |
Wenn AEM Forms auf BEA WebLogic Server® bereitgestellt wird, fügen Sie diese JAR-Datei ein. |
WebLogic-spezifisches Bibliotheksverzeichnis Wenn Sie Ihre Clientanwendung auf demselben J2EE-Anwendungsserver bereitstellen, müssen Sie diese Datei nicht einschließen. |
|
|
WebSphere-spezifisches lib-Verzeichnis ([WAS_HOME]/runtimes) Wenn Sie Ihre Clientanwendung auf demselben J2EE-Anwendungsserver bereitstellen, müssen Sie diese Datei nicht einschließen. |
In der folgenden Tabelle werden die Aufrufszenarien angegeben und die zum erfolgreichen Aufrufen von AEM Forms erforderlichen JAR-Dateien aufgeführt.
Dienste |
Aufrufmodus |
J2EE-Anwendungsserver |
Erforderliche JAR-Dateien |
---|---|---|---|
Forms-Dienst |
EJB |
JBoss |
|
Forms-Dienst Acrobat Reader DC Extensions-Dienst Signature-Dienst |
EJB |
JBoss |
|
Forms-Dienst |
SOAP |
WebLogic |
|
Forms-Dienst Acrobat Reader DC Extensions-Dienst Signature-Dienst |
SOAP |
WebLogic |
|
Wenn Sie ein Upgrade von LiveCycle auf AEM Forms durchführen, wird empfohlen, dass Sie die AEM Forms-JAR-Dateien in den Klassenpfad Ihres Java-Projekts aufnehmen. Wenn Sie beispielsweise Dienste wie den Rights Management-Dienst verwenden, tritt ein Kompatibilitätsproblem auf, wenn Sie keine AEM Forms-JAR-Dateien in Ihren Klassenpfad aufnehmen.
Angenommen, dass Sie auf AEM Forms aktualisieren Um eine Java-Anwendung zu verwenden, die den Rights Management-Dienst aufruft, schließen Sie die AEM Forms-Versionen der folgenden JAR-Dateien ein:
Siehe auch
AEM Forms mit der JavaAPI aufrufen
Verbindungseigenschaften festlegen
Übergeben von Daten an AEM Forms-Dienste mithilfe der Java-API
Aufrufen eines Dienstes mithilfe einer Java-Client-Bibliothek
Sie legen Verbindungseigenschaften fest, um AEM Forms bei Verwendung der Java-API aufzurufen. Geben Sie beim Festlegen von Verbindungseigenschaften an, ob Dienste remote oder lokal aufgerufen werden sollen, sowie den Verbindungsmodus und die Authentifizierungswerte. Authentifizierungswerte sind erforderlich, wenn die Dienstsicherheit aktiviert ist. Wenn die Servicesicherheit jedoch deaktiviert ist, müssen keine Authentifizierungswerte angegeben werden.
Der Verbindungsmodus kann entweder der SOAP- oder der EJB-Modus sein. Der EJB-Modus verwendet das RMI/IIOP-Protokoll, und die Leistung des EJB-Modus ist besser als die des SOAP-Modus. Der SOAP-Modus wird verwendet, um die Abhängigkeit eines J2EE-Anwendungsservers zu beseitigen oder wenn sich eine Firewall zwischen AEM Forms und der Client-Anwendung befindet. Der SOAP-Modus verwendet das https-Protokoll als zugrunde liegenden Transport und kann über Firewall-Grenzen hinweg kommunizieren. Wenn weder eine Abhängigkeit des J2EE-Anwendungsservers noch eine Firewall ein Problem darstellt, wird empfohlen, den EJB-Modus zu verwenden.
Um einen AEM Forms-Dienst erfolgreich aufzurufen, legen Sie die folgenden Verbindungseigenschaften fest:
DSC_DEFAULT_EJB_ENDPOINT: Wenn Sie den EJB-Verbindungsmodus verwenden, stellt dieser Wert die URL des J2EE-Anwendungsservers dar, auf dem AEM Forms implementiert ist. Um AEM Forms aus der Ferne aufzurufen, geben Sie den Namen des J2EE-Anwendungsservers an, auf dem AEM Forms implementiert ist. Wenn sich Ihre Client-Anwendung auf demselben J2EE-Anwendungsserver befindet, können Sie localhost
angeben. Geben Sie abhängig davon, auf welchem J2EE-Anwendungsserver AEM Forms implementiert ist, einen der folgenden Werte an:
https://<ServerName>:8080 (default port)
iiop://<ServerName>:2809 (default port)
t3://<ServerName>:7001 (default port)
DSC_DEFAULT_SOAP_ENDPOINT: Wenn Sie den SOAP-Verbindungsmodus verwenden, stellt dieser Wert den Endpunkt dar, an den eine Aufrufanforderung gesendet wird. Um AEM Forms aus der Ferne aufzurufen, geben Sie den Namen des J2EE-Anwendungsservers an, auf dem AEM Forms implementiert ist. Wenn sich Ihre Client-Anwendung auf demselben J2EE-Anwendungsserver befindet, können Sie localhost
angeben (z. B. http://localhost:8080
.)
8080
gilt, wenn die J2EE-Anwendung JBoss ist. Wenn der J2EE-Anwendungsserver IBM WebSphere ist, verwenden Sie Port 9080
. Wenn der J2EE-Anwendungsserver WebLogic ist, verwenden Sie Port 7001
. (Diese Werte sind Standardportwerte. Wenn Sie den Portwert ändern, verwenden Sie die entsprechende Portnummer.)DSC_TRANSPORT_PROTOCOL: Wenn Sie den EJB-Verbindungsmodus verwenden, geben Sie ServiceClientFactoryProperties.DSC_EJB_PROTOCOL
für diesen Wert an. Wenn Sie den SOAP-Verbindungsmodus verwenden, geben Sie ServiceClientFactoryProperties.DSC_SOAP_PROTOCOL
an.
DSC_SERVER_TYPE: Der J2EE-Anwendungsserver, auf dem AEM Forms bereitgestellt wird. Gültige Werte sind JBoss
, WebSphere
, WebLogic
.
WebSphere
setzen, wird der Wert java.naming.factory.initial
auf com.ibm.ws.naming.util.WsnInitCtxFactory
gesetzt.WebLogic
setzen, wird der Wert java.naming.factory.initial
auf weblogic.jndi.WLInitialContextFactory
gesetzt.JBoss
setzen, wird der Wert java.naming.factory.initial
ebenfalls auf org.jnp.interfaces.NamingContextFactory
gesetzt.java.naming.factory.initial
auf einen Wert setzen, der Ihren Anforderungen entspricht, wenn Sie die Standardwerte nicht verwenden möchten.Anstatt eine Zeichenfolge zu verwenden, um die DSC_SERVER_TYPE
Verbindungseigenschaft zu setzen, können Sie ein statisches Mitglied der ServiceClientFactoryProperties
Klasse verwenden. Die folgenden Werte können verwendet werden: ServiceClientFactoryProperties.DSC_WEBSPHERE_SERVER_TYPE
, ServiceClientFactoryProperties.DSC_WEBLOGIC_SERVER_TYPE
, oder ServiceClientFactoryProperties.DSC_JBOSS_SERVER_TYPE
.
DSC_CREDENTIAL_USERNAME: Gibt den AEM Forms-Benutzernamen an. Damit ein Benutzer erfolgreich einen AEM Forms-Dienst aufrufen kann, benötigen Sie die Rolle „Dienstbenutzer“. Ein Benutzer kann auch eine andere Rolle haben, die die Berechtigung zum Service-Aufruf enthält. Andernfalls wird eine Ausnahme ausgelöst, wenn versucht wird, einen Dienst aufzurufen. Wenn die Servicesicherheit jedoch deaktiviert ist, müssen keine Authentifizierungswerte angegeben werden.
DSC_CREDENTIAL_PASSWORD: Gibt den entsprechenden Kennwortwert an. Wenn die Service-Sicherheit jedoch deaktiviert ist, müssen keine Authentifizierungswerte angegeben werden.
DSC_REQUEST_TIMEOUT: Das Standardlimit für Anforderungszeitlimits für die SOAP-Anforderung beträgt 1200000 Millisekunden (20 Minuten). Manchmal kann eine Anfrage länger dauern, um den Vorgang abzuschließen. Beispielsweise kann eine SOAP-Anforderung, die eine große Menge von Datensätzen abruft, ein längeres Zeitlimit erfordern. Mit ServiceClientFactoryProperties.DSC_REQUEST_TIMEOUT
können Sie das Zeitlimit für Anforderungsaufrufe für die SOAP-Anforderungen erhöhen.
Hinweis: Nur SOAP-basierte Aufrufe unterstützen die DSC_REQUEST_TIMEOUT Eigenschaft.
Führen Sie die folgenden Aufgaben aus, um Verbindungseigenschaften festzulegen:
Erstellen Sie ein Objekt java.util.Properties
, indem Sie den Konstruktor verwenden.
Um die DSC_DEFAULT_EJB_ENDPOINT
Verbindungseigenschaft einzustellen, rufen Sie die setProperty
Methode des java.util.Properties
Objekts auf und übergeben die folgenden Werte:
ServiceClientFactoryProperties.DSC_DEFAULT_EJB_ENDPOINT
-EnumerationswertWenn Sie den SOAP-Verbindungsmodus verwenden, geben Sie den Aufzählungswert ServiceClientFactoryProperties.DSC_DEFAULT_SOAP_ENDPOINT
anstelle des Aufzählungswerts ServiceClientFactoryProperties.DSC_DEFAULT_EJB_ENDPOINT
an.
Um die DSC_TRANSPORT_PROTOCOL
Verbindungseigenschaft zu setzen, rufen Sie die setProperty
Methode des java.util.Properties
Objekts auf und übergeben die folgenden Werte:
ServiceClientFactoryProperties.DSC_TRANSPORT_PROTOCOL
ServiceClientFactoryProperties.DSC_EJB_PROTOCOL
Wenn Sie den SOAP-Verbindungsmodus verwenden, geben Sie den Aufzählungswert ServiceClientFactoryProperties.DSC_SOAP_PROTOCOL
anstelle des Aufzählungswerts ServiceClientFactoryProperties.DSC_EJB_PROTOCOL
an.
Um die DSC_SERVER_TYPE
Verbindungseigenschaft zu setzen, rufen Sie die java.util.Properties
Methode des Objekts setProperty
auf und übergeben die folgenden Werte:
Der Aufzählungswert ServiceClientFactoryProperties.DSC_SERVER_TYPE
Ein string-Wert, der den J2EE-Anwendungsserver angibt, auf dem AEM Forms gehostet wird. (wenn beispielsweise AEM Forms auf implementiert wird, geben Sie JBoss
JBoss an.)
DSC_CREDENTIAL_USERNAME
Verbindungseigenschaft einzustellen, rufen Sie die java.util.Properties
Methode des Objekts setProperty
auf und übergeben die folgenden Werte:Der Aufzählungswert ServiceClientFactoryProperties.DSC_CREDENTIAL_USERNAME
Ein Zeichenfolgenwert, der den Benutzernamen angibt, der zum Aufrufen von AEM Forms erforderlich ist
DSC_CREDENTIAL_PASSWORD
Verbindungseigenschaft einzustellen, rufen Sie die java.util.Properties
Methode des Objekts setProperty
auf und übergeben die folgenden Werte:Der Aufzählungswert ServiceClientFactoryProperties.DSC_CREDENTIAL_PASSWORD
Ein Zeichenfolgenwert, der den entsprechenden Kennwortwert angibt.
Einstellen des EJB-Verbindungsmodus für JBoss
Im folgenden Java-Codebeispiel werden Verbindungseigenschaften festgelegt, um AEM Forms aufzurufen, die auf JBoss implementiert sind und den EJB-Verbindungsmodus verwenden.
Properties ConnectionProps = new Properties();
ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_DEFAULT_EJB_ENDPOINT, "https://<hostname>:8080");
ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_TRANSPORT_PROTOCOL,ServiceClientFactoryProperties.DSC_EJB_PROTOCOL);
ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_SERVER_TYPE, "JBoss");
ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_CREDENTIAL_USERNAME, "administrator");
ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_CREDENTIAL_PASSWORD, "password");
ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_DOCUMENT_HTTP_ENDPOINT,"https://<hostname>:8080");
EJB-Verbindungsmodus für WebLogic festlegen
Im folgenden Java-Codebeispiel werden Verbindungseigenschaften festgelegt, um AEM Forms aufzurufen, die auf WebLogic implementiert sind und den EJB-Verbindungsmodus verwenden.
Properties ConnectionProps = new Properties();
ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_DEFAULT_EJB_ENDPOINT, "t3://localhost:7001");
ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_TRANSPORT_PROTOCOL,ServiceClientFactoryProperties.DSC_EJB_PROTOCOL);
ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_SERVER_TYPE, "WebLogic");
ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_CREDENTIAL_USERNAME, "administrator");
ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_CREDENTIAL_PASSWORD, "password");
Einstellung des EJB-Anschlussmodus für WebSphere
Im folgenden Java-Codebeispiel werden Verbindungseigenschaften festgelegt, um AEM Forms aufzurufen, die auf WebSphere implementiert sind und den EJB-Verbindungsmodus verwenden.
Properties ConnectionProps = new Properties();
ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_DEFAULT_EJB_ENDPOINT, "iiop://localhost:2809");
ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_TRANSPORT_PROTOCOL,ServiceClientFactoryProperties.DSC_EJB_PROTOCOL);
ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_SERVER_TYPE, "WebSphere");
ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_CREDENTIAL_USERNAME, "administrator");
ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_CREDENTIAL_PASSWORD, "password");
SOAP-Verbindungsmodus festlegen
Im folgenden Java-Codebeispiel werden Verbindungseigenschaften im SOAP-Modus festgelegt, um AEM Forms aufzurufen, was auf JBoss bereitgestellt ist.
Properties ConnectionProps = new Properties();
ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_DEFAULT_SOAP_ENDPOINT, "http://localhost:8080");
ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_TRANSPORT_PROTOCOL,ServiceClientFactoryProperties.DSC_SOAP_PROTOCOL);
ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_SERVER_TYPE, "JBoss");
ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_CREDENTIAL_USERNAME, "administrator");
ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_CREDENTIAL_PASSWORD, "password");
Wenn Sie den SOAP-Verbindungsmodus auswählen, müssen Sie sicherstellen, dass zusätzliche JAR-Dateien in den Klassenpfad Ihrer Clientanwendung aufgenommen werden.
Festlegen der Verbindungseigenschaften bei deaktivierter Dienstsicherheit
Im folgenden Java-Codebeispiel werden die Verbindungseigenschaften festgelegt, die zum Aufrufen von AEM Forms, das auf dem JBoss-Anwendungsserver bereitgestellt wird, und bei deaktivierter Dienstsicherheit erforderlich sind.
Properties ConnectionProps = new Properties();
ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_DEFAULT_EJB_ENDPOINT, "jnp://localhost:1099");
ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_TRANSPORT_PROTOCOL,ServiceClientFactoryProperties.DSC_EJB_PROTOCOL);
ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_SERVER_TYPE, "JBoss");
Alle mit dem Programmieren mit AEM Forms verbundenen Java-Schnellstarts zeigen sowohl EJB- als auch SOAP-Verbindungseinstellungen.
SOAP-Verbindungsmodus mit benutzerdefiniertem Timeout-Limit für den Aufruf festlegen
Properties ConnectionProps = new Properties();
ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_DEFAULT_SOAP_ENDPOINT, "http://localhost:8080");
ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_TRANSPORT_PROTOCOL,ServiceClientFactoryProperties.DSC_SOAP_PROTOCOL);
ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_SERVER_TYPE, "JBoss");
ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_CREDENTIAL_USERNAME, "administrator");
ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_CREDENTIAL_PASSWORD, "password");
ConnectionProps.setProperty(ServiceClientFactoryProperties.DSC_REQUEST_TIMEOUT, "1800000"); // Request timeout limit 30 Minutes
Verwendung eines Kontextobjekts zum Aufrufen von AEM Forms
Sie können ein Objekt. com.adobe.idp.Context
verwenden, um einen AEM Forms-Dienst mit einem authentifizierten Benutzer aufzurufen (das Objekt com.adobe.idp.Context
steht für einen authentifizierten Benutzer). Wenn Sie ein com.adobe.idp.Context
-Objekt verwenden, müssen Sie die Eigenschaften DSC_CREDENTIAL_USERNAME
oder DSC_CREDENTIAL_PASSWORD
nicht einstellen. Sie können ein com.adobe.idp.Context
-Objekt bei der Benutzerauthentifizierung erhalten, indem Sie die authenticate
-Methode des AuthenticationManagerServiceClient
-Objekts verwenden.
Die authenticate
-Methode gibt ein Objekt AuthResult
zurück, das das Ergebnis der Authentifizierung enthält. Sie können ein com.adobe.idp.Context
-Objekt erstellen, indem Sie seinen Konstruktor aufrufen. Rufen Sie dann die Methode com.adobe.idp.Context
des Objekts initPrincipal
auf, und übergeben Sie das Objekt AuthResult
wie im folgenden Code gezeigt:
Context myCtx = new Context();
myCtx.initPrincipal(authResult);
Anstatt die DSC_CREDENTIAL_USERNAME
oder DSC_CREDENTIAL_PASSWORD
Eigenschaften zu setzen, können Sie die setContext
Methode des ServiceClientFactory
Objekts aufrufen und das com.adobe.idp.Context
Objekt übergeben. Wenn Sie einen AEM Forms-Benutzer verwenden, um einen Dienst aufzurufen, stellen Sie sicher, dass er über die Rolle Services User
verfügt, die zum Aufrufen eines AEM Forms-Dienstes erforderlich ist.
Das folgende Codebeispiel zeigt, wie ein com.adobe.idp.Context
-Objekt in Verbindungseinstellungen verwendet wird, die zum Erstellen eines EncryptionServiceClient
-Objekts verwendet werden.
//Authenticate a user and use the Context object within connection settings
// Authenticate the user
String username = "wblue";
String password = "password";
AuthResult authResult = authClient.authenticate(username, password.getBytes());
//Set a Content object that represents the authenticated user
//Use the Context object to invoke the Encryption service
Context myCtx = new Context();
myCtx.initPrincipal(authResult);
//Set connection settings
Properties connectionProps = new Properties();
connectionProps.setProperty(ServiceClientFactoryProperties.DSC_DEFAULT_EJB_ENDPOINT, "jnp://<server>:1099");
connectionProps.setProperty(ServiceClientFactoryProperties.DSC_TRANSPORT_PROTOCOL, ServiceClientFactoryProperties.DSC_EJB_PROTOCOL);
connectionProps.setProperty(ServiceClientFactoryProperties.DSC_SERVER_TYPE, ServiceClientFactoryProperties.DSC_JBOSS_SERVER_TYPE);
connectionProps.setProperty(ServiceClientFactoryProperties.DSC_DOCUMENT_HTTP_ENDPOINT,"jnp://<server>:1099");
//Create a ServiceClientFactory object
ServiceClientFactory myFactory = ServiceClientFactory.createInstance(connectionProps);
myFactory.setContext(myCtx);
//Create an EncryptionServiceClient object
EncryptionServiceClient encryptClient = new EncryptionServiceClient(myFactory);
Vollständige Informationen zum Authentifizieren eines Benutzers finden Sie unter Benutzer authentifizieren.
Die folgenden Aufrufszenarien werden in diesem Abschnitt behandelt:
Das folgende Diagramm zeigt eine Client-Anwendung, die in einer eigenen JVM ausgeführt wird und eine eigenständige AEM Forms-Instanz aufruft.
In diesem Szenario wird eine Client-Anwendung in einer eigenen JVM ausgeführt und ruft AEM Forms-Dienste auf.
Dieses Szenario ist das Aufrufszenario, auf dem alle Schnellstarts basieren.
Das folgende Diagramm zeigt eine Client-Anwendung, die in einer eigenen JVM ausgeführt wird und eine eigenständige AEM Forms-Instanz in einem Cluster aufruft.
Dieses Szenario ähnelt der Client-Anwendung, die eine eigenständige AEM Forms-Instanz aufruft. Die Provider-URL ist jedoch unterschiedlich. Wenn eine Client-Anwendung eine Verbindung zu einem bestimmten J2EE-Anwendungsserver herstellen möchte, muss die Anwendung die URL ändern, um auf den jeweiligen J2EE-Anwendungsserver zu verweisen.
Der Verweis auf einen bestimmten J2EE-Anwendungsserver wird nicht empfohlen, da die Verbindung zwischen der Client-Anwendung und AEM Forms beendet wird, wenn der Anwendungsserver beendet wird. Es wird empfohlen, dass die Provider-URL anstelle eines bestimmten J2EE-Anwendungsservers auf einen JNDI-Manager auf Zellenebene verweist.
Client-Anwendungen, die den SOAP-Verbindungsmodus verwenden, können den HTTP-Load-Balancer-Port für das Cluster verwenden. Client-Anwendungen, die den EJB-Verbindungsmodus verwenden, können eine Verbindung zum EJB-Port eines bestimmten J2EE-Anwendungsservers herstellen. Diese Aktion behandelt den Lastausgleich zwischen Clusterknoten.
WebSphere
Das folgende Beispiel zeigt den Inhalt einer Datei „jndi.properties“, die zum Herstellen einer Verbindung mit AEM Forms verwendet wird, das in WebSphere implementiert wird.
java.naming.factory.initial=com.ibm.websphere.naming.
WsnInitialContextFactory
java.naming.provider.url=corbaloc::appserver1:9810,:appserver2:9810
WebLogic
Das folgende Beispiel zeigt den Inhalt einer Datei „jndi.properties“, die zum Herstellen einer Verbindung mit AEM Forms verwendet wird, das in WebLogic implementiert wird.
java.naming.factory.initial=weblogic.jndi.WLInitialContextFactory
java.naming.provider.url=t3://appserver1:8001, appserver2:8001
JBoss
Das folgende Beispiel zeigt den Inhalt einer Datei „jndi.properties“, die zum Herstellen einer Verbindung mit AEM Forms verwendet wird, das in JBoss implementiert wird.
java.naming.factory.initial= org.jnp.interfaces.NamingContextFactory
java.naming.provider.url= jnp://appserver1:1099, appserver2:1099,
appserver3:1099
Wenden Sie sich an Ihren Administrator, um den Namen und die Portnummer des J2EE-Anwendungsservers zu ermitteln.
Siehe auch
Einbeziehung von AEM Forms Java-Bibliotheksdateien
Übergeben von Daten an AEM Forms-Dienste mithilfe der Java-API
Aufrufen eines Dienstes mithilfe einer Java-Client-Bibliothek
AEM Forms-Dienstvorgänge verwenden normalerweise PDF-Dokumente oder erzeugen diese. Wenn Sie einen Dienst aufrufen, ist es manchmal erforderlich, ein PDF-Dokument (oder andere Dokumenttypen wie XML-Daten) an den Dienst zu übergeben. Ebenso ist es manchmal notwendig, ein vom Dienst zurückgegebenes PDF-Dokument zu verwenden. Die Java-Klasse, mit der Sie Daten an und von AEM Forms-Diensten übertragen können, ist com.adobe.idp.Document
.
AEM Forms-Dienste akzeptieren ein PDF-Dokument nicht als andere Datentypen, wie z. B. ein Objekt java.io.InputStream
oder ein Byte-Array. Ein com.adobe.idp.Document
-Objekt kann auch verwendet werden, um andere Datentypen, z. B. XML-Daten, an Dienste zu übergeben.
Das Objekt com.adobe.idp.Document
ist ein serialisierbarer Java-Typ, sodass es über einen RMI-Aufruf übergeben werden kann. Die Empfangsseite kann zusammengestellt werden (gleicher Host, gleiches Klassenladeprogramm), lokal (gleicher Host, anderes Klassenladeprogramm) oder Remote (anderer Host). Die Weitergabe von Dokumenteninhalten wird für jeden Fall optimiert. Befinden sich Sender und Empfänger beispielsweise auf demselben Host, wird der Inhalt über ein lokales Dateisystem übergeben. (In einigen Fällen können Dokumente im Speicher übergeben werden.)
Abhängig von der Objektgröße com.adobe.idp.Document
, werden die Daten innerhalb des Objekts com.adobe.idp.Document
befördert oder im Dateisystem des Servers gespeichert. Alle temporären Speicherressourcen, die vom Objekt com.adobe.idp.Document
belegt sind, werden nach der Entsorgung von com.adobe.idp.Document
automatisch entfernt. (Siehe Dokumentobjekte entsorgen.)
Manchmal ist es erforderlich, den Inhaltstyp eines com.adobe.idp.Document
-Objekts zu kennen, bevor Sie es an einen Dienst übergeben können. Wenn für einen Vorgang beispielsweise ein bestimmter Inhaltstyp erforderlich ist, z. B. application/pdf
, wird empfohlen, den Inhaltstyp zu bestimmen. (Siehe Festlegen des Inhaltstyps eines Dokuments.)
Das Objekt com.adobe.idp.Document
versucht, den Inhaltstyp anhand der bereitgestellten Daten zu ermitteln. Wenn der Inhaltstyp nicht aus den bereitgestellten Daten abgerufen werden kann (z. B. wenn die Daten als Byte-Array bereitgestellt wurden), legen Sie den Inhaltstyp fest. Um den Inhaltstyp festzulegen, rufen Sie die Methode com.adobe.idp.Document
des Objekts setContentType
auf. (Siehe Festlegen des Inhaltstyps eines Dokuments)
Wenn Begleitdateien sich im selben Dateisystem befinden, ist das Erstellen eines com.adobe.idp.Document
schneller. Wenn sich Begleitdateien auf Remote-Dateisystemen befinden, muss ein Kopiervorgang ausgeführt werden, der die Leistung beeinträchtigt.
Eine Anwendung kann sowohl com.adobe.idp.Document
als auch org.w3c.dom.Document
Datentypen enthalten. Stellen Sie jedoch sicher, dass Sie den Datentyp org.w3c.dom.Document
vollständig qualifizieren. Informationen zum Konvertieren eines org.w3c.dom.Document
-Objekts in ein com.adobe.idp.Document
-Objekt finden Sie unter Schnellstart (EJB-Modus): Formulare mit flexiblen Layouts mithilfe der Java-API vorbefüllen.
Um einen Speicherverlust in WebLogic bei der Verwendung eines com.adobe.idp.Document
-Objekts zu vermeiden, lesen Sie die Dokumentinformationen in Schritten von 2048 Byte oder weniger. Mit dem folgenden Code werden beispielsweise die Dokumentinformationen in 2048-Byte-Blöcken gelesen:
// Set up the chunk size to prevent a potential memory leak
int buffSize = 2048;
// Determine the total number of bytes to read
int docLength = (int) inDoc.length();
byte [] byteDoc = new byte[docLength];
// Set up the reading position
int pos = 0;
// Loop through the document information, 2048 bytes at a time
while (docLength > 0) {
// Read the next chunk of information
int toRead = Math.min(buffSize, docLength);
int bytesRead = inDoc.read(pos, byteDoc, pos, toRead);
// Handle the exception in case data retrieval failed
if (bytesRead == -1) {
inDoc.doneReading();
inDoc.dispose();
throw new RuntimeException("Data retrieval failed!");
}
// Update the reading position and number of bytes remaining
pos += bytesRead;
docLength -= bytesRead;
}
// The document information has been successfully read
inDoc.doneReading();
inDoc.dispose();
Siehe auch
AEM Forms mit der JavaAPI aufrufen
Verbindungseigenschaften festlegen
Erstellen Sie ein com.adobe.idp.Document
-Objekt, bevor Sie einen Dienstvorgang aufrufen, für den ein PDF-Dokument (oder andere Dokumenttypen) als Eingabewert erforderlich sind. Die Klasse com.adobe.idp.Document
stellt Konstruktoren bereit, mit denen Sie ein Dokument aus den folgenden Inhaltstypen erstellen können:
com.adobe.idp.Document
-Objektjava.io.File
-Objektjava.io.InputStream
-Objektjava.net.URL
-ObjektIm folgenden Codebeispiel wird ein com.adobe.idp.Document
-Objekt erstellt, das auf einem Byte-Array basiert.
Erstellen eines Dokumentobjekts basierend auf einem Byte-Array
Document myPDFDocument = new Document(myByteArray);
Im folgenden Codebeispiel wird ein com.adobe.idp.Document
-Objekt erstellt, das auf einem anderen com.adobe.idp.Document
-Objekt basiert.
Erstellen eines Dokumentobjekts basierend auf einem anderen Dokument
//Create a Document object based on a byte array
InputStream is = new FileInputStream("C:\\Map.pdf");
int len = is.available();
byte [] myByteArray = new byte[len];
int i = 0;
while (i < len) {
i += is.read(myByteArray, i, len);
}
Document myPDFDocument = new Document(myByteArray);
//Create another Document object
Document anotherDocument = new Document(myPDFDocument);
Im folgenden Codebeispiel wird ein com.adobe.idp.Document
-Objekt erstellt, das auf eine PDF-Datei map.pdf basiert. Diese Datei befindet sich im Stammverzeichnis der C-Festplatte. Dieser Konstruktor versucht, den MIME-Inhaltstyp des com.adobe.idp.Document
-Objekts mithilfe der Dateinamenerweiterung festzulegen.
Der com.adobe.idp.Document
Konstruktor, der ein java.io.File
-Objekt akzeptiert, akzeptiert auch einen Booleschen Parameter. Wenn Sie diese Parameter auf true
setzen, löscht das com.adobe.idp.Document
-Objekt die Datei. Diese Aktion bedeutet, dass Sie die Datei nicht entfernen müssen, nachdem Sie sie an den com.adobe.idp.Document
-Konstruktor übergeben haben.
Wenn Sie diesen Parameter auf false
setzen, behalten Sie den Besitz dieser Datei bei. Das Einstellen dieses Parameters auf true
ist effizienter. Der Grund ist, dass das com.adobe.idp.Document
-Objekt die Datei direkt in den lokalen verwalteten Bereich verschieben kann, anstatt sie zu kopieren (was langsamer ist).
Erstellen eines Dokumentobjekts basierend auf einer PDF-Datei
//Create a Document object based on the map.pdf source file
File mySourceMap = new File("C:\\map.pdf");
Document myPDFDocument = new Document(mySourceMap,true);
Im folgenden Codebeispiel wird ein com.adobe.idp.Document
-Objekt erstellt, das auf einemjava.io.InputStream
-Objekt basiert.
Erstellen eines Dokuments basierend auf einem InputStream-Objekt
//Create a Document object based on an InputStream object
InputStream is = new FileInputStream("C:\\Map.pdf");
Document myPDFDocument = new Document(is);
Im folgenden Codebeispiel wird ein com.adobe.idp.Document
-Objekt erstellt, das auf einer PDF-Datei map.pdf basiert. Diese Datei befindet sich in einer Web-Anwendung namens WebApp
, die auf localhost
läuft. Dieser Konstruktor versucht, den MIME-Inhaltstyp des com.adobe.idp.Document
-Objekts mithilfe des mit dem URL-Protokoll zurückgegebenen Inhaltstyps festzulegen.
Die URL des com.adobe.idp.Document
-Objekts wird immer an der Seite gelesen, an der das ursprüngliche com.adobe.idp.Document
-Objekt erstellt wird, wie in diesem Beispiel gezeigt:
Document doc = new Document(new java.net.URL("file:c:/temp/input.pdf"));
Die Datei c:/temp/input.pdf muss sich auf dem Client-Computer (nicht auf dem Servercomputer) befinden. Auf dem Client-Computer wird die URL gelesen und das com.adobe.idp.Document
-Objekt wurde erstellt.
Erstellen eines Dokuments basierend auf Inhalt, auf den über eine URL zugegriffen werden kann
//Create a Document object based on a java.net.URL object
URL myURL = new URL("http", "localhost", 8080,"/WebApp/map.pdf");
//Create another Document object
Document myPDFDocument = new Document(myURL);
Siehe auch
AEM Forms mit der JavaAPI aufrufen
Verbindungseigenschaften festlegen
Dienstvorgänge, die ein PDF-Dokument (oder andere Datentypen wie XML-Daten) als Ausgabewert zurückgeben, geben ein com.adobe.idp.Document
-Objekt zurück. Nachdem Sie ein com.adobe.idp.Document
-Objekt erhalten haben, können Sie es in die folgenden Formate konvertieren:
java.io.File
-Objektjava.io.InputStream
-ObjektDie folgende Codezeile konvertiert ein com.adobe.idp.Document
-Objekt in ein java.io.InputStream
-Objekt. Angenommen, dass myPDFDocument
ein com.adobe.idp.Document
-Objekt darstellt:
java.io.InputStream resultStream = myDocument.getInputStream();
Ebenso können Sie den Inhalt eines com.adobe.idp.Document
in eine lokale Datei kopieren, indem Sie die folgenden Aufgaben ausführen:
java.io.File
-Objekt.copyToFile
des Objekts com.adobe.idp.Document
auf, und übergeben Sie das java.io.File
-Objekt.Das folgende Codebeispiel kopiert den Inhalt eines com.adobe.idp.Document
-Objekts in eine Datei namens AnotherMap.pdf.
Kopieren des Inhalts eines Dokumentobjekts in eine Datei
File outFile = new File("C:\\AnotherMap.pdf");
myDocument.copyToFile (outFile);
Siehe auch
AEM Forms mit der JavaAPI aufrufen
Verbindungseigenschaften festlegen
Bestimmen Sie den MIME-Typ eines com.adobe.idp.Document
-Objekts, indem Sie die Methode getContentType
des Objekts com.adobe.idp.Document
aufrufen. Diese Methode gibt einen Zeichenfolgenwert zurück, der den Inhaltstyp des Objekts com.adobe.idp.Document
angibt. In der folgenden Tabelle werden die verschiedenen Inhaltstypen beschrieben, die AEM Forms zurückgibt.
MIME-Typ |
Beschreibung |
---|---|
|
PDF-Dokument |
|
XML Data Packaging (XDP), das für exportierte XFA-Formulare (XML Forms Architecture) verwendet wird |
|
Lesezeichen, Anhänge oder andere XML-Dokumente |
|
Forms Data Format (FDF), das für exportierte Acrobat-Formulare verwendet wird |
|
Forms Data Format (XFDF), das für exportierte Acrobat-Formulare verwendet wird |
|
Aussagekräftiges Datenformat und XML |
|
Generisches Datenformat |
|
Nicht angegebener MIME-Typ |
Das folgende Codebeispiel bestimmt den Inhaltstyp eines com.adobe.idp.Document
-Objekts.
Festlegen des Inhaltstyps eines Dokumentobjekts
//Determine the content type of the Document object
String ct = myDocument.getContentType();
System.out.println("The content type of the Document object is " +ct);
Siehe auch
AEM Forms mit der JavaAPI aufrufen
Verbindungseigenschaften festlegen
Wenn Sie ein Document
-Objekt nicht mehr benötigen, wird empfohlen, dass Sie es durch Aufrufen der dispose
-Methode entsorgen. Jedes Document
-Objekt benötigt einen Dateideskriptor und bis zu 75 MB RAM-Speicherplatz auf der Hostplattform Ihrer Anwendung. Wenn ein Document
-Objekt nicht bereitgestellt wird, wird es vom Java Garage-Erfassungsprozess bereitgestellt. Durch eine frühere Entsorgung mit der dispose
-Methode können Sie jedoch den Speicherplatz freigeben, der vom Document
-Objekt belegt wird.
Siehe auch
AEM Forms mit der JavaAPI aufrufen
Einbeziehung von AEM Forms Java-Bibliotheksdateien
Aufrufen eines Dienstes mithilfe einer Java-Client-Bibliothek
AEM Forms-Dienstvorgänge können mithilfe der stark typisierten API eines Diensts aufgerufen werden, die als Java-Clientbibliothek bezeichnet wird. Eine Java-Client-Bibliothek ist eine Reihe konkreter Klassen, die den Zugriff auf Dienste ermöglichen, die im Dienstcontainer bereitgestellt werden. Sie instanziieren ein Java-Objekt, das den Dienst zum Aufrufen darstellt, anstelle dass ein InvocationRequest
-Objekt durch die Verwendung der Aufruf-API erstellt wird. Die Aufruf-API wird zum Aufrufen von Prozessen wie langlebigen Prozessen verwendet, die in Workbench erstellt wurden. (Siehe An Menschen orientierte langlebige Prozesse aufrufen.)
Rufen Sie zum Ausführen eines Dienstvorgangs eine Methode auf, die zu dem Java-Objekt gehört. Eine Java-Client-Bibliothek enthält Methoden, die in der Regel Eins-zu-Eins-Serviceoperationen zuordnen. Legen Sie bei Verwendung einer Java-Client-Bibliothek die erforderlichen Verbindungseigenschaften fest. (Siehe Festlegen von Verbindungseigenschaften.)
Nachdem Sie die Verbindungseigenschaften festgelegt haben, erstellen Sie ein ServiceClientFactory
-Objekt, mit dem ein Java-Objekt instanziiert wird, mit dem Sie einen Service aufrufen können. Jeder Dienst, der über eine Java-Client-Bibliothek verfügt, verfügt über ein entsprechendes Client-Objekt. Um zum Beispiel den Repository-Dienst aufzurufen, erstellen Sie ein ResourceRepositoryClient
-Objekt, indem Sie seinen Konstruktor verwenden und das ServiceClientFactory
-Objekt übergeben. Das ServiceClientFactory
-Objekt ist für die Verwaltung der Verbindungseinstellungen verantwortlich, die zum Aufrufen von AEM Forms-Diensten erforderlich sind.
Obwohl das Beziehen eines ServiceClientFactory
normalerweise schnell ist, ist ein gewisser Aufwand erforderlich, wenn die Factory zum ersten Mal verwendet wird. Dieses Objekt ist für die Wiederverwendung optimiert. Wenn Sie mehrere Java-Client-Objekte erstellen, verwenden Sie dasselbe ServiceClientFactory
-Objekt. Das heißt, erstellen Sie kein separates ServiceClientFactory
-Objekt für jedes Client-Bibliothekobjekt, das Sie erstellen.
Es gibt eine Benutzer-Manager-Einstellung, die die Lebensdauer der SAML-Assertion steuert, die innerhalb des com.adobe.idp.Context
-Objekt ist, das das ServiceClientFactory
-Objekt beeinflusst. Diese Einstellung steuert die Gültigkeitsdauer des Authentifizierungskontexts in AEM Forms, einschließlich aller Aufrufe, die mit der Java-API ausgeführt werden. Standardmäßig beträgt der Zeitraum, in dem ein ServiceCleintFactory
-Objekt verwendet werden kann, zwei Stunden.
Um zu erläutern, wie ein Dienst mithilfe der Java-API aufgerufen wird, wird der Vorgang writeResource
aufgerufen. Durch diesen Vorgang wird eine neue Ressource in das Repository eingefügt.
Sie können den Repository-Dienst mithilfe einer Java-Clientbibliothek aufrufen und die folgenden Schritte ausführen:
Fügen Sie Client-JAR-Dateien wie „adobe-repository-client.jar“ in den Klassenpfad Ihres Java-Projekts ein. Weitere Informationen über den Speicherort dieser Dateien finden Sie unter Einbeziehen von AEM Forms Java-Bibliotheksdateien.
Legen Sie die Verbindungseigenschaften fest, die zum Aufrufen eines Dienstes erforderlich sind.
Erstellen Sie ein ServiceClientFactory
-Objekt, indem Sie die statische createInstance
-Methode des ServiceClientFactory
-Objekts aufrufen und das java.util.Properties
-Objekt übergeben, das die Verbindungseigenschaften enthält.
Erstellen Sie ein ResourceRepositoryClient
-Objekt, indem Sie seinen Konstruktor verwenden und das ServiceClientFactory
-Objekt übergeben. Verwenden Sie das ResourceRepositoryClient
-Objekt, um Repository-Dienstvorgänge aufzurufen.
Erstellen Sie ein RepositoryInfomodelFactoryBean
-Objekt, indem Sie seinen Konstruktor verwenden, und übergeben Sie null
. Mit diesem Objekt können Sie ein Resource
-Objekt erstellen, das den Inhalt darstellt, der dem Repository hinzugefügt wird.
Erstellen Sie ein Resource
Objekt, indem Sie die newImage
Methode des RepositoryInfomodelFactoryBean
Objekts aufrufen und die folgenden Werte übergeben:
new Id()
.new Lid()
.Wandeln Sie den Rückgabewert in Resource
um.
Erstellen Sie ein ResourceContent
-Objekt, indem Sie die newImage
-Methode des RepositoryInfomodelFactoryBean
-Objekts aufrufen und den Rückgabewert auf ResourceContent
zurückführen. Dieses Objekt stellt den Inhalt dar, der dem Repository hinzugefügt wird.
Erstellen Sie ein com.adobe.idp.Document
-Objekt indem Sie ein java.io.FileInputStream
Objekt übergeben, das die XDP-Datei speichert, die dem Repository hinzugefügt werden soll. (Siehe Erstellen eines Dokuments basierend auf einem InputStream-Objekt.)
Fügen Sie den Inhalt des com.adobe.idp.Document
-Objekts dem ResourceContent
-Objekt hinzu, indem Sie die setDataDocument
-Methode des ResourceContent
-Objekts aufrufen. Übergeben Sie das com.adobe.idp.Document
-Objekt.
Legen Sie den MIME-Typ der XDP-Datei fest, die dem Repository hinzugefügt werden soll, indem Sie die ResourceContent
-Methode des Objekts setMimeType
aufrufen und application/vnd.adobe.xdp+xml
übergeben.
Fügen Sie den Inhalt des ResourceContent
-Objekts dem Resource
-Objekt hinzu, indem Sie die setContent
-Methode des Resource
-Objekts aufrufen und das ResourceContent
-Objekt übergeben.
Fügen Sie eine Beschreibung der Ressource hinzu, indem Sie die Methode Resource
des Objekts setDescription
aufrufen und einen string-Wert übergeben, der eine Beschreibung der Ressource darstellt.
Fügen Sie den Formularentwurf in das Repository, indem Sie die Methode ResourceRepositoryClient
des Objekts writeResource
aufrufen und die folgenden Werte übergeben:
Resource
-ObjektSiehe auch
Schnellstart (EJB-Modus): Schreiben einer Ressource mithilfe der Java-API
AEM Forms mit der JavaAPI aufrufen
Einbeziehung von AEM Forms Java-Bibliotheksdateien
Sie können einen kurzlebigen Prozess mithilfe der Java Aufruf-API aufrufen. Wenn Sie einen kurzlebigen Prozess mit der Aufruf-API aufrufen, übergeben Sie die erforderlichen Parameterwerte mithilfe eines java.util.HashMap
-Objekts. Für jeden Parameter, der an einen Dienst übergeben werden soll, rufen Sie die Methode java.util.HashMap
des Objekts put
auf und geben Sie das Namen-Wertpaar an, das durch den Dienst erforderlich ist, um den angegebenen Vorgang durchzuführen. Geben Sie den genauen Namen der Parameter an, die zu dem kurzlebigen Prozess gehören.
Informationen zum Aufrufen eines langlebigen Prozesses finden Sie unter An Menschen orientierte langlebige Prozesse aufrufen.
In der folgenden Diskussion geht es um die Verwendung der Aufruf-API, um den folgenden kurzlebigen AEM Forms-Prozess namens MyApplication/EncryptDocument
aufzurufen.
Dieser Prozess basiert nicht auf einem vorhandenen AEM Forms-Prozess. Um dem Codebeispiel zu folgen, erstellen Sie einen Prozess mit dem Namen MyApplication/EncryptDocument
in Workbench. (Siehe Verwenden von Workbench.)
Wenn dieser Prozess aufgerufen wird, führt er die folgenden Aktionen aus:
SetValue
. Der Eingangsparameter für diesen Prozess ist eine document
-Prozessvariable mit dem Namen inDoc
.PasswordEncryptPDF
. Das kennwortverschlüsselte PDF-Dokument wird in einer Prozessvariablen namens outDoc
zurückgegeben.Rufen Sie den kurzlebigen Prozess MyApplication/EncryptDocument
mithilfe der Java-Aufruf-API auf:
Fügen Sie Client-JAR-Dateien wie „adobe-livecycle-client.jar“ in den Klassenpfad Ihres Java-Projekts ein. (Siehe Einbeziehen von AEM Forms Java-Bibliotheksdateien.)
Erstellen Sie ein ServiceClientFactory
-Objekt, das Verbindungseigenschaften enthält. (Siehe Einstellung von Verbindungseigenschaften.)
Erstellen Sie ein ServiceClient
-Objekt, indem Sie seinen Konstruktor verwenden und das ServiceClientFactory
-Objekt übergeben. Mit einem ServiceClient
-Objekt können Sie einen Dienstvorgang aufrufen. Es erledigt Aufgaben wie das Auffinden, Versenden und Weiterleiten von Aufrufanforderungen.
Erstellen Sie ein Objekt java.util.HashMap
, indem Sie den Konstruktor verwenden.
Rufen Sie die Methode java.util.HashMap
des put
-Objekts für jeden Eingabeparameter auf, der an den langlebigen Prozess übergeben erden soll. Da der kurzlebige Prozess MyApplication/EncryptDocument
einen Eingabeparameter des Typs Document
erfordert, müssen Sie nur die put
-Methode einmal aufrufen, wie im folgenden Beispiel gezeigt.
//Create a Map object to store the parameter value for inDoc
Map params = new HashMap();
InputStream inFile = new FileInputStream("C:\\Adobe\Loan.pdf");
Document inDoc = new Document(inFile);
params.put("inDoc", inDoc);
Erstellen Sie ein InvocationRequest
-Objekt, indem Sie die Methode createInvocationRequest
des ServiceClientFactory
-Objekts aufrufen und die folgenden Werte übergeben:
MyApplication/EncryptDocument
an, um den MyApplication/EncryptDocument
-Prozess aufzurufen.invoke
.java.util.HashMap
-Objekt, das die Parameterwerte enthält, die für den Dienstvorgang erforderlich sind.true
angibt, wodurch eine synchrone Anforderung erstellt wird (dieser Wert kann für den Aufruf eines kurzlebigen Prozesses verwendet werden).Senden Sie die Aufrufanforderung an den Dienst, indem Sie die Methode ServiceClient
des Objekts invoke
aufrufen und das InvocationRequest
-Objekt übergeben. Die Methode invoke
gibt ein InvocationReponse
-Objekt zurück.
Ein langlebiger Prozess kann aufgerufen werden, indem der Wert false
als vierter Parameter der createInvocationRequest
-Methode übergeben wird. Wenn Sie den Wert false
übergeben, wird eine asynchrone Anforderung erstellt.
Rufen Sie den der Rückgabewert des Verfahrens ab, indem Sie die Methode InvocationReponse
des Objekts getOutputParameter
aufrufen und übergeben Sie einen string-Wert, der den Namen des Ausgangsparameters angibt. Geben Sie in dieser Situation outDoc
an (outDoc
ist der Name des Ausgabeparameters für den Prozess MyApplication/EncryptDocument
). Wandeln Sie den Rückgabewert in Document
um, wie im folgenden Beispiel gezeigt.
InvocationResponse response = myServiceClient.invoke(request);
Document encryptDoc = (Document) response.getOutputParameter("outDoc");
Erstellen Sie ein java.io.File
-Objekt und stellen Sie sicher, dass die Dateierweiterung .pdf ist.
Rufen Sie die Methode copyToFile
des com.adobe.idp.Document
-Objekts auf, um den Inhalt des com.adobe.idp.Document
-Objekts in die Datei zu kopieren. Stellen Sie sicher, dass Sie das com.adobe.idp.Document
-Objekt verwenden, das von der getOutputParameter
-Methode zurückgegeben wurde.
Siehe auch
Schnellstart: Hervorrufen eines kurzlebigen Prozesses mit der Aufruf-API
An Menschen orientierte langlebige Prozesse aufrufen
Einbeziehung von AEM Forms Java-Bibliotheksdateien