使用AEM Forms存储库

关于存储库服务

存储库服务向AEM Forms提供资源存储和管理服务。 当开发人员创建​AEM Forms​应用程序时,他们可以在存储库中而不是文件系统中部署资产。 资产可以包括任何类型的附属品,包括XML表单、PDF forms(包括Acrobat表单)、表单片段、图像、用户档案、策略、SWF文件、DDX文件、XML模式、WSDL文件和测试数据。

例如,请考虑以下名为​Applications/FormsApplication​的Forms应用程序:

ww_ww_formrepository

请注意,FormsFolder中有一个名为Loan.xdp的文件。 要访问此表单设计,请指定完整路径(包括版本):Applications/FormsApplication/1.0/FormsFolder/Loan.xdp

注意

有关使用Workbench创建Forms应用程序的信息,请参阅Workbench帮助

位于AEM Forms存储库中的资源的路径为:

Applications/Application-name/Application-version/Folder.../Filename

以下值显示一些URI值的示例:

  • Applications/AppraisalReport/1.0/Forms/FullForm.xdp
  • Applications/AnotherApp/1.1/Assets/picture.jpg
  • Applications/SomeApp/2.0/Resources/Data/XSDs/MyData.xsd
注意

您可以使用Web浏览器浏览AEM Forms存储库。 要浏览存储库,请在Web浏览器中输入以下URL: https://[服务器名称]:[服务器端口]/存储库。 您可以使用Web浏览器验证与“使用AEM Forms存储库”部分关联的快速开始结果。 例如,如果向AEM Forms存储库添加内容,则可以在Web浏览器中查看该内容。 (请参阅快速开始(SOAP模式):使用Java API编写资源。)

存储库API提供了许多操作,您可以使用这些操作来存储和检索存储库中的信息。 例如,当处理应用程序时需要资源时,您可以获取资源列表或检索存储在存储库中的特定资源。

注意

存储库API不能用于与Content Services交互(已弃用)。 要与内容服务交互(已弃用),请使用文档管理API。

使用存储库服务API,您可以完成以下任务:

  • 创建文件夹。 请参阅创建文件夹
  • 编写资源及其属性。 请参阅编写资源
  • 列表给定集合中的资源或与其他资源相关的资源。 请参阅列出资源
  • 阅读资源及其属性。 请参阅读取资源
  • 更新资源及其属性。 请参阅更新资源
  • 搜索资源,包括其历史记录、相关资源和属性。 请参阅搜索资源
  • 指定资源之间的关系。 请参阅创建资源关系
  • 管理资源访问控制,包括锁定和解锁资源以及读写访问控制列表(ACL)。 请参阅锁定资源
  • 删除资源及其属性。 请参阅删除资源
注意

使用存储库API,您无法使用ECM存储库管理资源访问控制、搜索资源或指定资源关系。

注意

将加密的PDF写入存储库后,无法使用自动关系提取功能。 否则,加密的PDF可以存储在存储库中,然后进行检索。 在从存储库检索PDF后,检索器可以选择解密它。

注意

有关存储库服务的详细信息,请参阅AEM Forms的服务参考

创建文件夹

文件夹(资源集合)用于按有组织的分组存储对象(文件或资源)。 文件夹可以包含资源和其他文件夹,也称为子文件夹。 资源一次只能存储在一个文件夹中。

文件从文件夹继承访问控制列表(ACL),子文件夹从父文件夹继承ACL。 因此,在创建子文件夹之前,父文件夹必须存在。 通过IDE,您只能逐个文件夹进行交互,而不能逐个文件进行交互。 您不能对文件夹进行版本化,也无需这样做;文件夹不包含数据本身。 相反,它只是包含数据的资源的容器。 默认的ACL是系统级权限,这意味着用户必须具有系统级权限(读取、写入、遍历、管理ACL),直到有人授予他们特定文件夹的权限。 ACL只适用于IDE。

注意

有关存储库服务的详细信息,请参阅AEM Forms的服务参考

步骤的摘要

要创建文件夹,请按照以下步骤操作:

  1. 包括项目文件。
  2. 创建服务客户端。
  3. 创建文件夹。
  4. 将文件夹写入存储库。

包括项目文件

在开发项目中包含必要的文件。 如果您使用Java创建客户端应用程序,请包含必要的JAR文件。 如果您使用Web服务,请包含代理文件。

创建服务客户端

在以编程方式创建资源集合之前,必须建立连接并提供凭据。 这是通过创建服务客户端来完成的。

创建文件夹

调用存储库服务方法以创建资源集合,并使用标识信息填充资源集合,包括其UUID、文件夹名称和说明。

将文件夹写入存储库

调用目标库服务方法以写入资源集合,指定存储库文件夹的URI。

另请参阅

使用Java API创建文件夹

使用Web服务API创建文件夹

包括AEM FormsJava库文件

设置连接属性

存储库服务API快速开始

使用Java API创建文件夹

使用存储库服务API(Java)创建文件夹:

  1. 包括项目文件

    将项目文件包含在Java项目的类路径中。

  2. 创建服务客户端

    使用ResourceRepositoryClient对象的构造函数创建一个ServiceClientFactory对象,并传递一个包含连接属性的<a1/>对象。

  3. 创建文件夹

    要创建资源集合,必须先创建com.adobe.repository.infomodel.bean.RepositoryInfomodelFactoryBean对象。

    调用repositoryInfomodelFactoryBean对象的newResourceCollection方法,并传递以下参数:

    • 要分配给资源的com.adobe.repository.infomodel.Id UUID标识符。
    • 要分配给资源的com.adobe.repository.infomodel.Lid UUID标识符。
    • 包含资源集合名称的java.lang.String。 例如,FormsFolder

    该方法返回表示新文件夹的com.adobe.repository.infomodel.bean.ResourceCollection对象。

    使用setDescription方法设置文件夹的说明,并传递以下参数:

    • 描述资源集合的String。 在本示例中,使用"test Folder" .
  4. 将文件夹写入存储库

    调用ResourceRepositoryClient对象的writeResource方法并传入文件夹和ResourceCollection对象的URI。 例如,文件夹的URI可以是以下值/Applications/FormsApplication/1.0/

    该方法返回新创建的com.adobe.repository.infomodel.bean.Resource对象的实例。 例如,可以通过调用com.adobe.repository.infomodel.bean.Resource对象的getId方法来检索新资源的标识符值。

另请参阅

创建文件夹

快速开始(SOAP模式):使用Java API创建文件夹

包括AEM FormsJava库文件

设置连接属性

使用Web服务API创建文件夹

使用存储库服务API(Web服务)创建文件夹:

  1. 包括项目文件

    • 创建一个使用base64的Microsoft .NET客户端程序集,它使用存储库WSDL。
    • 引用Microsoft .NET客户端程序集。
  2. 创建服务客户端

    使用Microsoft .NET客户端程序集,通过调用其默认构造函数创建一个RepositoryServiceService对象。 使用包含用户名和密码的System.Net.NetworkCredential对象设置其Credentials属性。

  3. 创建文件夹

    使用ResourceCollection类的默认构造函数创建文件夹并传递以下参数:

    • 一个Id对象,通过为Id类调用默认构造函数创建该对象,并将其分配给Resource对象的id字段。
    • 一个Lid对象,通过为Lid类调用默认构造函数创建该对象,并将其分配给Resource对象的lid字段。
    • 包含资源集合名称的字符串,该名称被分配给Resource对象的name字段。 此示例中使用的名称为"testfolder"
    • 包含资源集合描述的字符串,该描述被分配给Resource对象的description字段。 此示例中使用的描述为"test folder"
  4. 将文件夹写入存储库

    调用RepositoryServiceService对象的writeResource方法并传递以下参数:

    • 要创建文件夹的路径。
    • 表示文件夹的ResourceCollection对象。
    • 传递null作为其他两个参数。

另请参阅

创建文件夹

使用Base64编码调用AEM Forms

写入资源

您可以在存储库中的给定位置创建资源。 自然文件大小受数据库限制和会话超时的影响。 对于默认配置,文件大小限制为25 MB。 要增大或减小最大文件大小,必须更改数据库配置。

写入资源等效于将数据存储在存储库中。 在将资源写入存储库后,存储库生态系统中的所有客户端都可以访问该资源。 将XML模式、XDP文件和XSD文件等资源写入存储库时,将根据MIME类型分析内容。 如果支持MIME类型,则分析器确定是否与其他内容存在隐含关系。 例如,如果层叠样式表(CSS)具有引用公共CSS的相对URL,则您也应将公共CSS提交到存储库中。 两个资源之间的关系被存储为30天的不可调节的待处理关系。 在30天内将公用CSS提交到存储库时,将形成关系。

创建资源时,访问控制列表(ACL)会从父文件夹继承。 在创建初始资源或文件夹之前,根文件夹具有系统级权限,此时该资源或文件夹将获得默认的ACL权限。

您可以使用Repository服务Java API或Web服务API以编程方式写入资源。

注意

有关存储库服务的详细信息,请参阅AEM Forms的服务参考

步骤的摘要

要编写资源,请执行以下步骤:

  1. 包括项目文件。
  2. 创建存储库服务客户端。
  3. 指定要读取的资源的URI。
  4. 阅读资源。

包括项目文件

在开发项目中包含必要的文件。 如果您使用Java创建客户端应用程序,请包含必要的JAR文件。 如果您使用Web服务,请包含代理文件。

创建服务客户端

在以编程方式读取资源之前,必须建立连接并提供凭据。 这是通过创建服务客户端来完成的。

为资源指定目标文件夹的URI

创建包含要读取的资源URI的字符串。 语法包括正斜杠,如本例所示:"/path/folder"。

创建资源

调用存储库服务方法以创建资源,并使用标识信息填充资源,包括其UUID、资源名称和说明。

指定资源内容

调用存储库服务方法以创建资源内容,并将该内容存储在资源中。

将资源写入目标文件夹

调用目标库服务方法以写入资源,指定存储库文件夹的URI。

另请参阅

使用Java API编写资源

使用Web服务API编写资源

包括AEM FormsJava库文件

设置连接属性

存储库服务API快速开始

使用Java API写入资源

使用存储库服务API(Java)编写资源:

  1. 包括项目文件

    在Java项目的类路径中包含客户端JAR文件。

  2. 创建服务客户端

    使用ResourceRepositoryClient对象的构造函数创建一个ServiceClientFactory对象,并传递一个包含连接属性的<a1/>对象。

  3. 为资源指定目标文件夹的URI

    为资源指定目标文件夹的URI。 在这种情况下,由于名为testResource的资源将存储在名为testFolder的文件夹中,因此该文件夹的URI为"/testFolder"。 URI存储为java.lang.String对象。

  4. 创建资源

    要创建资源,必须先创建com.adobe.repository.infomodel.bean.RepositoryInfomodelFactoryBean对象。

    调用RepositoryInfomodelFactoryBean对象的newResource方法,该方法创建com.adobe.repository.infomodel.bean.Resource对象。 在此示例中,提供了以下参数:

    • com.adobe.repository.infomodel.Id对象,通过为Id类调用默认构造函数来创建。
    • com.adobe.repository.infomodel.Lid对象,通过为Lid类调用默认构造函数来创建。
    • 包含资源文件名的java.lang.String

    要指定资源的描述,请调用Resource对象的setDescription方法并传递包含该描述的字符串。 在本示例中,说明为"test resource"

  5. 指定资源内容

    要为资源创建内容,请调用RepositoryInfomodelFactoryBean对象的newResourceContent方法,该方法返回com.adobe.repository.infomodel.bean.ResourceContent对象。 向ResourceContent对象添加内容。 在本示例中,这通过执行以下任务实现:

    • 调用ResourceContent对象的setDataDocument方法并传入com.adobe.idp.Document对象
    • 调用ResourceContent对象的setSize方法并传入Document对象的大小(以字节为单位)

    通过调用Resource对象的setContent方法并传入ResourceContent对象,将内容添加到资源。 有关详细信息,请参阅AEM FormsAPI参考

  6. 将资源写入目标文件夹

    调用ResourceRepositoryClient对象的writeResource方法并传入文件夹的URI以及Resource对象。

另请参阅

编写资源

快速开始(SOAP模式):使用Java API编写资源

包括AEM FormsJava库文件

设置连接属性

使用Web服务API写入资源

使用存储库服务API(Web服务)编写资源:

  1. 包括项目文件

    • 创建一个使用base64的Microsoft .NET客户端程序集,它使用存储库WSDL。
    • 引用Microsoft .NET客户端程序集。
  2. 创建服务客户端

    使用Microsoft .NET客户端程序集,通过调用其默认构造函数创建一个RepositoryServiceService对象。 使用包含用户名和密码的System.Net.NetworkCredential对象设置其Credentials属性。

  3. 为资源指定目标文件夹的URI

    为资源指定目标文件夹的URI。 在这种情况下,由于名为testResource的资源将存储在名为testFolder的文件夹中,因此该文件夹的URI为"/testFolder"。 使用与Microsoft .NET Framework(例如,C#)兼容的语言时,将URI存储在System.String对象中。

  4. 创建资源

    要创建资源,请调用Resource类的默认构造函数。 在此示例中,以下信息存储在Resource对象中:

    • com.adobe.repository.infomodel.Id对象,通过为Id类调用默认构造函数创建该对象,并将其分配给Resource对象的id字段。
    • com.adobe.repository.infomodel.Lid对象,通过为Lid类调用默认构造函数创建该对象,并将其分配给Resource对象的lid字段。
    • 包含资源文件名的字符串,该名称被分配给Resource对象的name字段。 此示例中使用的名称为"testResource"
    • 包含资源描述的字符串,该描述被分配给Resource对象的description字段。 此示例中使用的描述为"test resource"
  5. 指定资源内容

    要为资源创建内容,请调用ResourceContent类的默认构造函数。 然后,向ResourceContent对象添加内容。 在本示例中,这通过执行以下任务实现:

    • 将包含文档的BLOB对象分配给ResourceContent对象的dataDocument字段。
    • BLOB对象的大小(以字节为单位)指定给ResourceContent对象的size字段。

    ResourceContent对象分配给Resource对象的content字段,将内容添加到资源。

  6. 将资源写入目标文件夹

    调用RepositoryServiceService对象的writeResource方法并传入文件夹的URI以及Resource对象。 传递null作为其他两个参数。

另请参阅

编写资源

使用Base64编码调用AEM Forms

列出资源

您可以通过列出资源来发现资源。 对存储库执行查询以查找与给定资源集合相关的所有资源。

组织资源后,您可以检查通过查看结构的特定分支创建的结构,就像在操作系统中一样。

列表资源按关系运作:资源是文件夹的成员。 会员资格由“会员”类型的关系表示。 当您列表给定文件夹中的资源时,您将通过关系“成员”查询与给定文件夹相关的资源。 关系是方向性的:关系的成员具有作为目标成员的源。 来源是资源;目标是父文件夹。

注意

有关存储库服务的详细信息,请参阅AEM Forms的服务参考

步骤的摘要

要列表资源,请执行以下步骤:

  1. 包括项目文件。
  2. 创建服务客户端。
  3. 指定文件夹路径。
  4. 检索资源列表。

包括项目文件

在开发项目中包含必要的文件。 如果您使用Java创建客户端应用程序,请包含必要的JAR文件。 如果您使用Web服务,请包含代理文件。

创建服务客户端

在以编程方式创建资源集合之前,必须建立连接并提供凭据。 这是通过创建服务客户端来完成的。

指定文件夹路径

创建一个字符串,其中包含包含资源的文件夹的路径。 语法包括正斜杠,如本例所示:"/path/folder"。

检索资源列表

调用存储库服务方法以检索资源列表,指定目标文件夹的路径。

另请参阅

列表资源(使用Java API)

列表资源(使用Web服务API)

包括AEM FormsJava库文件

设置连接属性

存储库服务API快速开始

列表资源(使用Java API)

列表资源(使用Repository服务API(Java)):

  1. 包括项目文件

    在Java项目的类路径中包含客户端JAR文件。

  2. 创建服务客户端

    使用ResourceRepositoryClient对象的构造函数创建一个ServiceClientFactory对象,并传递一个包含连接属性的<a1/>对象。

  3. 指定文件夹路径

    指定要查询的资源集合的URI。 在这种情况下,其URI为"/testFolder"。 URI存储为java.lang.String对象。

  4. 检索资源列表

    调用ResourceRepositoryClient对象的listMembers方法并传入文件夹的URI。

    该方法返回com.adobe.repository.infomodel.bean.Resource对象的java.util.List,这些对象是Relation.TYPE_MEMBER_OF类型的com.adobe.repository.infomodel.bean.Relation的源,并将资源集合URI作为目标。 您可以循环访问此List以检索每个资源。 在此示例中,将显示每个资源的名称和说明。

另请参阅

列表资源

快速开始(SOAP模式):使用Java API列出资源

包括AEM FormsJava库文件

设置连接属性

列表资源(使用Web服务API)

列表资源(使用存储库服务API(Web服务)):

  1. 包括项目文件

    • 创建一个使用存储库WSDL的Microsoft .NET客户端程序集。
    • 引用Microsoft .NET客户端程序集。
  2. 创建服务客户端

    使用Microsoft .NET客户端程序集,通过调用其默认构造函数创建一个RepositoryServiceService对象。 使用包含用户名和密码的System.Net.NetworkCredential对象设置其Credentials属性。

  3. 指定文件夹路径

    指定包含要查询的文件夹的URI的字符串。 在这种情况下,其URI为"/testFolder"。 使用与Microsoft .NET Framework(例如,C#)兼容的语言时,将URI存储在System.String对象中。

  4. 检索资源列表

    调用RepositoryServiceService对象的listMembers方法,并作为第一个参数传入文件夹的URI。 传递null作为其他两个参数。

    该方法返回可转换为Resource对象的对象数组。 您可以对对象数组进行迭代以检索每个相关资源。 在此示例中,将显示每个资源的名称和说明。

另请参阅

列表资源

使用Base64编码调用AEM Forms

读取资源

您可以从存储库中的给定位置检索资源,以读取其内容和元数据。 该工作流由初始化表单作为前端。 该过程具有读取表单所需的所有权限。 系统检索数据表单并从存储库中读取内容。 存储库授予对内容和元数据的访问权限(甚至能够知道资源存在)。

存储库具有以下四种权限类型:

  • traverse:允许您列表资源;即读取资源元数据,但不读取资源内容
  • 阅读:允许您读取资源内容
  • 写入:允许您编写资源内容
  • 管理访问控制列表(ACL):允许您操作资源上的ACL

用户只能在具有运行进程权限时运行进程。 IDE用户需要遍历和读取权限才能与存储库同步。 ACL仅在设计时应用,因为运行时在系统上下文中发生。

您可以使用Repository服务Java API或Web服务API以编程方式读取资源。

注意

有关存储库服务的详细信息,请参阅AEM Forms的服务参考

步骤的摘要

要读取资源,请执行以下步骤:

  1. 包括项目文件。
  2. 创建存储库服务客户端。
  3. 指定要读取的资源的URI。
  4. 阅读资源。

包括项目文件

在开发项目中包含必要的文件。 如果您使用Java创建客户端应用程序,请包含必要的JAR文件。 如果您使用Web服务,请包含代理文件。

创建服务客户端

在以编程方式读取资源之前,必须建立连接并提供凭据。 这是通过创建服务客户端来完成的。

指定要读取的资源的URI

创建包含要读取的资源URI的字符串。 语法包括正斜杠,如本例所示:"/path/resource"。

阅读资源

调用存储库服务方法以读取资源,并指定URI。

另请参阅

使用Java API读取资源

使用Web服务API读取资源

包括AEM FormsJava库文件

设置连接属性

存储库服务API快速开始

使用Java API读取资源

使用存储库服务API(Java)读取资源:

  1. 包括项目文件

    在Java项目的类路径中包含客户端JAR文件。

  2. 创建服务客户端

    使用ResourceRepositoryClient对象的构造函数创建一个ServiceClientFactory对象,并传递一个包含连接属性的<a1/>对象。

  3. 指定要读取的资源的URI

    指定表示要检索的资源的URI的字符串值。 例如,假定资源名为​testResource,该资源位于名为​testFolder​的文件夹中,请指定/testFolder/testResource

  4. 阅读资源

    调用ResourceRepositoryClient对象的readResource方法,并将资源的URI作为参数传递。 此方法返回表示资源的Resource实例。

另请参阅

阅读资源

快速开始(SOAP模式):使用Java API读取资源

包括AEM FormsJava库文件

设置连接属性

使用Web服务API读取资源

使用存储库服务API(Web服务)读取资源:

  1. 包括项目文件

  2. 创建服务客户端

    使用Microsoft .NET客户端程序集,通过调用其默认构造函数创建一个RepositoryServiceService对象。 使用包含用户名和密码的System.Net.NetworkCredential对象设置其Credentials属性。

  3. 指定要读取的资源的URI

    指定包含要检索的资源的URI的字符串。 在这种情况下,由于名为testResource的资源位于名为testFolder的文件夹中,其URI为"/testFolder/testResource"。 使用与Microsoft .NET Framework(例如,C#)兼容的语言时,将URI存储在System.String对象中。

  4. 阅读资源

    调用RepositoryServiceService对象的readResource方法,并将资源的URI作为第一个参数传递。 传递null作为其他两个参数。

另请参阅

阅读资源

使用Base64编码调用AEM Forms

更新资源

您可以检索和更新存储库中的资源内容。 更新资源时,版本之间对这些资源的访问控制将保持不变。 执行更新时,您可以选择增加主版本。 如果您不选择增加主版本,则会自动更新次要版本。

更新资源时,将根据指定的资源属性创建新版本。 更新资源时,需要指定两个重要参数:目标URI和包含所有更新元数据的资源实例。 请务必注意,如果不更改给定属性(例如,名称),则传入的实例中仍需要该属性。 解析内容时创建的关系将添加到特定版本,除非指定,否则不会提前。

例如,如果更新XDP文件并且它包含对其他资源的引用,则还将记录这些附加引用。 假定form.xdp版本1.0包含两个外部引用:徽标和样式表,随后您将更新form.xdp,以便它现在有三个引用:徽标、样式表和模式文件。 在更新过程中,存储库会将第三个关系(添加到模式文件)添加到其挂起关系表中。 一旦模式文件存在在存储库中,该关系将自动形成。 但是,如果form.xdp版本2.0不再使用标志,form.xdp版本2.0将不与标志相关。

所有更新操作都是原子操作和事务操作。 例如,如果两个用户读取同一资源并且都决定将版本1.0更新到版本2.0,则其中一个将成功,其中一个将失败,则存储库的完整性将被保留,并且两者都将收到一条消息,确认成功或失败。 如果事务不提交,则在数据库发生故障时将回退,并根据应用程序服务器将超时或回退。

您可以使用Repository服务Java API或Web服务API以编程方式更新资源。

注意

有关存储库服务的详细信息,请参阅AEM Forms的服务参考

步骤的摘要

要更新资源,请执行以下步骤:

  1. 包括项目文件。
  2. 创建存储库服务客户端。
  3. 检索要更新的资源。
  4. 更新资源。

包括项目文件

在开发项目中包含必要的文件。 如果您使用Java创建客户端应用程序,请包含必要的JAR文件。 如果您使用Web服务,请包含代理文件。

创建服务客户端

在以编程方式读取资源之前,必须建立连接并提供凭据。 这是通过创建服务客户端来完成的。

检索要更新的资源

阅读资源。 有关详细信息,请参阅读取资源

更新资源

在资源中设置新信息并调用存储库服务方法以更新资源,指定URI、更新的资源以及如何更新版本信息。

另请参阅

使用Java API更新资源

使用Web服务API更新资源

包括AEM FormsJava库文件

设置连接属性

存储库服务API快速开始

使用Java API更新资源

使用存储库服务API(Java)更新资源:

  1. 包括项目文件

    在Java项目的类路径中包含客户端JAR文件。

  2. 创建服务客户端

    使用ResourceRepositoryClient对象的构造函数创建一个ServiceClientFactory对象,并传递一个包含连接属性的<a1/>对象。

  3. 检索要更新的资源

    指定要检索和读取资源的资源的URI。 在此示例中,资源的URI为"/testFolder/testResource"

  4. 更新资源

    更新Resource对象的信息。 在此示例中,要更新描述,请调用Resource对象的setDescription方法,并将新的描述字符串作为参数传递。

    然后调用ServiceClientFactory对象的updateResource方法,并传递以下参数:

    • 包含资源URI的java.lang.String对象。
    • Resource对象,包含更新的资源信息。
    • 一个boolean值,指示是更新主版本还是次版本。 在此示例中,传递值true以指示主版本将递增。

另请参阅

更新资源

快速开始(SOAP模式):使用Java API更新资源

包括AEM FormsJava库文件

设置连接属性

使用Web服务API更新资源

使用存储库API(Web服务)更新资源:

  1. 包括项目文件

    • 创建一个使用存储库WSDL的Microsoft .NET客户端程序集。
    • 引用Microsoft .NET客户端程序集。
  2. 创建服务客户端

    使用Microsoft .NET客户端程序集,通过调用其默认构造函数创建一个RepositoryServiceService对象。 使用包含用户名和密码的System.Net.NetworkCredential对象设置其Credentials属性。

  3. 检索要更新的资源

    指定要检索的资源的URI并读取资源。 在此示例中,资源的URI为"/testFolder/testResource"。 有关详细信息,请参阅读取资源

  4. 更新资源

    更新Resource对象的信息。 在此示例中,要更新说明,请为Resource对象的description字段指定新值。

  5. 调用RepositoryServiceService对象的updateResource方法,并传递以下参数:

    • 包含资源URI的System.String对象。
    • Resource对象,包含更新的资源信息。
    • 一个boolean值,指示是更新主版本还是次版本。 在此示例中,传递值true以指示主版本将递增。
    • 传递null以获得其余两个参数。

另请参阅

更新资源

使用Base64编码调用AEM Forms

搜索资源

您可以构建用于在存储库中搜索资源的查询,包括历史记录、相关资源和属性。

您可以检索相关资源以确定表单及其片段之间的相关性。 例如,如果您有表单,则可以确定表单使用的片段或外部资源。 如果您有图像,您还可以了解哪些表单使用图像。 您还可以使用基于属性的筛选来搜索相关资源。 例如,您可以搜索所有使用具有指定名称的图像的表单,或查找具有指定名称的表单使用的任何图像。 您还可以使用资源属性进行搜索。 例如,您可以执行查询来查找其名称开始为给定字符串的所有表单或资源,该字符串可能包括“%”和“_”通配符。 记住,基于属性的搜索并非基于关系;此类搜索基于您对给定资源具有特定知识的假设。

查询语句

查询​包含一个或多个与条件逻辑连接的语句。 语句​由左操作数、运算符和右操作数组成。 此外,还可以指定用于搜索结果的排序顺序。 排序顺序​包含与SQL ORDER BY子句等效的信息,并且由元素组成,这些元素包含搜索所基于的属性以及指示是使用升序还是降序的值。

您可以使用Repository服务Java API以编程方式搜索资源。 目前,无法使用Web服务API搜索资源。

排序行为

调用ResourceRepositoryClient对象的searchProperties方法并指定排序顺序时,不考虑排序顺序。 例如,假定您创建一个具有三个自定义属性的资源,其中属性名称为namesecondNameasecondName。 然后,在属性名称上创建一个排序顺序元素,并将ascending值设置为true

然后调用ResourceRepositoryClient对象的searchProperties方法并按排序顺序传递。 搜索返回具有三个属性的正确资源。 但是,属性不按属性名称排序。 它们按添加顺序返回:namesecondNameasecondName

注意

有关存储库服务的详细信息,请参阅AEM Forms的服务参考

步骤的摘要

要搜索资源,请执行以下步骤:

  1. 包括项目文件。
  2. 创建存储库服务客户端。
  3. 指定搜索的目标文件夹。
  4. 指定在搜索中使用的属性。
  5. 创建在搜索中使用的查询。
  6. 创建搜索结果的排序顺序。
  7. 搜索资源。
  8. 从搜索结果中检索资源。

包括项目文件

在开发项目中包含必要的文件。 如果您使用Java创建客户端应用程序,请包含必要的JAR文件。 如果您使用Web服务,请包含代理文件。

创建服务客户端

在以编程方式读取资源之前,必须建立连接并提供凭据。 这是通过创建服务客户端来完成的。

指定搜索的目标文件夹

创建一个字符串,其中包含用于执行搜索的基本路径。 语法包括正斜杠,如本例所示:"/path/folder"。

指定在搜索中使用的属性

您可以根据资源中包含的属性进行搜索。 指定用于执行搜索的属性值。

创建在搜索中使用的查询

使用语句和条件构建查询。 每个语句将指定搜索所基于的属性、要使用的条件以及要在搜索中使用的属性值。

创建搜索结果的排序顺序

排序顺序由元素组成,每个元素都包含搜索中使用的属性之一和指示使用升序还是降序的值。

搜索资源

使用文件夹、查询和排序顺序搜索资源。 此外,指示搜索深度和返回结果数的上限。

从搜索结果中检索资源

对返回的资源列表进行迭代并提取信息以进一步处理。

另请参阅

使用Java API搜索资源

包括AEM FormsJava库文件

设置连接属性

存储库服务API快速开始

使用Java API搜索资源

使用存储库服务API(Java)搜索资源:

  1. 包括项目文件

    在Java项目的类路径中包含客户端JAR文件。

  2. 创建服务客户端

    使用ResourceRepositoryClient对象的构造函数创建一个ServiceClientFactory对象,并传递一个包含连接属性的<a1/>对象。

  3. 指定搜索的目标文件夹

    指定要从中执行搜索的基本路径的URI。 在此示例中,资源的URI为/testFolder

  4. 指定在搜索中使用的属性

    指定用于执行搜索的属性的值。 属性存在于com.adobe.repository.infomodel.bean.Resource对象中。 在本例中,将对name属性进行搜索;因此,使用包含Resource对象名称的java.lang.String,在本例中为testResource

  5. 创建在搜索中使用的查询

    要创建查询,请通过调用Query类的默认构造函数创建com.adobe.repository.query.Query对象,并向查询添加语句。

    要创建语句,请调用com.adobe.repository.query.Query.Statement类的构造函数并传递以下参数:

    • 包含资源属性常数的左操作数。 在此示例中,由于资源名称用作搜索的基础,因此使用静态值Resource.ATTRIBUTE_NAME
    • 包含在搜索属性时使用的条件的运算符。 运算符必须是Query.Statement类中的静态常量之一。 在此示例中,使用静态值Query.Statement.OPERATOR_BEGINS_WITH
    • 包含用于执行搜索的属性值的右操作数。 在此示例中,使用名称属性String(包含值"testResource")。

    通过调用Query.Statement对象的setNamespace方法并传递com.adobe.repository.infomodel.bean.ResourceProperty类中包含的某个静态值,指定左操作数的命名空间。 在此示例中,使用ResourceProperty.RESERVED_NAMESPACE_REPOSITORY

    通过调用Query对象的addStatement方法并传入Query.Statement对象,将每个语句添加到查询。

  6. 创建搜索结果的排序顺序

    要指定搜索结果中使用的排序顺序,请通过调用SortOrder类的默认构造函数来创建com.adobe.repository.query.sort.SortOrder对象,并向排序顺序添加元素。

    要为排序顺序创建元素,请调用com.adobe.repository.query.sort.SortOrder.Element类的一个构造函数。 在此示例中,由于资源名称用作搜索的基础,因此静态值Resource.ATTRIBUTE_NAME用作第一个参数,并且升序顺序(booleantrue)指定为第二个参数。

    通过调用SortOrder对象的addSortElement方法并传入SortOrder.Element对象,将每个元素添加到排序顺序中。

  7. 搜索资源

    要根据属性属性搜索resources,请调用ResourceRepositoryClient对象的searchProperties方法并传递以下参数:

    • String,包含执行搜索的基本路径。 在这种情况下,使用"/testFolder"
    • 搜索中使用的查询。
    • 搜索深度。 在这种情况下,com.adobe.repository.infomodel.bean.ResourceCollection.DEPTH_INFINITE用于指示将使用基本路径及其所有文件夹。
    • 一个int值,指示要从中选择未分页结果集的第一行。 在此示例中,指定了0
    • 一个int值,指示要返回的结果的最大数。 在此示例中,指定了10
    • 搜索中使用的排序顺序。

    该方法按指定的排序顺序返回Resource对象的java.util.List

  8. 从搜索结果中检索资源

    要检索搜索结果中包含的资源,请遍历List并将每个对象转换为Resource,以提取其信息。 在此示例中,将显示每个资源的名称。

另请参阅

搜索资源

快速开始(SOAP模式):使用Java API搜索资源

包括AEM FormsJava库文件

设置连接属性

创建资源关系

您可以指定存储库中资源之间的关系。 有三种关系:

  • 依赖:资源依赖于其他资源的关系,这意味着存储库中需要所有相关资源。
  • 会员资格(文件系统):资源位于给定文件夹中的关系。
  • 自定义:您在资源之间指定的关系。例如,如果一个资源已弃用,而另一个资源已引入存储库,则可以指定您自己的替换关系。

您可以创建自己的自定义关系。 例如,如果将HTML文件存储在存储库中并且它使用图像,则可以指定自定义关系以将HTML文件与图像关联(因为通常只有XML文件使用存储库定义的依赖关系与图像关联)。 自定义关系的另一个示例是,如果要使用循环图结构而不是树结构构建存储库的不同视图。 您可以定义一个圆形图和一个查看器来遍历这些关系。 最后,您可以指示资源替换另一个资源,即使这两个资源完全不同。 在这种情况下,您可以定义保留范围之外的关系类型并在这两个资源之间建立关系。 您的应用程序将是唯一能够检测和处理关系的客户端,并且它可用于对该关系进行搜索。

可以使用Repository服务Java API或Web服务API以编程方式指定资源之间的关系。

注意

有关存储库服务的详细信息,请参阅AEM Forms的服务参考

步骤的摘要

要指定两个资源之间的关系,请执行以下步骤:

  1. 包括项目文件。
  2. 创建存储库服务客户端。
  3. 指定要关联的资源的URI。
  4. 创建关系。

包括项目文件

在开发项目中包含必要的文件。 如果您使用Java创建客户端应用程序,请包含必要的JAR文件。 如果您使用Web服务,请包含代理文件。

创建服务客户端

在以编程方式读取资源之前,必须建立连接并提供凭据。 这是通过创建服务客户端来完成的。

指定要关联的资源的URI

创建包含要相关的资源URI的字符串。 语法包括正斜杠,如本例所示:"/path/resource"。

创建关系

调用存储库服务方法以创建和指定关系类型。

另请参阅

使用Java API创建关系资源

使用Web服务API创建关系资源

包括AEM FormsJava库文件

设置连接属性

存储库服务API快速开始

使用Java API创建关系资源

使用Repository服务Java API创建关系资源,执行以下任务:

  1. 包括项目文件

    在Java项目的类路径中包含客户端JAR文件。

  2. 创建服务客户端

    使用ResourceRepositoryClient对象的构造函数创建一个ServiceClientFactory对象,并传递一个包含连接属性的<a1/>对象。

  3. 指定要关联的资源的URI

    指定要关联的资源的URI。 在这种情况下,由于资源名为testResource1testResource2,并位于名为testFolder的文件夹中,因此其URI为"/testFolder/testResource1""/testFolder/testResource2"。 URI作为java.lang.String对象存储。 在此示例中,资源首先写入存储库,并检索其URI。 有关编写资源的详细信息,请参阅编写资源

  4. 创建关系

    调用ResourceRepositoryClient对象的createRelationship方法并传递以下参数:

    • 源资源的URI。
    • 目标资源的URI。
    • 关系的类型,它是com.adobe.repository.infomodel.bean.Relation类中的静态常量之一。 在此示例中,通过指定值Relation.TYPE_DEPENDANT_OF建立依赖关系。
    • 一个boolean值,指示目标资源是否自动更新为新头资源的基于com.adobe.repository.infomodel.Id的标识符。 在此示例中,由于依赖关系,指定了值true

    您还可以通过调用ResourceRepositoryClient对象的getRelated方法并传递以下参数,检索给定资源的相关资源列表:

    • 要为其检索相关资源的资源的URI。 在此示例中,指定了源资源("/testFolder/testResource1")。
    • 一个boolean值,指示指定的资源是否是关系中的源资源。 在此示例中,指定了值true,因为这是情况。
    • 关系类型,它是Relation类中的静态常量之一。 在此示例中,使用之前使用的相同值来指定依赖关系:Relation.TYPE_DEPENDANT_OF

    getRelated方法返回Resource对象的java.util.List,通过该对象可以进行迭代以检索每个相关资源,并将List中包含的对象转换为Resource。 在此示例中,testResource2应为返回资源的列表。

另请参阅

创建资源关系

快速开始(SOAP模式):使用Java API创建资源之间的关系

包括AEM FormsJava库文件

设置连接属性

使用Web服务API创建关系资源

使用存储库API(Web服务)创建关系资源:

  1. 包括项目文件

    • 创建一个使用存储库WSDL的Microsoft .NET客户端程序集。
    • 引用Microsoft .NET客户端程序集。
  2. 创建服务客户端

    使用Microsoft .NET客户端程序集,通过调用其默认构造函数创建一个RepositoryServiceService对象。 使用包含用户名和密码的System.Net.NetworkCredential对象设置其Credentials属性。

  3. 指定要关联的资源的URI

    指定要关联的资源的URI。 在这种情况下,由于资源名为testResource1testResource2,并位于名为testFolder的文件夹中,因此其URI为"/testFolder/testResource1""/testFolder/testResource2"。 当使用与Microsoft .NET Framework(例如,C#)兼容的语言时,URI将存储为System.String对象。 在此示例中,资源首先写入存储库,并检索其URI。 有关编写资源的详细信息,请参阅编写资源

  4. 创建关系

    调用RepositoryServiceService对象的createRelationship方法并传递以下参数:

    • 源资源的URI。
    • 目标资源的URI。
    • 关系类型。 在此示例中,通过指定值3建立依赖关系。
    • 一个boolean值,指示是否指定了关系类型。 在此示例中,指定值true
    • 一个boolean值,指示目标资源是否自动更新为新头资源的基于Id的标识符。 在此示例中,由于依赖关系,指定了值true
    • 一个boolean值,指示是否指定了目标头。 在此示例中,指定值true
    • 传递null作为最后一个参数。

    您还可以通过调用RepositoryServiceService对象的getRelated方法并传递以下参数,检索给定资源的相关资源列表:

    • 要为其检索相关资源的资源的URI。 在此示例中,指定了源资源("/testFolder/testResource1")。
    • 一个boolean值,指示指定的资源是否是关系中的源资源。 在此示例中,指定了值true,因为这是情况。
    • 一个boolean值,指示是否指定了源资源。 在此示例中,提供了值true
    • 包含关系类型的整数数组。 在此示例中,通过在数组中使用与之前使用的相同值来指定依赖关系:3
    • 传递null以获得其余两个参数。

    getRelated方法返回可转换为Resource对象的对象数组,通过它可以进行迭代以检索每个相关资源。 在此示例中,testResource2应为返回资源的列表。

另请参阅

创建资源关系

使用Base64编码调用AEM Forms

锁定资源

您可以锁定某个资源或一组资源供特定用户独占使用或在多个用户之间共享使用。 共享锁表示资源会发生某些情况,但不会阻止任何其他人对该资源执行操作。 应将共享锁视为信令机制。 独占锁定意味着锁定资源的用户将更改资源,而锁定确保在用户不再需要访问资源并释放锁定之前,其他用户都无法更改资源。 如果存储库管理员解锁某个资源,则该资源上的所有独占和共享锁将自动删除。 此类操作适用于用户不再可用且未解锁资源的情况。

当资源被锁定时,当您视图Workbench中的“资源”选项卡时,会显示一个锁图标,如下图所示。

lr_lr_lockrepository

您可以使用Repository服务Java API或Web服务API以编程方式控制对资源的访问。

注意

有关存储库服务的详细信息,请参阅AEM Forms的服务参考

步骤的摘要

要锁定和解锁资源,请执行以下步骤:

  1. 包括项目文件。
  2. 创建存储库服务客户端。
  3. 指定要锁定的资源的URI。
  4. 锁定资源。
  5. 检索资源的锁。
  6. 解锁资源

包括项目文件

在开发项目中包含必要的文件。 如果您使用Java创建客户端应用程序,请包含必要的JAR文件。 如果您使用Web服务,请包含代理文件。

创建服务客户端

在以编程方式读取资源之前,必须建立连接并提供凭据。 这是通过创建服务客户端来完成的。

指定要锁定的资源的URI

创建包含要锁定的资源URI的字符串。 语法包括正斜杠,如本例所示:"/path/resource"。

锁定资源

调用存储库服务方法以锁定资源,指定URI、锁定类型和锁定深度。

检索资源的锁

调用存储库服务方法以检索资源的锁,并指定URI。

解锁资源

调用存储库服务方法以解锁资源,并指定URI。

另请参阅

使用Java API锁定资源

使用Web服务API锁定资源

包括AEM FormsJava库文件

设置连接属性

存储库服务API快速开始

使用Java API锁定资源

使用存储库服务API(Java)锁定资源:

  1. 包括项目文件

    在Java项目的类路径中包含客户端JAR文件。

  2. 创建服务客户端

    使用ResourceRepositoryClient对象的构造函数创建一个ServiceClientFactory对象,并传递一个包含连接属性的<a1/>对象。

  3. 指定要锁定的资源的URI

    指定要锁定的资源的URI。 在这种情况下,由于名为testResource的资源位于名为testFolder的文件夹中,其URI为"/testFolder/testResource"。 URI存储为java.lang.String对象。

  4. 锁定资源

    调用ResourceRepositoryClient对象的lockResource方法并传递以下参数:

    • 资源的URI。
    • 锁定范围。 在此示例中,由于资源将被锁定以供独占使用,因此锁定范围被指定为com.adobe.repository.infomodel.bean.Lock.SCOPE_EXCLUSIVE
    • 锁定深度。 在此示例中,由于锁定将仅应用于特定资源,并且不应用于其成员或子资源,因此锁定深度指定为Lock.DEPTH_ZERO
    注意

    需要四个参数的lockResource方法的重载版本将引发异常。 确保使用lockResource方法,该方法需要三个参数,如本演练中所示。

  5. 检索资源的锁

    调用ResourceRepositoryClient对象的getLocks方法,并将资源的URI作为参数传递。 该方法返回一列表Lock对象,您可以通过它进行迭代。 在此示例中,通过分别调用每个Lock对象的getOwnerUserIdgetDepthgetType方法,为每个对象打印锁所有者、深度和范围。

  6. 解锁资源

    调用ResourceRepositoryClient对象的unlockResource方法,并将资源的URI作为参数传递。 有关详细信息,请参阅AEM FormsAPI参考

另请参阅

锁定资源

快速开始(SOAP模式):使用Java API锁定资源

包括AEM FormsJava库文件

设置连接属性

使用Web服务API锁定资源

使用存储库服务API(Web服务)锁定资源:

  1. 包括项目文件

    • 创建使用Base64的Repository WSDL的Microsoft .NET客户端程序集。
    • 引用Microsoft .NET客户端程序集。
  2. 创建服务客户端

    使用Microsoft .NET客户端程序集,通过调用其默认构造函数创建一个RepositoryServiceService对象。 使用包含用户名和密码的System.Net.NetworkCredential对象设置其Credentials属性。

  3. 指定要锁定的资源的URI

    指定包含要锁定的资源URI的字符串。 在这种情况下,由于名为testResource的资源在文件夹testFolder中,其URI为"/testFolder/testResource"。 使用与Microsoft .NET Framework(例如,C#)兼容的语言时,将URI存储在System.String对象中。

  4. 锁定资源

    调用RepositoryServiceService对象的lockResource方法并传递以下参数:

    • 资源的URI。
    • 锁定范围。 在此示例中,由于资源将被锁定以供独占使用,因此锁定范围被指定为11
    • 锁定深度。 在此示例中,由于锁定将仅应用于特定资源,并且不应用于其成员或子资源,因此锁定深度指定为2
    • 一个int值,指示锁过期前的秒数。 在本示例中,使用1000的值。
    • 传递null作为最后一个参数。
  5. 检索资源的锁

    调用RepositoryServiceService对象的getLocks方法,将资源的URI作为第一个参数传递,将null作为第二个参数传递。 该方法返回一个object数组,它包含可通过它进行迭代的Lock对象。 在此示例中,通过分别访问每个Lock对象的ownerUserIddepthtype字段,为每个对象打印锁所有者、深度和范围。

  6. 解锁资源

    调用RepositoryServiceService对象的unlockResource方法,将资源的URI作为第一个参数传递,将null作为第二个参数传递。

另请参阅

锁定资源

使用Base64编码调用AEM Forms

删除资源

您可以使用存储库服务Java API(SOAP)从存储库中的给定位置以编程方式删除资源。

删除资源时,删除操作通常是永久的,但在某些情况下, ECM存储库可能会根据其历史记录机制存储资源的版本。 因此,删除资源时,务必确保您不再需要该资源。 删除资源的常见原因包括需要增加数据库中的可用空间。 您可以删除某个资源版本,但是,如果删除了该版本,则必须指定资源标识符,而不是其逻辑标识符(LID)或路径。 如果删除文件夹,则该文件夹中的所有内容(包括子文件夹和资源)都将自动删除。

相关资源不会被删除。 例如,如果您有一个使用logo.gif文件的表单,并且您删除logo.gif,则关系将存储在挂起的关系表中。 作为替代方法,对于版本弃用,请将最新版本的对象状态设置为已弃用。

删除操作在ECM系统中不是事务安全的。 例如,如果尝试删除100个资源,而第50个资源上的操作失败,则前49个实例将被删除,其余实例则不会删除。 否则,默认行为为回滚(非承诺)。

注意

com.adobe.repository.bindings.dsc.client.ResourceRepositoryClient.deleteResources()方法与ECM存储库(EMC Documentum Content Server和IBM FileNet P8 Content Manager)一起使用时,如果某个指定资源的删除失败,则事务将不会回滚,这意味着无法删除已删除的文件。

注意

有关存储库服务的详细信息,请参阅AEM Forms的服务参考

步骤的摘要

要删除资源,请执行以下步骤:

  1. 包括项目文件。
  2. 创建存储库服务客户端。
  3. 指定要删除的资源的URI。
  4. 删除资源。

包括项目文件

在开发项目中包含必要的文件。 如果您使用Java创建客户端应用程序,请包含必要的JAR文件。 如果您使用Web服务,请包含代理文件。

创建服务客户端

在以编程方式读取资源之前,必须建立连接并提供凭据。 这是通过创建服务客户端来完成的。

指定要删除的资源的URI

创建一个字符串,其中包含要删除的资源的URI。 语法包括正斜杠,如本例所示:"/path/resource"。 如果要删除的资源是文件夹,则删除将是递归的。

删除资源

调用存储库服务方法以删除资源,并指定URI。

另请参阅

使用Java API删除资源

使用Web服务API删除资源

包括AEM FormsJava库文件

设置连接属性

存储库服务API快速开始

使用Java API(SOAP)删除资源

使用存储库API(Java)删除资源:

  1. 包括项目文件

    在Java项目的类路径中包含客户端JAR文件。

  2. 创建服务客户端

    使用ResourceRepositoryClient对象的构造函数创建一个ServiceClientFactory对象,并传递一个包含连接属性的<a1/>对象。

  3. 指定要删除的资源的URI

    指定要检索的资源的URI。 在这种情况下,由于名为testResourceToBeDeleted的资源位于名为testFolder的文件夹中,其URI为/testFolder/testResourceToBeDeleted。 URI存储为java.lang.String对象。 在此示例中,资源首先写入存储库,并检索其URI。 有关编写资源的详细信息,请参阅编写资源

  4. 删除资源

    调用ResourceRepositoryClient对象的deleteResource方法,并将资源的URI作为参数传递。

另请参阅

删除资源

快速开始(SOAP模式):使用Java API搜索资源

包括AEM FormsJava库文件

设置连接属性

使用Web服务API删除资源

使用存储库API(Web服务)删除资源:

  1. 包括项目文件

    • 创建使用Base64的Repository WSDL的Microsoft .NET客户端程序集。
    • 引用Microsoft .NET客户端程序集。
  2. 创建服务客户端

    使用Microsoft .NET客户端程序集,通过调用其默认构造函数创建一个RepositoryServiceService对象。 使用包含用户名和密码的System.Net.NetworkCredential对象设置其Credentials属性。

  3. 指定要删除的资源的URI

    指定要检索的资源的URI。 在这种情况下,由于名为testResourceToBeDeleted的资源位于名为testFolder的文件夹中,其URI为"/testFolder/testResourceToBeDeleted"。 在此示例中,资源首先写入存储库,并检索其URI。 有关编写资源的详细信息,请参阅编写资源

  4. 删除资源

    调用RepositoryServiceService对象的deleteResources方法,并传递一个System.String数组,其中包含作为第一个参数的资源的URI。 传递null作为第二个参数。

另请参阅

删除资源

使用Base64编码调用AEM Forms

在此页面上