本文档中的示例和示例仅适用于JEE环境中的AEM Forms。
关于Endpoint Registry服务
Endpoint Registry服务提供以编程方式管理端点的功能。 例如,您可以向服务添加以下类型的端点:
SOAP、EJB和(JEE上的AEM表单已弃用)将为每个激活的服务自动创建远程处理端点。 SOAP和EJB端点为所有服务操作启用SOAP和EJB。
远程处理端点使Flex客户端能够调用将该端点添加到的AEM Forms服务上的操作。 将创建与端点同名的Flex目标,Flex客户端可以创建指向此目标的RemoteObjects以调用相关服务上的操作。
电子邮件、任务管理器和监视文件夹端点仅显示服务的特定操作。 添加这些端点需要第二个配置步骤来选择要调用、设置配置参数以及指定输入和输出参数映射的方法。
您可以将TaskManager端点组织到名为类别的组中。 然后,这些类别会通过TaskManager公开到工作区,最终用户在分类时会看到TaskManager端点。 在工作区中,最终用户会在导航窗格中看到这些类别。 每个类别中的端点在工作区的“开始进程”页面上显示为进程卡。
您可以使用Endpoint Registry服务完成以下任务:
您可以使用AEM Forms Java API以编程方式将EJB端点添加到服务。 通过向服务添加EJB端点,可以使客户端应用程序能够使用EJB模式调用该服务。 即,在设置调用AEM Forms所需的连接属性时,可以选择EJB模式。 (请参阅设置连接属性。)
不能使用Web服务添加EJB端点。
通常,EJB端点默认会添加到服务中。但是,EJB端点可以添加到以编程方式部署的进程中,或者当EJB端点被删除且必须再次添加时,也可以添加到该进程中。
要向服务添加EJB端点,请执行以下任务:
EndpointRegistry Client
对象。包含项目文件
在开发项目中包含必需的文件。 必须将以下JAR文件添加到项目的类路径中:
有关这些JAR文件位置的信息,请参阅包括AEM Forms Java库文件。
创建EndpointRegistry客户端对象
必须先创建EndpointRegistryClient
对象,然后才能以编程方式添加EJB端点。
设置EJB端点属性
要为服务创建EJB端点,请指定以下值:
EJB
。*
)。 但是,如果要指定特定操作而不是调用所有服务操作,请指定操作的名称,而不是使用通配符(*
)。创建EJB端点
设置EJB端点属性后,可以为服务创建EJB端点。
启用端点
创建新端点后,必须启用该端点。 启用端点后,可以使用它调用服务。 启用端点后,您可以在管理控制台中查看该端点。
另请参阅
使用Java API添加EJB端点:
包括项目文件。
将客户端JAR文件(如adobe-livecycle-client.jar)包含在您Java项目的类路径中。 (
创建EndpointRegistry客户端对象。
ServiceClientFactory
对象。EndpointRegistryClient
对象,并传递ServiceClientFactory
对象。设置EJB端点属性。
CreateEndpointInfo
对象的构造函数创建对象。CreateEndpointInfo
对象的setConnectorId
方法并传递字符串值EJB
来指定连接器标识符值。CreateEndpointInfo
对象的setDescription
方法并传递描述该端点的字符串值,指定端点的描述。CreateEndpointInfo
对象的setName
方法并传递指定名称的字符串值,指定端点的名称。CreateEndpointInfo
对象的setServiceId
方法并传递指定服务名称的字符串值,指定端点所属的服务。CreateEndpointInfo
对象的setOperationName
方法调用的操作,并传递指定操作名称的字符串值。 对于SOAP和EJB端点,指定通配符(*
),该字符表示所有操作。创建EJB端点。
通过调用EndpointRegistryClient
对象的createEndpoint
方法并传递CreateEndpointInfo
对象来创建端点。 此方法返回表示新EJB端点的Endpoint
对象。
启用端点。
通过调用EndpointRegistryClient
对象的enable方法并传递createEndpoint
方法返回的Endpoint
对象来启用端点。
另请参阅
您可以使用AEM Forms Java API以编程方式向服务添加SOAP端点。 通过添加SOAP端点,您可以使客户端应用程序能够使用SOAP模式调用服务。 也就是说,在设置调用AEM Forms所需的连接属性时,您可以选择SOAP模式。
不能使用Web服务添加SOAP端点。
通常,SOAP端点默认会添加到服务中。但是,SOAP端点可以添加到以编程方式部署的进程中,或者当SOAP端点被删除且必须再次添加时。
要向服务添加SOAP端点,请执行以下任务:
EndpointRegistryClient
对象。包含项目文件
在开发项目中包含必需的文件。 如果您使用Java创建客户端应用程序,请包含必需的JAR文件。 如果您使用的是Web服务,请确保包含代理文件。
必须将以下JAR文件添加到项目的类路径中:
创建SOAP端点时需要这些JAR文件。 但是,如果使用SOAP端点调用服务,则需要添加JAR文件。 有关AEM Forms JAR文件的信息,请参阅包括AEM Forms Java库文件。
创建EndpointRegistry客户端对象
要以编程方式向服务添加SOAP端点,必须创建EndpointRegistryClient
对象。
设置SOAP端点属性
要向服务添加SOAP端点,请指定以下值:
SOAP
。*
)。 但是,如果要指定特定操作而不是调用所有服务操作,请指定操作的名称,而不是使用通配符(*
)。创建SOAP端点
设置SOAP端点属性后,可以创建SOAP端点。
启用端点
创建新端点后,必须启用该端点。 启用端点后,可使用它调用服务。 启用端点后,您可以在管理控制台中查看该端点。
另请参阅
使用Java API向服务添加SOAP端点:
包括项目文件。
将客户端JAR文件(如adobe-livecycle-client.jar)包含在您Java项目的类路径中。
创建EndpointRegistry客户端对象。
ServiceClientFactory
对象。EndpointRegistryClient
对象,并传递ServiceClientFactory
对象。设置SOAP端点属性。
CreateEndpointInfo
对象的构造函数创建对象。CreateEndpointInfo
对象的setConnectorId
方法并传递字符串值SOAP
来指定连接器标识符值。CreateEndpointInfo
对象的setDescription
方法并传递描述该端点的字符串值,指定端点的描述。CreateEndpointInfo
对象的setName
方法并传递指定名称的字符串值,指定端点的名称。CreateEndpointInfo
对象的setServiceId
方法并传递指定服务名称的字符串值,指定端点所属的服务。CreateEndpointInfo
对象的setOperationName
方法并传递指定操作名称的字符串值来调用的操作。 对于SOAP和EJB端点,指定通配符(*
),该字符表示所有操作。创建SOAP端点。
通过调用EndpointRegistryClient
对象的createEndpoint
方法并传递CreateEndpointInfo
对象来创建端点。 此方法返回表示新SOAP端点的Endpoint
对象。
启用端点。
通过调用EndpointRegistryClient
对象的enable方法来启用端点,并传递createEndpoint
方法返回的Endpoint
对象。
另请参阅
您可以使用AEM Forms Java API以编程方式将监视文件夹端点添加到服务。 通过添加“监视文件夹”端点,用户可以将文件(如PDF文件)放置在文件夹中。 将文件放置到文件夹中后,将调用配置的服务并处理文件。 服务执行指定操作后,会将修改后的文件保存在指定的输出文件夹中。 已监视文件夹配置为以固定速率间隔或按照cron计划进行扫描,例如每周一、周三和周五的中午。
为了以编程方式向服务添加已监视文件夹端点,请考虑以下名为EncryptDocument的短期进程。 (请参阅了解AEM Forms进程。)
此过程接受不安全的PDF文档作为输入值,然后将不安全的PDF文档传递到加密服务的EncryptPDFUsingPassword
操作。 PDF文档使用密码加密,密码加密的PDF文档是此过程的输出值。 输入值的名称(不安全的PDF文档)为InDoc
,数据类型为com.adobe.idp.Document
。 输出值(密码加密的PDF文档)的名称为SecuredDoc
,数据类型为com.adobe.idp.Document
。
无法使用Web服务添加“监视文件夹”端点。
要向服务添加监视文件夹端点,请执行以下任务:
EndpointRegistryClient
对象。包含项目文件
在开发项目中包含必需的文件。 如果您使用Java创建客户端应用程序,请包含必需的JAR文件。 如果您使用的是Web服务,请确保包含代理文件。
必须将以下JAR文件添加到项目的类路径中:
有关这些JAR文件位置的信息,请参阅包括AEM Forms Java库文件。
创建EndpointRegistry客户端对象
要以编程方式添加“监视文件夹”端点,必须创建EndpointRegistryClient
对象。
设置监视文件夹端点属性
要为服务创建监视文件夹端点,请指定以下值:
WatchedFolder
。EncryptDocument
。invoke
。指定配置值
以编程方式向服务添加监视文件夹端点时,必须为监视文件夹端点指定配置值。 如果使用管理控制台添加了监视文件夹端点,则管理员会指定这些配置值。
以下列表指定了在以编程方式向服务添加监视文件夹端点时设置的配置值:
data*
,则不会选取与data*
匹配的所有文件和文件夹。 这包括名为data1
、data2
等的文件和文件夹。 此外,可以用通配符模式来补充该模式以指定文件模式。 监视文件夹修改正则表达式以支持通配符模式,如*.*
和*.pdf
。 正则表达式不支持这些通配符模式。*
,则会选取所有与input*
匹配的文件和文件夹。 这包括名为input1
、input2
等的文件和文件夹。 默认值为 *
. 此值指示所有文件和文件夹。 此外,可以用通配符模式来补充该模式以指定文件模式。 监视文件夹修改正则表达式以支持通配符模式,如*.*
和*.pdf
。 正则表达式不支持这些通配符模式。 此值是必填项。result/%Y/%M/%D/
. 这是已监视文件夹内的结果文件夹。preserve/%Y/%M/%D/
.failure/%Y/%M/%D/
.定义输入参数值
创建监视文件夹端点时,必须定义输入参数值。 也就是说,您必须描述传递到监视文件夹所调用操作的输入值。 例如,请考虑本主题中介绍的流程。 它有一个名为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
。
创建监视文件夹端点
在设置端点的属性、配置值并定义输入和输出参数值后,必须创建“监视文件夹”端点。
启用端点
创建监视文件夹端点后,必须启用该端点。 启用端点后,可使用它调用服务。 启用端点后,您可以在管理控制台中查看该端点。
另请参阅
使用AEM Forms Java API添加监视文件夹端点:
包括项目文件。
将客户端JAR文件(如adobe-livecycle-client.jar)包含在您Java项目的类路径中。
创建EndpointRegistry客户端对象。
ServiceClientFactory
对象。EndpointRegistryClient
对象,并传递ServiceClientFactory
对象。设置监视文件夹端点属性。
CreateEndpointInfo
对象的构造函数创建对象。CreateEndpointInfo
对象的setConnectorId
方法并传递字符串值WatchedFolder
来指定连接器标识符值。CreateEndpointInfo
对象的setDescription
方法并传递描述该端点的字符串值,指定端点的描述。CreateEndpointInfo
对象的setName
方法并传递指定名称的字符串值,指定端点的名称。CreateEndpointInfo
对象的setServiceId
方法并传递指定服务名称的字符串值,指定端点所属的服务。CreateEndpointInfo
对象的setOperationName
方法并传递指定操作名称的字符串值来调用的操作。 通常,在为源自在Workbench中创建的进程的服务创建“监视文件夹”端点时,会调用操作的名称。指定配置值。
对于要为监视文件夹端点设置的每个配置值,必须调用CreateEndpointInfo
对象的setConfigParameterAsText
方法。 例如,要设置url
配置值,请调用CreateEndpointInfo
对象的setConfigParameterAsText
方法并传递以下字符串值:
url
配置值时,请指定url
。url
配置值时,请指定监视的文件夹位置。要查看为EncryptDocument服务设置的所有配置值,请参阅位于QuickStart的Java代码示例:使用Java API添加监视文件夹端点。
定义输入参数值。
通过调用CreateEndpointInfo
对象的setInputParameterMapping
方法定义输入参数值,并传递以下值:
InDoc
。InDoc
输入参数的数据类型为com.adobe.idp.Document
。variable
。为要定义的每个输入参数值调用setInputParameterMapping
方法。 由于EncryptDocument进程只有一个输入参数,因此需要调用此方法一次。
定义输出参数值。
通过调用CreateEndpointInfo
对象的setOutputParameterMapping
方法定义输出参数值,并传递以下值:
SecuredDoc
。SecuredDoc
输出参数的数据类型为com.adobe.idp.Document
。%F.pdf
。创建监视文件夹端点。
通过调用EndpointRegistryClient
对象的createEndpoint
方法并传递CreateEndpointInfo
对象来创建端点。 此方法会返回一个Endpoint
对象,该对象表示“已监视文件夹”端点。
启用端点。
通过调用EndpointRegistryClient
对象的enable
方法并传递createEndpoint
方法返回的Endpoint
对象来启用端点。
另请参阅
快速入门:使用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流程。
此过程接受不安全的PDF文档作为输入值,然后将不安全的PDF文档传递到加密服务的EncryptPDFUsingPassword
操作。 此过程使用密码加密PDF文档,并返回密码加密的PDF文档作为输出值。 输入值的名称(不安全的PDF文档)为InDoc
,数据类型为com.adobe.idp.Document
。 输出值(密码加密的PDF文档)的名称为SecuredDoc
,数据类型为com.adobe.idp.Document
。
无法使用Web服务添加电子邮件端点。
要向服务添加电子邮件端点,请执行以下任务:
EndpointRegistryClient
对象。包含项目文件
在开发项目中包含必需的文件。 如果您使用Java创建客户端应用程序,请包含必需的JAR文件。 如果您使用的是Web服务,请确保包含代理文件。
必须将以下JAR文件添加到项目的类路径中:
有关这些JAR文件位置的信息,请参阅包括AEM Forms Java库文件。
创建EndpointRegistry客户端对象
必须先创建EndpointRegistryClient
对象,然后才能以编程方式添加电子邮件端点。
设置电子邮件端点属性
要为服务创建电子邮件端点,请指定以下值:
Email
。EncryptDocument
。invoke
。指定配置值
以编程方式向服务添加电子邮件端点时,必须为电子邮件端点指定配置值。 如果使用管理控制台添加电子邮件端点,则管理员会指定这些配置值。
受监控的电子邮件帐户是仅用于电子邮件端点的特殊帐户。 此帐户不是普通用户的电子邮件帐户。 常规用户的电子邮件帐户不得配置为电子邮件提供商使用的帐户,因为电子邮件提供商在邮件处理完成后会从收件箱中删除电子邮件。
以编程方式向服务添加电子邮件端点时,会设置以下配置值:
SuperAdmin
.DefaultDom
.adobe.com
,则仅处理adobe.com的电子邮件,则忽略其他域的电子邮件。*
.sender
,则会向发件人发送电子邮件结果。 最多支持100个收件人。 使用电子邮件地址指定其他收件人,每个收件人以逗号分隔。 要关闭此选项,请将此值留空。 在某些情况下,您可能希望触发某个流程,并且不希望收到有关结果的电子邮件通知。 默认值为 sender
.sender
,则会向发件人发送电子邮件结果。 最多支持100个收件人。 使用电子邮件地址指定其他收件人,每个收件人以逗号分隔。 要关闭此选项,请将此值留空。 默认值为 sender
.IMAP
或POP3
。 收件箱主机邮件服务器必须支持这些协议。UTF-8
.定义输入参数值
创建电子邮件端点时,必须定义输入参数值。 也就是说,您必须描述传递到电子邮件端点所调用操作的输入值。 例如,请考虑本主题中介绍的流程。 它有一个名为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添加电子邮件端点:
包括项目文件。
将客户端JAR文件(如adobe-livecycle-client.jar)包含在您Java项目的类路径中。
创建EndpointRegistry客户端对象。
ServiceClientFactory
对象。EndpointRegistryClient
对象,并传递ServiceClientFactory
对象。设置电子邮件端点属性。
CreateEndpointInfo
对象的构造函数创建对象。CreateEndpointInfo
对象的setConnectorId
方法并传递字符串值Email
来指定连接器标识符值。CreateEndpointInfo
对象的setDescription
方法并传递描述该端点的字符串值,指定端点的描述。CreateEndpointInfo
对象的setName
方法并传递指定名称的字符串值,指定端点的名称。CreateEndpointInfo
对象的setServiceId
方法并传递指定服务名称的字符串值,指定端点所属的服务。CreateEndpointInfo
对象的setOperationName
方法并传递指定操作名称的字符串值来调用的操作。 通常,在为源自在Workbench中创建的进程的服务创建电子邮件端点时,会调用操作的名称。指定配置值。
对于要为电子邮件端点设置的每个配置值,必须调用CreateEndpointInfo
对象的setConfigParameterAsText
方法。 例如,要设置smtpHost
配置值,请调用CreateEndpointInfo
对象的setConfigParameterAsText
方法并传递以下值:
smtpHost
配置值时,请指定smtpHost
。smtpHost
配置值时,请指定一个字符串值,以指定SMTP服务器的名称。要查看本节中介绍的EncryptDocument服务的所有配置值集,请参阅位于QuickStart的Java代码示例:使用Java API添加电子邮件端点。
定义输入参数值。
通过调用CreateEndpointInfo
对象的setInputParameterMapping
方法定义输入参数值,并传递以下值:
InDoc
。InDoc
输入参数的数据类型为com.adobe.idp.Document
。variable
。为要定义的每个输入参数值调用setInputParameterMapping
方法。 由于EncryptDocument进程只有一个输入参数,因此需要调用此方法一次。
定义输出参数值。
通过调用CreateEndpointInfo
对象的setOutputParameterMapping
方法并传递以下值来定义输出参数值:
SecuredDoc
。SecuredDoc
输出参数的数据类型为com.adobe.idp.Document
。%F.pdf
。创建电子邮件端点。
通过调用EndpointRegistryClient
对象的createEndpoint
方法并传递CreateEndpointInfo
对象来创建端点。 此方法会返回一个Endpoint
对象,表示电子邮件端点。
启用端点。
通过调用EndpointRegistryClient
对象的enable
方法并传递createEndpoint
方法返回的Endpoint
对象来启用端点。
另请参阅
快速入门:使用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的短期进程。
此过程接受不安全的PDF文档作为输入值,然后将不安全的PDF文档传递到加密服务的EncryptPDFUsingPassword
操作。 PDF文档使用密码加密,密码加密的PDF文档是此过程的输出值。 输入值的名称(不安全的PDF文档)为InDoc
,数据类型为com.adobe.idp.Document
。 输出值(密码加密的PDF文档)的名称为SecuredDoc
,数据类型为com.adobe.idp.Document
。
为了演示如何向服务添加远程处理端点,本节将远程处理端点添加到名为EncryptDocument的服务。
无法使用Web服务添加远程处理端点。
要从服务中删除端点,请执行以下任务:
EndpointRegistryClient
对象。包含项目文件
在开发项目中包含必需的文件。 如果您使用Java创建客户端应用程序,请包含必需的JAR文件。 如果您使用的是Web服务,请确保包含代理文件。
必须将以下JAR文件添加到项目的类路径中:
有关这些JAR文件位置的信息,请参阅包括AEM Forms Java库文件。
创建EndpointRegistry客户端对象
要以编程方式添加远程处理端点,必须创建一个EndpointRegistryClient
对象。
设置远程处理端点属性
要为服务创建远程处理端点,请指定以下值:
Remoting
。EncryptDocument
。创建远程处理端点
设置远程处理端点属性后,可以为服务创建远程处理端点。
启用端点
创建新端点后,必须启用该端点。 启用远程处理端点后,Flex客户端将调用该服务。
另请参阅
使用Java API添加远程处理端点:
包括项目文件。
将客户端JAR文件(如adobe-livecycle-client.jar)包含在您Java项目的类路径中。
创建EndpointRegistry客户端对象。
ServiceClientFactory
对象。EndpointRegistryClient
对象,并传递ServiceClientFactory
对象。设置远程处理端点属性。
CreateEndpointInfo
对象的构造函数创建对象。CreateEndpointInfo
对象的setConnectorId
方法并传递字符串值Remoting
来指定连接器标识符值。CreateEndpointInfo
对象的setDescription
方法并传递描述该端点的字符串值,指定端点的描述。CreateEndpointInfo
对象的setName
方法并传递指定名称的字符串值,指定端点的名称。CreateEndpointInfo
对象的setServiceId
方法并传递指定服务名称的字符串值,指定端点所属的服务。CreateEndpointInfo
对象的setOperationName
方法调用的操作,并传递指定操作名称的字符串值。 对于远程处理端点,指定通配符(*)。创建远程处理端点。
通过调用EndpointRegistryClient
对象的createEndpoint
方法并传递CreateEndpointInfo
对象来创建端点。 此方法会返回一个Endpoint
对象,该对象表示新的Remoting端点。
启用端点。
通过调用EndpointRegistryClient
对象的enable
方法并传递createEndpoint
方法返回的Endpoint
对象来启用端点。
另请参阅
您可以使用AEM Forms Java API以编程方式将TaskManager端点添加到服务。 通过向服务添加TaskManager端点,可让工作区用户调用该服务。 即,在工作区中工作的用户可以调用具有相应TaskManager端点的进程。
无法使用Web服务添加TaskManager端点。
要向服务添加TaskManager端点,请执行以下任务:
EndpointRegistryClient
对象。包含项目文件
在开发项目中包含必需的文件。 如果您使用Java创建客户端应用程序,请包含必需的JAR文件。 如果您使用的是Web服务,请确保包含代理文件。
必须将以下JAR文件添加到项目的类路径中:
有关这些JAR文件位置的信息,请参阅包括AEM Forms Java库文件。
创建EndpointRegistry客户端对象
必须先创建EndpointRegistryClient
对象,然后才能以编程方式添加TaskManager端点。
为端点创建类别
类别用于在工作区内组织服务。 即,工作区用户可以通过在工作区中选择类别来调用具有TaskManager端点的服务。 创建TaskManager端点时,可以引用现有类别或以编程方式创建新类别。
此部分在向服务添加TaskManager端点时会创建新类别。
设置TaskManager端点属性
要为服务创建TaskManager端点,请指定以下值:
TaskManagerConnector
。invoke
。创建TaskManager端点
设置TaskManager端点属性后,可以为服务创建TaskManager端点。
启用端点
创建新端点后,必须启用该端点。 启用端点后,可使用该端点在工作区中调用服务。 启用端点后,您可以在管理控制台中查看该端点。
另请参阅
使用Java API添加TaskManager端点:
包括项目文件。
将客户端JAR文件(如adobe-livecycle-client.jar)包含在您Java项目的类路径中。
创建EndpointRegistry客户端对象。
ServiceClientFactory
对象。EndpointRegistryClient
对象,并传递ServiceClientFactory
对象。为端点创建类别。
使用CreateEndpointCategoryInfo
对象的构造函数并传递以下值来创建该对象:
通过调用EndpointRegistryClient
对象的createEndpointCategory
方法并传递CreateEndpointCategoryInfo
对象来创建类别。 此方法返回表示新类别的EndpointCategory
对象。
设置TaskManager端点属性。
CreateEndpointInfo
对象的构造函数创建对象。CreateEndpointInfo
对象的setConnectorId
方法并传递字符串值TaskManagerConnector
来指定连接器标识符值。CreateEndpointInfo
对象的setDescription
方法并传递描述该端点的字符串值,指定端点的描述。CreateEndpointInfo
对象的setName
方法并传递指定名称的字符串值,指定端点的名称。CreateEndpointInfo
对象的setServiceId
方法并传递指定服务名称的字符串值,指定端点所属的服务。CreateEndpointInfo
对象的setCategoryId
方法并传递指定类别标识符值的字符串值,指定端点所属的类别。 可以调用EndpointCategory
对象的getId
方法来获取此类别的标识符值。CreateEndpointInfo
对象的setOperationName
方法并传递指定操作名称的字符串值来调用的操作。 通常,在为源自在Workbench中创建的进程的服务创建TaskManager
端点时,操作的名称为invoke
。创建TaskManager端点。
通过调用EndpointRegistryClient
对象的createEndpoint
方法并传递CreateEndpointInfo
对象来创建端点。 此方法返回表示新TaskManager端点的Endpoint
对象。
启用端点。
通过调用EndpointRegistryClient
对象的enable
方法并传递createEndpoint
方法返回的Endpoint
对象来启用端点。
另请参阅
快速入门:使用Java API添加TaskManager端点
您可以使用AEM Forms Java API以编程方式修改现有端点。 通过修改端点,可以更改端点的行为。 例如,考虑指定用作监视文件夹的文件夹的监视文件夹端点。 您可以以编程方式修改属于监视文件夹端点的配置值,从而导致另一个文件夹能够用作监视文件夹。 有关属于监视文件夹端点的配置值的信息,请参阅添加监视文件夹端点。
为了演示如何修改端点,本节通过更改行为与监视文件夹相同的文件夹来修改监视文件夹端点。
不能使用Web服务修改端点。
要修改端点,请执行以下任务:
EndpointRegistryClient
对象。包含项目文件
在开发项目中包含必需的文件。 如果您使用Java创建客户端应用程序,请包含必需的JAR文件。 如果您使用的是Web服务,请确保包含代理文件。
必须将以下JAR文件添加到项目的类路径中:
有关这些JAR文件位置的信息,请参阅包括AEM Forms Java库文件。
创建EndpointRegistry客户端对象
要以编程方式修改端点,必须创建一个EndpointRegistryClient
对象。
检索要修改的端点
在修改端点之前,必须先检索该端点。 要检索端点,您必须以有权访问端点的用户身份连接。 建议您以管理员身份连接。 (请参阅设置连接属性)。
您可以通过检索端点列表来检索端点。 然后,您可以遍历该列表,搜索要删除的特定端点。 例如,您可以通过确定与端点对应的服务以及端点的类型来定位端点。 在找到端点时,可以对其进行修改。
指定新配置值
修改端点时,请指定新的配置值。 例如,要修改监视文件夹端点,请重置所有监视文件夹端点配置值,而不仅仅是要修改的值。 有关属于监视文件夹端点的配置值的信息,请参阅添加监视文件夹端点。
有关属于电子邮件端点的配置值的信息,请参阅添加电子邮件端点。
您无法修改端点调用的服务。 如果尝试修改服务,则会引发异常。 要修改与给定端点关联的服务,请删除该端点并创建一个新端点。 (请参阅删除端点。)
另请参阅
使用Java API修改端点:
包括项目文件。
将客户端JAR文件(如adobe-livecycle-client.jar)包含在您Java项目的类路径中。
创建EndpointRegistry客户端对象。
ServiceClientFactory
对象。EndpointRegistryClient
对象,并传递ServiceClientFactory
对象。检索要修改的端点。
EndpointRegistryClient
对象的getEndpoints
方法并传递充当过滤器的PagingFilter
对象,检索当前用户(在连接属性中指定)可访问的所有端点的列表。 您可以传递(PagingFilter)null
值以返回所有端点。 此方法返回一个java.util.List
对象,其中每个元素都是一个Endpoint
对象。 有关PagingFilter
对象的信息,请参阅AEM Forms API引用。java.util.List
对象以确定它是否具有端点。 如果存在端点,则每个元素都是一个EndPoint
实例。EndPoint
对象的getServiceId
方法,确定与端点对应的服务。 此方法将返回一个指定服务名称的字符串值。EndPoint
对象的getConnectorId
方法来确定端点类型。 此方法会返回一个指定端点类型的字符串值。 例如,如果端点是“监视文件夹”端点,则此方法将返回WatchedFolder
。指定新配置值。
通过调用ModifyEndpointInfo
对象的构造函数创建对象。
对于要设置的每个配置值,调用ModifyEndpointInfo
对象的setConfigParameterAsText
方法。 例如,要设置URL配置值,请调用ModifyEndpointInfo
对象的setConfigParameterAsText
方法并传递以下值:
url
配置值,请指定url
。url
配置值定义值,请指定监视的文件夹位置。调用EndpointRegistryClient
对象的modifyEndpoint
方法并传递ModifyEndpointInfo
对象。
另请参阅
您可以使用AEM Forms Java API以编程方式从服务中删除端点。 删除端点后,无法使用已启用端点的调用方法调用该服务。 例如,如果从服务中删除SOAP端点,则无法使用SOAP模式调用该服务。
为了演示如何从服务中删除端点,本节将从名为EncryptDocument的服务中删除EJB端点。
不能使用Web服务删除端点。
要从服务中删除端点,请执行以下任务:
EndpointRegistryClient
对象。包含项目文件
将必需的文件包含到开发项目中。 如果您使用Java创建客户端应用程序,请包含必需的JAR文件。 如果您使用的是Web服务,请确保包含代理文件。
必须将以下JAR文件添加到项目的类路径中:
有关这些JAR文件位置的信息,请参阅包括AEM Forms Java库文件。
创建EndpointRegistry客户端对象
要以编程方式删除端点,必须创建EndpointRegistryClient
对象。
检索要删除的端点
在删除端点之前,必须先检索该端点。 要检索端点,您必须以有权访问端点的用户身份连接。 建议您以管理员身份连接。 (请参阅设置连接属性)。
您可以通过检索端点列表来检索端点。 然后,您可以遍历该列表,搜索要删除的特定端点。 例如,您可以通过确定与端点对应的服务以及端点的类型来定位端点。 在找到端点时,可以将其删除。
删除端点
创建新端点后,必须启用该端点。 启用端点后,可使用它调用服务。 启用端点后,您可以在管理控制台中查看该端点。
另请参阅
使用Java API删除端点:
包括项目文件。
将客户端JAR文件(如adobe-livecycle-client.jar)包含在您Java项目的类路径中。
创建EndpointRegistry客户端对象。
ServiceClientFactory
对象。EndpointRegistryClient
对象,并传递ServiceClientFactory
对象。检索要删除的端点。
EndpointRegistryClient
对象的getEndpoints
方法并传递充当过滤器的PagingFilter
对象,检索当前用户(在连接属性中指定)有权访问的所有端点的列表。 您可以传递(PagingFilter)null
以返回所有端点。 此方法返回一个java.util.List
对象,其中每个元素都是一个Endpoint
对象。java.util.List
对象以确定它是否具有端点。 如果存在端点,则每个元素都是一个EndPoint
实例。EndPoint
对象的getServiceId
方法,确定与端点对应的服务。 此方法将返回一个指定服务名称的字符串值。EndPoint
对象的getConnectorId
方法来确定端点类型。 此方法会返回一个指定端点类型的字符串值。 例如,如果端点是EJB端点,则此方法将返回EJB
。删除终结点。
通过调用EndpointRegistryClient
对象的remove
方法并传递表示要删除的端点的EndPoint
对象来删除端点。
另请参阅
您可以使用AEM Forms API以编程方式检索有关Endpoint Connectors的信息。 连接器使端点能够使用各种调用方法来调用服务。 例如,监视文件夹连接器使端点能够使用监视文件夹调用服务。 通过以编程方式检索有关端点连接器的信息,您可以检索与连接器关联的配置值,例如需要哪些配置值以及哪些配置值是可选的。
为了演示如何检索有关端点连接器的信息,此部分检索有关已监视文件夹连接器的信息。 (请参阅添加监视文件夹端点。)
您无法使用Web服务检索有关端点的信息。
本主题使用ConnectorRegistryClient
API检索有关Endpoint Connectors的信息。 (请参阅AEM Forms API引用。)
要检索端点连接器信息,请执行以下任务:
ConnectorRegistryClient
对象。包含项目文件
将必需的文件包含到开发项目中。 如果您使用Java创建客户端应用程序,请包含必需的JAR文件。 如果您使用的是Web服务,请确保包含代理文件。
必须将以下JAR文件添加到项目的类路径中:
如果AEM Forms部署在非JBoss的受支持J2EE应用程序服务器上,则请将adobe-utilities.jar和jbossall-client.jar替换为特定于部署了AEM Forms的J2EE应用程序服务器的JAR文件。 有关所有AEM Forms JAR文件位置的信息,请参阅包括AEM Forms Java库文件。
创建ConnectorRegistry客户端对象
要以编程方式检索Endpoint Connector信息,请创建ConnectorRegistryClient
对象。
指定连接器类型
指定要从中检索信息的连接器类型。 存在以下类型的连接器:
检索配置值
指定连接器类型后,可以检索有关连接器的信息,如支持的配置值。 例如,对于任何连接器,您可以确定需要哪些配置值以及哪些配置值是可选的。
另请参阅
使用Java API检索端点连接器信息:
包括项目文件。.
将客户端JAR文件(如adobe-livecycle-client.jar)包含在您Java项目的类路径中。
创建ConnectorRegistry客户端对象。
ServiceClientFactory
对象。ConnectorRegistryClient
对象,并传递ServiceClientFactory
对象。指定连接器类型。
通过调用ConnectorRegistryClient
对象的getEndpointDefinition
方法并传递指定连接器类型的字符串值来指定连接器类型。 例如,要指定“监视文件夹”连接器类型,请传递字符串值WatchedFolder
。 此方法返回与连接器类型对应的Endpoint
对象。
检索配置值。
Endpoint
对象的getConfigParameters
方法,检索此端点中关联的配置值。 此方法返回ConfigParameter
对象的数组。ConfigParameter
对象。 例如,您可以通过调用ConfigParameter
对象的isRequired
方法来确定配置值是必需值还是可选值。 如果需要配置值,则此方法将返回true
。另请参阅