Skapa en hanterare för att bjuda in externa användare create-invite-external-users-handler

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

Du kan skapa en hanterare för att bjuda in externa användare för tjänsten Rights Management. Med en Bjud in extern användarhanterare kan Rights Management-tjänsten bjuda in externa användare att bli Rights Management-användare. När en användare har blivit en Rights Management-användare kan han/hon utföra uppgifter som att öppna ett policyskyddat PDF-dokument. När hanteraren Bjud in externa användare har distribuerats till AEM Forms kan du använda administrationskonsolen för att interagera med den.

Sammanfattning av steg

Om du vill utveckla en hanterare för att bjuda in externa användare måste du utföra följande steg:

Konfigurera utvecklingsmiljön setting-up-development-environment

Om du vill konfigurera utvecklingsmiljön måste du skapa ett Java-projekt, till exempel ett Eclipse-projekt. Den version av Eclipse som stöds är 3.2.1 eller senare.

Rights Management SPI kräver att filen edc-server-spi.jar anges i projektets klasssökväg. Om du inte refererar till den här JAR-filen kan du inte använda Rights Management SPI i ditt Java-projekt. Den här JAR-filen installeras med AEM Forms SDK i mappen [install directory]\Adobe\Adobe_Experience_Manager_forms\sdk\spi.

Förutom att lägga till filen edc-server-spi.jar i projektets klasssökväg måste du också lägga till de JAR-filer som krävs för att använda API:t för tjänsten Rights Management. De här filerna behövs för att du ska kunna använda API:t för tjänsten Rights Management i hanteraren för att bjuda in externa användare.

Definiera implementering av inbjuden extern användarhanterare define-invite-external-users-handler

Om du vill utveckla en inbjudan till en extern användarhanterare måste du skapa en Java-klass som implementerar gränssnittet com.adobe.edc.server.spi.ersp.InvitedUserProvider. Den här klassen innehåller en metod med namnet invitedUser, som anropas av tjänsten Rights Management när e-postadresser skickas via sidan Lägg till inbjudna användare som du kommer åt via administrationskonsolen.

Metoden invitedUser accepterar en java.util.List-instans som innehåller strängtypade e-postadresser som skickas från sidan Lägg till inbjudna användare. Metoden invitedUser returnerar en array med InvitedUserProviderResult-objekt, vilket vanligtvis är en mappning av e-postadresser till användarobjekt (returnerar inte null).

Implementeringen av hanteraren för inbjudan av externa användare innehåller en användardefinierad metod med namnet createLocalPrincipalAccount. Den här metoden accepterar ett strängvärde som anger en e-postadress som ett parametervärde. Metoden createLocalPrincipalAccount förutsätter att det redan finns en lokal domän med namnet EDC_EXTERNAL_REGISTERED. Du kan konfigurera det här domännamnet så att det blir vad du vill, men för ett produktionsprogram kanske du vill integrera med en företagsdomän.

Metoden createUsers itererar över alla e-postadresser och skapar ett motsvarande användarobjekt (en lokal användare i domänen EDC_EXTERNAL_REGISTERED). Slutligen anropas metoden doEmails. Den här metoden finns avsiktligt kvar som en stub i exemplet. I en produktionsimplementering skulle den innehålla programlogik för att skicka e-postmeddelanden med inbjudningar till de nyskapade användarna. Det lämnas i exemplet för att visa programmets logikflöde i ett verkligt program.

Definiera implementering av inbjuden extern användarhanterare user-handler-implementation

Följande inbjudan till implementering av extern användarhanterare accepterar e-postadresser som skickas från sidan Lägg till inbjudna användare som kan nås via administrationskonsolen.

package com.adobe.livecycle.samples.inviteexternalusers.provider;

import com.adobe.edc.server.spi.ersp.*;
import com.adobe.idp.dsc.clientsdk.ServiceClientFactory;
import com.adobe.idp.um.api.*;
import com.adobe.idp.um.api.infomodel.*;
import com.adobe.idp.um.api.impl.UMBaseLibrary;
import com.adobe.livecycle.usermanager.client.DirectoryManagerServiceClient;

import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;

public class InviteExternalUsersSample implements InvitedUserProvider
{
       private ServiceClientFactory _factory = null;

       private User createLocalPrincipalAccount(String email_address) throws Exception
       {
    String ret = null;

    //  Assume the local domain already exists!
    String domain = "EDC_EXTERNAL_REGISTERED";

    List aliases = new ArrayList();
    aliases.add( email_address );

    User local_user = UMBaseLibrary.createUser( email_address, domain, email_address );
    local_user.setCommonName( email_address );
    local_user.setEmail( email_address );
    local_user.setEmailAliases( aliases );

    //  You may wish to disable the local user until, for example, his registration is processed by a confirmation link
    //local_user.setDisabled( true );

    DirectoryManager directory_manager = new DirectoryManagerServiceClient( _factory );
    String ret_oid = directory_manager.createLocalUser( local_user, null );

    if( ret_oid == null )
    {
        throw new Exception( "FAILED TO CREATE PRINCIPAL FOR EMAIL ADDRESS: " + email_address );
    }

    return local_user;
       }

       protected User[] createUsers( List emails ) throws Exception
       {
    ArrayList ret_users = new ArrayList();

    _factory = ServiceClientFactory.createInstance();

    Iterator iter = emails.iterator();

    while( iter.hasNext() )
    {
        String current_email = (String)iter.next();

        ret_users.add( createLocalPrincipalAccount( current_email ) );
    }

    return (User[])ret_users.toArray( new User[0] );
       }

       protected void doInvitations(List emails)
       {
    //  Here you may choose to send the users who were created an invitation email
    //  This step is completely optional, depending on your requirements.
       }

       public InvitedUserProviderResult[] invitedUser(List emails)
       {
    //  This sample demonstrates the workflow for inviting a user via email

    try
    {

        User[] principals = createUsers(emails);

        InvitedUserProviderResult[] result = new InvitedUserProviderResult[principals.length];
        for( int i = 0; i < principals.length; i++ )
        {
        result[i] = new InvitedUserProviderResult();

        result[i].setEmail( (String)emails.get( i ) );
        result[i].setUser( principals[i] );
        }

        doInvitations(emails);

        System.out.println( "SUCCESSFULLY INVITED " + result.length + " USERS" );

        return result;

    }
    catch( Exception e )
    {
        System.out.println( "FAILED TO INVITE USERS FOR INVITE USERS SAMPLE" );
        e.printStackTrace();

        return new InvitedUserProviderResult[0];
    }
       }
}

Definiera komponentens XML-fil för behörighetshanteraren define-component-xml-authorization-handler

Definiera en komponent-XML-fil för att distribuera komponenten för att bjuda in externa användare. En komponent-XML-fil finns för varje komponent och innehåller metadata om komponenten.

Följande component.xml-fil används för att bjuda in externa användare. Observera att tjänstnamnet är InviteExternalUsersSample och att åtgärden som den här tjänsten visar har namnet invitedUser. Indataparametern är en java.util.List-instans och utdatavärdet är en array med com.adobe.edc.server.spi.esrp.InvitedUserProviderResult instanser.

Definiera komponentens XML-fil för hanteraren för att bjuda in externa användare component-xml-invite-external-users-handler

<component xmlns="https://adobe.com/idp/dsc/component/document">
<component-id>com.adobe.livecycle.samples.inviteexternalusers</component-id>
<version>1.0</version>
<bootstrap-class>com.adobe.livecycle.samples.inviteexternalusers.provider.BootstrapImpl</bootstrap-class>
<descriptor-class>com.adobe.idp.dsc.component.impl.DefaultPOJODescriptorImpl</descriptor-class>
<services>
<service name="InviteExternalUsersSample">
<specifications>
<specification spec-id="com.adobe.edc.server.spi.ersp.InvitedUserProvider"/>
</specifications>
<specification-version>1.0</specification-version>
<implementation-class>com.adobe.livecycle.samples.inviteexternalusers.provider.InviteExternalUsersSample</implementation-class>
<auto-deploy category-id="Samples" service-id="InviteExternalUsersSample" major-version="1" minor-version="0"/>
<operations>
<operation name="invitedUser">
<input-parameter name="input" type="java.util.List" required="true"/>
<output-parameter name="result" type="com.adobe.edc.server.spi.esrp.InvitedUserProviderResult[]"/>
</operation>
</operations>
</service>
</services>
</component>

Paketera hanteraren för inbjudan till externa användare packaging-invite-external-users-handler

Om du vill distribuera hanteraren för att bjuda in externa användare till AEM Forms måste du paketera ditt Java-projekt i en JAR-fil. Kontrollera att de externa JAR-filer som den externa användarhanterarens affärslogik är beroende av, t.ex. edc-server-spi.jar- och adobe-rightsmanagement-client.jar-filerna, också inkluderas i JAR-filen. Komponentens XML-fil måste också finnas. Filen component.xml och de externa JAR-filerna måste finnas i roten för JAR-filen.

Följande bild visar Java-projektets innehåll som paketeras i JAR-filen för den externa användarhanteraren.

A. Externa JAR-filer som krävs för komponenten B. JAVA-fil

Paketera hanteraren för inbjudan till externa användare i en JAR-fil. Observera att .JAVA-filer visas i listan i föregående diagram. När de paketerats i en JAR-fil måste även motsvarande CLASS-filer anges. Utan CLASS-filerna fungerar inte behörighetshanteraren.

Testa hanteraren för att bjuda in externa användare testing-invite-external-users-handler

Om du vill testa hanteraren för att bjuda in externa användare kan du lägga till externa användare som ska bjudas in med administrationskonsolen.

Så här lägger du till externa användare att bjuda in med administrationskonsolen: