使用AEM Forms存储库 working-with-aem-forms-repository
本文档中的示例和示例仅适用于JEE环境上的AEM Forms 。
关于存储库服务
存储库服务为AEM Forms提供资源存储和管理服务。 当开发人员创建 AEM Forms 应用程序中,他们可以在存储库中部署资产,而不是部署文件系统。 资产可以包括任何类型的附属资料,包括XML表单、PDF forms(包括Acrobat表单)、表单片段、图像、配置文件、策略、SWF文件、DDX文件、XML架构、WSDL文件和测试数据。
例如,考虑以下名为的Forms应用程序 Applications/FormsApplication:
请注意,FormsFolder中有一个名为Loan.xdp的文件。 要访问此表单设计,请指定完整路径(包括版本): Applications/FormsApplication/1.0/FormsFolder/Loan.xdp
.
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
https://[server name]:[server port]/repository
. 您可以使用Web浏览器验证与使用AEM Forms存储库部分关联的快速入门结果。 例如,如果将内容添加到AEM Forms存储库,则可以在Web浏览器中查看该内容。 (请参阅 快速入门(SOAP模式):使用Java API编写资源.)存储库API提供了几种可用于存储和检索存储库信息的操作。 例如,在处理应用程序时需要资源时,您可以获取资源列表或检索存储在存储库中的特定资源。
使用存储库服务API,您可以完成以下任务:
创建文件夹 creating-folders
文件夹(资源集合)用于将对象(文件或资源)存储在组织的分组中。 文件夹可以包含资源和其他文件夹,也称为子文件夹。 资源一次只能存储在一个文件夹中。
文件从文件夹继承访问控制列表(ACL),子文件夹从其父文件夹继承ACL。 因此,在创建子文件夹之前,父文件夹必须存在。 IDE仅允许您逐个文件夹进行交互,而不是逐个文件进行交互。 您不能对文件夹进行版本控制,也不需要这样做;文件夹本身并不包含数据。 它只是包含数据的资源的容器。 默认的ACL是系统级别的权限,这意味着用户必须具有系统级别的权限(读取、写入、遍历、管理ACL),直到有人授予他们对特定文件夹的权限为止。 ACL只能在IDE中工作。
步骤摘要 summary-of-steps
要创建文件夹,请执行以下步骤:
- 包括项目文件。
- 创建服务客户端。
- 创建文件夹。
- 将文件夹写入存储库。
包含项目文件
在开发项目中包含必要的文件。 如果要使用Java创建客户端应用程序,请包含必要的JAR文件。 如果您使用的是Web服务,请包含代理文件。
创建服务客户端
必须先建立连接并提供凭据,然后才能以编程方式创建资源集合。 这是通过创建服务客户端来实现的。
创建文件夹
调用存储库服务方法以创建资源集合,并使用标识信息(包括其UUID、文件夹名称和描述)填充资源集合。
将文件夹写入存储库
调用存储库服务方法以写入资源集合,指定目标文件夹的URI。
另请参阅
使用Java API创建文件夹 create-folders-using-the-java-api
使用存储库服务API (Java)创建文件夹:
-
包含项目文件
在Java项目的类路径中包含项目文件。
-
创建服务客户端
创建
ResourceRepositoryClient
对象,使用它的构造函数传递ServiceClientFactory
包含连接属性的对象。 -
创建文件夹
要创建资源集合,必须先创建
com.adobe.repository.infomodel.bean.RepositoryInfomodelFactoryBean
对象。调用
repositoryInfomodelFactoryBean
对象的newResourceCollection
方法,并传入以下参数:- A
com.adobe.repository.infomodel.Id
要分配给资源的UUID标识符。 - A
com.adobe.repository.infomodel.Lid
要分配给资源的UUID标识符。 - A
java.lang.String
包含资源集合的名称。 例如:FormsFolder
。
此方法会返回
com.adobe.repository.infomodel.bean.ResourceCollection
表示新文件夹的对象。使用设置文件夹的描述
setDescription
方法,并传入以下参数:- A
String
描述资源集合。 在此示例中,"test Folder"
已使用.
- A
-
将文件夹写入存储库
调用
ResourceRepositoryClient
对象的writeResource
方法,并在文件夹的URI中传递和ResourceCollection
对象。 例如,文件夹的URI可以是以下值/Applications/FormsApplication/1.0/
.方法返回新创建的实例
com.adobe.repository.infomodel.bean.Resource
对象。 例如,您可以通过调用com.adobe.repository.infomodel.bean.Resource
对象的getId
方法。
另请参阅
使用Web服务API创建文件夹 create-folders-using-the-web-service-api
使用存储库服务API(Web服务)创建文件夹:
-
包含项目文件
- 使用base64创建使用存储库WSDL的Microsoft .NET客户端程序集。
- 引用Microsoft .NET客户端程序集。
-
创建服务客户端
使用Microsoft .NET客户端程序集,创建
RepositoryServiceService
对象。 设置其Credentials
属性使用System.Net.NetworkCredential
包含用户名和密码的对象。 -
创建文件夹
使用默认构造函数创建文件夹
ResourceCollection
类并传入以下参数:- An
Id
对象,这是通过调用Id
类并分配给Resource
对象的id
字段。 - An
Lid
对象,这是通过调用Lid
类并分配给Resource
对象的lid
字段。 - 一个字符串,其中包含分配给
Resource
对象的name
字段。 本示例中使用的名称为"testfolder"
. - 包含资源集合说明的字符串,该资源集合已分配给
Resource
对象的description
字段。 本示例中使用的描述为"test folder"
.
- An
-
将文件夹写入存储库
调用
RepositoryServiceService
对象的writeResource
方法并传递以下参数:- 要创建文件夹的路径。
- 此
ResourceCollection
表示文件夹的对象。 - 通过
null
其他两个参数。
另请参阅
写入资源 writing-resources
您可以在存储库中的给定位置创建资源。 自然文件大小受数据库限制和会话超时的影响。 对于默认配置,文件限制为25 MB。 要提高或降低最大文件大小,必须更改数据库配置。
写入资源相当于将数据存储在存储库中。 将资源写入存储库后,存储库生态系统中的所有客户端都可以访问该资源。 将资源(如XML架构、XDP文件和XSD文件)写入存储库时,会根据MIME类型解析内容。 如果支持MIME类型,则解析器确定是否存在与其他内容的隐含关系。 例如,如果层叠样式表(CSS)具有引用公共CSS的相对URL,则您还应将公共CSS提交到存储库中。 这两个资源之间的关系作为待定关系存储30天的不可调整周期。 在30天期限内将公共CSS提交到存储库时,即会形成关系。
创建资源时,访问控制列表(ACL)继承自父文件夹。 在创建初始资源或文件夹之前,根文件夹具有系统级别的权限,此时资源或文件夹将获得默认ACL权限。
您可以使用存储库服务Java API或Web服务API以编程方式编写资源。
步骤摘要 summary_of_steps-1
要编写资源,请执行以下步骤:
- 包括项目文件。
- 创建存储库服务客户端。
- 指定要读取的资源的URI。
- 读取资源。
包含项目文件
在开发项目中包含必要的文件。 如果要使用Java创建客户端应用程序,请包含必要的JAR文件。 如果您使用的是Web服务,请包含代理文件。
创建服务客户端
必须先建立连接并提供凭据,然后才能以编程方式读取资源。 这是通过创建服务客户端来实现的。
为资源指定目标文件夹的URI
创建包含要读取的资源URI的字符串。 语法包括正斜杠,如以下示例所示:"/路径/文件夹“。
创建资源
调用存储库服务方法以创建资源,并使用标识信息(包括资源的UUID、资源名称和说明)填充资源。
指定资源内容
调用存储库服务方法以创建资源内容,并将该内容存储在资源中。
将资源写入目标文件夹
调用存储库服务方法来写入资源,指定目标文件夹的URI。
另请参阅
使用Java API编写资源 write-resources-using-the-java-api
使用存储库服务API (Java)编写资源:
-
包含项目文件
在Java项目的类路径中包含客户端JAR文件。
-
创建服务客户端
创建
ResourceRepositoryClient
对象,使用它的构造函数传递ServiceClientFactory
包含连接属性的对象。 -
为资源指定目标文件夹的URI
为资源指定目标文件夹的URI。 在本例中,因为指定的资源
testResource
将存储在名为的文件夹中testFolder
,文件夹的URI为"/testFolder"
. URI存储为java.lang.String
对象。 -
创建资源
要创建资源,必须先创建
com.adobe.repository.infomodel.bean.RepositoryInfomodelFactoryBean
对象。调用
RepositoryInfomodelFactoryBean
对象的newResource
方法,用于创建com.adobe.repository.infomodel.bean.Resource
对象。 在此示例中,提供了以下参数:- A
com.adobe.repository.infomodel.Id
对象,这是通过调用Id
类。 - A
com.adobe.repository.infomodel.Lid
对象,这是通过调用Lid
类。 - A
java.lang.String
包含资源的文件名。
要指定资源的说明,请调用
Resource
对象的setDescription
方法,并传递包含描述的字符串。 在此示例中,描述为"test resource"
. - A
-
指定资源内容
要为资源创建内容,请调用
RepositoryInfomodelFactoryBean
对象的newResourceContent
方法,返回com.adobe.repository.infomodel.bean.ResourceContent
对象。 将内容添加到ResourceContent
对象。 在本例中,可通过执行以下任务来实现这一点:- 调用
ResourceContent
对象的setDataDocument
方法并传入com.adobe.idp.Document
对象 - 调用
ResourceContent
对象的setSize
方法并传入的大小(以字节为单位)Document
对象
通过调用
Resource
对象的setContent
方法并传入ResourceContent
对象。 有关更多信息,请参阅 AEM Forms API参考. - 调用
-
将资源写入目标文件夹
调用
ResourceRepositoryClient
对象的writeResource
方法,并在文件夹的URI中传递,Resource
对象。
另请参阅
使用Web服务API编写资源 write-resources-using-the-web-service-api
使用存储库服务API(Web服务)编写资源:
-
包含项目文件
- 使用base64创建使用存储库WSDL的Microsoft .NET客户端程序集。
- 引用Microsoft .NET客户端程序集。
-
创建服务客户端
使用Microsoft .NET客户端程序集,创建
RepositoryServiceService
对象。 设置其Credentials
属性使用System.Net.NetworkCredential
包含用户名和密码的对象。 -
为资源指定目标文件夹的URI
为资源指定目标文件夹的URI。 在本例中,因为指定的资源
testResource
将存储在名为的文件夹中testFolder
,文件夹的URI为"/testFolder"
. 使用与Microsoft .NET Framework兼容的语言时(例如,C#),将URI存储在System.String
对象。 -
创建资源
要创建资源,请调用
Resource
类。 在此示例中,以下信息存储在Resource
对象:- A
com.adobe.repository.infomodel.Id
对象,这是通过调用Id
类并分配给Resource
对象的id
字段。 - A
com.adobe.repository.infomodel.Lid
对象,这是通过调用Lid
类并分配给Resource
对象的lid
字段。 - 一个字符串,其中包含分配给的资源的文件名。
Resource
对象的name
字段。 本示例中使用的名称为"testResource"
. - 一个字符串,其中包含分配给的资源的描述。
Resource
对象的description
字段。 本示例中使用的描述为"test resource"
.
- A
-
指定资源内容
要为资源创建内容,请调用
ResourceContent
类。 然后将内容添加到ResourceContent
对象。 在本例中,可通过执行以下任务来实现这一点:- 分配
BLOB
包含文档的对象ResourceContent
对象的dataDocument
字段。 - 分配的大小(以字节为单位)
BLOB
对象ResourceContent
对象的size
字段。
通过分配
ResourceContent
对象Resource
对象的content
字段。 - 分配
-
将资源写入目标文件夹
调用
RepositoryServiceService
对象的writeResource
方法,并在文件夹的URI中传递,Resource
对象。 通过null
其他两个参数。
另请参阅
列出资源 listing-resources
您可以通过列出资源来发现资源。 对存储库执行查询,以查找与给定资源集合相关的所有资源。
整理资源后,您可以检查通过查看结构的特定分支创建的结构,就像在操作系统中一样。
列出资源按关系运行:资源是文件夹的成员。 成员资格由“成员”类型的关系表示。 在给定文件夹中列出资源时,将查询与关系“member of”的给定文件夹相关的资源。 关系是方向性的:关系的成员具有作为目标成员的源。 源是资源;目标是父文件夹。
步骤摘要 summary_of_steps-2
要列出资源,请执行以下步骤:
- 包括项目文件。
- 创建服务客户端。
- 指定文件夹路径。
- 检索资源列表。
包含项目文件
在开发项目中包含必要的文件。 如果要使用Java创建客户端应用程序,请包含必要的JAR文件。 如果您使用的是Web服务,请包含代理文件。
创建服务客户端
必须先建立连接并提供凭据,然后才能以编程方式创建资源集合。 这是通过创建服务客户端来实现的。
指定文件夹路径
创建一个字符串,其中包含包含资源的文件夹的路径。 语法包括正斜杠,如以下示例所示:"/路径/文件夹“。
检索资源列表
调用存储库服务方法以检索资源列表,指定目标文件夹的路径。
另请参阅
使用Java API列出资源 list-resources-using-the-java-api
使用存储库服务API (Java)列出资源:
-
包含项目文件
在Java项目的类路径中包含客户端JAR文件。
-
创建服务客户端
创建
ResourceRepositoryClient
对象,使用它的构造函数传递ServiceClientFactory
包含连接属性的对象。 -
指定文件夹路径
指定要查询的资源集合的URI。 在这种情况下,其URI为
"/testFolder"
. URI存储为java.lang.String
对象。 -
检索资源列表
调用
ResourceRepositoryClient
对象的listMembers
方法,并在文件夹的URI中传递。此方法会返回
java.util.List
之com.adobe.repository.infomodel.bean.Resource
源对象com.adobe.repository.infomodel.bean.Relation
类型Relation.TYPE_MEMBER_OF
并将资源收集URI作为目标。 您可以对此进行迭代List
以检索每个资源。 在此示例中,将显示每个资源的名称和说明。
另请参阅
列出资源.
使用Web服务API列出资源 list-resources-using-the-web-service-api
使用存储库服务API(Web服务)列出资源:
-
包含项目文件
- 创建使用存储库WSDL的Microsoft .NET客户端程序集。
- 引用Microsoft .NET客户端程序集。
-
创建服务客户端
使用Microsoft .NET客户端程序集,创建
RepositoryServiceService
对象。 设置其Credentials
属性使用System.Net.NetworkCredential
包含用户名和密码的对象。 -
指定文件夹路径
指定包含要查询的文件夹URI的字符串。 在这种情况下,其URI为
"/testFolder"
. 使用与Microsoft .NET Framework兼容的语言时(例如,C#),将URI存储在System.String
对象。 -
检索资源列表
调用
RepositoryServiceService
对象的listMembers
方法,并在文件夹的URI中传递作为第一个参数。 通过null
其他两个参数。方法返回一个对象数组,可以将这些对象强制转换为
Resource
对象。 您可以循环遍历对象数组以检索每个相关资源。 在此示例中,将显示每个资源的名称和说明。
另请参阅
列出资源.
正在读取资源 reading-resources
您可以从存储库中的给定位置检索资源以读取其内容和元数据。 工作流由初始化表单作为前端。 该流程具有读取表单所需的所有权限。 系统检索数据表单并从存储库中读取内容。 存储库授予对内容和元数据的访问权限(甚至能够知道资源存在)。
存储库具有以下四种权限类型:
- 遍历:用于列出资源;即读取资源元数据,但不读取资源内容
- 读取:用于读取资源内容
- 写入:用于编写资源内容
- 管理访问控制列表(ACL):用于处理资源上的ACL
用户只有在拥有运行进程的权限时,才能运行进程。 IDE用户需要遍历和读取权限才能与存储库同步。 ACL仅在设计时应用,因为运行时发生在系统上下文中。
您可以使用存储库服务Java API或Web服务API以编程方式读取资源。
步骤摘要 summary_of_steps-3
要读取资源,请执行以下步骤:
- 包括项目文件。
- 创建存储库服务客户端。
- 指定要读取的资源的URI。
- 读取资源。
包含项目文件
在开发项目中包含必要的文件。 如果要使用Java创建客户端应用程序,请包含必要的JAR文件。 如果您使用的是Web服务,请包含代理文件。
创建服务客户端
必须先建立连接并提供凭据,然后才能以编程方式读取资源。 这是通过创建服务客户端来实现的。
指定要读取的资源的URI
创建包含要读取的资源URI的字符串。 语法包括正斜杠,如以下示例所示:"/路径/资源“。
读取资源
调用存储库服务方法以读取资源,指定URI。
另请参阅
使用Java API读取资源 read-resources-using-the-java-api
使用存储库服务API (Java)读取资源:
-
包含项目文件
在Java项目的类路径中包含客户端JAR文件。
-
创建服务客户端
创建
ResourceRepositoryClient
对象,使用它的构造函数传递ServiceClientFactory
包含连接属性的对象。 -
指定要读取的资源的URI
指定一个字符串值,该值表示要检索的资源的URI。 例如,假定资源名为 testResource 位于名为的文件夹中 testFolder,指定
/testFolder/testResource
. -
读取资源
调用
ResourceRepositoryClient
对象的readResource
方法将资源的URI作为参数传递。 此方法会返回Resource
表示资源的实例。
另请参阅
使用Web服务API读取资源 reading-resources-using-the-web-service-api
使用存储库服务API(Web服务)读取资源:
-
包含项目文件
- 创建使用存储库WSDL的Microsoft .NET客户端程序集。 (请参阅 创建使用Base64编码的.NET客户端程序集.)
- 引用Microsoft .NET客户端程序集。 (请参阅 创建使用Base64编码的.NET客户端程序集.)
-
创建服务客户端
使用Microsoft .NET客户端程序集,创建
RepositoryServiceService
对象。 设置其Credentials
属性使用System.Net.NetworkCredential
包含用户名和密码的对象。 -
指定要读取的资源的URI
指定包含要检索的资源URI的字符串。 在本例中,因为指定的资源
testResource
位于名为的文件夹中testFolder
,其URI为"/testFolder/testResource"
. 使用与Microsoft .NET Framework兼容的语言时(例如,C#),将URI存储在System.String
对象。 -
读取资源
调用
RepositoryServiceService
对象的readResource
方法,并将资源的URI作为第一个参数传递。 通过null
其他两个参数。
另请参阅
更新资源 updating-resources
您可以检索和更新存储库中的资源内容。 更新资源时,对这些资源的访问控制在版本之间保持不变。 执行更新时,您可以选择递增主版本。 如果不选择递增主版本,则会自动更新次版本。
更新资源时,会根据指定的资源属性创建新版本。 更新资源时,需要指定两个重要参数:目标URI和包含所有已更新元数据的资源实例。 请务必注意,如果不更改给定属性(例如,名称),则在您传入的实例中仍需要该属性。 解析内容时创建的关系将添加到特定版本,除非另外指定,否则不会转发这些关系。
例如,如果更新XDP文件并且它包含对其他资源的引用,则也会记录这些附加引用。 假设form.xdp版本1.0具有两个外部引用:徽标和样式表,随后您更新了form.xdp,使其现在具有三个引用:徽标、样式表和架构文件。 在更新过程中,存储库会将第三个关系(添加到架构文件)添加到其挂起关系表中。 一旦架构文件出现在存储库中,关系就会自动形成。 但是,如果form.xdp 2.0版不再使用徽标,则form.xdp 2.0版将与徽标无关。
所有更新操作都是原子操作和事务性操作。 例如,如果两个用户读取同一资源,并且都决定将1.0版本更新为2.0版本,则其中一个用户将成功,而其中一个用户将失败,存储库的完整性将得到维护,并且两个用户都将收到一条消息,确认存储库是成功还是失败。 如果事务未提交,则在出现数据库故障时将会回滚,并且会超时或回滚,具体取决于应用程序服务器。
您可以使用存储库服务Java API或Web服务API以编程方式更新资源。
步骤摘要 summary_of_steps-4
要更新资源,请执行以下步骤:
- 包括项目文件。
- 创建存储库服务客户端。
- 检索要更新的资源。
- 更新资源。
包含项目文件
在开发项目中包含必要的文件。 如果要使用Java创建客户端应用程序,请包含必要的JAR文件。 如果您使用的是Web服务,请包含代理文件。
创建服务客户端
必须先建立连接并提供凭据,然后才能以编程方式读取资源。 这是通过创建服务客户端来实现的。
检索要更新的资源
读取资源。 有关更多信息,请参阅 正在读取资源.
更新资源
在资源中设置新信息并调用存储库服务方法来更新资源,指定URI、更新的资源以及应如何更新版本信息。
另请参阅
使用Java API更新资源 update-resources-using-the-java-api
使用存储库服务API (Java)更新资源:
-
包含项目文件
在Java项目的类路径中包含客户端JAR文件。
-
创建服务客户端
创建
ResourceRepositoryClient
对象,使用它的构造函数传递ServiceClientFactory
包含连接属性的对象。 -
检索要更新的资源
指定要检索和读取资源的资源URI。 在此示例中,资源的URI为
"/testFolder/testResource"
. -
更新资源
更新
Resource
对象的信息。 在此示例中,要更新说明,请调用Resource
对象的setDescription
方法将新的描述字符串作为参数传递。然后调用
ServiceClientFactory
对象的updateResource
方法,并传入以下参数:- A
java.lang.String
包含资源URI的对象。 - 此
Resource
包含已更新资源信息的对象。 - A
boolean
指示是更新主要版本还是次要版本的值。 在此示例中,值为true
传递以指示主版本将递增。
- A
另请参阅
使用Web服务API更新资源 update-resources-using-the-web-service-api
使用存储库API(Web服务)更新资源:
-
包含项目文件
- 创建使用存储库WSDL的Microsoft .NET客户端程序集。
- 引用Microsoft .NET客户端程序集。
-
创建服务客户端
使用Microsoft .NET客户端程序集,创建
RepositoryServiceService
对象。 设置其Credentials
属性使用System.Net.NetworkCredential
包含用户名和密码的对象。 -
检索要更新的资源
指定要检索的资源的URI并读取该资源。 在此示例中,资源的URI为
"/testFolder/testResource"
. 有关更多信息,请参阅 正在读取资源. -
更新资源
更新
Resource
对象的信息。 在本例中,要更新说明,请为Resource
对象的description
字段。 -
调用
RepositoryServiceService
对象的updateResource
方法,并传入以下参数:- A
System.String
包含资源URI的对象。 - 此
Resource
包含已更新资源信息的对象。 - A
boolean
指示是更新主要版本还是次要版本的值。 在此示例中,值为true
传递以指示主版本将递增。 - 通过
null
对于其余两个参数。
- A
另请参阅
搜索资源 searching-for-resources
您可以构建用于搜索存储库中资源(包括历史记录、相关资源和属性)的查询。
您可以检索相关资源以确定表单及其片段之间的依赖关系。 例如,如果您有一个表单,则可以确定它使用的片段或外部资源。 如果您有图像,您还可以找到使用该图像的表单。 您还可以使用基于属性的筛选来搜索相关资源。 例如,您可以搜索使用具有指定名称的图像的所有表单,或查找由具有指定名称的表单使用的任何图像。 您还可以使用资源属性进行搜索。 例如,您可以执行查询以查找其名称以给定字符串开头的所有表单或资源,该字符串可能包含“%”和“_”通配符。 请记住,基于属性的搜索不是基于关系;此类搜索基于您对给定资源具有特定知识的假设。
查询语句
A 查询 包含一个或多个用条件逻辑连接的语句。 A 语句 由一个左操作数、一个运算符和一个右操作数组成。 此外,您还可以指定用于搜索结果的排序顺序。 此 排序顺序 包含与SQL等效的信息 ORDER BY
子句并且由元素组成,这些元素包含搜索所基于的属性,以及一个指示要使用升序还是降序的值。
您可以使用存储库服务Java API以编程方式搜索资源。 此时,无法使用Web服务API来搜索资源。
排序行为
调用时未遵循排序顺序 ResourceRepositoryClient
对象的 searchProperties
方法和指定排序顺序。 例如,假设您创建了一个具有三个自定义属性的资源,其中属性名称为 name
, secondName
、和 asecondName
. 接下来,在属性名称上创建排序顺序元素,并设置 ascending
值至 true
.
然后调用 ResourceRepositoryClient
对象的 searchProperties
方法,并按排序顺序传递。 搜索将返回正确的资源,并具有三个属性。 但是,属性不按属性名称排序。 它们会按添加顺序返回: name
, secondName
、和 asecondName
.
步骤摘要 summary_of_steps-5
要搜索资源,请执行以下步骤:
- 包括项目文件。
- 创建存储库服务客户端。
- 指定搜索的目标文件夹。
- 指定搜索中使用的属性。
- 创建搜索中使用的查询。
- 为搜索结果创建排序顺序。
- 搜索资源。
- 从搜索结果中检索资源。
包含项目文件
在开发项目中包含必要的文件。 如果要使用Java创建客户端应用程序,请包含必要的JAR文件。 如果您使用的是Web服务,请包含代理文件。
创建服务客户端
必须先建立连接并提供凭据,然后才能以编程方式读取资源。 这是通过创建服务客户端来实现的。
指定搜索的目标文件夹
创建一个字符串,其中包含进行搜索的基本路径。 语法包括正斜杠,如以下示例所示:"/路径/文件夹“。
指定搜索中使用的属性
您可以根据资源中包含的属性进行搜索。 指定要执行搜索的属性的值。
创建搜索中使用的查询
使用语句和条件构造查询。 每个语句将指定搜索所基于的属性、要使用的条件以及要在搜索中使用的属性值。
为搜索结果创建排序顺序
排序顺序由元素组成,每个元素包含搜索中使用的属性之一,以及指示使用升序还是降序的值。
搜索资源
使用文件夹、查询和排序顺序搜索资源。 此外,指示搜索的深度以及要返回的结果数量的上限。
从搜索结果中检索资源
对返回的资源列表进行迭代,并提取信息以供进一步处理。
另请参阅
使用Java API搜索资源 search-for-resources-using-the-java-api
使用存储库服务API (Java)搜索资源:
-
包含项目文件
在Java项目的类路径中包含客户端JAR文件。
-
创建服务客户端
创建
ResourceRepositoryClient
对象,使用它的构造函数传递ServiceClientFactory
包含连接属性的对象。 -
指定搜索的目标文件夹
指定要从中执行搜索的基本路径的URI。 在此示例中,资源的URI为
/testFolder
. -
指定搜索中使用的属性
指定要执行搜索的属性的值。 属性存在于
com.adobe.repository.infomodel.bean.Resource
对象。 在本例中,将对name属性进行搜索;因此,java.lang.String
包含Resource
使用的对象名称为testResource
这种情况下。 -
创建搜索中使用的查询
要创建查询,请创建
com.adobe.repository.query.Query
对象,方法是Query
类并向查询中添加语句。要创建语句,请调用
com.adobe.repository.query.Query.Statement
类并传入以下参数:- 包含资源属性常量的左操作数。 在本例中,由于资源的名称用作搜索的基础,因此使用静态值
Resource.ATTRIBUTE_NAME
已使用。 - 包含搜索属性时使用的条件的运算符。 运算符必须是
Query.Statement
类。 在此示例中,静态值Query.Statement.OPERATOR_BEGINS_WITH
已使用。 - 包含进行搜索的属性值的右操作数。 在此示例中,name属性a
String
包含值"testResource"
,使用。
通过调用
Query.Statement
对象的setNamespace
方法,并传入包含在com.adobe.repository.infomodel.bean.ResourceProperty
类。 在此示例中,使用ResourceProperty.RESERVED_NAMESPACE_REPOSITORY
。通过调用
Query
对象的addStatement
方法并传入Query.Statement
对象。 - 包含资源属性常量的左操作数。 在本例中,由于资源的名称用作搜索的基础,因此使用静态值
-
为搜索结果创建排序顺序
要指定搜索结果中使用的排序顺序,请创建
com.adobe.repository.query.sort.SortOrder
对象,方法是SortOrder
类,并向排序顺序中添加元素。要为排序顺序创建元素,请调用以下项的构造函数之一:
com.adobe.repository.query.sort.SortOrder.Element
类。 在本例中,由于资源的名称用作搜索的基础,因此使用静态值Resource.ATTRIBUTE_NAME
用作第一个参数,按升序排列(aboolean
值true
)指定为第二个参数。通过调用
SortOrder
对象的addSortElement
方法并传入SortOrder.Element
对象。 -
搜索资源
要搜索
resources
根据属性属性,调用ResourceRepositoryClient
对象的searchProperties
方法并传递以下参数:- A
String
包含执行搜索的基本路径。 在本例中,"/testFolder"
已使用。 - 搜索中使用的查询。
- 搜索的深度。 在本例中,
com.adobe.repository.infomodel.bean.ResourceCollection.DEPTH_INFINITE
用于指示要使用基本路径及其所有文件夹。 - An
int
表示从中选择未分页结果集的第一行的值。 在此示例中,0
已指定。 - An
int
表示返回的最大结果数的值。 在此示例中,10
已指定。 - 搜索中使用的排序顺序。
此方法会返回
java.util.List
之Resource
对象按指定的排序顺序。 - A
-
从搜索结果中检索资源
要检索搜索结果中包含的资源,请通过
List
并将每个对象转换为Resource
以提取其信息。 在此示例中,将显示每个资源的名称。
另请参阅
创建资源关系 creating-resource-relationships
您可以指定存储库中资源之间的关系。 有三种关系:
- 依赖性:资源依赖其他资源的关系,这意味着存储库中需要所有相关资源。
- 成员资格(文件系统):资源位于给定文件夹中的关系。
- 自定义:在资源之间指定的关系。 例如,如果一个资源已被弃用,而另一个资源被引入存储库,则您可以指定自己的替换关系。
您可以创建自己的自定义关系。 例如,如果将HTML文件存储在存储库中并且它使用图像,则可以指定自定义关系以将HTML文件与图像相关联(因为通常只有XML文件使用存储库定义的依赖关系与图像相关联)。 另一个自定义关系示例是,如果您想使用循环图结构而不是树结构构建存储库的不同视图。 您可以定义循环图以及查看器来遍历这些关系。 最后,您可以指明一个资源将替换另一个资源,即使这两个资源完全不同。 在这种情况下,您可以在保留范围之外定义关系类型,并在这两个资源之间创建关系。 您的应用程序将是唯一能够检测并处理这种关系的客户,并且可用于对该关系进行搜索。
您可以使用存储库服务Java API或Web服务API以编程方式指定资源之间的关系。
步骤摘要 summary_of_steps-6
要指定两个资源之间的关系,请执行以下步骤:
- 包括项目文件。
- 创建存储库服务客户端。
- 指定要关联的资源的URI。
- 创建关系。
包含项目文件
在开发项目中包含必要的文件。 如果要使用Java创建客户端应用程序,请包含必要的JAR文件。 如果您使用的是Web服务,请包含代理文件。
创建服务客户端
必须先建立连接并提供凭据,然后才能以编程方式读取资源。 这是通过创建服务客户端来实现的。
指定要关联的资源的URI
创建包含要关联的资源的URI的字符串。 语法包括正斜杠,如以下示例所示:"/路径/资源“。
创建关系
调用Repository服务方法来创建和指定关系的类型。
另请参阅
使用Java API创建关系资源 create-relationship-resources-using-the-java-api
使用存储库服务Java API创建关系资源,执行以下任务:
-
包含项目文件
在Java项目的类路径中包含客户端JAR文件。
-
创建服务客户端
创建
ResourceRepositoryClient
对象,使用它的构造函数传递ServiceClientFactory
包含连接属性的对象。 -
指定要关联的资源的URI
指定要关联的资源的URI。 在这种情况下,因为资源已命名
testResource1
和testResource2
和位于名为的文件夹中testFolder
,它们的URI为"/testFolder/testResource1"
和"/testFolder/testResource2"
. URI存储为java.lang.String
对象。 在本例中,首先向存储库写入资源,然后检索其URI。 有关编写资源的详细信息,请参见 写入资源. -
创建关系
调用
ResourceRepositoryClient
对象的createRelationship
方法并传递以下参数:- 源资源的URI。
- 目标资源的URI。
- 关系的类型,它是
com.adobe.repository.infomodel.bean.Relation
类。 在此示例中,通过指定值来建立依赖关系Relation.TYPE_DEPENDANT_OF
. - A
boolean
指示目标资源是否自动更新到的值com.adobe.repository.infomodel.Id
新head资源的基于的标识符。 在此示例中,由于依赖关系,值true
已指定。
您还可以通过调用
ResourceRepositoryClient
对象的getRelated
方法并传入以下参数:- 要检索相关资源的资源的URI。 在此示例中,源资源(
"/testFolder/testResource1"
)指定了。 - A
boolean
指示指定的资源是否为关系中的源资源的值。 在此示例中,值true
指定了,因为情况如此。 - 关系类型,它是
Relation
类。 在本例中,使用先前使用的相同值指定依赖关系:Relation.TYPE_DEPENDANT_OF
.
此
getRelated
方法返回java.util.List
之Resource
对象,通过它可以迭代检索每个相关资源,转换包含在List
到Resource
就象你一样。 在此示例中,testResource2
应包含在返回的资源的列表中。
另请参阅
快速入门(SOAP模式):使用Java API创建资源之间的关系
使用Web服务API创建关系资源 create-relationship-resources-using-the-web-service-api
使用存储库API(Web服务)创建关系资源:
-
包含项目文件
- 创建使用存储库WSDL的Microsoft .NET客户端程序集。
- 引用Microsoft .NET客户端程序集。
-
创建服务客户端
使用Microsoft .NET客户端程序集,创建
RepositoryServiceService
对象。 设置其Credentials
属性使用System.Net.NetworkCredential
包含用户名和密码的对象。 -
指定要关联的资源的URI
指定要关联的资源的URI。 在这种情况下,因为资源已命名
testResource1
和testResource2
和位于名为的文件夹中testFolder
,它们的URI为"/testFolder/testResource1"
和"/testFolder/testResource2"
. 使用与Microsoft .NET Framework兼容的语言(例如C#)时,URI存储为System.String
对象。 在本例中,首先向存储库写入资源,然后检索其URI。 有关编写资源的详细信息,请参见 写入资源. -
创建关系
调用
RepositoryServiceService
对象的createRelationship
方法并传递以下参数:- 源资源的URI。
- 目标资源的URI。
- 关系的类型。 在此示例中,通过指定值来建立依赖关系
3
. - A
boolean
指示是否指定了关系类型的值。 在此示例中,值true
已指定。 - A
boolean
指示目标资源是否自动更新到的值Id
新head资源的基于的标识符。 在此示例中,由于依赖关系,值true
已指定。 - A
boolean
指示是否指定了目标标头的值。 在此示例中,值true
已指定。 - 通过
null
最后一个参数。
您还可以通过调用
RepositoryServiceService
对象的getRelated
方法并传入以下参数:- 要检索相关资源的资源的URI。 在此示例中,源资源(
"/testFolder/testResource1"
)指定了。 - A
boolean
指示指定的资源是否为关系中的源资源的值。 在此示例中,值true
指定了,因为情况如此。 - A
boolean
指示是否指定了源资源的值。 在此示例中,值true
提供了。 - 包含关系类型的整数数组。 在本例中,使用与之前使用的值相同的数组来指定依赖关系:
3
. - 通过
null
对于其余两个参数。
此
getRelated
方法返回可强制转换为的对象数组Resource
用于迭代检索每个相关资源的对象。 在此示例中,testResource2
应包含在返回的资源的列表中。
另请参阅
锁定资源 locking-resources
您可以锁定资源或资源集,以供特定用户独占使用,或在多个用户之间共享使用。 共享锁表示资源会发生一些情况,但不会阻止其他任何人对该资源执行操作。 共享锁定应被视为一种信令机制。 独占锁意味着锁定资源的用户将要更改资源,并且该锁可确保在用户不再需要访问资源并已释放该锁之前,其他人都无法执行此操作。 如果存储库管理员解锁资源,则该资源上的所有独占和共享锁定将被自动删除。 此类操作适用于用户不再可用并且未解锁资源的情况。
锁定资源后,当您在Workbench中查看“资源”选项卡时,会出现一个锁定图标,如下图所示。
您可以使用存储库服务Java API或Web服务API以编程方式控制对资源的访问。
步骤摘要 summary_of_steps-7
要锁定和解锁资源,请执行以下步骤:
- 包括项目文件。
- 创建存储库服务客户端。
- 指定要锁定的资源的URI。
- 锁定资源。
- 检索资源的锁定。
- 解锁资源
包含项目文件
在开发项目中包含必要的文件。 如果要使用Java创建客户端应用程序,请包含必要的JAR文件。 如果您使用的是Web服务,请包含代理文件。
创建服务客户端
必须先建立连接并提供凭据,然后才能以编程方式读取资源。 这是通过创建服务客户端来实现的。
指定要锁定的资源的URI
创建包含要锁定的资源的URI的字符串。 语法包括正斜杠,如以下示例所示:"/路径/资源“。
锁定资源
调用存储库服务方法以锁定资源,指定URI、锁定类型和锁定深度。
检索资源的锁定
调用Repository服务方法以检索资源的锁,指定URI。
解锁资源
调用存储库服务方法以解锁资源,指定URI。
另请参阅
使用Java API锁定资源 lock-resources-using-the-java-api
使用存储库服务API (Java)锁定资源:
-
包含项目文件
在Java项目的类路径中包含客户端JAR文件。
-
创建服务客户端
创建
ResourceRepositoryClient
对象,使用它的构造函数传递ServiceClientFactory
包含连接属性的对象。 -
指定要锁定的资源的URI
指定要锁定的资源的URI。 在本例中,因为指定的资源
testResource
位于名为的文件夹中testFolder
,其URI为"/testFolder/testResource"
. URI存储为java.lang.String
对象。 -
锁定资源
调用
ResourceRepositoryClient
对象的lockResource
方法并传递以下参数:- 资源的URI。
- 锁定范围。 在本例中,由于资源将被锁定以便独占使用,因此锁定范围指定为
com.adobe.repository.infomodel.bean.Lock.SCOPE_EXCLUSIVE
. - 锁定深度。 在本例中,由于锁定将仅应用于特定资源而不应用于其任何成员或子资源,因此锁定深度指定为
Lock.DEPTH_ZERO
.
note note NOTE 重载版本的 lockResource
需要四个参数的方法会引发异常。 确保使用lockResource
方法需要三个参数,如本演练中所示。 -
检索资源的锁定
调用
ResourceRepositoryClient
对象的getLocks
方法将资源的URI作为参数传递。 该方法会返回一个Lock对象列表,您可以通过该列表进行迭代。 在此示例中,通过调用每个锁定对象的getOwnerUserId
,getDepth
、和getType
方法。 -
解锁资源
调用
ResourceRepositoryClient
对象的unlockResource
方法将资源的URI作为参数传递。 欲了解更多信息,请参见 AEM Forms API参考.
另请参阅
使用Web服务API锁定资源 lock-resources-using-the-web-service-api
使用存储库服务API(Web服务)锁定资源:
-
包含项目文件
- 使用Base64创建使用存储库WSDL的Microsoft .NET客户端程序集。
- 引用Microsoft .NET客户端程序集。
-
创建服务客户端
使用Microsoft .NET客户端程序集,创建
RepositoryServiceService
对象。 设置其Credentials
属性使用System.Net.NetworkCredential
包含用户名和密码的对象。 -
指定要锁定的资源的URI
指定包含要锁定的资源的URI的字符串。 在本例中,因为指定的资源
testResource
在文件夹中testFolder
,其URI为"/testFolder/testResource"
. 使用与Microsoft .NET Framework兼容的语言时(例如,C#),将URI存储在System.String
对象。 -
锁定资源
调用
RepositoryServiceService
对象的lockResource
方法并传递以下参数:- 资源的URI。
- 锁定范围。 在本例中,由于资源将被锁定以便独占使用,因此锁定范围指定为
11
. - 锁定深度。 在本例中,由于锁定将仅应用于特定资源而不应用于其任何成员或子资源,因此锁定深度指定为
2
. - An
int
表示锁定到期前的秒数的值。 在此示例中,的值1000
已使用。 - 通过
null
最后一个参数。
-
检索资源的锁定
调用
RepositoryServiceService
对象的getLocks
方法将资源的URI作为第一个参数传递和null
用于第二个参数。 此方法会返回object
数组,包含Lock
可对其进行迭代的对象。 在此示例中,通过访问每个对象来打印每个对象的锁所有者、深度和范围Lock
对象的ownerUserId
,depth
、和type
字段。 -
解锁资源
调用
RepositoryServiceService
对象的unlockResource
方法将资源的URI作为第一个参数传递和null
用于第二个参数。
另请参阅
删除资源 deleting-resources
您可以使用存储库服务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 ),如果删除指定资源之一失败,则不会回滚事务,这意味着无法取消删除已删除的文件。步骤摘要 summary_of_steps-8
要删除资源,请执行以下步骤:
- 包括项目文件。
- 创建存储库服务客户端。
- 指定要删除的资源的URI。
- 删除资源。
包含项目文件
在开发项目中包含必要的文件。 如果要使用Java创建客户端应用程序,请包含必要的JAR文件。 如果您使用的是Web服务,请包含代理文件。
创建服务客户端
必须先建立连接并提供凭据,然后才能以编程方式读取资源。 这是通过创建服务客户端来实现的。
指定要删除的资源的URI
创建包含要删除的资源URI的字符串。 语法包括正斜杠,如以下示例所示:"/路径/资源“。 如果要删除的资源是文件夹,则删除操作将递归。
删除资源
调用Repository服务方法以删除资源,指定URI。
另请参阅
使用Java API(SOAP)删除资源 delete-resources-using-the-java-api-soap
使用存储库API (Java)删除资源:
-
包含项目文件
在Java项目的类路径中包含客户端JAR文件。
-
创建服务客户端
创建
ResourceRepositoryClient
对象,使用它的构造函数传递ServiceClientFactory
包含连接属性的对象。 -
指定要删除的资源的URI
指定要检索的资源的URI。 在这种情况下,由于名为testResourceToBeDeleted的资源位于名为testFolder的文件夹中,其URI为
/testFolder/testResourceToBeDeleted
. URI存储为java.lang.String
对象。 在本例中,首先将资源写入存储库,并检索其URI。 有关编写资源的详细信息,请参见 写入资源. -
删除资源
调用
ResourceRepositoryClient
对象的deleteResource
方法将资源的URI作为参数传递。
另请参阅
使用Web服务API删除资源 delete-resources-using-the-web-service-api
使用存储库API(Web服务)删除资源:
-
包含项目文件
- 使用Base64创建使用存储库WSDL的Microsoft .NET客户端程序集。
- 引用Microsoft .NET客户端程序集。
-
创建服务客户端
使用Microsoft .NET客户端程序集,创建
RepositoryServiceService
对象。 设置其Credentials
属性使用System.Net.NetworkCredential
包含用户名和密码的对象。 -
指定要删除的资源的URI
指定要检索的资源的URI。 在本例中,因为指定的资源
testResourceToBeDeleted
位于名为的文件夹中testFolder
,其URI为"/testFolder/testResourceToBeDeleted"
. 在本例中,首先将资源写入存储库,并检索其URI。 有关编写资源的详细信息,请参见 写入资源. -
删除资源
调用
RepositoryServiceService
对象的deleteResources
方法和传递System.String
数组,包含作为第一个参数的资源URI。 通过null
用于第二个参数。
另请参阅