创建“邀请外部用户”处理程序

本文档中的示例和示例仅适用于JEE环境中的AEM Forms。

您可以为Rights Management服务创建“邀请外部用户”处理程序。 邀请外部用户处理程序使Rights Management服务能够邀请外部用户成为Rights Management用户。 在用户成为Rights Management用户后,用户能够执行各种任务,如打开受策略保护的PDF文档。 将“邀请外部用户”处理程序部署到AEM Forms后,您可以使用管理控制台与其进行交互。

注意

“邀请外部用户”处理程序是AEM Forms组件。 在创建“邀请外部用户”处理程序之前,建议您熟悉如何创建组件。

步骤摘要

要开发“邀请外部用户”处理程序,必须执行以下步骤:

  1. 设置开发环境。
  2. 定义“邀请外部用户”处理程序实施。
  3. 定义组件XML文件。
  4. 部署“邀请外部用户”处理程序。
  5. 测试“邀请外部用户”处理程序。

设置开发环境

要设置开发环境,您必须创建新的Java项目,如Eclipse项目。 支持的Eclipse版本为3.2.1或更高版本。

Rights ManagementSPI要求在项目的类路径中设置edc-server-spi.jar文件。 如果不引用此JAR文件,则无法在Java项目中使用Rights ManagementSPI。 此JAR文件随AEM Forms SDK一起安装在[install directory]\Adobe\Adobe_Experience_Manager_forms\sdk\spi文件夹中。

除了将edc-server-spi.jar文件添加到项目的类路径之外,您还必须添加使用Rights Management服务API所需的JAR文件。 在“邀请外部用户”处理程序中使用Rights Management服务API时需要这些文件。

定义邀请外部用户处理程序实现

要开发“邀请外部用户”处理程序,必须创建一个用于实现com.adobe.edc.server.spi.ersp.InvitedUserProvider接口的Java类。 此类包含名为invitedUser的方法,在使用可通过管理控制台访问的​添加受邀用户​页面提交电子邮件地址时,Rights Management服务会调用此方法。

invitedUser方法接受java.util.List实例,该实例包含从​添加受邀用户​页面提交的字符串类型电子邮件地址。 invitedUser方法返回一个InvitedUserProviderResult对象数组,该数组通常是电子邮件地址到用户对象的映射(不返回空值)。

注意

除了演示如何创建邀请外部用户处理程序之外,本节还使用AEM Forms API。

邀请外部用户处理程序的实现包含一个名为createLocalPrincipalAccount的用户定义方法。 此方法接受一个字符串值,该值将电子邮件地址指定为参数值。 createLocalPrincipalAccount方法假定存在名为EDC_EXTERNAL_REGISTERED的本地域。 您可以将此域名配置为任何所需的域名;但是,对于生产应用程序,您可能希望与企业域集成。

createUsers方法会遍历每个电子邮件地址,并创建相应的User对象(EDC_EXTERNAL_REGISTERED域中的本地用户)。 最后,调用doEmails方法。 此方法有意作为样本中的存根保留。 在生产实施中,它将包含应用程序逻辑,用于向新创建的用户发送邀请电子邮件消息。 它留在示例中,用于演示实际应用程序的应用程序逻辑流。

定义邀请外部用户处理程序实现

以下邀请外部用户处理程序实施接受从“添加受邀用户”页面提交的电子邮件地址,该页面可通过管理控制台访问。

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]; 
    } 
       } 
}
 
注意

此Java类将另存为名为InviteExternalUsersSample.java的JAVA文件。

为授权处理程序定义组件XML文件

必须定义组件XML文件才能部署邀请外部用户处理程序组件。 每个组件都存在一个组件XML文件,它提供了有关该组件的元数据。

以下component.xml文件用于邀请外部用户处理程序。 请注意,服务名称为InviteExternalUsersSample,此服务公开的操作名为invitedUser。 输入参数是java.util.List实例,输出值是com.adobe.edc.server.spi.esrp.InvitedUserProviderResult实例数组。

为邀请外部用户处理程序定义组件XML文件

<component xmlns="http://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> 

打包邀请外部用户处理程序

要将邀请外部用户处理程序部署到AEM Forms,您必须将Java项目打包到JAR文件中。 您必须确保邀请外部用户处理程序的业务逻辑所依赖的外部JAR文件(如edc-server-spi.jaradobe-rightsmanagement-client.jar文件)也包含在JAR文件中。 此外,组件XML文件必须存在。 component.xml文件和外部JAR文件必须位于JAR文件的根中。

注意

在下图中,显示了BootstrapImpl类。 本节不讨论如何创建BootstrapImpl类。

下图显示了打包到邀请外部用户处理程序的JAR文件中的Java项目内容。

邀请用户

A.组件所需的外部JAR文件B. JAVA文件

必须将邀请外部用户处理程序打包到JAR文件中。 在上图中,请注意列出了.JAVA文件。 打包到JAR文件后,还必须指定相应的.CLASS文件。 如果没有.CLASS文件,则授权处理程序不起作用。

注意

将外部授权处理程序打包到JAR文件中后,可以将该组件部署到AEM Forms。 给定时间只能部署一个邀请外部用户处理程序。

注意

您还可以采用编程方式部署组件。

测试邀请外部用户处理程序

要测试“邀请外部用户”处理程序,您可以使用管理控制台添加要邀请的外部用户。

要使用管理控制台添加要邀请的外部用户,请执行以下操作:

  1. 使用Workbench部署邀请外部用户处理程序的JAR文件。
  2. 重新启动应用程序服务器。
  3. 登录到管理控制台。
  4. 单击​服务 > Rights Management > 配置 >受邀​用户注册
  5. 选中​启用邀请用户注册​框,以启用邀请用户注册。 在​使用内置注册系统​下,单击​。 保存设置。
  6. 在管理控制台主页中,单击​设置 > 用户管理 > 域管理
  7. 单击​新建本地域。 在下一页,创建名称和标识符值为EDC_EXTERNAL_REGISTERED的域。 保存更改。
  8. 在管理控制台主页中,单击​服务 > Rights Management > 受邀和本地用户。 出现“添加邀请的用户”页面。
  9. 输入电子邮件地址(因为当前邀请外部用户处理程序实际上不发送电子邮件消息,因此电子邮件地址不必有效)。 单击​确定。系统会邀请用户加入。
  10. 在管理控制台主页中,单击​设置 > 用户管理 > 用户和组
  11. 在​Find​字段中,输入您指定的电子邮件地址。 单击​查找。 您邀请的用户在本地EDC_EXTERNAL_REGISTERED域中显示为用户。
注意

如果停止或卸载组件,“邀请外部用户”处理程序将失败。

在此页面上