AEM Forms aanroepen met de Java API invoking-aem-forms-using-the-javaapi

de Steekproeven en de voorbeelden in dit document zijn slechts voor AEM Forms op milieu JEE.

AEM Forms kan worden aangeroepen met de AEM Forms Java API. Wanneer u de AEM Forms Java API gebruikt, kunt u de Invocation API- of Java-clientbibliotheken gebruiken. Java-clientbibliotheken zijn beschikbaar voor services zoals de service Rights Management. Met deze sterk getypeerde API's kunt u Java-toepassingen ontwikkelen die AEM Forms aanroepen.

De oproepings-API zijn klassen die zich in het com.adobe.idp.dsc -pakket bevinden. Met deze klassen kunt u een aanroepingsverzoek rechtstreeks naar een service verzenden en een geretourneerde aanroepingsreactie afhandelen. Gebruik de oproepings-API om kortstondige of langlevende processen aan te roepen die met Workbench zijn gemaakt.

De geadviseerde manier om een dienst programmatically aan te halen is een de cliëntbibliotheek van Java te gebruiken die aan de dienst in tegenstelling tot de Inroeping API beantwoordt. Als u bijvoorbeeld de coderingsservice wilt aanroepen, gebruikt u de clientbibliotheek van de coderingsservice. Om een de dienstverrichting van de Encryptie uit te voeren, haal een methode aan die tot het de dienstcliëntvoorwerp van de Encryptie behoort. U kunt een PDF-document versleutelen met een wachtwoord door de methode encryptPDFUsingPassword van het object EncryptionServiceClient aan te roepen.

De Java API ondersteunt de volgende functies:

Inclusief AEM Forms Java-bibliotheekbestanden

Het aanhalen van mens-Centric langlevende Processen

AEM Forms aanroepen met webservices

Verbindingseigenschappen instellen

Gegevens doorgeven aan AEM Forms-services met de Java API

Een service aanroepen met een Java-clientbibliotheek

Een kortstondig proces aanroepen met de API voor aanroepen

Een Java-webtoepassing maken die een menselijk-centrisch proces van lange duur oproept

Inclusief AEM Forms Java-bibliotheekbestanden including-aem-forms-java-library-files

Als u een AEM Forms-service programmatisch wilt aanroepen met de Java API, neemt u de vereiste bibliotheekbestanden (JAR-bestanden) op in het klassepad van uw Java-project. De JAR-bestanden die u in het klassepad van uw clienttoepassing opneemt, zijn afhankelijk van verschillende factoren:

Servicespecifieke JAR-bestanden service-specific-jar-files

In de volgende tabel worden de JAR-bestanden weergegeven die nodig zijn om AEM Forms-services aan te roepen.

Verbindingsmodus en JAR-bestanden voor J2EE-toepassing connection-mode-and-j2ee-application-jar-files

In de volgende tabel worden de JAR-bestanden weergegeven die afhankelijk zijn van de verbindingsmodus en de J2EE-toepassingsserver waarop AEM Forms wordt geïmplementeerd.

Oproepen van scenario's invoking-scenarios

In de volgende tabel worden de aanroepingsscenario's aangegeven en worden de JAR-bestanden weergegeven die AEM Forms moeten aanroepen.

JAR-bestanden bijwerken upgrading-jar-files

Als u een upgrade uitvoert van LiveCycle naar AEM Forms, wordt u aangeraden de AEM Forms JAR-bestanden op te nemen in het klassenpad van uw Java-project. Als u bijvoorbeeld services zoals de service Rights Management gebruikt, treedt er een compatibiliteitsprobleem op als u geen AEM Forms JAR-bestanden opneemt in het klassenpad.

Ervan uitgaande dat u een upgrade uitvoert naar AEM Forms. Als u een Java-toepassing wilt gebruiken die de service Rights Management aanroept, neemt u de AEM Forms-versies van de volgende JAR-bestanden op:

zie ook

AEM Forms aanroepen met de Java API

Verbindingseigenschappen instellen

Gegevens doorgeven aan AEM Forms-services met de Java API

Een service aanroepen met een Java-clientbibliotheek

Verbindingseigenschappen instellen setting-connection-properties

U stelt verbindingseigenschappen in om AEM Forms aan te roepen wanneer u de Java API gebruikt. Geef bij het instellen van eigenschappen voor verbindingen op of services extern of lokaal moeten worden aangeroepen en geef ook de verbindingsmodus en verificatiewaarden op. De waarden van de authentificatie worden vereist als de dienstveiligheid wordt toegelaten. Nochtans, als de dienstveiligheid gehandicapt is, is het niet noodzakelijk om authentificatiewaarden te specificeren.

De verbindingsmodus kan SOAP of EJB zijn. De modus EJB maakt gebruik van het RMI/IIOP-protocol en de prestaties van de modus EJB zijn beter dan die van de SOAP. De SOAP modus wordt gebruikt om een J2EE-toepassingsserverafhankelijkheid te elimineren of wanneer een firewall zich tussen AEM Forms en de clienttoepassing bevindt. De SOAP wijze gebruikt het HTTPS protocol als onderliggend vervoer en kan over firewallgrenzen communiceren. Als noch een J2EE-toepassingsserverafhankelijkheid, noch een firewall een probleem is, wordt u aangeraden de EJB-modus te gebruiken.

Als u een AEM Forms-service wilt aanroepen, stelt u de volgende verbindingseigenschappen in:

Voer de volgende taken uit om verbindingseigenschappen in te stellen:

plaatsend de EJB verbindingswijze voor JBoss

In het volgende Java-codevoorbeeld worden eigenschappen voor verbindingen ingesteld om AEM Forms aan te roepen dat wordt geïmplementeerd op JBoss en met de EJB-verbindingsmodus.

 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");

plaatsend de EJB verbindingswijze voor WebLogic

In het volgende Java-codevoorbeeld worden eigenschappen voor verbindingen ingesteld om AEM Forms aan te roepen dat wordt geïmplementeerd op WebLogic en met de EJB-verbindingsmodus.

 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");

plaatsend de EJB verbindingswijze voor WebSphere

In het volgende Java-codevoorbeeld worden eigenschappen van een verbinding ingesteld om AEM Forms aan te roepen dat wordt geïmplementeerd op WebSphere en met de EJB-verbindingsmodus.

 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");

plaatsend de SOAP verbindingswijze

In het volgende Java-codevoorbeeld worden eigenschappen van een verbinding in SOAP modus ingesteld om AEM Forms aan te roepen dat wordt geïmplementeerd op JBoss.

 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");

plaatsende verbindingseigenschappen wanneer de dienstveiligheid gehandicapt is

In het volgende Java-codevoorbeeld worden verbindingseigenschappen ingesteld die vereist zijn om AEM Forms aan te roepen dat wordt geïmplementeerd op JBoss Application Server en wanneer de servicebeveiliging is uitgeschakeld.

 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");

plaatsend de SOAP verbindingswijze met de grens van de douaneverzoekonderbreking

 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

Gebruikend een voorwerp van de Context om AEM Forms aan te halen

U kunt een com.adobe.idp.Context -object gebruiken om een AEM Forms-service met een geverifieerde gebruiker aan te roepen (het com.adobe.idp.Context -object vertegenwoordigt een geverifieerde gebruiker). Wanneer u een com.adobe.idp.Context -object gebruikt, hoeft u de eigenschappen DSC_CREDENTIAL_USERNAME of DSC_CREDENTIAL_PASSWORD niet in te stellen. U kunt een com.adobe.idp.Context -object verkrijgen wanneer u gebruikers ontwerpt met de methode AuthenticationManagerServiceClient object authenticate .

De methode authenticate retourneert een AuthResult -object dat de resultaten van de verificatie bevat. U kunt een com.adobe.idp.Context -object maken door de constructor ervan aan te roepen. Roep vervolgens de methode initPrincipal van het object com.adobe.idp.Context aan en geef het object AuthResult door, zoals in de volgende code wordt getoond:

 Context myCtx = new Context();
 myCtx.initPrincipal(authResult);

In plaats van de eigenschappen DSC_CREDENTIAL_USERNAME of DSC_CREDENTIAL_PASSWORD in te stellen, kunt u de methode ServiceClientFactory van het object setContext aanroepen en het object com.adobe.idp.Context doorgeven. Wanneer u een gebruiker van een AEM gebruikt om een service aan te roepen, moet u ervoor zorgen dat deze de rol Services User heeft die nodig is om een AEM Forms-service aan te roepen.

In het volgende codevoorbeeld wordt getoond hoe u een com.adobe.idp.Context -object gebruikt binnen verbindingsinstellingen die worden gebruikt om een EncryptionServiceClient -object te maken.

 //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);

Oproepen van scenario's invoking_scenarios-1

De volgende aanroepende scenario's worden besproken in deze sectie:

Clienttoepassing die een zelfstandige AEM Forms-instantie aanroept client-application-invoking-a-stand-alone-aem-forms-instance

In het volgende diagram ziet u een clienttoepassing die in een eigen JVM wordt uitgevoerd en een zelfstandige AEM Forms-instantie aanroept.

In dit scenario wordt een clienttoepassing uitgevoerd in een eigen JVM en worden AEM Forms-services aangeroepen.

Clienttoepassing die geclusterde AEM Forms-instanties aanroept client-application-invoking-clustered-aem-forms-instances

In het volgende diagram wordt een clienttoepassing weergegeven die in een eigen JVM wordt uitgevoerd en die AEM Forms-instanties in een cluster oproept.

Dit scenario is vergelijkbaar met een clienttoepassing die een zelfstandige AEM Forms-instantie aanroept. De URL van de provider is echter anders. Als een clienttoepassing verbinding wil maken met een specifieke J2EE-toepassingsserver, moet de toepassing de URL wijzigen om naar de specifieke J2EE-toepassingsserver te verwijzen.

Verwijzen naar een specifieke J2EE-toepassingsserver wordt niet aanbevolen omdat de verbinding tussen de clienttoepassing en AEM Forms wordt verbroken als de toepassingsserver wordt gestopt. Het wordt aanbevolen dat de provider-URL verwijst naar een JNDI-manager op celniveau in plaats van een specifieke J2EE-toepassingsserver.

Clienttoepassingen die de SOAP verbindingsmodus gebruiken, kunnen de HTTP-taakverdelingpoort voor de cluster gebruiken. Clienttoepassingen die gebruikmaken van de EJB-verbindingsmodus kunnen verbinding maken met de EJB-poort van een specifieke J2EE-toepassingsserver. Met deze handeling wordt de taakverdeling tussen clusterknooppunten afgehandeld.

WebSphere

In het volgende voorbeeld wordt de inhoud getoond van een bestand jndi.properties dat wordt gebruikt om verbinding te maken met AEM Forms dat op WebSphere is geïmplementeerd.

 java.naming.factory.initial=com.ibm.websphere.naming.
 WsnInitialContextFactory
 java.naming.provider.url=corbaloc::appserver1:9810,:appserver2:9810

Weblogica

Het volgende voorbeeld toont de inhoud van het bestand jndi.properties dat wordt gebruikt om verbinding te maken met AEM Forms dat is gedistribueerd via WebLogic.

 java.naming.factory.initial=weblogic.jndi.WLInitialContextFactory
 java.naming.provider.url=t3://appserver1:8001, appserver2:8001

JBoss

In het volgende voorbeeld wordt de inhoud getoond van een bestand jndi.properties dat wordt gebruikt om verbinding te maken met AEM Forms dat op JBoss wordt geïmplementeerd.

 java.naming.factory.initial= org.jnp.interfaces.NamingContextFactory
 java.naming.provider.url= jnp://appserver1:1099, appserver2:1099,
 appserver3:1099

Zie ook

Inclusief Java-bibliotheekbestanden van AEM Forms

Gegevens doorgeven aan AEM Forms-services met gebruik van de Java-API

Een service aanroepen met behulp van een Java-clientbibliotheek

Gegevens doorgeven aan AEM Forms-services met gebruik van de Java-API passing-data-to-aem-forms-services-using-the-java-api

Bij AEM Forms-servicetaken worden doorgaans PDF-documenten gebruikt of geproduceerd. Wanneer u de dienst aanhaalt, soms is het noodzakelijk om een document van de PDF (of andere documenttypes zoals de gegevens van XML) tot de dienst over te gaan. Soms is het ook nodig om een PDF-document te verwerken dat van de service is geretourneerd. De Java-klasse waarmee u gegevens kunt doorgeven van en naar AEM Forms-services is com.adobe.idp.Document .

AEM Forms-services accepteren een PDF-document niet als andere gegevenstypen, zoals een java.io.InputStream -object of een bytearray. Een com.adobe.idp.Document -object kan ook worden gebruikt om andere gegevenstypen, zoals XML-gegevens, aan services door te geven.

Een com.adobe.idp.Document -object is een Java-type met serienummering, zodat het kan worden doorgegeven via een RMI-aanroep. De ontvangende zijde kan (zelfde gastheer, zelfde klassenlader), lokaal (zelfde gastheer, verschillende klassenlader), of ver (verschillende gastheer) worden collocated. Het doorgeven van documentinhoud is voor elk geval geoptimaliseerd. Als de afzender en de ontvanger zich bijvoorbeeld op dezelfde host bevinden, wordt de inhoud doorgegeven via een lokaal bestandssysteem. (In sommige gevallen kunnen documenten in het geheugen worden doorgegeven.)

Afhankelijk van de objectgrootte van com.adobe.idp.Document worden de gegevens binnen het com.adobe.idp.Document -object vervoerd of op het bestandssysteem van de server opgeslagen. Eventuele tijdelijke opslagbronnen die door het object com.adobe.idp.Document worden gebruikt, worden automatisch verwijderd wanneer com.adobe.idp.Document wordt verwijderd. (Zie het Verwerpen de voorwerpen van het Document.)

Soms is het nodig het inhoudstype van een com.adobe.idp.Document -object te kennen voordat u het aan een service kunt doorgeven. Als een bewerking bijvoorbeeld een specifiek inhoudstype vereist, zoals application/pdf , wordt u aangeraden het inhoudstype te bepalen. (Zie Bepalend het inhoudstype van een document.)

Het com.adobe.idp.Document -object probeert het inhoudstype te bepalen aan de hand van de verschafte gegevens. Als het inhoudstype niet kan worden opgehaald uit de opgegeven gegevens (bijvoorbeeld wanneer de gegevens zijn opgegeven als een bytearray), stelt u het inhoudstype in. Als u het inhoudstype wilt instellen, roept u de methode setContentType van het object com.adobe.idp.Document aan. (Zie Bepalend het inhoudstype van een document)

Als secundaire bestanden zich op hetzelfde bestandssysteem bevinden, kunt u sneller een com.adobe.idp.Document -object maken. Als secundaire bestanden zich op externe bestandssystemen bevinden, moet er een kopieerbewerking worden uitgevoerd die de prestaties beïnvloedt.

Een toepassing kan zowel com.adobe.idp.Document als org.w3c.dom.Document gegevenstypen bevatten. Zorg er echter voor dat u het gegevenstype org.w3c.dom.Document volledig kwalificeert. Voor informatie over het omzetten van een org.w3c.dom.Document voorwerp in een com.adobe.idp.Document voorwerp, zie Snel Begin (wijze EJB): Prepopulating Forms met Stroombare Lay-outs die Java API gebruiken.

        // 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();

zie ook

AEM Forms aanroepen met de Java API

Verbindingseigenschappen instellen

Documenten maken creating-documents

Maak een com.adobe.idp.Document -object voordat u een servicebewerking aanroept waarvoor een PDF-document (of andere documenttypen) als invoerwaarde is vereist. De klasse com.adobe.idp.Document biedt constructors waarmee u een document kunt maken van de volgende inhoudstypen:

Een document maken op basis van een bytearray creating-a-document-based-on-a-byte-array

In het volgende codevoorbeeld wordt een com.adobe.idp.Document -object gemaakt dat is gebaseerd op een bytearray.

Creërend een voorwerp van het Document dat op een byteserie gebaseerd is

 Document myPDFDocument = new Document(myByteArray);

Een document maken op basis van een ander document creating-a-document-based-on-another-document

In het volgende codevoorbeeld wordt een com.adobe.idp.Document -object gemaakt dat is gebaseerd op een ander com.adobe.idp.Document -object.

Creërend een voorwerp van het Document dat op een ander document gebaseerd is

 //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);

Een document maken op basis van een bestand creating-a-document-based-on-a-file

Het volgende codevoorbeeld leidt tot een com.adobe.idp.Document voorwerp dat op een PDF dossier genoemd map.pdf gebaseerd is. Dit bestand bevindt zich in de hoofdmap van de C-vaste schijf. Deze constructor probeert het MIME-inhoudstype van het com.adobe.idp.Document -object in te stellen met de bestandsnaamextensie.

De constructor com.adobe.idp.Document die een java.io.File -object accepteert, accepteert ook een Booleaanse parameter. Door deze parameter in te stellen op true , verwijdert het com.adobe.idp.Document -object het bestand. Deze handeling houdt in dat u het bestand niet hoeft te verwijderen nadat u het hebt doorgegeven aan de constructor com.adobe.idp.Document .

Als u deze parameter instelt op false , blijft de eigendom van dit bestand behouden. Het instellen van deze parameter op true is efficiënter. De reden hiervoor is dat het com.adobe.idp.Document -object het bestand rechtstreeks naar het lokale beheerde gebied kan verplaatsen in plaats van het te kopiëren (wat langzamer is).

Creërend een voorwerp van het Document dat op een dossier van PDF gebaseerd is

 //Create a Document object based on the map.pdf source file
 File mySourceMap = new File("C:\\map.pdf");
 Document myPDFDocument = new Document(mySourceMap,true);

Een document maken op basis van een InputStream-object creating-a-document-based-on-an-inputstream-object

In het volgende Java-codevoorbeeld wordt een object com.adobe.idp.Document gemaakt dat is gebaseerd op een object java.io.InputStream .

Creërend een document dat op een voorwerp InputStream wordt gebaseerd

 //Create a Document object based on an InputStream object
 InputStream is = new FileInputStream("C:\\Map.pdf");
 Document myPDFDocument = new Document(is);

Een document maken op basis van inhoud die toegankelijk is via een URL creating-a-document-based-on-content-accessible-from-an-url

Het volgende de codevoorbeeld van Java leidt tot een com.adobe.idp.Document voorwerp dat op een PDF dossier genoemd map.pdf gebaseerd is. Dit bestand bevindt zich in een webtoepassing met de naam WebApp die wordt uitgevoerd op localhost . Deze constructor probeert het MIME-inhoudstype van het com.adobe.idp.Document -object in te stellen met het inhoudstype dat met het URL-protocol wordt geretourneerd.

De URL die aan het object com.adobe.idp.Document wordt geleverd, wordt altijd gelezen aan de zijde waar het oorspronkelijke object com.adobe.idp.Document is gemaakt, zoals in dit voorbeeld wordt getoond:

     Document doc = new Document(new java.net.URL("file:c:/temp/input.pdf"));

Het c:/temp/input.pdf-bestand moet zich op de clientcomputer bevinden (niet op de servercomputer). Het is de clientcomputer waar de URL wordt gelezen en waar het com.adobe.idp.Document object is gemaakt.

Creërend een document dat op inhoud toegankelijk van een URL wordt gebaseerd

 //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);

zie ook

AEM Forms aanroepen met de Java API

Verbindingseigenschappen instellen

Geretourneerde documenten afhandelen handling-returned-documents

Servicebewerkingen die een PDF-document (of andere gegevenstypen zoals XML-gegevens) als uitvoerwaarde retourneren, retourneren een com.adobe.idp.Document object. Nadat u een com.adobe.idp.Document object hebt ontvangen, kunt u het converteren naar de volgende indelingen:

De volgende coderegel zet een com.adobe.idp.Document -object om in een java.io.InputStream -object. Stel dat myPDFDocument een com.adobe.idp.Document -object vertegenwoordigt:

     java.io.InputStream resultStream = myDocument.getInputStream();

Op dezelfde manier kunt u de inhoud van een com.adobe.idp.Document naar een lokaal bestand kopiëren door de volgende taken uit te voeren:

Het volgende codevoorbeeld kopieert de inhoud van a com.adobe.idp.Document voorwerp aan een dossier genoemd anotherMap.pdf.

Kopieert de inhoud van een documentvoorwerp aan een dossier

 File outFile = new File("C:\\AnotherMap.pdf");
 myDocument.copyToFile (outFile);

zie ook

AEM Forms aanroepen met de Java API

Verbindingseigenschappen instellen

Het inhoudstype van een document bepalen determining-the-content-type-of-a-document

Bepaal het MIME-type van een com.adobe.idp.Document -object door de methode com.adobe.idp.Document object getContentType aan te roepen. Deze methode retourneert een tekenreekswaarde die het inhoudstype van het com.adobe.idp.Document -object opgeeft. In de volgende tabel worden de verschillende inhoudstypen beschreven die AEM Forms retourneert.

Het volgende codevoorbeeld bepaalt het inhoudstype van een com.adobe.idp.Document voorwerp.

Bepalend het inhoudstype van een voorwerp van het Document

 //Determine the content type of the Document object
 String ct = myDocument.getContentType();
 System.out.println("The content type of the Document object is " +ct);

zie ook

AEM Forms aanroepen met de Java API

Verbindingseigenschappen instellen

Documentobjecten verwijderen disposing-document-objects

Wanneer u een Document -object niet meer nodig hebt, wordt u aangeraden het te verwijderen door de dispose -methode aan te roepen. Elk Document -object gebruikt een bestandsdescriptor en maar liefst 75 MB aan RAM-ruimte op het hostplatform van uw toepassing. Als een Document -object niet wordt verwijderd, verwijdert het Java Garage-verzamelingsproces het object. Als u deze methode echter eerder verwijdert met de methode dispose , kunt u het geheugen dat door het object Document wordt gebruikt, vrijmaken.

zie ook

AEM Forms aanroepen met de Java API

Inclusief AEM Forms Java-bibliotheekbestanden

Een service aanroepen met een Java-clientbibliotheek

Een service aanroepen met een Java-clientbibliotheek invoking-a-service-using-a-java-client-library

De de dienstverrichtingen van AEM Forms kunnen worden aangehaald door sterk getypte API van de dienst te gebruiken, die als een cliëntbibliotheek van Java wordt bekend. A de cliëntbibliotheek van Java is een reeks concrete klassen die toegang tot de diensten verlenen die in de de dienstcontainer worden opgesteld. U instantieert een Java-object dat de service vertegenwoordigt die moet worden aangeroepen in plaats van een InvocationRequest -object te maken met de Invocation API. De oproepings-API wordt gebruikt om processen, zoals langlevende processen, aan te roepen die in Workbench zijn gemaakt. (Zie het aanhalen van mens-Centric langlevende Processen.)

Als u een servicebewerking wilt uitvoeren, roept u een methode aan die tot het Java-object behoort. Een Java-clientbibliotheek bevat methoden die doorgaans een-op-een toewijzen aan servicebewerkingen. Wanneer u een Java-clientbibliotheek gebruikt, stelt u de vereiste verbindingseigenschappen in. (Zie Plaatsende verbindingseigenschappen.)

Nadat u verbindingseigenschappen hebt ingesteld, maakt u een ServiceClientFactory -object dat wordt gebruikt om een Java-object te instantiëren waarmee u een service kunt aanroepen. Elke service met een Java-clientbibliotheek heeft een overeenkomstig clientobject. Als u bijvoorbeeld de Repository-service wilt aanroepen, maakt u een ResourceRepositoryClient -object met de constructor ervan en geeft u het ServiceClientFactory -object door. Het ServiceClientFactory object is verantwoordelijk voor het behoud van de verbindingsinstellingen die vereist zijn voor het aanroepen van AEM Forms-services.

Hoewel het verkrijgen van een ServiceClientFactory doorgaans snel is, is er enige overhead van belang wanneer de factory voor het eerst wordt gebruikt. Dit object is geoptimaliseerd voor hergebruik en gebruik daarom, indien mogelijk, hetzelfde ServiceClientFactory -object wanneer u meerdere Java-client-objecten maakt. Maak dus geen afzonderlijk ServiceClientFactory -object voor elk clientbibliotheekobject dat u maakt.

Er is een instelling voor Gebruikersbeheer die de levensduur van de SAML-bewering bepaalt die zich binnen het com.adobe.idp.Context -object bevindt dat het ServiceClientFactory -object beïnvloedt. Deze instelling bepaalt de levensduur van alle verificatiecontext in AEM Forms, inclusief alle aanroepen die worden uitgevoerd met de Java API. Standaard kan een ServiceCleintFactory -object twee uur worden gebruikt.

U kunt de service Opslagplaats aanroepen door gebruik te maken van een Java-clientbibliotheek en de volgende stappen uit te voeren:

zie ook

Snel starten (EJB-modus): een bron schrijven met de Java API

AEM Forms aanroepen met de Java API

Inclusief AEM Forms Java-bibliotheekbestanden

Een kortstondig proces aanroepen met de API voor aanroepen invoking-a-short-lived-process-using-the-invocation-api

U kunt een kortstondig proces aanroepen met de Java Invocation-API. Wanneer u een kortstondig proces aanroept met behulp van de Inroeping-API, geeft u vereiste parameterwaarden door met behulp van een java.util.HashMap -object. Voor elke parameter om aan de dienst over te gaan, haalt de methode put van het voorwerp java.util.HashMap aan en specificeert het naam-waardepaar dat door de dienst wordt vereist om de gespecificeerde verrichting uit te voeren. Geef de exacte naam op van de parameters die bij het kortstondige proces horen.

Het volgende onderwerp gaat over het gebruik van de API Inroeping om het volgende kortstondige AEM Forms-proces met de naam MyApplication/EncryptDocument aan te roepen.

Wanneer dit proces wordt aangeroepen, worden de volgende handelingen uitgevoerd:

Het kortstondige MyApplication/EncryptDocument-proces aanroepen met de Java-oproepings-API invoke-the-myapplication-encryptdocument-short-lived-process-using-the-java-invocation-api

Roep het MyApplication/EncryptDocument kortstondige proces aan met behulp van de Java-oproepings-API:

zie ook

Snel starten: Een kortstondig proces aanroepen met de API voor aanroepen

Het aanhalen van mens-Centric langlevende Processen

Inclusief AEM Forms Java-bibliotheekbestanden