以编程方式管理端点

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

关于Endpoint Registry服务

Endpoint Registry服务提供以编程方式管理端点的功能。 例如,您可以向服务添加以下类型的端点:

  • EJB
  • SOAP
  • 监视文件夹
  • 电子邮件
  • (AEM表单已弃用)远程处理
  • 任务管理器
注意

SOAP、EJB和(JEE上的AEM表单已弃用)将为每个激活的服务自动创建远程处理端点。 SOAP和EJB端点为所有服务操作启用SOAP和EJB。

远程处理端点使Flex客户端能够调用将该端点添加到的AEM Forms服务上的操作。 将创建与端点同名的Flex目标,Flex客户端可以创建指向此目标的RemoteObjects以调用相关服务上的操作。

电子邮件、任务管理器和监视文件夹端点仅显示服务的特定操作。 添加这些端点需要第二个配置步骤来选择要调用、设置配置参数以及指定输入和输出参数映射的方法。

您可以将TaskManager端点组织到名为​类别​的组中。 然后,这些类别会通过TaskManager公开到工作区,最终用户在分类时会看到TaskManager端点。 在工作区中,最终用户会在导航窗格中看到这些类别。 每个类别中的端点在工作区的“开始进程”页面上显示为进程卡。

您可以使用Endpoint Registry服务完成以下任务:

添加EJB端点

您可以使用AEM Forms Java API以编程方式将EJB端点添加到服务。 通过向服务添加EJB端点,可以使客户端应用程序能够使用EJB模式调用该服务。 即,在设置调用AEM Forms所需的连接属性时,可以选择EJB模式。 (请参阅设置连接属性。)

注意

不能使用Web服务添加EJB端点。

注意

通常,EJB端点默认会添加到服务中。但是,EJB端点可以添加到以编程方式部署的进程中,或者当EJB端点被删除且必须再次添加时,也可以添加到该进程中。

步骤的摘要

要向服务添加EJB端点,请执行以下任务:

  1. 包括项目文件。
  2. 创建EndpointRegistry Client对象。
  3. 设置EJB端点属性。
  4. 创建EJB端点。
  5. 启用端点。

包含项目文件

在开发项目中包含必需的文件。 必须将以下JAR文件添加到项目的类路径中:

  • adobe-livecycle-client.jar
  • adobe-usermanager-client.jar
  • adobe-utilities.jar(如果AEM Forms部署在JBoss应用程序服务器上,则此变量为必需变量)
  • jbossall-client.jar(如果AEM Forms部署在JBoss应用程序服务器上,则此为必需字段)

有关这些JAR文件位置的信息,请参阅包括AEM Forms Java库文件

创建EndpointRegistry客户端对象

必须先创建EndpointRegistryClient对象,然后才能以编程方式添加EJB端点。

设置EJB端点属性

要为服务创建EJB端点,请指定以下值:

  • 连接器标识符:指定要创建的端点类型。要创建EJB端点,请指定EJB
  • 描述:指定端点描述。
  • 名称:指定端点的名称。
  • 服务标识符:指定端点所属的服务。
  • 操作名称:指定使用端点调用的操作的名称。创建EJB端点时,请指定通配符(*)。 但是,如果要指定特定操作而不是调用所有服务操作,请指定操作的名称,而不是使用通配符(*)。

创建EJB端点

设置EJB端点属性后,可以为服务创建EJB端点。

启用端点

创建新端点后,必须启用该端点。 启用端点后,可以使用它调用服务。 启用端点后,您可以在管理控制台中查看该端点。

另请参阅

使用Java API添加EJB端点

包括AEM Forms Java库文件

设置连接属性

使用Java API添加EJB端点

使用Java API添加EJB端点:

  1. 包括项目文件。

    将客户端JAR文件(如adobe-livecycle-client.jar)包含在您Java项目的类路径中。 (

  2. 创建EndpointRegistry客户端对象。

    • 创建包含连接属性的ServiceClientFactory对象。
    • 使用其构造函数创建EndpointRegistryClient对象,并传递ServiceClientFactory对象。
  3. 设置EJB端点属性。

    • 使用CreateEndpointInfo对象的构造函数创建对象。
    • 通过调用CreateEndpointInfo对象的setConnectorId方法并传递字符串值EJB来指定连接器标识符值。
    • 通过调用CreateEndpointInfo对象的setDescription方法并传递描述该端点的字符串值,指定端点的描述。
    • 通过调用CreateEndpointInfo对象的setName方法并传递指定名称的字符串值,指定端点的名称。
    • 通过调用CreateEndpointInfo对象的setServiceId方法并传递指定服务名称的字符串值,指定端点所属的服务。
    • 指定通过调用CreateEndpointInfo对象的setOperationName方法调用的操作,并传递指定操作名称的字符串值。 对于SOAP和EJB端点,指定通配符(*),该字符表示所有操作。
  4. 创建EJB端点。

    通过调用EndpointRegistryClient对象的createEndpoint方法并传递CreateEndpointInfo对象来创建端点。 此方法返回表示新EJB端点的Endpoint对象。

  5. 启用端点。

    通过调用EndpointRegistryClient对象的enable方法并传递createEndpoint方法返回的Endpoint对象来启用端点。

另请参阅

步骤摘要

快速入门:使用Java API添加EJB端点

包括AEM Forms Java库文件

设置连接属性

添加SOAP端点

您可以使用AEM Forms Java API以编程方式向服务添加SOAP端点。 通过添加SOAP端点,您可以使客户端应用程序能够使用SOAP模式调用服务。 也就是说,在设置调用AEM Forms所需的连接属性时,您可以选择SOAP模式。

注意

不能使用Web服务添加SOAP端点。

注意

通常,SOAP端点默认会添加到服务中。但是,SOAP端点可以添加到以编程方式部署的进程中,或者当SOAP端点被删除且必须再次添加时。

步骤的摘要

要向服务添加SOAP端点,请执行以下任务:

  1. 包括项目文件。
  2. 创建EndpointRegistryClient对象。
  3. 设置SOAP端点属性。
  4. 创建SOAP端点。
  5. 启用端点。

包含项目文件

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

必须将以下JAR文件添加到项目的类路径中:

  • adobe-livecycle-client.jar
  • adobe-usermanager-client.jar
  • adobe-utilities.jar(如果AEM Forms部署在JBoss应用程序服务器上,则此变量为必需变量)
  • jbossall-client.jar(如果AEM Forms部署在JBoss应用程序服务器上,则此为必需字段)

创建SOAP端点时需要这些JAR文件。 但是,如果使用SOAP端点调用服务,则需要添加JAR文件。 有关AEM Forms JAR文件的信息,请参阅包括AEM Forms Java库文件

创建EndpointRegistry客户端对象

要以编程方式向服务添加SOAP端点,必须创建EndpointRegistryClient对象。

设置SOAP端点属性

要向服务添加SOAP端点,请指定以下值:

  • 连接器标识符值:指定要创建的端点类型。要创建SOAP端点,请指定SOAP
  • 描述:指定端点描述。
  • 名称:指定终结点名称。
  • 服务标识符值:指定端点所属的服务。
  • 操作名称:指定使用端点调用的操作的名称。创建SOAP端点时,请指定通配符(*)。 但是,如果要指定特定操作而不是调用所有服务操作,请指定操作的名称,而不是使用通配符(*)。

创建SOAP端点

设置SOAP端点属性后,可以创建SOAP端点。

启用端点

创建新端点后,必须启用该端点。 启用端点后,可使用它调用服务。 启用端点后,您可以在管理控制台中查看该端点。

另请参阅

使用Java API添加SOAP端点

包括AEM Forms Java库文件

设置连接属性

使用Java API添加SOAP端点

使用Java API向服务添加SOAP端点:

  1. 包括项目文件。

    将客户端JAR文件(如adobe-livecycle-client.jar)包含在您Java项目的类路径中。

  2. 创建EndpointRegistry客户端对象。

    • 创建包含连接属性的ServiceClientFactory对象。
    • 使用其构造函数创建EndpointRegistryClient对象,并传递ServiceClientFactory对象。
  3. 设置SOAP端点属性。

    • 使用CreateEndpointInfo对象的构造函数创建对象。
    • 通过调用CreateEndpointInfo对象的setConnectorId方法并传递字符串值SOAP来指定连接器标识符值。
    • 通过调用CreateEndpointInfo对象的setDescription方法并传递描述该端点的字符串值,指定端点的描述。
    • 通过调用CreateEndpointInfo对象的setName方法并传递指定名称的字符串值,指定端点的名称。
    • 通过调用CreateEndpointInfo对象的setServiceId方法并传递指定服务名称的字符串值,指定端点所属的服务。
    • 指定通过调用CreateEndpointInfo对象的setOperationName方法并传递指定操作名称的字符串值来调用的操作。 对于SOAP和EJB端点,指定通配符(*),该字符表示所有操作。
  4. 创建SOAP端点。

    通过调用EndpointRegistryClient对象的createEndpoint方法并传递CreateEndpointInfo对象来创建端点。 此方法返回表示新SOAP端点的Endpoint对象。

  5. 启用端点。

    通过调用EndpointRegistryClient对象的enable方法来启用端点,并传递createEndpoint方法返回的Endpoint对象。

另请参阅

步骤摘要

快速入门:使用Java API添加SOAP端点

包括AEM Forms Java库文件

设置连接属性

添加监视文件夹端点

您可以使用AEM Forms Java API以编程方式将监视文件夹端点添加到服务。 通过添加“监视文件夹”端点,用户可以将文件(如PDF文件)放置在文件夹中。 将文件放置到文件夹中后,将调用配置的服务并处理文件。 服务执行指定操作后,会将修改后的文件保存在指定的输出文件夹中。 已监视文件夹配置为以固定速率间隔或按照cron计划进行扫描,例如每周一、周三和周五的中午。

为了以编程方式向服务添加已监视文件夹端点,请考虑以下名为​EncryptDocument​的短期进程。 (请参阅了解AEM Forms进程。)

aw_aw_encryptdocumentprocess

此过程接受不安全的PDF文档作为输入值,然后将不安全的PDF文档传递到加密服务的EncryptPDFUsingPassword操作。 PDF文档使用密码加密,密码加密的PDF文档是此过程的输出值。 输入值的名称(不安全的PDF文档)为InDoc,数据类型为com.adobe.idp.Document。 输出值(密码加密的PDF文档)的名称为SecuredDoc,数据类型为com.adobe.idp.Document

注意

无法使用Web服务添加“监视文件夹”端点。

步骤的摘要

要向服务添加监视文件夹端点,请执行以下任务:

  1. 包括项目文件。
  2. 创建EndpointRegistryClient对象。
  3. 设置监视文件夹端点属性。
  4. 指定配置值。
  5. 定义输入参数值。
  6. 定义输出参数值。
  7. 创建监视文件夹端点。
  8. 启用端点。

包含项目文件

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

必须将以下JAR文件添加到项目的类路径中:

  • adobe-livecycle-client.jar
  • adobe-usermanager-client.jar
  • adobe-utilities.jar(如果AEM Forms部署在JBoss应用程序服务器上,则此变量为必需变量)
  • jbossall-client.jar(如果AEM Forms部署在JBoss应用程序服务器上,则此为必需字段)

有关这些JAR文件位置的信息,请参阅包括AEM Forms Java库文件

创建EndpointRegistry客户端对象

要以编程方式添加“监视文件夹”端点,必须创建EndpointRegistryClient对象。

设置监视文件夹端点属性

要为服务创建监视文件夹端点,请指定以下值:

  • 连接器标识符:指定所创建的端点类型。要创建监视文件夹端点,请指定WatchedFolder
  • 描述:指定端点的描述。
  • 名称:指定端点的名称。
  • 服务标识符:指定端点所属的服务。例如,要向本节介绍的进程添加“监视文件夹”端点(当使用Workbench激活某个进程时,该进程将成为服务),请指定EncryptDocument
  • 操作名称:指定使用端点调用的操作的名称。通常,在为源自在Workbench中创建的进程的服务创建“监视文件夹”端点时,操作的名称为invoke

指定配置值

以编程方式向服务添加监视文件夹端点时,必须为监视文件夹端点指定配置值。 如果使用管理控制台添加了监视文件夹端点,则管理员会指定这些配置值。

以下列表指定了在以编程方式向服务添加监视文件夹端点时设置的配置值:

  • url:指定监视的文件夹位置。在群集环境中,此值必须指向可从群集中的每台计算机访问的共享网络文件夹。
  • 异步:将调用类型标识为异步或同步。瞬态和同步进程只能同步调用。 默认值为true。 建议使用异步。
  • cronExpression:由石英用来计划输入目录的轮询。有关配置CRON表达式的详细信息,请参阅https://quartz.sourceforge.net/javadoc/org/quartz/CronTrigger.html
  • purgeDuration:这是一个必填属性。结果文件夹中的文件和文件夹如果比此值旧,则会清除它们。 此值以天为单位。 此属性有助于确保结果文件夹不变为完整。 值为–1天表示从不删除结果文件夹。 默认值为–1。
  • repeatInterval:扫描监视文件夹以进行输入的间隔,以秒为单位。除非启用限制,否则该值应比处理平均作业的时间长;否则,系统可能会变得过载。 默认值为 5。
  • repeatCount:监视文件夹扫描文件夹或目录的次数。值为–1表示无限扫描。 默认值为–1。
  • throttleOn:限制可在任何给定时间处理的已监视文件夹作业的数量。最大作业数由batchSize值确定。
  • userName:从监视文件夹调用目标服务时使用的用户名。此值是必需的。 默认值为SuperAdmin。
  • domainName:用户的域。此值是必需的。 默认值为DefaultDom。
  • batchSize:每次扫描要选取的文件或文件夹数。使用此值可防止系统过载;一次扫描过多文件可能会导致崩溃。 默认值为 2。
  • waitTime:在创建文件夹或文件后扫描之前等待的时间(以毫秒为单位)。例如,如果等待时间为36,000,000毫秒(一小时),而文件是在一分钟前创建的,则此文件将在59分钟或更久之后被提取。 此属性有助于确保将文件或文件夹完全复制到输入文件夹。 例如,如果要处理大文件,并且需要10分钟才能下载该文件,请将等待时间设置为10*60 *1000毫秒。 如果已观看文件夹等待了10分钟,则此设置会阻止其扫描文件。 默认值为 0。
  • excludeFilePattern:已监视文件夹用来确定要扫描和选取的文件和文件夹的模式。将不会扫描任何具有此模式的文件或文件夹以进行处理。 当输入的文件夹包含多个文件时,此设置非常有用。 文件夹的内容可以复制到一个文件夹中,该文件夹的名称将由监视文件夹选取。 此步骤可阻止监视文件夹在文件夹完全复制到输入文件夹之前提取待处理的文件夹。 例如,如果excludeFilePattern值为data*,则不会选取与data*匹配的所有文件和文件夹。 这包括名为data1data2等的文件和文件夹。 此外,可以用通配符模式来补充该模式以指定文件模式。 监视文件夹修改正则表达式以支持通配符模式,如*.**.pdf。 正则表达式不支持这些通配符模式。
  • includeFilePattern:监视文件夹用来确定要扫描和选取的文件夹和文件的模式。例如,如果此值为*,则会选取所有与input*匹配的文件和文件夹。 这包括名为input1input2等的文件和文件夹。 默认值为 *. 此值指示所有文件和文件夹。 此外,可以用通配符模式来补充该模式以指定文件模式。 监视文件夹修改正则表达式以支持通配符模式,如*.**.pdf。 正则表达式不支持这些通配符模式。 此值是必填项。
  • resultFolderName:保存结果的文件夹。此位置可以是绝对路径或相对目录路径。 如果结果未显示在此文件夹中,请检查失败文件夹。 只读文件不会进行处理,并将保存在失败文件夹中。 默认值为 result/%Y/%M/%D/. 这是已监视文件夹内的结果文件夹。
  • preserveFolderName:成功扫描和拾取文件后存储文件的位置。此位置可以是绝对、相对或空目录路径。 默认值为 preserve/%Y/%M/%D/.
  • failureFolderName:保存失败文件的文件夹。此位置始终与监视文件夹相对。 只读文件不会进行处理,并将保存在失败文件夹中。 默认值为 failure/%Y/%M/%D/.
  • preserveOnFailure:在无法对服务执行操作时保留输入文件。默认值为true。
  • overwriteDuplicateFilename:如果设置为true,则结果文件夹和保留文件夹中的文件将被覆盖。当设置为false时,将使用具有数字索引后缀的文件和文件夹作为名称。 默认值为false。

定义输入参数值

创建监视文件夹端点时,必须定义输入参数值。 也就是说,您必须描述传递到监视文件夹所调用操作的输入值。 例如,请考虑本主题中介绍的流程。 它有一个名为InDoc的输入值,其数据类型为com.adobe.idp.Document。 为此进程创建“监视文件夹”端点(在激活某个进程后,该进程将成为服务)时,必须定义输入参数值。

要定义监视文件夹端点所需的输入参数值,请指定以下值:

输入参数名称:输入参数的名称。在Workbench中为流程指定输入值的名称。 如果输入值属于服务操作(不是在Workbench中创建的进程的服务),则输入名称在component.xml文件中指定。 例如,本节介绍的进程的输入参数名称为InDoc

映射类型:用于配置调用服务操作所需的输入值。映射类型有两种:

  • Literal:监视文件夹端点使用在显示时在字段中输入的值。支持所有基本的Java类型。 例如,如果API使用String、long、int和Boolean等输入,则字符串将转换为正确的类型并调用服务。
  • Variable:输入的值是已监视文件夹用来选取输入的文件模式。例如,如果为映射类型选择变量,并且输入文档必须是PDF文件,则可以指定*.pdf作为映射值。

映射值:指定映射类型的值。例如,如果选择Variable映射类型,则可以指定*.pdf作为文件模式。

数据类型:指定输入值的数据类型。例如,本节介绍的进程输入值的数据类型为com.adobe.idp.Document

定义输出参数值

创建监视文件夹端点时,必须定义输出参数值。 也就是说,您必须描述由监视文件夹端点调用的服务返回的输出值。 例如,请考虑本主题中介绍的流程。 其输出值名为SecuredDoc,数据类型为com.adobe.idp.Document。 为此进程创建“监视文件夹”端点时(在激活某个进程后,该进程将成为服务),必须定义输出参数值。

要定义监视文件夹端点所需的输出参数值,请指定以下值:

输出参数名称:输出参数的名称。进程输出值的名称在Workbench中指定。 如果输出值属于服务操作(不是在Workbench中创建的进程的服务),则输出名称在component.xml文件中指定。 例如,本节介绍的进程的输出参数名称为SecuredDoc

映射类型:用于配置服务和操作的输出。以下选项可供选择:

  • 如果服务返回单个对象(单个文档),则模式为%F.pdf,源目标为sourcefilename.pdf。 例如,本节中引入的流程会返回一个文档。 因此,映射类型可定义为%F.pdf%F表示使用给定的文件名)。 模式%E指定输入文档的扩展名。
  • 如果服务返回列表,则模式为Result\%F\,源目标为Result\sourcefilename\source1 (output 1)和Result\sourcefilename\source2 (output 2)。
  • 如果服务返回映射,则模式为Result\%F\,源目标为Result\sourcefilename\file1 and Result\sourcefilename\file2。 如果映射包含多个对象,则模式为Result\%F.pdf,源目标为Result\sourcefilename1.pdf(output 1)、Result\sourcefilenam2.pdf(output 2),等等。

数据类型:指定返回值的数据类型。例如,本节介绍的进程返回值的数据类型为com.adobe.idp.Document

创建监视文件夹端点

在设置端点的属性、配置值并定义输入和输出参数值后,必须创建“监视文件夹”端点。

启用端点

创建监视文件夹端点后,必须启用该端点。 启用端点后,可使用它调用服务。 启用端点后,您可以在管理控制台中查看该端点。

另请参阅

使用Java API添加监视文件夹端点

包括AEM Forms Java库文件

设置连接属性

使用Java API添加监视文件夹端点

使用AEM Forms Java API添加监视文件夹端点:

  1. 包括项目文件。

    将客户端JAR文件(如adobe-livecycle-client.jar)包含在您Java项目的类路径中。

  2. 创建EndpointRegistry客户端对象。

    • 创建包含连接属性的ServiceClientFactory对象。
    • 使用其构造函数创建EndpointRegistryClient对象,并传递ServiceClientFactory对象。
  3. 设置监视文件夹端点属性。

    • 使用CreateEndpointInfo对象的构造函数创建对象。
    • 通过调用CreateEndpointInfo对象的setConnectorId方法并传递字符串值WatchedFolder来指定连接器标识符值。
    • 通过调用CreateEndpointInfo对象的setDescription方法并传递描述该端点的字符串值,指定端点的描述。
    • 通过调用CreateEndpointInfo对象的setName方法并传递指定名称的字符串值,指定端点的名称。
    • 通过调用CreateEndpointInfo对象的setServiceId方法并传递指定服务名称的字符串值,指定端点所属的服务。
    • 指定通过调用CreateEndpointInfo对象的setOperationName方法并传递指定操作名称的字符串值来调用的操作。 通常,在为源自在Workbench中创建的进程的服务创建“监视文件夹”端点时,会调用操作的名称。
  4. 指定配置值。

    对于要为监视文件夹端点设置的每个配置值,必须调用CreateEndpointInfo对象的setConfigParameterAsText方法。 例如,要设置url配置值,请调用CreateEndpointInfo对象的setConfigParameterAsText方法并传递以下字符串值:

    • 一个字符串值,用于指定配置值的名称。 设置url配置值时,请指定url
    • 一个字符串值,用于指定配置值的值。 设置url配置值时,请指定监视的文件夹位置。
    注意

    要查看为EncryptDocument服务设置的所有配置值,请参阅位于QuickStart的Java代码示例:使用Java API添加监视文件夹端点。

  5. 定义输入参数值。

    通过调用CreateEndpointInfo对象的setInputParameterMapping方法定义输入参数值,并传递以下值:

    • 一个字符串值,用于指定输入参数的名称。 例如,EncryptDocument服务的输入参数的名称为InDoc
    • 一个字符串值,用于指定输入参数的数据类型。 例如,InDoc输入参数的数据类型为com.adobe.idp.Document
    • 指定映射类型的字符串值。 例如,您可以指定variable
    • 指定映射类型值的字符串值。 例如,您可以指定*.pdf作为文件模式。
    注意

    为要定义的每个输入参数值调用setInputParameterMapping方法。 由于EncryptDocument进程只有一个输入参数,因此需要调用此方法一次。

  6. 定义输出参数值。

    通过调用CreateEndpointInfo对象的setOutputParameterMapping方法定义输出参数值,并传递以下值:

    • 一个字符串值,用于指定输出参数的名称。 例如,EncryptDocument服务的输出参数的名称为SecuredDoc
    • 一个字符串值,用于指定输出参数的数据类型。 例如,SecuredDoc输出参数的数据类型为com.adobe.idp.Document
    • 指定映射类型的字符串值。 例如,您可以指定%F.pdf
  7. 创建监视文件夹端点。

    通过调用EndpointRegistryClient对象的createEndpoint方法并传递CreateEndpointInfo对象来创建端点。 此方法会返回一个Endpoint对象,该对象表示“已监视文件夹”端点。

  8. 启用端点。

    通过调用EndpointRegistryClient对象的enable方法并传递createEndpoint方法返回的Endpoint对象来启用端点。

另请参阅

步骤摘要

快速入门:使用Java API添加监视文件夹端点

包括AEM Forms Java库文件

设置连接属性

监视文件夹配置值常量文件

快速入门:使用Java API添加监视文件夹端点会使用必须是Java项目一部分的常量文件,才能编译快速入门。 此常量文件表示在添加监视文件夹端点时必须设置的配置值。 以下Java代码表示常量文件。

 /**
     * 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";
        }

添加电子邮件端点

您可以使用AEM Forms Java API以编程方式向服务添加电子邮件端点。 通过添加电子邮件端点,用户可以向指定的电子邮件帐户发送包含一个或多个文件附件的电子邮件。 然后,调用配置服务操作并操作文件。 服务执行指定操作后,会向发送者发送一封电子邮件,其中包含已修改的文件作为文件附件。

为了以编程方式向服务添加电子邮件端点,请考虑以下名为​MyApplication\EncryptDocument​的短期进程。 有关短时间流程的信息,请参阅了解AEM Forms流程

ae_ae_encryptdocumentprocess

此过程接受不安全的PDF文档作为输入值,然后将不安全的PDF文档传递到加密服务的EncryptPDFUsingPassword操作。 此过程使用密码加密PDF文档,并返回密码加密的PDF文档作为输出值。 输入值的名称(不安全的PDF文档)为InDoc,数据类型为com.adobe.idp.Document。 输出值(密码加密的PDF文档)的名称为SecuredDoc,数据类型为com.adobe.idp.Document

注意

无法使用Web服务添加电子邮件端点。

步骤的摘要

要向服务添加电子邮件端点,请执行以下任务:

  1. 包括项目文件。
  2. 创建EndpointRegistryClient对象。
  3. 设置电子邮件端点属性。
  4. 指定配置值。
  5. 定义输入参数值。
  6. 定义输出参数值。
  7. 创建电子邮件端点。
  8. 启用端点。

包含项目文件

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

必须将以下JAR文件添加到项目的类路径中:

  • adobe-livecycle-client.jar
  • adobe-usermanager-client.jar
  • adobe-utilities.jar(如果AEM Forms部署在JBoss应用程序服务器上,则此变量为必需变量)
  • jbossall-client.jar(如果AEM Forms部署在JBoss应用程序服务器上,则此为必需字段)

有关这些JAR文件位置的信息,请参阅包括AEM Forms Java库文件

创建EndpointRegistry客户端对象

必须先创建EndpointRegistryClient对象,然后才能以编程方式添加电子邮件端点。

设置电子邮件端点属性

要为服务创建电子邮件端点,请指定以下值:

  • 连接器标识符值:指定所创建的端点类型。要创建电子邮件端点,请指定Email
  • 描述:指定端点的描述。
  • 名称:指定端点的名称。
  • 服务标识符值:指定端点所属的服务。例如,要向本节介绍的进程添加电子邮件端点(使用Workbench激活某个进程后,该进程将变为服务),请指定EncryptDocument
  • 操作名称:指定使用端点调用的操作的名称。通常,在为源自在Workbench中创建的进程的服务创建电子邮件端点时,操作的名称为invoke

指定配置值

以编程方式向服务添加电子邮件端点时,必须为电子邮件端点指定配置值。 如果使用管理控制台添加电子邮件端点,则管理员会指定这些配置值。

注意

受监控的电子邮件帐户是仅用于电子邮件端点的特殊帐户。 此帐户不是普通用户的电子邮件帐户。 常规用户的电子邮件帐户不得配置为电子邮件提供商使用的帐户,因为电子邮件提供商在邮件处理完成后会从收件箱中删除电子邮件。

以编程方式向服务添加电子邮件端点时,会设置以下配置值:

  • cronExpression:cron表达式,如果必须使用cron表达式计划电子邮件,则为此表达式。
  • repeatCount:电子邮件端点扫描文件夹或目录的次数。值为–1表示无限扫描。 默认值为–1。
  • repeatInterval:接收器用于检查传入邮件的扫描速率(以秒为单位)。默认值为 10。
  • startDelay:计划程序启动后等待扫描的时间。默认时间为0。
  • batchSize:接收者每次扫描处理的电子邮件数量,以获得最佳性能。值–1表示所有电子邮件。 默认值为 2。
  • userName:从电子邮件调用目标服务时使用的用户名。默认值为 SuperAdmin.
  • domainName:必需的配置值。默认值为 DefaultDom.
  • domainPattern:指定提供商接受的传入电子邮件的域模式。例如,如果使用adobe.com,则仅处理adobe.com的电子邮件,则忽略其他域的电子邮件。
  • filePattern:指定提供程序接受的传入文件附件模式。这包括具有特定文件扩展名(*.dat、*.xml)的文件,具有特定名称(数据)的文件,以及具有名称和扩展名(*)的复合表达式的文件。[dD][aA]'port')。默认值为 *.
  • recipientSuccessfulJob:将邮件发送到的电子邮件地址,用于指示作业成功。默认情况下,成功的作业消息始终会发送给发件人。 如果键入sender,则会向发件人发送电子邮件结果。 最多支持100个收件人。 使用电子邮件地址指定其他收件人,每个收件人以逗号分隔。 要关闭此选项,请将此值留空。 在某些情况下,您可能希望触发某个流程,并且不希望收到有关结果的电子邮件通知。 默认值为 sender.
  • recipientFailedJob:发送消息以指示作业失败的电子邮件地址。默认情况下,失败的作业消息始终会发送给发件人。 如果键入sender,则会向发件人发送电子邮件结果。 最多支持100个收件人。 使用电子邮件地址指定其他收件人,每个收件人以逗号分隔。 要关闭此选项,请将此值留空。 默认值为 sender.
  • inboxHost:要扫描的电子邮件提供商的收件箱主机名或IP地址。
  • inboxPort:电子邮件服务器使用的端口。POP3的默认值为110,IMAP的默认值为143。 如果启用了SSL,则POP3的默认值为995,IMAP的默认值为993。
  • inboxProtocol:用于扫描收件箱的电子邮件端点的电子邮件协议。选项为IMAPPOP3。 收件箱主机邮件服务器必须支持这些协议。
  • inboxTimeOut:电子邮件提供商等待收件箱响应的超时时间(以秒为单位)。默认值为 60。
  • inboxUser:登录到电子邮件帐户所需的用户名。根据电子邮件服务器和配置的不同,这可能只是电子邮件的用户名部分,也可能是完整的电子邮件地址。
  • inboxPassword:收件箱用户的密码。
  • inboxSSLEnabled:设置此值后,在发送结果或错误通知消息时,强制电子邮件提供程序使用SSL。确保IMAP或POP3主机支持SSL。
  • smtpHost:电子邮件提供商向其发送结果和错误消息的邮件服务器的主机名。
  • smtpPort:SMTP端口的默认值为25。
  • smtp用户:电子邮件提供商在发送结果和错误的电子邮件通知时要使用的用户帐户。
  • smtpPassword:SMTP帐户的密码。某些邮件服务器不需要SMTP密码。
  • charSet:电子邮件提供商使用的字符集。默认值为 UTF-8.
  • smtpSSLEnabled:设置此值后,在发送结果或错误通知消息时,强制电子邮件提供程序使用SSL。确保SMTP主机支持SSL。
  • failedJobFolder:指定在SMTP邮件服务器无法运行时用于存储结果的目录。
  • 异步:设置为同步时,将处理所有输入文档并返回单个响应。设置为异步时,将为处理的每个输入文档发送响应。 例如,将为本主题中引入的流程创建电子邮件端点,并向端点的收件箱发送一封电子邮件,其中包含多个不安全的PDF文档。 当所有PDF文档都使用密码进行加密,并且如果端点配置为同步,则会发送一封单个响应电子邮件消息,并附加所有安全的PDF文档。 如果端点配置为异步,则会为每个安全PDF文档发送单独的响应电子邮件消息。 每封电子邮件都包含一个作为附件的PDF文档。 默认值为异步。

定义输入参数值

创建电子邮件端点时,必须定义输入参数值。 也就是说,您必须描述传递到电子邮件端点所调用操作的输入值。 例如,请考虑本主题中介绍的流程。 它有一个名为InDoc的输入值,其数据类型为com.adobe.idp.Document。 为此进程创建电子邮件端点(在激活某个进程后,该进程将变为服务)时,必须定义输入参数值。

要定义电子邮件端点所需的输入参数值,请指定以下值:

输入参数名称:输入参数的名称。在Workbench中为流程指定输入值的名称。 如果输入值属于服务操作(不是在Workbench中创建的进程的Forms服务),则输入名称在component.xml文件中指定。 例如,本节介绍的进程的输入参数名称为InDoc

映射类型:用于配置调用服务操作所需的输入值。映射类型分为以下两种:

  • Literal:电子邮件端点使用在字段中输入的值(显示时)。支持所有基本的Java类型。 例如,如果API使用String、long、int和Boolean等输入,则字符串将转换为正确的类型并调用服务。
  • Variable:输入的值是电子邮件端点用于选取输入的文件模式。例如,如果为映射类型选择变量,并且输入文档必须是PDF文件,则可以指定*.pdf作为映射值。

映射值:指定映射类型的值。例如,如果选择变量映射类型,则可以指定*.pdf作为文件模式。

数据类型:指定输入值的数据类型。例如,此部分引入的进程输入值的数据类型是com.adobe.idp.Document。

定义输出参数值

创建电子邮件端点时,必须定义输出参数值。 也就是说,您必须描述由电子邮件端点调用的服务返回的输出值。 例如,请考虑本主题中介绍的流程。 其输出值名为SecuredDoc,数据类型为com.adobe.idp.Document。 为此进程创建电子邮件端点(在激活某个进程后,该进程将变为服务)时,必须定义输出参数值。

要定义电子邮件端点所需的输出参数值,请指定以下值:

输出参数名称:输出参数的名称。进程输出值的名称在Workbench中指定。 如果输出值属于服务操作(不是在Workbench中创建的进程的服务),则输出名称在component.xml文件中指定。 例如,本节介绍的进程的输出参数名称为SecuredDoc

映射类型:用于配置服务和操作的输出。以下选项可供选择:

  • 如果服务返回单个对象(单个文档),则模式为%F.pdf,源目标为sourcefilename.pdf。 例如,本节中引入的流程会返回一个文档。 因此,映射类型可定义为%F.pdf%F表示使用给定的文件名)。 模式%E指定输入文档的扩展名。
  • 如果服务返回列表,则模式为Result\%F\,源目标为Result\sourcefilename\source1 (output 1)和Result\sourcefilename\source2 (output 2)。
  • 如果服务返回映射,则模式为Result\%F\,源目标为Result\sourcefilename\file1 and Result\sourcefilename\file2。 如果映射包含多个对象,则模式为Result\%F.pdf,源目标为Result\sourcefilename1.pdf(output 1)、Result\sourcefilenam2.pdf(output 2),等等。

数据类型:指定返回值的数据类型。例如,本节介绍的进程返回值的数据类型为com.adobe.idp.Document

创建电子邮件端点

在设置电子邮件端点属性和配置值并定义输入和输出参数值后,必须创建电子邮件端点。

启用端点

创建电子邮件端点后,必须启用它。 启用端点后,可使用它调用服务。 启用端点后,您可以在管理控制台中查看该端点。

另请参阅

使用Java API添加电子邮件端点

包括AEM Forms Java库文件

设置连接属性

使用Java API添加电子邮件端点

使用Java API添加电子邮件端点:

  1. 包括项目文件。

    将客户端JAR文件(如adobe-livecycle-client.jar)包含在您Java项目的类路径中。

  2. 创建EndpointRegistry客户端对象。

    • 创建包含连接属性的ServiceClientFactory对象。
    • 使用其构造函数创建EndpointRegistryClient对象,并传递ServiceClientFactory对象。
  3. 设置电子邮件端点属性。

    • 使用CreateEndpointInfo对象的构造函数创建对象。
    • 通过调用CreateEndpointInfo对象的setConnectorId方法并传递字符串值Email来指定连接器标识符值。
    • 通过调用CreateEndpointInfo对象的setDescription方法并传递描述该端点的字符串值,指定端点的描述。
    • 通过调用CreateEndpointInfo对象的setName方法并传递指定名称的字符串值,指定端点的名称。
    • 通过调用CreateEndpointInfo对象的setServiceId方法并传递指定服务名称的字符串值,指定端点所属的服务。
    • 指定通过调用CreateEndpointInfo对象的setOperationName方法并传递指定操作名称的字符串值来调用的操作。 通常,在为源自在Workbench中创建的进程的服务创建电子邮件端点时,会调用操作的名称。
  4. 指定配置值。

    对于要为电子邮件端点设置的每个配置值,必须调用CreateEndpointInfo对象的setConfigParameterAsText方法。 例如,要设置smtpHost配置值,请调用CreateEndpointInfo对象的setConfigParameterAsText方法并传递以下值:

    • 一个字符串值,用于指定配置值的名称。 设置smtpHost配置值时,请指定smtpHost
    • 一个字符串值,用于指定配置值的值。 设置smtpHost配置值时,请指定一个字符串值,以指定SMTP服务器的名称。
    注意

    要查看本节中介绍的EncryptDocument服务的所有配置值集,请参阅位于QuickStart的Java代码示例:使用Java API添加电子邮件端点。

  5. 定义输入参数值。

    通过调用CreateEndpointInfo对象的setInputParameterMapping方法定义输入参数值,并传递以下值:

    • 一个字符串值,用于指定输入参数的名称。 例如,EncryptDocument服务的输入参数的名称为InDoc
    • 一个字符串值,用于指定输入参数的数据类型。 例如,InDoc输入参数的数据类型为com.adobe.idp.Document
    • 指定映射类型的字符串值。 例如,您可以指定variable
    • 指定映射类型值的字符串值。 例如,您可以指定*.pdf作为文件模式。
    注意

    为要定义的每个输入参数值调用setInputParameterMapping方法。 由于EncryptDocument进程只有一个输入参数,因此需要调用此方法一次。

  6. 定义输出参数值。

    通过调用CreateEndpointInfo对象的setOutputParameterMapping方法并传递以下值来定义输出参数值:

    • 一个字符串值,用于指定输出参数的名称。 例如,EncryptDocument服务的输出参数的名称为SecuredDoc
    • 一个字符串值,用于指定输出参数的数据类型。 例如,SecuredDoc输出参数的数据类型为com.adobe.idp.Document
    • 指定映射类型的字符串值。 例如,您可以指定%F.pdf
  7. 创建电子邮件端点。

    通过调用EndpointRegistryClient对象的createEndpoint方法并传递CreateEndpointInfo对象来创建端点。 此方法会返回一个Endpoint对象,表示电子邮件端点。

  8. 启用端点。

    通过调用EndpointRegistryClient对象的enable方法并传递createEndpoint方法返回的Endpoint对象来启用端点。

另请参阅

步骤摘要

快速入门:使用Java API添加监视文件夹端点

包括AEM Forms Java库文件

设置连接属性

电子邮件配置值常量文件

快速入门:使用Java API添加电子邮件端点会使用必须属于您的Java项目的常量文件来编译快速入门。 此常量文件表示添加电子邮件端点时必须设置的配置值。 以下Java代码表示常量文件。

 /**
     * 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";
 }

添加远程处理端点

注意

LiveCycle RemotingAPI已在JEE上的AEM Forms中弃用。

您可以使用AEM Forms Java API以编程方式向服务添加远程处理端点。 通过添加远程处理端点,您使Flex应用程序能够使用远程处理来调用服务。 (请参阅使用调用AEM Forms(AEM表单已弃用)AEM Forms Remoting。)

为了以编程方式向服务添加远程处理端点,请考虑以下名为​EncryptDocument​的短期进程。

ar_ar_encryptdocumentprocess

此过程接受不安全的PDF文档作为输入值,然后将不安全的PDF文档传递到加密服务的EncryptPDFUsingPassword操作。 PDF文档使用密码加密,密码加密的PDF文档是此过程的输出值。 输入值的名称(不安全的PDF文档)为InDoc,数据类型为com.adobe.idp.Document。 输出值(密码加密的PDF文档)的名称为SecuredDoc,数据类型为com.adobe.idp.Document

为了演示如何向服务添加远程处理端点,本节将远程处理端点添加到名为EncryptDocument的服务。

注意

无法使用Web服务添加远程处理端点。

步骤的摘要

要从服务中删除端点,请执行以下任务:

  1. 包括项目文件。
  2. 创建EndpointRegistryClient对象。
  3. 设置远程处理端点属性。
  4. 创建远程处理端点。
  5. 启用端点。

包含项目文件

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

必须将以下JAR文件添加到项目的类路径中:

  • adobe-livecycle-client.jar
  • adobe-usermanager-client.jar
  • adobe-utilities.jar(如果AEM Forms部署在JBoss应用程序服务器上,则此变量为必需变量)
  • jbossall-client.jar(如果AEM Forms部署在JBoss应用程序服务器上,则此为必需字段)

有关这些JAR文件位置的信息,请参阅包括AEM Forms Java库文件

创建EndpointRegistry客户端对象

要以编程方式添加远程处理端点,必须创建一个EndpointRegistryClient对象。

设置远程处理端点属性

要为服务创建远程处理端点,请指定以下值:

  • 连接器标识符值:指定所创建的端点类型。要创建远程处理端点,请指定Remoting
  • 描述:指定端点的描述。
  • 名称:指定端点的名称。
  • 服务标识符值:指定端点所属的服务。例如,要向本节介绍的进程添加远程处理端点(当在Workbench中激活某个进程时,该进程将成为服务),请指定EncryptDocument
  • 操作名称:指定使用端点调用的操作的名称。创建远程处理端点时,请指定通配符(*)。

创建远程处理端点

设置远程处理端点属性后,可以为服务创建远程处理端点。

启用端点

创建新端点后,必须启用该端点。 启用远程处理端点后,Flex客户端将调用该服务。

另请参阅

使用Java API添加远程处理端点

包括AEM Forms Java库文件

设置连接属性

使用Java API添加远程处理端点

使用Java API添加远程处理端点:

  1. 包括项目文件。

    将客户端JAR文件(如adobe-livecycle-client.jar)包含在您Java项目的类路径中。

  2. 创建EndpointRegistry客户端对象。

    • 创建包含连接属性的ServiceClientFactory对象。
    • 使用其构造函数创建EndpointRegistryClient对象,并传递ServiceClientFactory对象。
  3. 设置远程处理端点属性。

    • 使用CreateEndpointInfo对象的构造函数创建对象。
    • 通过调用CreateEndpointInfo对象的setConnectorId方法并传递字符串值Remoting来指定连接器标识符值。
    • 通过调用CreateEndpointInfo对象的setDescription方法并传递描述该端点的字符串值,指定端点的描述。
    • 通过调用CreateEndpointInfo对象的setName方法并传递指定名称的字符串值,指定端点的名称。
    • 通过调用CreateEndpointInfo对象的setServiceId方法并传递指定服务名称的字符串值,指定端点所属的服务。
    • 指定由CreateEndpointInfo对象的setOperationName方法调用的操作,并传递指定操作名称的字符串值。 对于远程处理端点,指定通配符(*)。
  4. 创建远程处理端点。

    通过调用EndpointRegistryClient对象的createEndpoint方法并传递CreateEndpointInfo对象来创建端点。 此方法会返回一个Endpoint对象,该对象表示新的Remoting端点。

  5. 启用端点。

    通过调用EndpointRegistryClient对象的enable方法并传递createEndpoint方法返回的Endpoint对象来启用端点。

另请参阅

步骤摘要

快速入门:使用Java API添加远程处理端点

包括AEM Forms Java库文件

设置连接属性

添加TaskManager端点

您可以使用AEM Forms Java API以编程方式将TaskManager端点添加到服务。 通过向服务添加TaskManager端点,可让工作区用户调用该服务。 即,在工作区中工作的用户可以调用具有相应TaskManager端点的进程。

注意

无法使用Web服务添加TaskManager端点。

步骤的摘要

要向服务添加TaskManager端点,请执行以下任务:

  1. 包括项目文件。
  2. 创建EndpointRegistryClient对象。
  3. 为端点创建类别。
  4. 设置TaskManager端点属性。
  5. 创建TaskManager端点。
  6. 启用端点。

包含项目文件

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

必须将以下JAR文件添加到项目的类路径中:

  • adobe-livecycle-client.jar
  • adobe-usermanager-client.jar
  • adobe-utilities.jar(如果AEM Forms部署在JBoss应用程序服务器上,则此变量为必需变量)
  • jbossall-client.jar(如果AEM Forms部署在JBoss应用程序服务器上,则此为必需字段)

有关这些JAR文件位置的信息,请参阅包括AEM Forms Java库文件

创建EndpointRegistry客户端对象

必须先创建EndpointRegistryClient对象,然后才能以编程方式添加TaskManager端点。

为端点创建类别

类别用于在工作区内组织服务。 即,工作区用户可以通过在工作区中选择类别来调用具有TaskManager端点的服务。 创建TaskManager端点时,可以引用现有类别或以编程方式创建新类别。

注意

此部分在向服务添加TaskManager端点时会创建新类别。

设置TaskManager端点属性

要为服务创建TaskManager端点,请指定以下值:

  • 连接器标识符:指定所创建的端点类型。要创建TaskManager端点,请指定TaskManagerConnector
  • 描述:指定端点的描述。
  • 名称:指定端点的名称。
  • 服务标识符:指定端点所属的服务。
  • 类别:指定与TaskManager端点关联的类别标识符值。
  • 操作名称:通常,在为源自在Workbench中创建的进程的服务创建TaskManager端点时,操作的名称为 invoke

创建TaskManager端点

设置TaskManager端点属性后,可以为服务创建TaskManager端点。

启用端点

创建新端点后,必须启用该端点。 启用端点后,可使用该端点在工作区中调用服务。 启用端点后,您可以在管理控制台中查看该端点。

另请参阅

使用Java API添加TaskManager端点

包括AEM Forms Java库文件

设置连接属性

使用Java API添加TaskManager端点

使用Java API添加TaskManager端点:

  1. 包括项目文件。

    将客户端JAR文件(如adobe-livecycle-client.jar)包含在您Java项目的类路径中。

  2. 创建EndpointRegistry客户端对象。

    • 创建包含连接属性的ServiceClientFactory对象。
    • 使用其构造函数创建EndpointRegistryClient对象,并传递ServiceClientFactory对象。
  3. 为端点创建类别。

    • 使用CreateEndpointCategoryInfo对象的构造函数并传递以下值来创建该对象:

      • 指定类别标识符值的字符串值
      • 一个字符串值,用于指定类别的描述
    • 通过调用EndpointRegistryClient对象的createEndpointCategory方法并传递CreateEndpointCategoryInfo对象来创建类别。 此方法返回表示新类别的EndpointCategory对象。

  4. 设置TaskManager端点属性。

    • 使用CreateEndpointInfo对象的构造函数创建对象。
    • 通过调用CreateEndpointInfo对象的setConnectorId方法并传递字符串值TaskManagerConnector来指定连接器标识符值。
    • 通过调用CreateEndpointInfo对象的setDescription方法并传递描述该端点的字符串值,指定端点的描述。
    • 通过调用CreateEndpointInfo对象的setName方法并传递指定名称的字符串值,指定端点的名称。
    • 通过调用CreateEndpointInfo对象的setServiceId方法并传递指定服务名称的字符串值,指定端点所属的服务。
    • 通过调用CreateEndpointInfo对象的setCategoryId方法并传递指定类别标识符值的字符串值,指定端点所属的类别。 可以调用EndpointCategory对象的getId方法来获取此类别的标识符值。
    • 指定通过调用CreateEndpointInfo对象的setOperationName方法并传递指定操作名称的字符串值来调用的操作。 通常,在为源自在Workbench中创建的进程的服务创建TaskManager端点时,操作的名称为invoke
  5. 创建TaskManager端点。

    通过调用EndpointRegistryClient对象的createEndpoint方法并传递CreateEndpointInfo对象来创建端点。 此方法返回表示新TaskManager端点的Endpoint对象。

  6. 启用端点。

    通过调用EndpointRegistryClient对象的enable方法并传递createEndpoint方法返回的Endpoint对象来启用端点。

另请参阅

步骤摘要

快速入门:使用Java API添加TaskManager端点

包括AEM Forms Java库文件

设置连接属性

修改端点

您可以使用AEM Forms Java API以编程方式修改现有端点。 通过修改端点,可以更改端点的行为。 例如,考虑指定用作监视文件夹的文件夹的监视文件夹端点。 您可以以编程方式修改属于监视文件夹端点的配置值,从而导致另一个文件夹能够用作监视文件夹。 有关属于监视文件夹端点的配置值的信息,请参阅添加监视文件夹端点

为了演示如何修改端点,本节通过更改行为与监视文件夹相同的文件夹来修改监视文件夹端点。

注意

不能使用Web服务修改端点。

步骤的摘要

要修改端点,请执行以下任务:

  1. 包括项目文件。
  2. 创建EndpointRegistryClient对象。
  3. 检索端点。
  4. 指定新配置值。

包含项目文件

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

必须将以下JAR文件添加到项目的类路径中:

  • adobe-livecycle-client.jar
  • adobe-usermanager-client.jar
  • adobe-utilities.jar(如果AEM Forms部署在JBoss应用程序服务器上,则此变量为必需变量)
  • jbossall-client.jar(如果AEM Forms部署在JBoss应用程序服务器上,则此为必需字段)

有关这些JAR文件位置的信息,请参阅包括AEM Forms Java库文件

创建EndpointRegistry客户端对象

要以编程方式修改端点,必须创建一个EndpointRegistryClient对象。

检索要修改的端点

在修改端点之前,必须先检索该端点。 要检索端点,您必须以有权访问端点的用户身份连接。 建议您以管理员身份连接。 (请参阅设置连接属性)。

您可以通过检索端点列表来检索端点。 然后,您可以遍历该列表,搜索要删除的特定端点。 例如,您可以通过确定与端点对应的服务以及端点的类型来定位端点。 在找到端点时,可以对其进行修改。

指定新配置值

修改端点时,请指定新的配置值。 例如,要修改监视文件夹端点,请重置所有监视文件夹端点配置值,而不仅仅是要修改的值。 有关属于监视文件夹端点的配置值的信息,请参阅添加监视文件夹端点

注意

有关属于电子邮件端点的配置值的信息,请参阅添加电子邮件端点

注意

您无法修改端点调用的服务。 如果尝试修改服务,则会引发异常。 要修改与给定端点关联的服务,请删除该端点并创建一个新端点。 (请参阅删除端点。)

另请参阅

使用Java API修改端点

包括AEM Forms Java库文件

设置连接属性

使用Java API修改端点

使用Java API修改端点:

  1. 包括项目文件。

    将客户端JAR文件(如adobe-livecycle-client.jar)包含在您Java项目的类路径中。

  2. 创建EndpointRegistry客户端对象。

    • 创建包含连接属性的ServiceClientFactory对象。
    • 使用其构造函数创建EndpointRegistryClient对象,并传递ServiceClientFactory对象。
  3. 检索要修改的端点。

    • 通过调用EndpointRegistryClient对象的getEndpoints方法并传递充当过滤器的PagingFilter对象,检索当前用户(在连接属性中指定)可访问的所有端点的列表。 您可以传递(PagingFilter)null值以返回所有端点。 此方法返回一个java.util.List对象,其中每个元素都是一个Endpoint对象。 有关PagingFilter对象的信息,请参阅AEM Forms API引用
    • 遍历java.util.List对象以确定它是否具有端点。 如果存在端点,则每个元素都是一个EndPoint实例。
    • 通过调用EndPoint对象的getServiceId方法,确定与端点对应的服务。 此方法将返回一个指定服务名称的字符串值。
    • 通过调用EndPoint对象的getConnectorId方法来确定端点类型。 此方法会返回一个指定端点类型的字符串值。 例如,如果端点是“监视文件夹”端点,则此方法将返回WatchedFolder
  4. 指定新配置值。

    • 通过调用ModifyEndpointInfo对象的构造函数创建对象。

    • 对于要设置的每个配置值,调用ModifyEndpointInfo对象的setConfigParameterAsText方法。 例如,要设置URL配置值,请调用ModifyEndpointInfo对象的setConfigParameterAsText方法并传递以下值:

      • 一个字符串值,用于指定配置值的名称。 例如,要设置url配置值,请指定url
      • 一个字符串值,用于指定配置值的值。 要为url配置值定义值,请指定监视的文件夹位置。
    • 调用EndpointRegistryClient对象的modifyEndpoint方法并传递ModifyEndpointInfo对象。

另请参阅

步骤摘要

快速入门:使用Java API修改端点

包括AEM Forms Java库文件

设置连接属性

删除端点

您可以使用AEM Forms Java API以编程方式从服务中删除端点。 删除端点后,无法使用已启用端点的调用方法调用该服务。 例如,如果从服务中删除SOAP端点,则无法使用SOAP模式调用该服务。

为了演示如何从服务中删除端点,本节将从名为​EncryptDocument​的服务中删除EJB端点。

注意

不能使用Web服务删除端点。

步骤的摘要

要从服务中删除端点,请执行以下任务:

  1. 包括项目文件。
  2. 创建EndpointRegistryClient对象。
  3. 检索端点。
  4. 删除终结点。

包含项目文件

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

必须将以下JAR文件添加到项目的类路径中:

  • adobe-livecycle-client.jar
  • adobe-usermanager-client.jar
  • adobe-utilities.jar(如果AEM Forms部署在JBoss应用程序服务器上,则此变量为必需变量)
  • jbossall-client.jar(如果AEM Forms部署在JBoss应用程序服务器上,则此为必需字段)

有关这些JAR文件位置的信息,请参阅包括AEM Forms Java库文件

创建EndpointRegistry客户端对象

要以编程方式删除端点,必须创建EndpointRegistryClient对象。

检索要删除的端点

在删除端点之前,必须先检索该端点。 要检索端点,您必须以有权访问端点的用户身份连接。 建议您以管理员身份连接。 (请参阅设置连接属性)。

您可以通过检索端点列表来检索端点。 然后,您可以遍历该列表,搜索要删除的特定端点。 例如,您可以通过确定与端点对应的服务以及端点的类型来定位端点。 在找到端点时,可以将其删除。

删除端点

创建新端点后,必须启用该端点。 启用端点后,可使用它调用服务。 启用端点后,您可以在管理控制台中查看该端点。

另请参阅

使用Java API删除端点

包括AEM Forms Java库文件

设置连接属性

使用Java API删除端点

使用Java API删除端点:

  1. 包括项目文件。

    将客户端JAR文件(如adobe-livecycle-client.jar)包含在您Java项目的类路径中。

  2. 创建EndpointRegistry客户端对象。

    • 创建包含连接属性的ServiceClientFactory对象。
    • 使用其构造函数创建EndpointRegistryClient对象,并传递ServiceClientFactory对象。
  3. 检索要删除的端点。

    • 通过调用EndpointRegistryClient对象的getEndpoints方法并传递充当过滤器的PagingFilter对象,检索当前用户(在连接属性中指定)有权访问的所有端点的列表。 您可以传递(PagingFilter)null以返回所有端点。 此方法返回一个java.util.List对象,其中每个元素都是一个Endpoint对象。
    • 遍历java.util.List对象以确定它是否具有端点。 如果存在端点,则每个元素都是一个EndPoint实例。
    • 通过调用EndPoint对象的getServiceId方法,确定与端点对应的服务。 此方法将返回一个指定服务名称的字符串值。
    • 通过调用EndPoint对象的getConnectorId方法来确定端点类型。 此方法会返回一个指定端点类型的字符串值。 例如,如果端点是EJB端点,则此方法将返回EJB
  4. 删除终结点。

    通过调用EndpointRegistryClient对象的remove方法并传递表示要删除的端点的EndPoint对象来删除端点。

另请参阅

步骤摘要

快速入门:使用Java API删除端点

包括AEM Forms Java库文件

设置连接属性

正在检索终结点连接器信息

您可以使用AEM Forms API以编程方式检索有关Endpoint Connectors的信息。 连接器使端点能够使用各种调用方法来调用服务。 例如,监视文件夹连接器使端点能够使用监视文件夹调用服务。 通过以编程方式检索有关端点连接器的信息,您可以检索与连接器关联的配置值,例如需要哪些配置值以及哪些配置值是可选的。

为了演示如何检索有关端点连接器的信息,此部分检索有关已监视文件夹连接器的信息。 (请参阅添加监视文件夹端点。)

注意

您无法使用Web服务检索有关端点的信息。

注意

本主题使用ConnectorRegistryClient API检索有关Endpoint Connectors的信息。 (请参阅AEM Forms API引用。)

步骤的摘要

要检索端点连接器信息,请执行以下任务:

  1. 包括项目文件。
  2. 创建ConnectorRegistryClient对象。
  3. 指定连接器类型。
  4. 检索配置值。

包含项目文件

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

必须将以下JAR文件添加到项目的类路径中:

  • adobe-livecycle-client.jar
  • adobe-usermanager-client.jar
  • adobe-utilities.jar(如果AEM Forms部署在JBoss应用程序服务器上,则此变量为必需变量)
  • jbossall-client.jar(如果AEM Forms部署在JBoss应用程序服务器上,则此为必需字段)

如果AEM Forms部署在非JBoss的受支持J2EE应用程序服务器上,则请将adobe-utilities.jar和jbossall-client.jar替换为特定于部署了AEM Forms的J2EE应用程序服务器的JAR文件。 有关所有AEM Forms JAR文件位置的信息,请参阅包括AEM Forms Java库文件

创建ConnectorRegistry客户端对象

要以编程方式检索Endpoint Connector信息,请创建ConnectorRegistryClient对象。

指定连接器类型

指定要从中检索信息的连接器类型。 存在以下类型的连接器:

  • EJB:允许客户端应用程序使用EJB模式调用服务。
  • SOAP:允许客户端应用程序使用SOAP模式调用服务。
  • 监视文件夹:允许监视文件夹调用服务。
  • 电子邮件:允许电子邮件调用服务。
  • 远程处理:使Flex客户端应用程序能够调用服务。
  • TaskManagerConnector:允许工作区用户从工作区内调用服务。

检索配置值

指定连接器类型后,可以检索有关连接器的信息,如支持的配置值。 例如,对于任何连接器,您可以确定需要哪些配置值以及哪些配置值是可选的。

另请参阅

使用Java API检索端点连接器信息

包括AEM Forms Java库文件

设置连接属性

使用Java API检索端点连接器信息

使用Java API检索端点连接器信息:

  1. 包括项目文件。.

    将客户端JAR文件(如adobe-livecycle-client.jar)包含在您Java项目的类路径中。

  2. 创建ConnectorRegistry客户端对象。

    • 创建包含连接属性的ServiceClientFactory对象。
    • 使用其构造函数创建ConnectorRegistryClient对象,并传递ServiceClientFactory对象。
  3. 指定连接器类型。

    通过调用ConnectorRegistryClient对象的getEndpointDefinition方法并传递指定连接器类型的字符串值来指定连接器类型。 例如,要指定“监视文件夹”连接器类型,请传递字符串值WatchedFolder。 此方法返回与连接器类型对应的Endpoint对象。

  4. 检索配置值。

    • 通过调用Endpoint对象的getConfigParameters方法,检索此端点中关联的配置值。 此方法返回ConfigParameter对象的数组。
    • 通过检索数组中的每个元素,检索有关每个配置值的信息。 每个元素都是一个ConfigParameter对象。 例如,您可以通过调用ConfigParameter对象的isRequired方法来确定配置值是必需值还是可选值。 如果需要配置值,则此方法将返回true

另请参阅

步骤摘要

快速入门:使用Java API检索端点连接器信息

包括AEM Forms Java库文件

设置连接属性

在此页面上