Hantera slutpunkter programmatiskt programmatically-managing-endpoints
Exempel och exempel i det här dokumentet är bara för AEM Forms i JEE-miljö.
Om registertjänsten för slutpunkter
Tjänsten Endpoint Registry ger möjlighet att programmässigt hantera slutpunkter. Du kan till exempel lägga till följande typer av slutpunkter i en tjänst:
- EJB
- SOAP
- Bevakad mapp
- E-post
- (Borttaget för AEM formulär) Remoting
- Aktivitetshanteraren
En fjärrslutpunkt gör att Flex-klienter kan anropa åtgärder för den AEM Forms-tjänst som slutpunkten läggs till i. Ett Flex-mål med samma namn som slutpunkten skapas och Flex-klienter kan skapa RemoteObjects som pekar på det här målet för att anropa åtgärder på den aktuella tjänsten.
Slutpunkterna för e-post, Aktivitetshanteraren och Bevakade mappar visar bara en viss åtgärd för tjänsten. För att lägga till dessa slutpunkter krävs ett andra konfigurationssteg för att välja en metod att anropa, ange konfigurationsparametrar och ange in- och utdataparametermappningar.
Du kan ordna TaskManager-slutpunkter i grupper som kallas kategorier. Dessa kategorier visas sedan för Workspace via TaskManager, där slutanvändarna ser slutpunkterna för TaskManager när de kategoriseras. I Workspace ser slutanvändarna dessa kategorier i navigeringsrutan. Slutpunkterna i varje kategori visas som processkort på sidan Starta processer i Workspace.
Du kan utföra följande uppgifter med hjälp av tjänsten för slutpunktsregister:
- Lägg till EJB-slutpunkter. (Se Lägga till EJB-slutpunkter.)
- Lägg till SOAP-slutpunkter. (Se Lägga till SOAP-slutpunkter.)
- Lägg till övervakade mappslutpunkter (se Lägga till bevakade mappslutpunkter.)
- Lägg till e-postslutpunkter. (Se Lägga till e-postslutpunkter.)
- Lägg till fjärrslutpunkter. (Se Lägga till fjärrslutpunkter.)
- Lägg till TaskManager-slutpunkter (Se Lägger till TaskManager-slutpunkter.)
- Ändra slutpunkter (se Ändra slutpunkter.)
- Ta bort slutpunkter (se Tar bort slutpunkter.)
- Hämta information om slutpunktsanslutning (se Hämtar information om slutpunktsanslutning.)
Lägga till EJB-slutpunkter adding-ejb-endpoints
Du kan programmässigt lägga till en EJB-slutpunkt till en tjänst med hjälp av AEM Forms Java API. Genom att lägga till en EJB-slutpunkt till en tjänst aktiverar du ett klientprogram att anropa tjänsten i EJB-läge. Det innebär att du kan välja EJB-läge när du anger anslutningsegenskaper som krävs för att anropa AEM Forms. (Se Ange anslutningsegenskaper.)
Sammanfattning av steg summary-of-steps
Utför följande åtgärder om du vill lägga till en EJB-slutpunkt i en tjänst:
- Inkludera projektfiler.
- Skapa en
EndpointRegistry Client
-objekt. - Ange EJB-slutpunktsattribut.
- Skapa en EJB-slutpunkt.
- Aktivera slutpunkten.
Inkludera projektfiler
Inkludera nödvändiga filer i utvecklingsprojektet. Följande JAR-filer måste läggas till i projektets klasssökväg:
- adobe-livecycle-client.jar
- adobe-usermanager-client.jar
- adobe-utilities.jar (krävs om AEM Forms körs på JBoss Application Server)
- jbossall-client.jar (krävs om AEM Forms körs på JBoss Application Server)
Mer information om var dessa JAR-filer finns i Inkludera AEM Forms Java-biblioteksfiler.
Skapa ett EndpointRegistry-klientobjekt
Innan du kan lägga till en EJB-slutpunkt med programkod måste du skapa en EndpointRegistryClient
-objekt.
Ange EJB-slutpunktsattribut
Om du vill skapa en EJB-slutpunkt för en tjänst anger du följande värden:
- Kopplingsidentifierare: Anger vilken typ av slutpunkt som ska skapas. Om du vill skapa en EJB-slutpunkt anger du
EJB
. - Beskrivning: Anger slutpunktsbeskrivningen.
- Namn: Anger slutpunktens namn.
- Tjänstidentifierare: Anger den tjänst som slutpunkten tillhör.
- Åtgärdsnamn: Anger namnet på åtgärden som anropas med slutpunkten. När du skapar en EJB-slutpunkt anger du ett jokertecken (
*
). Om du vill ange en viss åtgärd i stället för att anropa alla tjänståtgärder, anger du åtgärdens namn i stället för att använda jokertecknet (*
).
Skapa en EJB-slutpunkt
När du har angett EJB-slutpunktsattribut kan du skapa en EJB-slutpunkt för en tjänst.
Aktivera slutpunkten
När du har skapat en slutpunkt måste du aktivera den. När du har aktiverat slutpunkten kan den användas för att anropa tjänsten. När du har aktiverat slutpunkten kan du visa den i administrationskonsolen.
Se även
Lägga till en EJB-slutpunkt med Java API
Inkludera AEM Forms Java-biblioteksfiler
Lägga till en EJB-slutpunkt med Java API adding-an-ejb-endpoint-using-the-java-api
Lägg till en EJB-slutpunkt med Java API:
-
Inkludera projektfiler.
Inkludera JAR-klientfiler, t.ex. adobe-livecycle-client.jar, i Java-projektets klassökväg. (
-
Skapa ett EndpointRegistry-klientobjekt.
- Skapa en
ServiceClientFactory
objekt som innehåller anslutningsegenskaper. - Skapa en
EndpointRegistryClient
genom att använda konstruktorn och skickaServiceClientFactory
-objekt.
- Skapa en
-
Ange EJB-slutpunktsattribut.
- Skapa en
CreateEndpointInfo
genom att använda dess konstruktor. - Ange anslutnings-ID-värdet genom att anropa
CreateEndpointInfo
objektetssetConnectorId
metoden och skicka strängvärdetEJB
. - Ange beskrivningen av slutpunkten genom att anropa
CreateEndpointInfo
objektetssetDescription
och skickar ett strängvärde som beskriver slutpunkten. - Ange slutpunktens namn genom att anropa
CreateEndpointInfo
objektetssetName
och skickar ett strängvärde som anger namnet. - Ange tjänsten som slutpunkten tillhör genom att anropa
CreateEndpointInfo
objektetssetServiceId
och skickar ett strängvärde som anger tjänstnamnet. - Ange åtgärden som anropas genom att anropa
CreateEndpointInfo
objektetssetOperationName
och skicka ett strängvärde som anger åtgärdsnamnet. För SOAP- och EJB-slutpunkter anger du ett jokertecken (*
), vilket betyder alla operationer.
- Skapa en
-
Skapa en EJB-slutpunkt.
Skapa slutpunkten genom att starta
EndpointRegistryClient
objektetscreateEndpoint
metoden och skickaCreateEndpointInfo
-objekt. Den här metoden returnerar enEndpoint
objekt som representerar den nya EJB-slutpunkten. -
Aktivera slutpunkten.
Aktivera slutpunkten genom att anropa
EndpointRegistryClient
objektets enable-metod och skickaEndpoint
objekt som returneras avcreateEndpoint
-metod.
Se även
QuickStart: Lägga till en EJB-slutpunkt med Java API
Inkludera AEM Forms Java-biblioteksfiler
Lägga till SOAP-slutpunkter adding-soap-endpoints
Du kan programmässigt lägga till en SOAP-slutpunkt till en tjänst med hjälp av AEM Forms Java API. Genom att lägga till en SOAP-slutpunkt aktiverar du ett klientprogram att anropa tjänsten i SOAP-läge. När du anger de anslutningsegenskaper som krävs för att anropa AEM Forms kan du alltså välja SOAP-läge.
Sammanfattning av steg summary_of_steps-1
Utför följande åtgärder om du vill lägga till en SOAP-slutpunkt till en tjänst:
- Inkludera projektfiler.
- Skapa en
EndpointRegistryClient
-objekt. - Ange SOAP-slutpunktsattribut.
- Skapa en SOAP-slutpunkt.
- Aktivera slutpunkten.
Inkludera projektfiler
Inkludera nödvändiga filer i utvecklingsprojektet. Om du skapar ett klientprogram med Java, inkluderar du de JAR-filer som behövs. Om du använder webbtjänster måste du ta med proxyfilerna.
Följande JAR-filer måste läggas till i projektets klasssökväg:
- adobe-livecycle-client.jar
- adobe-usermanager-client.jar
- adobe-utilities.jar (krävs om AEM Forms körs på JBoss Application Server)
- jbossall-client.jar (krävs om AEM Forms körs på JBoss Application Server)
Dessa JAR-filer krävs för att skapa en SOAP-slutpunkt. Du behöver emellertid ytterligare JAR-filer om du använder SOAP-slutpunkten för att anropa tjänsten. Mer information om AEM Forms JAR-filer finns i Inkludera AEM Forms Java-biblioteksfiler.
Skapa ett EndpointRegistry-klientobjekt
Om du vill lägga till en SOAP-slutpunkt i en tjänst med programkod måste du skapa en EndpointRegistryClient
-objekt.
Ange SOAP-slutpunktsattribut
Om du vill lägga till en SOAP-slutpunkt till en tjänst anger du följande värden:
- Identifieringsvärde för koppling: Anger vilken typ av slutpunkt som ska skapas. Om du vill skapa en SOAP-slutpunkt anger du
SOAP
. - Beskrivning: Anger slutpunktsbeskrivningen.
- Namn: Anger slutpunktens namn.
- Tjänstidentifierarvärde: Anger den tjänst som slutpunkten tillhör.
- Åtgärdsnamn: Anger namnet på åtgärden som anropas med slutpunkten. När du skapar en SOAP-slutpunkt anger du ett jokertecken (
*
). Om du vill ange en viss åtgärd i stället för att anropa alla tjänståtgärder, anger du åtgärdens namn i stället för att använda jokertecknet (*
).
Skapa en SOAP-slutpunkt
När du har angett SOAP-slutpunktsattribut kan du skapa en SOAP-slutpunkt.
Aktivera slutpunkten
När du har skapat en slutpunkt måste du aktivera den. När slutpunkten är aktiverad kan den användas för att anropa tjänsten. När du har aktiverat slutpunkten kan du visa den i administrationskonsolen.
Se även
Lägga till en SOAP-slutpunkt med Java API
Inkludera AEM Forms Java-biblioteksfiler
Lägga till en SOAP-slutpunkt med Java API add-a-soap-endpoint-using-the-java-api
Lägg till en SOAP-slutpunkt till en tjänst med hjälp av Java API:
-
Inkludera projektfiler.
Inkludera JAR-klientfiler, t.ex. adobe-livecycle-client.jar, i Java-projektets klassökväg.
-
Skapa ett EndpointRegistry-klientobjekt.
- Skapa en
ServiceClientFactory
objekt som innehåller anslutningsegenskaper. - Skapa en
EndpointRegistryClient
genom att använda konstruktorn och skickaServiceClientFactory
-objekt.
- Skapa en
-
Ange SOAP-slutpunktsattribut.
- Skapa en
CreateEndpointInfo
genom att använda dess konstruktor. - Ange anslutnings-ID-värdet genom att anropa
CreateEndpointInfo
objektetssetConnectorId
metoden och skicka strängvärdetSOAP
. - Ange beskrivningen av slutpunkten genom att anropa
CreateEndpointInfo
objektetssetDescription
och skickar ett strängvärde som beskriver slutpunkten. - Ange slutpunktens namn genom att anropa
CreateEndpointInfo
objektetssetName
och skickar ett strängvärde som anger namnet. - Ange tjänsten som slutpunkten tillhör genom att anropa
CreateEndpointInfo
objektetssetServiceId
och skickar ett strängvärde som anger tjänstnamnet. - Ange åtgärden som anropas genom att anropa
CreateEndpointInfo
objektetssetOperationName
och skickar ett strängvärde som anger åtgärdens namn. För SOAP- och EJB-slutpunkter anger du ett jokertecken (*
), vilket betyder alla operationer.
- Skapa en
-
Skapa en SOAP-slutpunkt.
Skapa slutpunkten genom att starta
EndpointRegistryClient
objektetscreateEndpoint
metoden och skickaCreateEndpointInfo
-objekt. Den här metoden returnerar enEndpoint
objekt som representerar den nya SOAP-slutpunkten. -
Aktivera slutpunkten.
Aktivera slutpunkten genom att anropa
EndpointRegistryClient
objektets enable-metod och skickaEndpoint
objekt som returneras avcreateEndpoint
-metod.
Se även
QuickStart: Lägga till en SOAP-slutpunkt med Java API
Inkludera AEM Forms Java-biblioteksfiler
Lägga till bevakade mappslutpunkter adding-watched-folder-endpoints
Du kan programmässigt lägga till en bevakad mappslutpunkt till en tjänst med hjälp av AEM Forms Java API. Genom att lägga till en bevakad mappslutpunkt kan användare placera en fil (till exempel en PDF-fil) i en mapp. När filen placeras i mappen anropas den konfigurerade tjänsten och filen ändras. När tjänsten har utfört den angivna åtgärden sparas den ändrade filen i en angiven utdatamapp. En bevakad mapp är konfigurerad för att skannas med ett fast intervall eller med ett cron-schema, till exempel varje måndag, onsdag och fredag vid tolv.
Om du vill lägga till en övervakad mappslutpunkt i en tjänst med programkod bör du överväga följande kortlivade process med namnet EncryptDocument. (Se Förstå AEM Forms processer.)
I den här processen accepteras ett oskyddat PDF-dokument som ett indatavärde och det oskyddade PDF-dokumentet skickas sedan till krypteringstjänstens EncryptPDFUsingPassword
operation. PDF-dokumentet krypteras med ett lösenord och det lösenordskrypterade PDF-dokumentet är utdatavärdet för den här processen. Namnet på indatavärdet (det oskyddade PDF-dokumentet) är InDoc
och datatypen är com.adobe.idp.Document
. Namnet på utdatavärdet (det lösenordskrypterade PDF-dokumentet) är SecuredDoc
och datatypen är com.adobe.idp.Document
.
Sammanfattning av steg summary_of_steps-2
Utför följande åtgärder om du vill lägga till en bevakad mappslutpunkt i en tjänst:
- Inkludera projektfiler.
- Skapa en
EndpointRegistryClient
-objekt. - Ange slutpunktsattribut för bevakad mapp.
- Ange konfigurationsvärden.
- Definiera indataparametervärden.
- Definiera ett utdataparametervärde.
- Skapa en bevakad mappslutpunkt.
- Aktivera slutpunkten.
Inkludera projektfiler
Inkludera nödvändiga filer i utvecklingsprojektet. Om du skapar ett klientprogram med Java, inkluderar du de JAR-filer som behövs. Om du använder webbtjänster måste du ta med proxyfilerna.
Följande JAR-filer måste läggas till i projektets klasssökväg:
- adobe-livecycle-client.jar
- adobe-usermanager-client.jar
- adobe-utilities.jar (krävs om AEM Forms körs på JBoss Application Server)
- jbossall-client.jar (krävs om AEM Forms körs på JBoss Application Server)
Mer information om var dessa JAR-filer finns i Inkludera AEM Forms Java-biblioteksfiler.
Skapa ett EndpointRegistry-klientobjekt
Om du vill lägga till en bevakad mappslutpunkt med programkod måste du skapa en EndpointRegistryClient
-objekt.
Ange slutpunktsattribut för bevakad mapp
Om du vill skapa en bevakad mappslutpunkt för en tjänst anger du följande värden:
- Kopplingsidentifierare: Anger den typ av slutpunkt som skapas. Om du vill skapa en bevakad mappslutpunkt anger du
WatchedFolder
. - Beskrivning: Anger slutpunktens beskrivning.
- Namn: Anger slutpunktens namn.
- Tjänstidentifierare: Anger den tjänst som slutpunkten tillhör. Om du till exempel vill lägga till en bevakad mappslutpunkt i processen som introduceras i det här avsnittet (en process blir en tjänst när den aktiveras med Workbench) anger du
EncryptDocument
. - Åtgärdsnamn: Anger namnet på åtgärden som anropas med slutpunkten. När du skapar en bevakad mappslutpunkt för en tjänst som kommer från en process som har skapats i Workbench, är namnet på åtgärden vanligtvis
invoke
.
Ange konfigurationsvärden
Ange konfigurationsvärden för en bevakad mappslutpunkt när du programmässigt lägger till en bevakad mappslutpunkt till en tjänst. Dessa konfigurationsvärden anges av en administratör om en bevakad mappslutpunkt läggs till med administrationskonsolen.
Följande lista anger konfigurationsvärden som anges när en bevakad mappslutpunkt läggs till i en tjänst via programmering:
- url: Anger platsen för bevakad mapp. I en klustrad miljö måste det här värdet peka på en delad nätverksmapp som är tillgänglig från alla datorer i klustret.
- asynkron: Identifierar anropstypen som asynkron eller synkron. Övergående och synkrona processer kan bara anropas synkront. Standardvärdet är true. Asynkron rekommenderas.
- cronExpression: Används av kvarts för att schemalägga avsökningen av indatakatalogen.
- purgeDuration: Detta är ett obligatoriskt attribut. Filer och mappar i resultatmappen tas bort när de är äldre än det här värdet. Detta värde mäts i dagar. Det här attributet är användbart för att säkerställa att resultatmappen inte blir full. Värdet -1 dagar anger att resultatmappen aldrig ska tas bort. Standardvärdet är -1.
- repeatInterval: Intervallet, i sekunder, för inläsning av den bevakade mappen. Om inte strypning är aktiverat bör det här värdet vara längre än tiden för att bearbeta ett genomsnittligt jobb. Annars kan systemet bli överbelastat. Standardvärdet är 5.
- repeatCount: Antal gånger en bevakad mapp genomsöker mappen eller katalogen. Värdet -1 anger oändlig skanning. Standardvärdet är -1.
- strypningPå: Begränsar antalet övervakade mappjobb som kan bearbetas vid en given tidpunkt. Det maximala antalet jobb bestäms av batchSize-värdet.
- userName: Det användarnamn som används när en måltjänst anropas från den bevakade mappen. Detta värde är obligatoriskt. Standardvärdet är SuperAdmin.
- domainName: Användarens domän. Detta värde är obligatoriskt. Standardvärdet är DefaultDom.
- batchSize: Antalet filer eller mappar som ska hämtas per skanning. Använd det här värdet om du vill förhindra överbelastning på datorn. Om du skannar för många filer samtidigt kan det resultera i en krasch. Standardvärdet är 2.
- waitTime: Den tid i millisekunder som du vill vänta innan du skannar en mapp eller fil efter att den har skapats. Om väntetiden t.ex. är 36 000 000 millisekunder (en timme) och filen skapades för en minut sedan, hämtas den här filen när 59 eller fler minuter har gått. Det här attributet är användbart för att säkerställa att en fil eller mapp kopieras helt till indatamappen. Om du till exempel har en stor fil att bearbeta och det tar tio minuter att hämta filen, ställer du in väntetiden på 10*60 *1 000 millisekunder. Den här inställningen förhindrar att den bevakade mappen skannar filen om den inte har väntat i tio minuter. Standardvärdet är 0.
- excludeFilePattern: Det mönster som en bevakad mapp använder för att avgöra vilka filer och mappar som ska sökas igenom och plockas upp. Filer eller mappar med det här mönstret skannas inte för bearbetning. Den här inställningen är användbar när indata är en mapp som innehåller flera filer. Innehållet i mappen kan kopieras till en mapp som har ett namn som kommer att hämtas av den bevakade mappen. Det här steget förhindrar att den bevakade mappen hämtar en mapp för bearbetning innan mappen kopieras helt till indatamappen. Om värdet excludeFilePattern till exempel är
data*
, alla filer och mappar som matchardata*
har inte hämtats. Detta inkluderar filer och mappar med namndata1
,data2
och så vidare. Dessutom kan mönstret kompletteras med jokertecken för att ange filmönster. Den bevakade mappen ändrar det reguljära uttrycket så att det stöder jokerteckenmönster som*.*
och*.pdf
. Dessa mönster med jokertecken stöds inte av reguljära uttryck. - includeFilePattern: Det mönster som den bevakade mappen använder för att avgöra vilka mappar och filer som ska sökas igenom och hämtas. Om värdet till exempel är
*
, alla filer och mappar som matcharinput*
plockas upp. Detta inkluderar filer och mappar med namninput1
,input2
och så vidare. Standardvärdet är*
. Detta värde anger alla filer och mappar. Dessutom kan mönstret kompletteras med jokertecken för att ange filmönster. Den bevakade mappen ändrar det reguljära uttrycket så att det stöder jokerteckenmönster som*.*
och*.pdf
. Dessa mönster med jokertecken stöds inte av reguljära uttryck. Detta värde är obligatoriskt. - resultFolderName: Mappen där de sparade resultaten lagras. Platsen kan vara en absolut eller relativ katalogsökväg. Om resultaten inte visas i den här mappen kontrollerar du felmappen. Skrivskyddade filer bearbetas inte och sparas i felmappen. Standardvärdet är
result/%Y/%M/%D/
. Det här är resultatmappen i den bevakade mappen. - preserveFolderName: Den plats där filerna lagras efter att sökningen och hämtningen har slutförts. Den här platsen kan vara en absolut, relativ eller en null-katalogsökväg. Standardvärdet är
preserve/%Y/%M/%D/
. - errorFolderName: Mappen där felfiler sparas. Den här platsen är alltid relativ till den bevakade mappen. Skrivskyddade filer bearbetas inte och sparas i felmappen. Standardvärdet är
failure/%Y/%M/%D/
. - preserveOnFailure: Bevara indatafiler om det inte går att köra åtgärden på en tjänst. Standardvärdet är true.
- overwriteDuplicateFilename: Om true skrivs filerna i resultatmappen och i den bevarade mappen över. Om värdet är false används filer och mappar med ett numeriskt indexsuffix som namn. Standardvärdet är false.
Definiera indataparametervärden
När du skapar en bevakad mappslutpunkt måste du definiera värden för indataparametrar. Du måste alltså beskriva indatavärdena som skickas till åtgärden som anropas av den bevakade mappen. Ta till exempel en titt på processen som introducerades i det här avsnittet. Den har ett indatavärde med namnet InDoc
och dess datatyp är com.adobe.idp.Document
. När du skapar en bevakad mappslutpunkt för den här processen (när en process har aktiverats blir den en tjänst) måste du definiera värdet för indataparametern.
Om du vill definiera indataparametervärden som krävs för en bevakad mappslutpunkt anger du följande värden:
Namn på indataparameter: Namnet på indataparametern. Namnet på ett indatavärde anges i Workbench för en process. Om indatavärdet tillhör en tjänståtgärd (en tjänst som inte är en process som har skapats i Workbench) anges indatanamnet i filen component.xml. Namnet på indataparametern för processen som introduceras i det här avsnittet är till exempel InDoc
.
Mappningstyp: Används för att konfigurera de indatavärden som krävs för att anropa tjänståtgärden. Det finns två typer av mappningar:
Literal
: Slutpunkten för bevakad mapp använder det värde som anges i fältet när det visas. Alla grundläggande Java-typer stöds. Om ett API till exempel använder indata som String, long, int och Boolean, konverteras strängen till rätt typ och tjänsten anropas.Variable
: Det angivna värdet är ett filmönster som den bevakade mappen använder för att välja indata. Om du till exempel väljer Variabel som mappningstyp och indatadokumentet måste vara en PDF-fil, kan du ange*.pdf
som mappningsvärde.
Mappningsvärde: Anger värdet för mappningstypen. Om du till exempel väljer en Variable
mappningstyp, du kan ange *.pdf
som filmönstret.
Datatyp: Anger datatypen för indatavärdena. Datatypen för indatavärdet för processen som introduceras i det här avsnittet är com.adobe.idp.Document
.
Definiera ett utdataparametervärde
När du skapar en bevakad mappslutpunkt måste du definiera ett utdataparametervärde. Det innebär att du måste beskriva utdatavärdet som returneras av tjänsten som anropas av slutpunkten för bevakad mapp. Ta till exempel en titt på processen som introducerades i det här avsnittet. Den har ett utdatavärde med namnet SecuredDoc
och dess datatyp är com.adobe.idp.Document
. När du skapar en bevakad mappslutpunkt för den här processen (när en process har aktiverats blir den en tjänst) måste du definiera parametervärdet för utdata.
Om du vill definiera ett utdataparametervärde som krävs för en bevakad mappslutpunkt anger du följande värden:
Namn på utdataparameter: Namnet på utdataparametern. Namnet på ett processutdatavärde anges i Workbench. Om utdatavärdet tillhör en tjänståtgärd (en tjänst som inte är en process som har skapats i Workbench) anges utdatanamnet i filen component.xml. Namnet på utdataparametern för processen som introduceras i det här avsnittet är till exempel SecuredDoc
.
Mappningstyp: Används för att konfigurera utdata för tjänsten och åtgärden. Följande alternativ är tillgängliga:
- Om tjänsten returnerar ett enstaka objekt (ett enstaka dokument) är mönstret
%F.pdf
och källmålet är sourceFilename.pdf. Processen som introducerades i det här avsnittet returnerar till exempel ett enstaka dokument. Därför kan mappningstypen definieras som%F.pdf
(%F
använder det angivna filnamnet). Mönstret%E
Anger tillägget för indatadokumentet. - Om tjänsten returnerar en lista är mönstret
Result\%F\
och källmålet är Result\sourcefilename\source1 (output 1) och Result\sourcefilename\source2 (output 2). - Om tjänsten returnerar en karta är mönstret
Result\%F\
och källmålet är Result\sourcefilename\file1 och Result\sourcefilename\file2. Om kartan innehåller mer än ett objekt är mönstretResult\%F.pdf
och källmålet är Result\sourcefilename1.pdf (output 1), Result\sourcefilenam2.pdf (output 2) osv.
Datatyp: Anger datatypen för returvärdet. Datatypen för returvärdet för processen som introducerades i det här avsnittet är com.adobe.idp.Document
.
Skapa en bevakad mappslutpunkt
När du har angett slutpunktens attribut, konfigurationsvärden och definierat in- och utdataparametervärden måste du skapa slutpunkten för den bevakade mappen.
Aktivera slutpunkten
När du har skapat en bevakad mappslutpunkt måste du aktivera den. När slutpunkten är aktiverad kan den användas för att anropa tjänsten. När du har aktiverat slutpunkten kan du visa den i administrationskonsolen.
Se även
Lägga till en bevakad mappslutpunkt med Java API
Inkludera AEM Forms Java-biblioteksfiler
Lägga till en bevakad mappslutpunkt med Java API add-a-watched-folder-endpoint-using-the-java-api
Lägg till en bevakad mappslutpunkt med AEM Forms Java API:
-
Inkludera projektfiler.
Inkludera JAR-klientfiler, t.ex. adobe-livecycle-client.jar, i Java-projektets klassökväg.
-
Skapa ett EndpointRegistry-klientobjekt.
- Skapa en
ServiceClientFactory
objekt som innehåller anslutningsegenskaper. - Skapa en
EndpointRegistryClient
genom att använda konstruktorn och skickaServiceClientFactory
-objekt.
- Skapa en
-
Ange slutpunktsattribut för bevakad mapp.
- Skapa en
CreateEndpointInfo
genom att använda dess konstruktor. - Ange anslutnings-ID-värdet genom att anropa
CreateEndpointInfo
objektetssetConnectorId
metoden och skicka strängvärdetWatchedFolder
. - Ange beskrivningen av slutpunkten genom att anropa
CreateEndpointInfo
objektetssetDescription
och skickar ett strängvärde som beskriver slutpunkten. - Ange slutpunktens namn genom att anropa
CreateEndpointInfo
objektetssetName
och skickar ett strängvärde som anger namnet. - Ange tjänsten som slutpunkten tillhör genom att anropa
CreateEndpointInfo
objektetssetServiceId
och skickar ett strängvärde som anger tjänstnamnet. - Ange åtgärden som anropas genom att anropa
CreateEndpointInfo
objektetssetOperationName
och skickar ett strängvärde som anger åtgärdens namn. När du skapar en bevakad mappslutpunkt för en tjänst som kommer från en process som skapats i Workbench anropas vanligtvis åtgärdens namn.
- Skapa en
-
Ange konfigurationsvärden.
För varje konfigurationsvärde som ska anges för slutpunkten för bevakad mapp måste du anropa
CreateEndpointInfo
objektetssetConfigParameterAsText
-metod. För att till exempel ställa inurl
konfigurationsvärde, anropaCreateEndpointInfo
objektetssetConfigParameterAsText
och skicka följande strängvärden:- Ett strängvärde som anger namnet på konfigurationsvärdet. När du anger
url
konfigurationsvärde, angeurl
. - Ett strängvärde som anger värdet för konfigurationsvärdet. När du anger
url
konfigurationsvärde, anger platsen för bevakad mapp.
note note NOTE Om du vill se alla konfigurationsvärden som angetts för EncryptDocument-tjänsten kan du läsa Java-kodexemplet som finns på QuickStart: Lägga till en bevakad mappslutpunkt med Java API. - Ett strängvärde som anger namnet på konfigurationsvärdet. När du anger
-
Definiera indataparametervärden.
Definiera ett indataparametervärde genom att anropa
CreateEndpointInfo
objektetssetInputParameterMapping
och skicka följande värden:- Ett strängvärde som anger namnet på indataparametern. Namnet på indataparametern för EncryptDocument-tjänsten är
InDoc
. - Ett strängvärde som anger datatypen för indataparametern. Datatypen för
InDoc
indataparametern ärcom.adobe.idp.Document
. - Ett strängvärde som anger mappningstypen. Du kan till exempel ange
variable
. - Ett strängvärde som anger mappningstypsvärdet. Du kan till exempel ange *.pdf som filmönster.
note note NOTE Anropa setInputParameterMapping
metod för varje indataparametervärde som ska definieras. Eftersom EncryptDocument-processen bara har en indataparameter, måste du anropa den här metoden en gång. - Ett strängvärde som anger namnet på indataparametern. Namnet på indataparametern för EncryptDocument-tjänsten är
-
Definiera ett utdataparametervärde.
Definiera ett utdataparametervärde genom att anropa
CreateEndpointInfo
objektetssetOutputParameterMapping
och skicka följande värden:- Ett strängvärde som anger namnet på utdataparametern. Namnet på utdataparametern för EncryptDocument-tjänsten är till exempel
SecuredDoc
. - Ett strängvärde som anger datatypen för utdataparametern. Datatypen för
SecuredDoc
output-parametern ärcom.adobe.idp.Document
. - Ett strängvärde som anger mappningstypen. Du kan till exempel ange
%F.pdf
.
- Ett strängvärde som anger namnet på utdataparametern. Namnet på utdataparametern för EncryptDocument-tjänsten är till exempel
-
Skapa en bevakad mappslutpunkt.
Skapa slutpunkten genom att starta
EndpointRegistryClient
objektetscreateEndpoint
metoden och skickaCreateEndpointInfo
-objekt. Den här metoden returnerar enEndpoint
som representerar den bevakade mappens slutpunkt. -
Aktivera slutpunkten.
Aktivera slutpunkten genom att anropa
EndpointRegistryClient
objektetsenable
metoden och skickaEndpoint
objekt som returneras avcreateEndpoint
-metod.
Se även
QuickStart: Lägga till en bevakad mappslutpunkt med Java API
Inkludera AEM Forms Java-biblioteksfiler
Konstanta filer för mappkonfigurationsvärden som bevakas watched-folder-configuration-values-constant-file
The QuickStart: Lägga till en bevakad mappslutpunkt med Java API använder en konstant fil som måste ingå i Java-projektet för att kompilera snabbstarten. Den här konstanta filen representerar konfigurationsvärden som måste anges när du lägger till en bevakad mappslutpunkt. Följande Java-kod representerar den konstanta filen.
/**
* This class contains constants that can be used when setting Watched Folder
* configuration values
*/
public final class WatchedFolderEndpointConfigConstants {
public static final String PROPERTY_FILEPROVIDER_URL = "url";
public static final String PROPERTY_PROPERTY_ASYNCHRONOUS = "asynchronous";
public static final String PROPERTY_CRON_EXPRESSION = "cronExpression";
public static final String PROPERTY_PURGE_DURATION = "purgeDuration";
public static final String PROPERTY_REPEAT_INTERVAL = "repeatInterval";
public static final String PROPERTY_REPEAT_COUNT = "repeatCount";
public static final String PROPERTY_THROTTLE = "throttleOn";
public static final String PROPERTY_USERNAMER = "userName";
public static final String PROPERTY_DOMAINNAME = "domainName";
public static final String PROPERTY_FILEPROVIDER_BATCH_SIZE = "batchSize";
public static final String PROPERTY_FILEPROVIDER_WAIT_TIME = "waitTime";
public static final String PROPERTY_EXCLUDE_FILE_PATTERN = "excludeFilePattern";
public static final String PROPERTY_INCLUDE_FILE_PATTERN = "excludeFilePattern";
public static final String PROPERTY_FILEPROVIDER_RESULT_FOLDER_NAME = "resultFolderName";
public static final String PROPERTY_FILEPROVIDER_PRESERVE_FOLDER_NAME = "preserveFolderName";
public static final String PROPERTY_FILEPROVIDER_FAILURE_FOLDER_NAME = "failureFolderName";
public static final String PROPERTY_FILEPROVIDER_PRESERVE_ON_FAILURE = "preserveOnFailure";
public static final String PROPERTY_FILEPROVIDER_OVERWRITE_DUPLICATE_FILENAME = "overwriteDuplicateFilename";
}
Lägga till e-postslutpunkter adding-email-endpoints
Du kan programmässigt lägga till en e-postslutpunkt till en tjänst med AEM Forms Java API. Genom att lägga till en e-postslutpunkt kan du göra det möjligt för användare att skicka ett e-postmeddelande med en eller flera bifogade filer till ett angivet e-postkonto. Sedan anropas åtgärden för konfigurationstjänsten och filerna ändras. När tjänsten har utfört den angivna åtgärden skickas ett e-postmeddelande till avsändaren med de ändrade filerna som bifogade filer.
Om du vill lägga till en e-postslutpunkt i en tjänst programmatiskt bör du överväga följande kortlivade process med namnet MyApplication\EncryptDocument. Mer information om kortvariga processer finns i Förstå AEM Forms processer.
I den här processen accepteras ett oskyddat PDF-dokument som ett indatavärde och det oskyddade PDF-dokumentet skickas sedan till krypteringstjänstens EncryptPDFUsingPassword
operation. Den här processen krypterar PDF-dokumentet med ett lösenord och returnerar det lösenordskrypterade PDF-dokumentet som utdatavärde. Namnet på indatavärdet (det oskyddade PDF-dokumentet) är InDoc
och datatypen är com.adobe.idp.Document
. Namnet på utdatavärdet (det lösenordskrypterade PDF-dokumentet) är SecuredDoc
och datatypen är com.adobe.idp.Document
.
Sammanfattning av steg summary_of_steps-3
Gör så här om du vill lägga till en e-postslutpunkt till en tjänst:
- Inkludera projektfiler.
- Skapa en
EndpointRegistryClient
-objekt. - Ange slutpunktsattribut för e-post.
- Ange konfigurationsvärden.
- Definiera indataparametervärden.
- Definiera ett utdataparametervärde.
- Skapa e-postslutpunkten.
- Aktivera slutpunkten.
Inkludera projektfiler
Inkludera nödvändiga filer i utvecklingsprojektet. Om du skapar ett klientprogram med Java, inkluderar du de JAR-filer som behövs. Om du använder webbtjänster måste du ta med proxyfilerna.
Följande JAR-filer måste läggas till i projektets klasssökväg:
- adobe-livecycle-client.jar
- adobe-usermanager-client.jar
- adobe-utilities.jar (krävs om AEM Forms körs på JBoss Application Server)
- jbossall-client.jar (krävs om AEM Forms körs på JBoss Application Server)
Mer information om var dessa JAR-filer finns i Inkludera AEM Forms Java-biblioteksfiler.
Skapa ett EndpointRegistry-klientobjekt
Innan du kan lägga till en e-postslutpunkt med programkod måste du skapa en EndpointRegistryClient
-objekt.
Ange slutpunktsattribut för e-post
Om du vill skapa en e-postslutpunkt för en tjänst anger du följande värden:
- Identifieringsvärde för koppling: Anger den typ av slutpunkt som skapas. Om du vill skapa en e-postslutpunkt anger du
Email
. - Beskrivning: Anger en beskrivning för slutpunkten.
- Namn: Anger slutpunktens namn.
- Tjänstidentifierarvärde: Anger den tjänst som slutpunkten tillhör. Om du till exempel vill lägga till en e-postslutpunkt i processen som introduceras i det här avsnittet (en process blir en tjänst när den aktiveras med Workbench) anger du
EncryptDocument
. - Åtgärdsnamn: Anger namnet på åtgärden som anropas med slutpunkten. När du skapar en e-postslutpunkt för en tjänst som kommer från en process som har skapats i Workbench är namnet på åtgärden vanligtvis
invoke
.
Ange konfigurationsvärden
Ange konfigurationsvärden för en e-postslutpunkt när du programmässigt lägger till en e-postslutpunkt till en tjänst. Dessa konfigurationsvärden anges av en administratör om en e-postslutpunkt läggs till med administrationskonsolen.
Följande konfigurationsvärden ställs in när en e-postslutpunkt läggs till i en tjänst via programmering:
- cronExpression: Ett cron-uttryck om e-postmeddelandet måste schemaläggas med ett cron-uttryck.
- repeatCount: Antal gånger som e-postslutpunkten skannar mappen eller katalogen. Värdet -1 anger oändlig skanning. Standardvärdet är -1.
- repeatInterval: Skanningsfrekvensen i sekunder som mottagaren använder för att kontrollera inkommande e-post. Standardvärdet är 10.
- startDelay: Den tid det tar att vänta på genomsökningen efter att schemaläggaren har startats. Standardtiden är 0.
- batchSize: Antalet e-postmeddelanden som mottagaren bearbetar per sökning för optimala prestanda. Värdet -1 anger alla e-postmeddelanden. Standardvärdet är 2.
- userName: Det användarnamn som används när en måltjänst anropas från e-post. Standardvärdet är
SuperAdmin
. - domainName: Ett obligatoriskt konfigurationsvärde. Standardvärdet är
DefaultDom
. - domainPattern: Anger domänmönster för inkommande e-post som accepteras av providern. Om
adobe.com
används, endast e-post från adobe.com behandlas, e-post från andra domäner ignoreras. - filePattern: Anger inkommande mönster för bifogade filer som accepteras av providern. Detta inkluderar filer som har specifika filnamnstillägg (*.dat, *.xml), filer som har specifika namn (data) och filer som har sammansatta uttryck i namn och filnamnstillägg (*).[dD][aA]port). Standardvärdet är
*
. - receiveSuccessfulJob: En e-postadress dit meddelanden skickas för att ange slutförda jobb. Som standard skickas alltid ett meddelande om att jobbet lyckades till avsändaren. Om du skriver
sender
, skickas e-postresultat till avsändaren. Stöd för upp till 100 mottagare. Ange ytterligare mottagare med e-postadresser, där var och en avgränsas med kommatecken. Om du vill inaktivera det här alternativet lämnar du det här värdet tomt. I vissa fall kanske du vill utlösa en process och inte skicka ett e-postmeddelande om resultatet. Standardvärdet ärsender
. - receiveFailedJob: En e-postadress dit meddelanden skickas för att ange misslyckade jobb. Som standard skickas alltid ett meddelande om misslyckat jobb till avsändaren. Om du skriver
sender
, skickas e-postresultat till avsändaren. Stöd för upp till 100 mottagare. Ange ytterligare mottagare med e-postadresser, där var och en avgränsas med kommatecken. Om du vill inaktivera det här alternativet lämnar du det här värdet tomt. Standardvärdet ärsender
. - inboxHost: Inkorgens värdnamn eller IP-adress som e-postprovidern ska skanna.
- inboxPort: Den port som e-postservern använder. Standardvärdet för POP3 är 110 och standardvärdet för IMAP är 143. Om SSL är aktiverat är standardvärdet för POP3 995 och standardvärdet för IMAP är 993.
- inboxProtocol: E-postprotokollet för e-postslutpunkten som ska användas för att skanna inkorgen. Alternativen är
IMAP
ellerPOP3
. Inkorgens värdserver för e-post måste stödja dessa protokoll. - inboxTimeOut: Tidsgräns i sekunder för att e-postprovidern ska vänta på inkorgssvar. Standardvärdet är 60.
- inboxUser: Det användarnamn som krävs för att logga in på e-postkontot. Beroende på e-postservern och konfigurationen kan det här endast vara användarnamnsdelen i e-postmeddelandet eller den fullständiga e-postadressen.
- inboxPassword: Lösenordet för inkorgsanvändaren.
- inboxSSLEnabled: Ange det här värdet för att tvinga e-postleverantören att använda SSL när meddelanden om resultat eller fel skickas. Kontrollera att IMAP- eller POP3-värden har stöd för SSL.
- smtpHost: Värdnamnet på den e-postserver som e-postleverantören skickar resultat och felmeddelanden till.
- smtpPort: Standardvärdet för SMTP-porten är 25.
- smtpUser: Användarkontot som e-postleverantören ska använda när den skickar e-postmeddelanden om resultat och fel.
- smtpPassword: Lösenordet för SMTP-kontot. Vissa e-postservrar kräver inget SMTP-lösenord.
- charSet: Den teckenuppsättning som används av e-postleverantören. Standardvärdet är
UTF-8
. - smtpSSLEnabled: Ange det här värdet för att tvinga e-postleverantören att använda SSL när meddelanden om resultat eller fel skickas. Kontrollera att SMTP-värden stöder SSL.
- failedJobFolder: Anger en katalog där resultat ska lagras när SMTP-e-postservern inte är i drift.
- asynkron: När det är synkront bearbetas alla indatadokument och ett svar returneras. När inställningen är asynkron skickas ett svar för varje indatadokument som bearbetas. En e-postslutpunkt skapas till exempel för den process som introduceras i det här avsnittet, och ett e-postmeddelande skickas till slutpunktens inkorg som innehåller flera oskyddade PDF-dokument. När alla PDF-dokument har krypterats med ett lösenord, och om slutpunkten har konfigurerats som synkron, skickas ett enda e-postmeddelande med alla säkra PDF-dokument bifogade. Om slutpunkten är konfigurerad som asynkron skickas ett separat e-postmeddelande för svar för varje skyddat PDF-dokument. Varje e-postmeddelande innehåller ett enda dokument i PDF som en bifogad fil. Standardvärdet är asynkront.
Definiera indataparametervärden
När du skapar en e-postslutpunkt måste du definiera indataparametervärden. Det innebär att du måste beskriva indatavärdena som skickas till åtgärden som anropas av e-postslutpunkten. Ta till exempel en titt på processen som introducerades i det här avsnittet. Den har ett indatavärde med namnet InDoc
och dess datatyp är com.adobe.idp.Document
. När du skapar en e-postslutpunkt för den här processen (när en process har aktiverats blir den en tjänst) måste du definiera indataparametervärdet.
Om du vill definiera indataparametervärden som krävs för en e-postslutpunkt anger du följande värden:
Namn på indataparameter: Namnet på indataparametern. Namnet på ett indatavärde anges i Workbench för en process. Om indatavärdet tillhör en tjänståtgärd (en Forms-tjänst som inte är en process som har skapats i Workbench) anges indatanamnet i filen component.xml. Namnet på indataparametern för processen som introduceras i det här avsnittet är till exempel InDoc
.
Mappningstyp: Används för att konfigurera de indatavärden som krävs för att anropa tjänståtgärden. Två typer av mappningar är:
Literal
: Slutpunkten för e-post använder det värde som anges i fältet när det visas. Alla grundläggande Java-typer stöds. Om ett API till exempel använder indata som String, long, int och Boolean, konverteras strängen till rätt typ och tjänsten anropas.Variable
: Det angivna värdet är ett filmönster som e-postslutpunkten använder för att välja indata. Om du till exempel väljer Variabel som mappningstyp och indatadokumentet måste vara en PDF-fil, kan du ange*.pdf
som mappningsvärde.
Mappningsvärde: Anger värdet för mappningstypen. Om du till exempel väljer en typ av variabelmappning kan du ange *.pdf
som filmönstret.
Datatyp: Anger datatypen för indatavärdena. Datatypen för indatavärdet för processen som introduceras i det här avsnittet är till exempel com.adobe.idp.Document.
Definiera ett utdataparametervärde
När du skapar en e-postslutpunkt måste du definiera ett utdataparametervärde. Det innebär att du måste beskriva det utdatavärde som returneras av tjänsten som anropas av e-postslutpunkten. Ta till exempel en titt på processen som introducerades i det här avsnittet. Den har ett utdatavärde med namnet SecuredDoc
och dess datatyp är com.adobe.idp.Document
. När du skapar en e-postslutpunkt för den här processen (när en process har aktiverats blir den en tjänst) måste du definiera parametervärdet för utdata.
Om du vill definiera ett utdataparametervärde som krävs för en e-postslutpunkt anger du följande värden:
Namn på utdataparameter: Namnet på utdataparametern. Namnet på ett processutdatavärde anges i Workbench. Om utdatavärdet tillhör en tjänståtgärd (en tjänst som inte är en process som har skapats i Workbench) anges utdatanamnet i filen component.xml. Namnet på utdataparametern för processen som introduceras i det här avsnittet är till exempel SecuredDoc
.
Mappningstyp: Används för att konfigurera utdata för tjänsten och åtgärden. Följande alternativ är tillgängliga:
- Om tjänsten returnerar ett enstaka objekt (ett enstaka dokument) är mönstret
%F.pdf
och källmålet är sourceFilename.pdf. Processen som introducerades i det här avsnittet returnerar till exempel ett enstaka dokument. Därför kan mappningstypen definieras som%F.pdf
(%F
använder det angivna filnamnet). Mönstret%E
Anger tillägget för indatadokumentet. - Om tjänsten returnerar en lista är mönstret
Result\%F\
och källmålet är Result\sourcefilename\source1 (output 1) och Result\sourcefilename\source2 (output 2). - Om tjänsten returnerar en karta är mönstret
Result\%F\
och källmålet är Result\sourcefilename\file1 och Result\sourcefilename\file2. Om kartan innehåller mer än ett objekt är mönstretResult\%F.pdf
och källmålet är Result\sourcefilename1.pdf (output 1), Result\sourcefilenam2.pdf (output 2) osv.
Datatyp: Anger datatypen för returvärdet. Datatypen för returvärdet för processen som introducerades i det här avsnittet är com.adobe.idp.Document
.
Skapa e-postslutpunkten
När du har angett attribut och konfigurationsvärden för e-postslutpunkten och angett in- och utdataparametervärden måste du skapa e-postslutpunkten.
Aktivera slutpunkten
När du har skapat en e-postslutpunkt måste du aktivera den. När slutpunkten är aktiverad kan den användas för att anropa tjänsten. När du har aktiverat slutpunkten kan du visa den i administrationskonsolen.
Se även
Lägga till en e-postslutpunkt med Java API
Inkludera AEM Forms Java-biblioteksfiler
Lägga till en e-postslutpunkt med Java API add-an-email-endpoint-using-the-java-api
Lägg till en e-postslutpunkt med Java API:
-
Inkludera projektfiler.
Inkludera JAR-klientfiler, t.ex. adobe-livecycle-client.jar, i Java-projektets klassökväg.
-
Skapa ett EndpointRegistry-klientobjekt.
- Skapa en
ServiceClientFactory
objekt som innehåller anslutningsegenskaper. - Skapa en
EndpointRegistryClient
genom att använda konstruktorn och skickaServiceClientFactory
-objekt.
- Skapa en
-
Ange slutpunktsattribut för e-post.
- Skapa en
CreateEndpointInfo
genom att använda dess konstruktor. - Ange anslutnings-ID-värdet genom att anropa
CreateEndpointInfo
objektetssetConnectorId
metoden och skicka strängvärdetEmail
. - Ange beskrivningen av slutpunkten genom att anropa
CreateEndpointInfo
objektetssetDescription
och skickar ett strängvärde som beskriver slutpunkten. - Ange slutpunktens namn genom att anropa
CreateEndpointInfo
objektetssetName
och skickar ett strängvärde som anger namnet. - Ange tjänsten som slutpunkten tillhör genom att anropa
CreateEndpointInfo
objektetssetServiceId
och skickar ett strängvärde som anger tjänstnamnet. - Ange åtgärden som anropas genom att anropa
CreateEndpointInfo
objektetssetOperationName
och skickar ett strängvärde som anger åtgärdens namn. När du skapar en e-postslutpunkt för en tjänst som kommer från en process som skapats i Workbench anropas vanligtvis åtgärdens namn.
- Skapa en
-
Ange konfigurationsvärden.
För varje konfigurationsvärde som ska anges för e-postslutpunkten måste du anropa
CreateEndpointInfo
objektetssetConfigParameterAsText
-metod. För att till exempel ställa insmtpHost
konfigurationsvärde, anropaCreateEndpointInfo
objektetssetConfigParameterAsText
och skicka följande värden:- Ett strängvärde som anger namnet på konfigurationsvärdet. När du anger
smtpHost
konfigurationsvärde, angesmtpHost
. - Ett strängvärde som anger värdet för konfigurationsvärdet. När du anger
smtpHost
konfigurationsvärde anger du ett strängvärde som anger namnet på SMTP-servern.
note note NOTE Om du vill se alla konfigurationsvärden som angetts för EncryptDocument-tjänsten som introducerades i det här avsnittet kan du läsa Java-kodexemplet som finns på QuickStart: Lägga till en e-postslutpunkt med Java API. - Ett strängvärde som anger namnet på konfigurationsvärdet. När du anger
-
Definiera indataparametervärden.
Definiera ett indataparametervärde genom att anropa
CreateEndpointInfo
objektetssetInputParameterMapping
och skicka följande värden:- Ett strängvärde som anger namnet på indataparametern. Namnet på indataparametern för EncryptDocument-tjänsten är
InDoc
. - Ett strängvärde som anger datatypen för indataparametern. Datatypen för
InDoc
indataparametern ärcom.adobe.idp.Document
. - Ett strängvärde som anger mappningstypen. Du kan till exempel ange
variable
. - Ett strängvärde som anger mappningstypsvärdet. Du kan till exempel ange *.pdf som filmönster.
note note NOTE Anropa setInputParameterMapping
metod för varje indataparametervärde som ska definieras. Eftersom EncryptDocument-processen bara har en indataparameter, måste du anropa den här metoden en gång. - Ett strängvärde som anger namnet på indataparametern. Namnet på indataparametern för EncryptDocument-tjänsten är
-
Definiera ett utdataparametervärde.
Definiera ett utdataparametervärde genom att anropa
CreateEndpointInfo
objektetssetOutputParameterMapping
och skicka följande värden:- Ett strängvärde som anger namnet på utdataparametern. Namnet på utdataparametern för EncryptDocument-tjänsten är till exempel
SecuredDoc
. - Ett strängvärde som anger datatypen för utdataparametern. Datatypen för
SecuredDoc
output-parametern ärcom.adobe.idp.Document
. - Ett strängvärde som anger mappningstypen. Du kan till exempel ange
%F.pdf
.
- Ett strängvärde som anger namnet på utdataparametern. Namnet på utdataparametern för EncryptDocument-tjänsten är till exempel
-
Skapa e-postslutpunkten.
Skapa slutpunkten genom att starta
EndpointRegistryClient
objektetscreateEndpoint
metoden och skickaCreateEndpointInfo
-objekt. Den här metoden returnerar enEndpoint
objekt som representerar e-postslutpunkten. -
Aktivera slutpunkten.
Aktivera slutpunkten genom att anropa
EndpointRegistryClient
objektetsenable
metoden och skickaEndpoint
objekt som returneras avcreateEndpoint
-metod.
Se även
QuickStart: Lägga till en bevakad mappslutpunkt med Java API
Inkludera AEM Forms Java-biblioteksfiler
Konstantfil för e-postkonfigurationsvärden email-configuration-values-constant-file
The QuickStart: Lägga till en e-postslutpunkt med Java API använder en konstant fil som måste ingå i Java-projektet för att kompilera snabbstarten. Den här konstanta filen representerar konfigurationsvärden som måste anges när du lägger till en e-postslutpunkt. Följande Java-kod representerar den konstanta filen.
/**
* This class contains constants that can be used when setting email endpoint
* configuration values
*/
public class EmailEndpointConfigConstants {
public static final String PROPERTY_EMAILPROVIDER_CRON_EXPRESSION = "cronExpression";
public static final String PROPERTY_EMAILPROVIDER_REPREAT_COUNT = "repeatCount";
public static final String PROPERTY_EMAILPROVIDER_REPREAT_INTERVAL = "repeatInterval";
public static final String PROPERTY_EMAILPROVIDER_START_DELAY = "startDelay";
public static final String PROPERTY_EMAILPROVIDER_BATCH_SIZE = "batchSize";
public static final String PROPERTY_EMAILPROVIDER_USERNAME = "userName";
public static final String PROPERTY_EMAILPROVIDER_DOMAINNAME = "domainName";
public static final String PROPERTY_EMAILPROVIDER_DOMAINPATTERN = "domainPattern";
public static final String PROPERTY_EMAILPROVIDER_FILEPATTERN = "filePattern";
public static final String PROPERTY_EMAILPROVIDER_RECIPIENT_SUCCESSFUL_JOB = "recipientSuccessfulJob";
public static final String PROPERTY_EMAILPROVIDER_RECIPIENT_FAILED_JOB = "recipientFailedJob";
public static final String PROPERTY_EMAILPROVIDER_INBOX_HOST = "inboxHost";
public static final String PROPERTY_EMAILPROVIDER_INBOX_PORT = "inboxPort";
public static final String PROPERTY_EMAILPROVIDER_PROTOCOL = "inboxProtocol";
public static final String PROPERTY_EMAILPROVIDER_INBOX_TIMEOUT = "inboxTimeOut";
public static final String PROPERTY_EMAILPROVIDER_INBOX_USER = "inboxUser";
public static final String PROPERTY_EMAILPROVIDER_INBOX_PASSWORD = "inboxPassword";
public static final String PROPERTY_EMAILPROVIDER_INBOX_SSL = "inboxSSLEnabled";
public static final String PROPERTY_EMAILPROVIDER_SMTP_HOST = "smtpHost";
public static final String PROPERTY_EMAILPROVIDER_SMTP_PORT = "smtpPort";
public static final String PROPERTY_EMAILPROVIDER_SMTP_USER = "smtpUser";
public static final String PROPERTY_EMAILPROVIDER_SMTP_PASSWORD = "smtpPassword";
public static final String PROPERTY_EMAILPROVIDER_CHARSET = "charSet";
public static final String PROPERTY_EMAILPROVIDER_SMTP_SSL = "smtpSSLEnabled";
public static final String PROPERTY_EMAILPROVIDER_FAILED_FOLDER = "failedJobFolder";
public static final String PROPERTY_EMAILPROVIDER_ASYNCHRONOUS = "asynchronous";
}
Lägga till fjärrslutpunkter adding-remoting-endpoints
Du kan programmässigt lägga till en fjärrslutpunkt till en tjänst med hjälp av AEM Forms Java API. Genom att lägga till en fjärrslutpunkt aktiverar du ett Flex-program att anropa tjänsten med hjälp av fjärrkommunikation. (Se Anropa AEM Forms Remoting med (borttaget för AEM).)
Om du vill lägga till en fjärrslutpunkt till en tjänst programmatiskt bör du överväga följande kortlivade process med namnet EncryptDocument.
I den här processen accepteras ett oskyddat PDF-dokument som ett indatavärde och det oskyddade PDF-dokumentet skickas sedan till krypteringstjänstens EncryptPDFUsingPassword
operation. PDF-dokumentet krypteras med ett lösenord och det lösenordskrypterade PDF-dokumentet är utdatavärdet för den här processen. Namnet på indatavärdet (det oskyddade PDF-dokumentet) är InDoc
och datatypen är com.adobe.idp.Document
. Namnet på utdatavärdet (det lösenordskrypterade PDF-dokumentet) är SecuredDoc
och datatypen är com.adobe.idp.Document
.
För att visa hur du lägger till en fjärrslutpunkt till en tjänst lägger det här avsnittet till en fjärrslutpunkt till en tjänst med namnet EncryptDocument.
Sammanfattning av steg summary_of_steps-4
Så här tar du bort en slutpunkt från en tjänst:
- Inkludera projektfiler.
- Skapa en
EndpointRegistryClient
-objekt. - Ange slutpunktsattribut för fjärrstyrning.
- Skapa en fjärrslutpunkt.
- Aktivera slutpunkten.
Inkludera projektfiler
Inkludera nödvändiga filer i utvecklingsprojektet. Om du skapar ett klientprogram med Java, inkluderar du de JAR-filer som behövs. Om du använder webbtjänster måste du ta med proxyfilerna.
Följande JAR-filer måste läggas till i projektets klasssökväg:
- adobe-livecycle-client.jar
- adobe-usermanager-client.jar
- adobe-utilities.jar (krävs om AEM Forms körs på JBoss Application Server)
- jbossall-client.jar (krävs om AEM Forms körs på JBoss Application Server)
Mer information om var dessa JAR-filer finns i Inkludera AEM Forms Java-biblioteksfiler.
Skapa ett EndpointRegistry-klientobjekt
Om du vill lägga till en fjärrslutpunkt med programkod måste du skapa en EndpointRegistryClient
-objekt.
Ange slutpunktsattribut för fjärrstyrning
Om du vill skapa en fjärrslutpunkt för en tjänst anger du följande värden:
- Identifieringsvärde för koppling: Anger den typ av slutpunkt som skapas. Om du vill skapa en fjärrslutpunkt anger du
Remoting
. - Beskrivning: Anger slutpunktens beskrivning.
- Namn: Anger slutpunktens namn.
- Tjänstidentifierarvärde: Anger den tjänst som slutpunkten tillhör. Om du till exempel vill lägga till en fjärrslutpunkt i processen som introduceras i det här avsnittet (en process blir en tjänst när den aktiveras i Workbench) anger du
EncryptDocument
. - Åtgärdsnamn: Anger namnet på åtgärden som anropas med slutpunkten. När du skapar en fjärrslutpunkt anger du ett jokertecken (*).
Skapa en fjärrslutpunkt
När du har angett slutpunktsattribut för Remoting kan du skapa en slutpunkt för Remoting för en tjänst.
Aktivera slutpunkten
När du har skapat en slutpunkt måste du aktivera den. När en fjärrslutpunkt är aktiverad aktiveras den av en Flex-klient för att anropa tjänsten.
Se även
Lägga till en fjärrslutpunkt med Java API
Inkludera AEM Forms Java-biblioteksfiler
Lägga till en fjärrslutpunkt med Java API add-a-remoting-endpoint-using-the-java-api
Lägg till en fjärrslutpunkt med Java API:
-
Inkludera projektfiler.
Inkludera JAR-klientfiler, t.ex. adobe-livecycle-client.jar, i Java-projektets klassökväg.
-
Skapa ett EndpointRegistry-klientobjekt.
- Skapa en
ServiceClientFactory
objekt som innehåller anslutningsegenskaper. - Skapa en
EndpointRegistryClient
genom att använda konstruktorn och skickaServiceClientFactory
-objekt.
- Skapa en
-
Ange slutpunktsattribut för fjärrstyrning.
- Skapa en
CreateEndpointInfo
genom att använda dess konstruktor. - Ange anslutnings-ID-värdet genom att anropa
CreateEndpointInfo
objektetssetConnectorId
metoden och skicka strängvärdetRemoting
. - Ange beskrivningen av slutpunkten genom att anropa
CreateEndpointInfo
objektetssetDescription
och skickar ett strängvärde som beskriver slutpunkten. - Ange slutpunktens namn genom att anropa
CreateEndpointInfo
objektetssetName
och skickar ett strängvärde som anger namnet. - Ange tjänsten som slutpunkten tillhör genom att anropa
CreateEndpointInfo
objektetssetServiceId
och skickar ett strängvärde som anger tjänstnamnet. - Ange den åtgärd som anropas av
CreateEndpointInfo
objektetssetOperationName
och skickar ett strängvärde som anger åtgärdens namn. Ange ett jokertecken (*) för en fjärrslutpunkt.
- Skapa en
-
Skapa en fjärrslutpunkt.
Skapa slutpunkten genom att starta
EndpointRegistryClient
objektetscreateEndpoint
metoden och skickaCreateEndpointInfo
-objekt. Den här metoden returnerar enEndpoint
objekt som representerar den nya fjärrslutpunkten. -
Aktivera slutpunkten.
Aktivera slutpunkten genom att anropa
EndpointRegistryClient
objektetsenable
metoden och skickaEndpoint
objekt som returneras avcreateEndpoint
-metod.
Se även
QuickStart: Lägga till en fjärrslutpunkt med Java API
Inkludera AEM Forms Java-biblioteksfiler
Lägger till TaskManager-slutpunkter adding-taskmanager-endpoints
Du kan programmässigt lägga till en TaskManager-slutpunkt till en tjänst med hjälp av AEM Forms Java API. Genom att lägga till en TaskManager-slutpunkt till en tjänst kan du aktivera tjänsten för en Workspace-användare. Det innebär att en användare som arbetar i Workspace kan anropa en process som har en motsvarande TaskManager-slutpunkt.
Sammanfattning av steg summary_of_steps-5
Så här lägger du till en TaskManager-slutpunkt till en tjänst:
- Inkludera projektfiler.
- Skapa en
EndpointRegistryClient
-objekt. - Skapa en kategori för slutpunkten.
- Ange slutpunktsattribut för TaskManager.
- Skapa en TaskManager-slutpunkt.
- Aktivera slutpunkten.
Inkludera projektfiler
Inkludera nödvändiga filer i utvecklingsprojektet. Om du skapar ett klientprogram med Java, inkluderar du de JAR-filer som behövs. Om du använder webbtjänster måste du ta med proxyfilerna.
Följande JAR-filer måste läggas till i projektets klasssökväg:
- adobe-livecycle-client.jar
- adobe-usermanager-client.jar
- adobe-utilities.jar (krävs om AEM Forms körs på JBoss Application Server)
- jbossall-client.jar (krävs om AEM Forms körs på JBoss Application Server)
Mer information om var dessa JAR-filer finns i Inkludera AEM Forms Java-biblioteksfiler.
Skapa ett EndpointRegistry-klientobjekt
Innan du kan lägga till en TaskManager-slutpunkt med programkod måste du skapa en EndpointRegistryClient
-objekt.
Skapa en kategori för slutpunkten
Kategorier används för att ordna tjänster i Workspace. Det innebär att en Workspace-användare kan anropa en tjänst som har en TaskManager-slutpunkt genom att välja en kategori i Workspace. När du skapar en TaskManager-slutpunkt kan du antingen referera till en befintlig kategori eller skapa en kategori programmatiskt.
Ange slutpunktsattribut för TaskManager
Om du vill skapa en TaskManager-slutpunkt för en tjänst anger du följande värden:
- Kopplingsidentifierare: Anger den typ av slutpunkt som skapas. Om du vill skapa en TaskManager-slutpunkt anger du
TaskManagerConnector
. - Beskrivning: Anger slutpunktens beskrivning.
- Namn: Anger slutpunktens namn.
- Tjänstidentifierare: Anger den tjänst som slutpunkten tillhör.
- Kategori: Anger ett värde för kategoriidentifierare som är associerat med TaskManager-slutpunkten.
- Åtgärdsnamn: När du skapar en TaskManager-slutpunkt för en tjänst som kommer från en process som har skapats i Workbench är namnet på åtgärden vanligtvis
invoke
.
Skapa en TaskManager-slutpunkt
När du har angett slutpunktsattribut för TaskManager kan du skapa en TaskManager-slutpunkt för en tjänst.
Aktivera slutpunkten
När du har skapat en slutpunkt måste du aktivera den. När slutpunkten är aktiverad kan den användas för att anropa tjänsten inifrån Workspace. När du har aktiverat slutpunkten kan du visa den i administrationskonsolen.
Se även
Lägga till en TaskManager-slutpunkt med Java API
Inkludera AEM Forms Java-biblioteksfiler
Lägga till en TaskManager-slutpunkt med Java API add-a-taskmanager-endpoint-using-the-java-api
Lägg till en TaskManager-slutpunkt med Java API:
-
Inkludera projektfiler.
Inkludera JAR-klientfiler, t.ex. adobe-livecycle-client.jar, i Java-projektets klassökväg.
-
Skapa ett EndpointRegistry-klientobjekt.
- Skapa en
ServiceClientFactory
objekt som innehåller anslutningsegenskaper. - Skapa en
EndpointRegistryClient
genom att använda konstruktorn och skickaServiceClientFactory
-objekt.
- Skapa en
-
Skapa en kategori för slutpunkten.
-
Skapa en
CreateEndpointCategoryInfo
genom att använda dess konstruktor och skicka följande värden:- Ett strängvärde som anger kategoriens identifierarvärde
- Ett strängvärde som anger beskrivningen av kategorin
-
Skapa kategorin genom att starta
EndpointRegistryClient
objektetscreateEndpointCategory
metoden och skickaCreateEndpointCategoryInfo
-objekt. Den här metoden returnerar enEndpointCategory
objekt som representerar den nya kategorin.
-
-
Ange slutpunktsattribut för TaskManager.
- Skapa en
CreateEndpointInfo
genom att använda dess konstruktor. - Ange anslutnings-ID-värdet genom att anropa
CreateEndpointInfo
objektetssetConnectorId
metoden och skicka strängvärdetTaskManagerConnector
. - Ange beskrivningen av slutpunkten genom att anropa
CreateEndpointInfo
objektetssetDescription
och skickar ett strängvärde som beskriver slutpunkten. - Ange slutpunktens namn genom att anropa
CreateEndpointInfo
objektetssetName
och skickar ett strängvärde som anger namnet. - Ange tjänsten som slutpunkten tillhör genom att anropa
CreateEndpointInfo
objektetssetServiceId
och skickar ett strängvärde som anger tjänstnamnet. - Ange kategorin som slutpunkten tillhör genom att anropa
CreateEndpointInfo
objektetssetCategoryId
och skickar ett strängvärde som anger kategorins identifierarvärde. Du kan anropaEndpointCategory
objektetsgetId
metod för att hämta identifierarvärdet för den här kategorin. - Ange åtgärden som anropas genom att anropa
CreateEndpointInfo
objektetssetOperationName
och skickar ett strängvärde som anger åtgärdens namn. Vanligtvis när du skapar enTaskManager
slutpunkt för en tjänst som härstammar från en process som skapats i Workbench, namnet på åtgärden ärinvoke
.
- Skapa en
-
Skapa en TaskManager-slutpunkt.
Skapa slutpunkten genom att starta
EndpointRegistryClient
objektetscreateEndpoint
metoden och skickaCreateEndpointInfo
-objekt. Den här metoden returnerar enEndpoint
objekt som representerar den nya TaskManager-slutpunkten. -
Aktivera slutpunkten.
Aktivera slutpunkten genom att anropa
EndpointRegistryClient
objektetsenable
metoden och skickaEndpoint
objekt som returneras avcreateEndpoint
-metod.
Se även
QuickStart: Lägga till en TaskManager-slutpunkt med Java API
Inkludera AEM Forms Java-biblioteksfiler
Ändra slutpunkter modifying-endpoints
Du kan programmässigt ändra en befintlig slutpunkt med AEM Forms Java API. Genom att ändra en slutpunkt kan du ändra beteendet för slutpunkten. Tänk dig till exempel en bevakad mappslutpunkt som anger en mapp som används som bevakad mapp. Du kan programmässigt ändra konfigurationsvärden som tillhör slutpunkten Bevakade mappar, vilket resulterar i att en annan mapp fungerar som bevakade mappar. Mer information om konfigurationsvärden som tillhör en bevakad mappslutpunkt finns i Lägga till bevakade mappslutpunkter.
För att visa hur du ändrar en slutpunkt ändrar det här avsnittet en bevakad mappslutpunkt genom att ändra mappen som fungerar som bevakad mapp.
Sammanfattning av steg summary_of_steps-6
Gör så här om du vill ändra en slutpunkt:
- Inkludera projektfiler.
- Skapa en
EndpointRegistryClient
-objekt. - Hämta slutpunkten.
- Ange nya konfigurationsvärden.
Inkludera projektfiler
Inkludera nödvändiga filer i utvecklingsprojektet. Om du skapar ett klientprogram med Java, inkluderar du de JAR-filer som behövs. Om du använder webbtjänster måste du ta med proxyfilerna.
Följande JAR-filer måste läggas till i projektets klasssökväg:
- adobe-livecycle-client.jar
- adobe-usermanager-client.jar
- adobe-utilities.jar (krävs om AEM Forms körs på JBoss Application Server)
- jbossall-client.jar (krävs om AEM Forms körs på JBoss Application Server)
Mer information om var dessa JAR-filer finns i Inkludera AEM Forms Java-biblioteksfiler.
Skapa ett EndpointRegistry-klientobjekt
Om du vill ändra en slutpunkt programmatiskt måste du skapa en EndpointRegistryClient
-objekt.
Hämta slutpunkten som ska ändras
Innan du kan ändra en slutpunkt måste du hämta den. Om du vill hämta en slutpunkt måste du ansluta som en användare som har åtkomst till en slutpunkt. Vi rekommenderar att du ansluter som administratör. (Se Ange anslutningsegenskaper).
Du kan hämta en slutpunkt genom att hämta en lista med slutpunkter. Du kan sedan iterera igenom listan och söka efter den specifika slutpunkt som ska tas bort. Du kan till exempel hitta en slutpunkt genom att fastställa vilken tjänst som motsvarar slutpunkten och typen av slutpunkt. När du hittar slutpunkten kan du ändra den.
Ange nya konfigurationsvärden
Ange nya konfigurationsvärden när du ändrar en slutpunkt. Om du till exempel vill ändra slutpunkten för en bevakad mapp återställer du alla konfigurationsvärden för bevakad mapp, inte bara de som du vill ändra. Mer information om konfigurationsvärden som tillhör en bevakad mappslutpunkt finns i Lägga till bevakade mappslutpunkter.
Se även
Ändra en slutpunkt med Java API
Inkludera AEM Forms Java-biblioteksfiler
Ändra en slutpunkt med Java API modifying-an-endpoint-using-the-java-api
Ändra en slutpunkt med Java API:
-
Inkludera projektfiler.
Inkludera JAR-klientfiler, t.ex. adobe-livecycle-client.jar, i Java-projektets klassökväg.
-
Skapa ett EndpointRegistry-klientobjekt.
- Skapa en
ServiceClientFactory
objekt som innehåller anslutningsegenskaper. - Skapa en
EndpointRegistryClient
genom att använda konstruktorn och skickaServiceClientFactory
-objekt.
- Skapa en
-
Hämta slutpunkten som ska ändras.
- Hämta en lista med alla slutpunkter som den aktuella användaren (som anges i anslutningsegenskaperna) kan komma åt genom att anropa
EndpointRegistryClient
objektetsgetEndpoints
metod och skicka enPagingFilter
objekt som fungerar som ett filter. Du kan skicka en(PagingFilter)null
värde för att returnera alla slutpunkter. Den här metoden returnerar enjava.util.List
objekt där varje element är ettEndpoint
-objekt. Mer information omPagingFilter
objekt, se AEM Forms API-referens. - Iterera genom
java.util.List
-objekt för att avgöra om det har slutpunkter. Om det finns slutpunkter är varje element ettEndPoint
-instans. - Bestäm vilken tjänst som motsvarar en slutpunkt genom att anropa
EndPoint
objektetsgetServiceId
-metod. Den här metoden returnerar ett strängvärde som anger tjänstnamnet. - Bestäm typen av slutpunkt genom att anropa
EndPoint
objektetsgetConnectorId
-metod. Den här metoden returnerar ett strängvärde som anger typen av slutpunkt. Om slutpunkten till exempel är en bevakad mappslutpunkt returnerar den här metodenWatchedFolder
.
- Hämta en lista med alla slutpunkter som den aktuella användaren (som anges i anslutningsegenskaperna) kan komma åt genom att anropa
-
Ange nya konfigurationsvärden.
-
Skapa en
ModifyEndpointInfo
genom att anropa dess konstruktor. -
För varje konfigurationsvärde som ska anges anropar du
ModifyEndpointInfo
objektetssetConfigParameterAsText
-metod. Om du till exempel vill ange ett URL-konfigurationsvärde anropar duModifyEndpointInfo
objektetssetConfigParameterAsText
och skicka följande värden:- Ett strängvärde som anger namnet på konfigurationsvärdet. För att till exempel ställa in
url
konfigurationsvärde, angeurl
. - Ett strängvärde som anger värdet för konfigurationsvärdet. Definiera ett värde för
url
konfigurationsvärde, anger platsen för bevakad mapp.
- Ett strängvärde som anger namnet på konfigurationsvärdet. För att till exempel ställa in
-
Anropa
EndpointRegistryClient
objektetsmodifyEndpoint
och skickaModifyEndpointInfo
-objekt.
-
Se även
QuickStart: Ändra en slutpunkt med Java API
Inkludera AEM Forms Java-biblioteksfiler
Tar bort slutpunkter removing-endpoints
Du kan ta bort en slutpunkt från en tjänst programmatiskt med AEM Forms Java API. När du har tagit bort en slutpunkt kan tjänsten inte anropas med den anropsmetod som slutpunkten aktiverade. Om du till exempel tar bort en SOAP-slutpunkt från en tjänst kan du inte anropa tjänsten i SOAP-läge.
För att visa hur du tar bort en slutpunkt från en tjänst tar det här avsnittet bort en EJB-slutpunkt från en tjänst med namnet EncryptDocument.
Sammanfattning av steg summary_of_steps-7
Så här tar du bort en slutpunkt från en tjänst:
- Inkludera projektfiler.
- Skapa en
EndpointRegistryClient
-objekt. - Hämta slutpunkten.
- Ta bort slutpunkten.
Inkludera projektfiler
Inkludera nödvändiga filer i utvecklingsprojektet. Om du skapar ett klientprogram med Java, inkluderar du de JAR-filer som behövs. Om du använder webbtjänster måste du ta med proxyfilerna.
Följande JAR-filer måste läggas till i projektets klasssökväg:
- adobe-livecycle-client.jar
- adobe-usermanager-client.jar
- adobe-utilities.jar (krävs om AEM Forms körs på JBoss Application Server)
- jbossall-client.jar (krävs om AEM Forms körs på JBoss Application Server)
Mer information om var dessa JAR-filer finns i Inkludera AEM Forms Java-biblioteksfiler.
Skapa ett EndpointRegistry-klientobjekt
Om du vill ta bort en slutpunkt programmatiskt måste du skapa en EndpointRegistryClient
-objekt.
Hämta slutpunkten som ska tas bort
Innan du kan ta bort en slutpunkt måste du hämta den. Om du vill hämta en slutpunkt måste du ansluta som en användare som har åtkomst till en slutpunkt. Vi rekommenderar att du ansluter som administratör. (Se Ange anslutningsegenskaper).
Du kan hämta en slutpunkt genom att hämta en lista med slutpunkter. Du kan sedan iterera igenom listan och söka efter den specifika slutpunkt som ska tas bort. Du kan till exempel hitta en slutpunkt genom att fastställa vilken tjänst som motsvarar slutpunkten och typen av slutpunkt. När du hittar slutpunkten kan du ta bort den.
Ta bort slutpunkten
När du har skapat en slutpunkt måste du aktivera den. När slutpunkten är aktiverad kan den användas för att anropa tjänsten. När du har aktiverat slutpunkten kan du visa den i administrationskonsolen.
Se även
Ta bort en slutpunkt med Java API
Inkludera AEM Forms Java-biblioteksfiler
Ta bort en slutpunkt med Java API removing-an-endpoint-using-the-java-api
Ta bort en slutpunkt med Java API:
-
Inkludera projektfiler.
Inkludera JAR-klientfiler, t.ex. adobe-livecycle-client.jar, i Java-projektets klassökväg.
-
Skapa ett EndpointRegistry-klientobjekt.
- Skapa en
ServiceClientFactory
objekt som innehåller anslutningsegenskaper. - Skapa en
EndpointRegistryClient
genom att använda konstruktorn och skickaServiceClientFactory
-objekt.
- Skapa en
-
Hämta slutpunkten som ska tas bort.
- Hämta en lista över alla slutpunkter som den aktuella användaren (som anges i anslutningsegenskaperna) har åtkomst till genom att anropa
EndpointRegistryClient
objektetsgetEndpoints
metod och skicka enPagingFilter
objekt som fungerar som ett filter. Du kan skicka(PagingFilter)null
för att returnera alla slutpunkter. Den här metoden returnerar enjava.util.List
objekt där varje element är ettEndpoint
-objekt. - Iterera genom
java.util.List
-objekt för att avgöra om det har slutpunkter. Om det finns slutpunkter är varje element ettEndPoint
-instans. - Bestäm vilken tjänst som motsvarar en slutpunkt genom att anropa
EndPoint
objektetsgetServiceId
-metod. Den här metoden returnerar ett strängvärde som anger tjänstnamnet. - Bestäm typen av slutpunkt genom att anropa
EndPoint
objektetsgetConnectorId
-metod. Den här metoden returnerar ett strängvärde som anger typen av slutpunkt. Om slutpunkten till exempel är en EJB-slutpunkt returnerar den här metodenEJB
.
- Hämta en lista över alla slutpunkter som den aktuella användaren (som anges i anslutningsegenskaperna) har åtkomst till genom att anropa
-
Ta bort slutpunkten.
Ta bort slutpunkten genom att anropa
EndpointRegistryClient
objektetsremove
metoden och skickaEndPoint
objekt som representerar den slutpunkt som ska tas bort.
Se även
QuickStart: Ta bort en slutpunkt med Java API
Inkludera AEM Forms Java-biblioteksfiler
Hämtar information om slutpunktsanslutning retrieving-endpoint-connector-information
Med AEM Forms API kan du programmässigt hämta information om slutpunktsanslutningar. En koppling gör att en slutpunkt kan anropa en tjänst med hjälp av olika anropsmetoder. En övervakad mappkoppling gör det till exempel möjligt för en slutpunkt att anropa en tjänst med bevakade mappar. Genom att hämta information om slutpunktskopplingar programmatiskt kan du hämta konfigurationsvärden som är kopplade till en koppling, t.ex. vilka konfigurationsvärden som krävs och vilka som är valfria.
Det här avsnittet visar hur du hämtar information om slutpunktsanslutningar genom att hämta information om en övervakad mappkoppling. (Se Lägga till bevakade mappslutpunkter.)
ConnectorRegistryClient
API för att hämta information om slutpunktsanslutningar. (Se AEM Forms API-referens.)Sammanfattning av steg summary_of_steps-8
Utför följande uppgifter för att hämta information om slutpunktsanslutning:
- Inkludera projektfiler.
- Skapa en
ConnectorRegistryClient
-objekt. - Ange anslutningstyp.
- Hämta konfigurationsvärden.
Inkludera projektfiler
Inkludera nödvändiga filer i utvecklingsprojektet. Om du skapar ett klientprogram med Java, inkluderar du de JAR-filer som behövs. Om du använder webbtjänster måste du ta med proxyfilerna.
Följande JAR-filer måste läggas till i projektets klasssökväg:
- adobe-livecycle-client.jar
- adobe-usermanager-client.jar
- adobe-utilities.jar (krävs om AEM Forms körs på JBoss Application Server)
- jbossall-client.jar (krävs om AEM Forms körs på JBoss Application Server)
Om AEM Forms körs på en J2EE-programserver som stöds och som inte är JBoss, ska du ersätta adobe-utilities.jar och jbossall-client.jar med JAR-filer som är specifika för J2EE-programservern där AEM Forms är installerat. Information om platsen för alla AEM Forms JAR-filer finns i Inkludera AEM Forms Java-biblioteksfiler.
Skapa ett klientobjekt för ConnectorRegistry
Skapa en ConnectorRegistryClient
-objekt.
Ange anslutningstyp
Ange den typ av koppling som informationen ska hämtas från. Följande typer av anslutningar finns:
- EJB: Gör att ett klientprogram kan anropa en tjänst i EJB-läge.
- SOAP: Gör att ett klientprogram kan anropa en tjänst i SOAP-läge.
- Bevakad mapp: Gör att bevakade mappar kan anropa en tjänst.
- E-post: Gör att e-postmeddelanden kan anropa en tjänst.
- Remoting: Gör att ett Flex-klientprogram kan anropa en tjänst.
- TaskManagerKoppling: Gör det möjligt för en arbetsyteanvändare att anropa en tjänst från arbetsytan.
Hämta konfigurationsvärden
När du har angett anslutningstypen kan du hämta information om kopplingen, t.ex. ett konfigurationsvärde som stöds. För alla anslutningar kan du till exempel bestämma vilka konfigurationsvärden som krävs och vilka som är valfria.
Se även
Hämta slutpunktsanslutningsinformation med Java API
Inkludera AEM Forms Java-biblioteksfiler
Hämta slutpunktsanslutningsinformation med Java API retrieve-endpoint-connector-information-using-the-java-api
Hämta information om slutpunktsanslutning med Java API:
-
Inkludera projektfiler.
Inkludera JAR-klientfiler, t.ex. adobe-livecycle-client.jar, i Java-projektets klassökväg.
-
Skapa ett klientobjekt för ConnectorRegistry.
- Skapa en
ServiceClientFactory
objekt som innehåller anslutningsegenskaper. - Skapa en
ConnectorRegistryClient
genom att använda konstruktorn och skickaServiceClientFactory
-objekt.
- Skapa en
-
Ange anslutningstyp.
Ange anslutningstypen genom att anropa
ConnectorRegistryClient
objektetsgetEndpointDefinition
och skickar ett strängvärde som anger anslutningstypen. Om du till exempel vill ange anslutningstypen Bevakad mapp skickar du strängvärdetWatchedFolder
. Den här metoden returnerar enEndpoint
objekt som motsvarar kopplingstypen. -
Hämta konfigurationsvärden.
- Hämta konfigurationsvärden som är kopplade till den här slutpunkten genom att anropa
Endpoint
objektetsgetConfigParameters
-metod. Den här metoden returnerar en array medConfigParameter
objekt. - Hämta information om varje konfigurationsvärde genom att hämta varje element i arrayen. Varje element är en
ConfigParameter
-objekt. Du kan till exempel avgöra om konfigurationsvärdet är obligatoriskt eller valfritt genom att anropaConfigParameter
objektetsisRequired
-metod. Om konfigurationsvärdet krävs returnerar den här metodentrue
.
- Hämta konfigurationsvärden som är kopplade till den här slutpunkten genom att anropa
Se även
QuickStart: Hämtar slutpunktsanslutningsinformation med Java API
Inkludera AEM Forms Java-biblioteksfiler