Anropa AEM Forms med Java API invoking-aem-forms-using-the-javaapi

Exempel och exempel i det här dokumentet gäller endast för AEM Forms i JEE-miljö.

AEM Forms kan anropas med AEM Forms Java API. När du använder AEM Forms Java API kan du antingen använda anrops-API eller Java-klientbibliotek. Java-klientbibliotek är tillgängliga för tjänster som Rights Management. Med dessa starkt typbestämda API:er kan du utveckla Java-program som anropar AEM Forms.

Anrops-API:t är klasser som finns i paketet com.adobe.idp.dsc. Med dessa klasser kan du skicka en anropsbegäran direkt till en tjänst och hantera ett anropssvar som returneras. Använd anrops-API:t för att anropa kortlivade eller långvariga processer som skapats med Workbench.

Det rekommenderade sättet att programmässigt anropa en tjänst är att använda ett Java-klientbibliotek som motsvarar tjänsten i motsats till anrops-API:t. Om du till exempel vill anropa krypteringstjänsten använder du krypteringstjänstens klientbibliotek. Om du vill utföra en krypteringstjänståtgärd anropar du en metod som tillhör krypteringstjänstens klientobjekt. Du kan kryptera ett PDF-dokument med ett lösenord genom att anropa EncryptionServiceClient-objektets encryptPDFUsingPassword-metod.

Java API har stöd för följande funktioner:

Inkludera AEM Forms Java-biblioteksfiler

Anropa personalcentrerade, långlivade processer

Anropa AEM Forms med Web Services

Ange anslutningsegenskaper

Skicka data till AEM Forms-tjänster med Java API

Anropa en tjänst med ett Java-klientbibliotek

Anropa en kort process med anrops-API

Skapa ett Java-webbprogram som anropar en mänsklig, lång process

Inkludera AEM Forms Java-biblioteksfiler including-aem-forms-java-library-files

Om du vill anropa en AEM Forms-tjänst med hjälp av Java API:t inkluderar du nödvändiga biblioteksfiler (JAR-filer) i Java-projektets klassökväg. JAR-filerna som du inkluderar i klientprogrammets klassökväg beror på flera faktorer:

Tjänstspecifika JAR-filer service-specific-jar-files

I följande tabell visas de JAR-filer som krävs för att anropa AEM Forms-tjänster.

Anslutningsläge och JAR-filer för J2EE-program connection-mode-and-j2ee-application-jar-files

I följande tabell visas de JAR-filer som är beroende av anslutningsläget och J2EE-programservern som AEM Forms distribueras på.

Anropa scenarier invoking-scenarios

I följande tabell anges vilka scenarier som anropas och vilka JAR-filer som krävs för att anropa AEM Forms.

Uppgraderar JAR-filer upgrading-jar-files

Om du uppgraderar från LiveCycle till AEM Forms bör du ta med AEM Forms JAR-filerna i Java-projektets klassökväg. Om du till exempel använder tjänster som Rights Management stöter du på ett kompatibilitetsproblem om du inte inkluderar AEM Forms JAR-filer i klassökvägen.

Anta att du uppgraderar till AEM Forms. Om du vill använda ett Java-program som anropar tjänsten Rights Management inkluderar du AEM Forms-versionerna av följande JAR-filer:

Se även

Anropa AEM Forms med Java API

Ange anslutningsegenskaper

Skicka data till AEM Forms-tjänster med Java API

Anropa en tjänst med ett Java-klientbibliotek

Ange anslutningsegenskaper setting-connection-properties

Du anger anslutningsegenskaper som anropar AEM Forms när du använder Java API. När du anger anslutningsegenskaper anger du om tjänsterna ska anropas från fjärrdatorn eller lokalt, och anger även anslutnings- och autentiseringsvärden. Autentiseringsvärden krävs om tjänstsäkerhet är aktiverat. Om tjänstsäkerhet är inaktiverad behöver du inte ange autentiseringsvärden.

Anslutningsläget kan antingen vara SOAP eller EJB-läge. I EJB-läget används RMI/IIOP-protokollet, och prestanda för EJB-läget är bättre än prestanda för SOAP. Läget SOAP används för att ta bort ett J2EE-serverberoende eller när en brandvägg finns mellan AEM Forms och klientprogrammet. SOAP använder https-protokollet som underliggande transport och kan kommunicera över brandväggsgränserna. Om varken ett J2EE-programserverberoende eller en brandvägg är ett problem rekommenderar vi att du använder EJB-läget.

Om du vill anropa en AEM Forms-tjänst anger du följande anslutningsegenskaper:

Utför följande åtgärder för att ange anslutningsegenskaper:

Anger EJB-anslutningsläget för JBoss

I följande Java-kodexempel ställs anslutningsegenskaperna in så att AEM Forms anropas i JBoss och EJB-anslutningsläget används.

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

Anger EJB-anslutningsläget för WebLogic

I följande Java-kodexempel ställs anslutningsegenskaperna in så att AEM Forms anropas i WebLogic och EJB-anslutningsläget används.

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

Anger EJB-anslutningsläget för WebSphere

I följande Java-kodexempel ställs anslutningsegenskaperna in så att AEM Forms anropas i WebSphere och EJB-anslutningsläget används.

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

Anger SOAP anslutningsläge

I följande Java-kodexempel ställs anslutningsegenskaperna in i SOAP läge så att AEM Forms anropas i 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");

Anger anslutningsegenskaper när tjänstsäkerhet är inaktiverad

I följande Java-kodexempel ställs anslutningsegenskaper in som krävs för att anropa AEM Forms som distribueras på JBoss Application Server och när tjänstsäkerhet är inaktiverad.

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

Anger SOAP anslutningsläge med tidsgräns för anpassad begäran

 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

Anropa AEM Forms med ett Context-objekt

Du kan använda ett com.adobe.idp.Context-objekt för att anropa en AEM Forms-tjänst med en autentiserad användare (objektet com.adobe.idp.Context representerar en autentiserad användare). När du använder ett com.adobe.idp.Context-objekt behöver du inte ange egenskaperna DSC_CREDENTIAL_USERNAME eller DSC_CREDENTIAL_PASSWORD. Du kan hämta ett com.adobe.idp.Context-objekt när du autentiserar användare med AuthenticationManagerServiceClient-objektets authenticate-metod.

Metoden authenticate returnerar ett AuthResult-objekt som innehåller autentiseringsresultatet. Du kan skapa ett com.adobe.idp.Context-objekt genom att anropa dess konstruktor. Anropa sedan com.adobe.idp.Context-objektets initPrincipal-metod och skicka AuthResult-objektet enligt följande kod:

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

I stället för att ange egenskaperna DSC_CREDENTIAL_USERNAME eller DSC_CREDENTIAL_PASSWORD kan du anropa ServiceClientFactory-objektets setContext-metod och skicka com.adobe.idp.Context-objektet. När du använder en AEM formuläranvändare för att anropa en tjänst måste du se till att de har rollen Services User som krävs för att anropa en AEM Forms-tjänst.

I följande kodexempel visas hur du använder ett com.adobe.idp.Context-objekt i anslutningsinställningarna som används för att skapa ett EncryptionServiceClient -objekt.

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

Anropa scenarier invoking_scenarios-1

Följande scenarier beskrivs i det här avsnittet:

Klientprogram som anropar en fristående AEM Forms-instans client-application-invoking-a-stand-alone-aem-forms-instance

I följande diagram visas ett klientprogram som körs i en egen JVM och som anropar en fristående AEM Forms-instans.

I det här scenariot körs ett klientprogram i sin egen JVM och anropar AEM Forms tjänster.

Klientprogrammet anropar klustrade AEM Forms-instanser client-application-invoking-clustered-aem-forms-instances

I följande diagram visas ett klientprogram som körs i en egen JVM och som anropar AEM Forms-instanser i ett kluster.

Detta scenario liknar ett klientprogram som anropar en fristående AEM Forms-instans. Providerns URL är dock annorlunda. Om ett klientprogram vill ansluta till en specifik J2EE-programserver måste programmet ändra URL:en så att den refererar till den specifika J2EE-programservern.

Du bör inte referera till en specifik J2EE-programserver eftersom anslutningen mellan klientprogrammet och AEM Forms avbryts om programservern avbryts. Vi rekommenderar att provider-URL refererar till en JNDI-hanterare på cellnivå i stället för en specifik J2EE-programserver.

Klientprogram som använder SOAP anslutningsläge kan använda HTTP-belastningsutjämnarporten för klustret. Klientprogram som använder EJB-anslutningsläget kan ansluta till EJB-porten för en viss J2EE-programserver. Den här åtgärden hanterar belastningsutjämning mellan klusternoder.

WebSphere

I följande exempel visas innehållet i en jndi.properties-fil som används för att ansluta till AEM Forms som distribueras på WebSphere.

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

WebLogic (på engelska)

I följande exempel visas innehållet i en jndi.properties-fil som används för att ansluta till AEM Forms som distribueras på WebLogic.

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

JBoss

I följande exempel visas innehållet i en jndi.properties-fil som används för att ansluta till AEM Forms som distribueras på JBoss.

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

Se även

Inklusive AEM Forms Java-biblioteksfiler

Skicka data till AEM Forms-tjänster med Java API

Anropa en tjänst med hjälp av ett Java-klientbibliotek

Skicka data till AEM Forms-tjänster med Java API passing-data-to-aem-forms-services-using-the-java-api

AEM Forms serviceverksamhet använder eller producerar vanligtvis PDF-dokument. När du anropar en tjänst kan det ibland vara nödvändigt att skicka ett PDF-dokument (eller andra dokumenttyper som XML-data) till tjänsten. Ibland är det också nödvändigt att hantera ett PDF-dokument som returneras från tjänsten. Java-klassen som gör att du kan skicka data till och från AEM Forms-tjänster är com.adobe.idp.Document.

AEM Forms-tjänster accepterar inte ett PDF-dokument som andra datatyper, till exempel ett java.io.InputStream-objekt eller en bytearray. Ett com.adobe.idp.Document-objekt kan också användas för att skicka andra typer av data, till exempel XML-data, till tjänster.

Ett com.adobe.idp.Document-objekt är en Java-serialiserbar typ, så det kan skickas över ett RMI-anrop. Mottagande sida kan sorteras (samma värd, samma klassinläsare), lokal (samma värd, annan klassinläsare) eller fjärransluten (en annan värd). Dokumentinnehållet är optimerat för varje enskilt fall. Om till exempel avsändaren och mottagaren finns på samma värd, överförs innehållet via ett lokalt filsystem. (I vissa fall kan dokument skickas i minnet.)

Beroende på objektstorleken för com.adobe.idp.Document överförs data inom objektet com.adobe.idp.Document eller lagras på serverns filsystem. Eventuella tillfälliga lagringsresurser som upptas av objektet com.adobe.idp.Document tas automatiskt bort när com.adobe.idp.Document tas bort. (Se Ta bort dokumentobjekt.)

Ibland är det nödvändigt att känna till innehållstypen för ett com.adobe.idp.Document-objekt innan du kan skicka det till en tjänst. Om en åtgärd till exempel kräver en viss innehållstyp, som application/pdf, bör du fastställa innehållstypen. (Se Bestämma innehållstypen för ett dokument.)

Objektet com.adobe.idp.Document försöker identifiera innehållstypen med hjälp av angivna data. Om innehållstypen inte kan hämtas från de data som anges (till exempel när data har angetts som en bytearray), anger du innehållstypen. Anropa com.adobe.idp.Document-objektets setContentType-metod för att ange innehållstypen. (Se Bestämma innehållstypen för ett dokument)

Om det finns sidofiler i samma filsystem går det snabbare att skapa ett com.adobe.idp.Document-objekt. Om det finns filer som kan användas i fjärranslutna filsystem måste en kopieringsåtgärd utföras, vilket påverkar prestandan.

Ett program kan innehålla datatyperna com.adobe.idp.Document och org.w3c.dom.Document. Se dock till att du kvalificerar datatypen org.w3c.dom.Document fullständigt. Information om hur du konverterar ett org.w3c.dom.Document-objekt till ett com.adobe.idp.Document-objekt finns i Snabbstart (EJB-läge): Förifyll Forms med flödeslayouter med Java API.

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

Se även

Anropa AEM Forms med Java API

Ange anslutningsegenskaper

Skapa dokument creating-documents

Skapa ett com.adobe.idp.Document-objekt innan du anropar en tjänståtgärd som kräver ett PDF-dokument (eller andra dokumenttyper) som indatavärde. Klassen com.adobe.idp.Document innehåller konstruktorer som gör att du kan skapa ett dokument av följande innehållstyper:

Skapa ett dokument baserat på en bytearray creating-a-document-based-on-a-byte-array

I följande kodexempel skapas ett com.adobe.idp.Document-objekt som baseras på en bytearray.

Skapa ett Document-objekt som baseras på en bytearray

 Document myPDFDocument = new Document(myByteArray);

Skapa ett dokument baserat på ett annat dokument creating-a-document-based-on-another-document

I följande kodexempel skapas ett com.adobe.idp.Document-objekt som är baserat på ett annat com.adobe.idp.Document-objekt.

Skapa ett dokumentobjekt som är baserat på ett annat 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);

Skapa ett dokument baserat på en fil creating-a-document-based-on-a-file

I följande kodexempel skapas ett com.adobe.idp.Document-objekt som baseras på en PDF-fil med namnet map.pdf. Den här filen finns i roten på hårddisken C. Den här konstruktorn försöker ange MIME-innehållstypen för objektet com.adobe.idp.Document med filnamnstillägget.

Konstruktorn com.adobe.idp.Document som accepterar ett java.io.File -objekt accepterar också en Boolean-parameter. Genom att ställa in den här parametern på true tar com.adobe.idp.Document-objektet bort filen. Den här åtgärden innebär att du inte behöver ta bort filen efter att du har skickat den till konstruktorn com.adobe.idp.Document.

Om du anger den här parametern till false innebär det att du behåller ägarskapet för den här filen. Det är mer effektivt att ställa in den här parametern på true. Orsaken är att objektet com.adobe.idp.Document kan flytta filen direkt till det lokala hanterade området i stället för att kopiera den (vilket är långsammare).

Skapa ett Document-objekt som baseras på en PDF-fil

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

Skapa ett dokument baserat på ett InputStream-objekt creating-a-document-based-on-an-inputstream-object

I följande Java-kodexempel skapas ett com.adobe.idp.Document-objekt som är baserat på ett java.io.InputStream-objekt.

Skapa ett dokument baserat på ett InputStream-objekt

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

Skapa ett dokument baserat på innehåll som är tillgängligt från en URL creating-a-document-based-on-content-accessible-from-an-url

I följande Java-kodexempel skapas ett com.adobe.idp.Document-objekt som baseras på en PDF-fil med namnet map.pdf. Den här filen finns i ett webbprogram med namnet WebApp som körs på localhost. Den här konstruktorn försöker ange MIME-innehållstypen för objektet com.adobe.idp.Document med den innehållstyp som returneras med URL-protokollet.

URL:en som anges för objektet com.adobe.idp.Document läses alltid på den sida där det ursprungliga com.adobe.idp.Document-objektet skapas, vilket visas i det här exemplet:

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

Filen c:/temp/input.pdf måste finnas på klientdatorn (inte på serverdatorn). Klientdatorn är den plats där URL:en läses och där com.adobe.idp.Document objektet skapades.

Skapa ett dokument baserat på innehåll som är tillgängligt från en URL

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

Se även

Anropa AEM Forms med Java API

Ställa in anslutningsegenskaper

Hantering av returnerade dokument handling-returned-documents

Tjänståtgärder som returnerar ett PDF-dokument (eller andra datatyper, t.ex. XML-data) som ett utdatavärde returnerar ett com.adobe.idp.Document objekt. När du har fått ett com.adobe.idp.Document objekt kan du konvertera det till följande format:

Följande kodrad konverterar ett com.adobe.idp.Document-objekt till ett java.io.InputStream-objekt. Anta att myPDFDocument representerar ett com.adobe.idp.Document-objekt:

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

Du kan på samma sätt kopiera innehållet i en com.adobe.idp.Document till en lokal fil genom att utföra följande åtgärder:

I följande kodexempel kopieras innehållet i ett com.adobe.idp.Document-objekt till en fil med namnet OtherMap.pdf.

Kopiera innehållet i ett dokumentobjekt till en fil

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

Se även

Anropa AEM Forms med Java API

Ange anslutningsegenskaper

Bestämma innehållstypen för ett dokument determining-the-content-type-of-a-document

Bestäm MIME-typen för ett com.adobe.idp.Document-objekt genom att anropa com.adobe.idp.Document-objektets getContentType-metod. Den här metoden returnerar ett strängvärde som anger innehållstypen för objektet com.adobe.idp.Document. I följande tabell beskrivs de olika innehållstyper som AEM Forms returnerar.

Följande kodexempel avgör innehållstypen för ett com.adobe.idp.Document-objekt.

Bestämmer innehållstypen för ett Document-objekt

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

Se även

Anropa AEM Forms med Java API

Ange anslutningsegenskaper

Disponera dokumentobjekt disposing-document-objects

När du inte längre behöver ett Document-objekt rekommenderar vi att du tar bort det genom att anropa dess dispose-metod. Varje Document-objekt förbrukar en filbeskrivning och så mycket som 75 MB RAM-utrymme på programmets värdplattform. Om ett Document-objekt inte tas bort tas det bort av Java Garage-samlingsprocessen. Genom att kassera den tidigare med metoden dispose kan du dock frigöra det minne som upptas av objektet Document.

Se även

Anropa AEM Forms med Java API

Inkludera AEM Forms Java-biblioteksfiler

Anropa en tjänst med ett Java-klientbibliotek

Anropa en tjänst med ett Java-klientbibliotek invoking-a-service-using-a-java-client-library

AEM Forms tjänståtgärder kan anropas med hjälp av en tjänsts starkt typbestämda API, som kallas Java-klientbibliotek. Ett Java-klientbibliotek är en uppsättning konkreta klasser som ger åtkomst till tjänster som distribueras i tjänstbehållaren. Du instansierar ett Java-objekt som representerar tjänsten som ska anropas i stället för att skapa ett InvocationRequest-objekt med hjälp av API:t för anrop. Anrops-API:t används för att anropa processer, till exempel långvariga processer, som skapats i Workbench. (Se Anropar humancentrerade, långlivade processer.)

Om du vill utföra en tjänståtgärd anropar du en metod som tillhör Java-objektet. Ett Java-klientbibliotek innehåller metoder som vanligtvis mappar en-till-en med serviceåtgärder. Ange nödvändiga anslutningsegenskaper när du använder ett Java-klientbibliotek. (Se Ange anslutningsegenskaper.)

När du har angett anslutningsegenskaper skapar du ett ServiceClientFactory-objekt som används för att instansiera ett Java-objekt som gör att du kan anropa en tjänst. Varje tjänst som har ett Java-klientbibliotek har ett motsvarande klientobjekt. Om du till exempel vill anropa databastjänsten skapar du ett ResourceRepositoryClient-objekt med hjälp av dess konstruktor och skickar objektet ServiceClientFactory. Objektet ServiceClientFactory ansvarar för att underhålla de anslutningsinställningar som krävs för att anropa AEM Forms-tjänster.

Även om det är snabbt att hämta en ServiceClientFactory är det en del overheadkostnader som uppstår när fabriken används för första gången. Det här objektet är optimerat för återanvändning och därför, när det är möjligt, ska du använda samma ServiceClientFactory-objekt när du skapar flera Java-klientobjekt. Det innebär att du inte ska skapa ett separat ServiceClientFactory-objekt för varje klientbiblioteksobjekt som du skapar.

Det finns en inställning för användarhantering som styr livslängden för SAML-försäkran som finns inuti objektet com.adobe.idp.Context som påverkar objektet ServiceClientFactory. Den här inställningen styr alla livstider för autentiseringskontext i hela AEM Forms, inklusive alla anrop som utförs med Java API. Som standard är den tidsperiod under vilken ett ServiceCleintFactory-objekt kan användas två timmar.

Du kan anropa databastjänsten med hjälp av ett Java-klientbibliotek och genom att utföra följande steg:

Se även

Snabbstart (EJB-läge): Skriva en resurs med Java API

Anropa AEM Forms med Java API

Inkludera AEM Forms Java-biblioteksfiler

Anropa en kort process med anrops-API invoking-a-short-lived-process-using-the-invocation-api

Du kan anropa en kort process med Java Anvocation API. När du anropar en kortvarig process med anrops-API skickar du obligatoriska parametervärden med hjälp av ett java.util.HashMap-objekt. För varje parameter som ska skickas till en tjänst anropar du java.util.HashMap-objektets put-metod och anger det namn/värde-par som krävs för att tjänsten ska kunna utföra den angivna åtgärden. Ange det exakta namnet på parametrarna som tillhör den kortvariga processen.

Diskussionen här handlar om att använda anrops-API för att anropa följande kortlivade AEM Forms-process med namnet MyApplication/EncryptDocument.

När processen anropas utför den följande åtgärder:

Anropa den kortvariga processen MyApplication/EncryptDocument med hjälp av Java-anrops-API invoke-the-myapplication-encryptdocument-short-lived-process-using-the-java-invocation-api

Anropa den kortvariga MyApplication/EncryptDocument-processen med Java-anrops-API:

Se även

Snabbstart: Anropa en kort process med anrops-API

Anropa personalcentrerade, långlivade processer

Inkludera AEM Forms Java-biblioteksfiler