本文档中的示例和示例仅适用于AEM Forms on JEE环境。
关于终结点注册表服务
Endpoint Registry服务提供了以编程方式管理端点的功能。 例如,您可以将以下类型的端点添加到服务:
SOAP、EJB和(对于JEE上的AEM Forms已弃用)远程处理端点是为每个激活的服务自动创建的。 SOAP和EJB端点为所有服务操作启用SOAP和EJB。
远程端点使Flex客户端能够调用对端点所添加到的AEM Forms服务的操作。 将创建与端点同名的Flex目标,并且Flex客户端可以创建指向此目标的RemoteObjects以调用对相关服务的操作。
电子邮件、任务管理器和Watched Folder端点仅公开服务的特定操作。 添加这些端点需要执行第二个配置步骤,以选择要调用的方法、设置配置参数以及指定输入和输出参数映射。
您可以将TaskManager端点组织成组,称为 类别. 然后,这些类别将通过TaskManager向Workspace公开,最终用户在分类时看到TaskManager端点。 在Workspace中,最终用户可在导航窗格中看到这些类别。 每个类别中的端点在Workspace的“启动进程”页面上显示为进程卡。
您可以使用Endpoint Registry服务完成以下任务:
您可以使用AEM Forms Java API以编程方式将EJB端点添加到服务。 通过将EJB端点添加到服务,可以使客户机应用程序使用EJB模式调用该服务。 也就是说,在设置调用AEM Forms所需的连接属性时,可以选择EJB模式。 (请参阅 设置连接属性.)
无法使用Web服务添加EJB端点。
通常,默认情况下会将EJB端点添加到服务中。但是,可以将EJB端点添加到以编程方式部署的进程中,或者在删除了EJB端点且必须再次添加时,可以将EJB端点添加到进程中。
要向服务添加EJB端点,请执行以下任务:
EndpointRegistry Client
对象。包括项目文件
在开发项目中包含必要的文件。 必须将以下JAR文件添加到项目的类路径中:
有关这些JAR文件位置的信息,请参见 包括AEM Forms Java库文件.
创建EndpointRegistry客户端对象
必须先创建一个 EndpointRegistryClient
对象。
设置EJB终结点属性
要为服务创建EJB端点,请指定以下值:
EJB
.*
)。 但是,如果要指定特定操作而不是调用所有服务操作,请指定操作名称,而不是使用通配符( *
)。创建EJB端点
设置EJB终结点属性后,可以为服务创建EJB终结点。
启用端点
创建新端点后,必须启用它。 启用端点后,便可用于调用服务。 启用该端点后,您可以在管理控制台中查看它。
另请参阅
使用Java API添加EJB端点:
包括项目文件。
在Java项目的类路径中包含客户端JAR文件,例如adobe-livecycle-client.jar。 (
创建EndpointRegistry客户端对象。
ServiceClientFactory
包含连接属性的对象。EndpointRegistryClient
对象,使用它的构造函数传递 ServiceClientFactory
对象。设置EJB终结点属性。
CreateEndpointInfo
对象。CreateEndpointInfo
对象的 setConnectorId
方法和传递字符串值 EJB
.CreateEndpointInfo
对象的 setDescription
方法和传递描述端点的字符串值。CreateEndpointInfo
对象的 setName
方法,并传递一个指定名称的字符串值。CreateEndpointInfo
对象的 setServiceId
方法,并传递一个指定服务名称的字符串值。CreateEndpointInfo
对象的 setOperationName
方法,并传递一个指定操作名称的字符串值。 对于SOAP和EJB端点,请指定通配符( *
),这表示所有操作。创建EJB端点。
通过调用 EndpointRegistryClient
对象的 createEndpoint
方法和传递 CreateEndpointInfo
对象。 此方法会返回 Endpoint
表示新EJB端点的对象。
启用端点。
通过调用 EndpointRegistryClient
对象的enable方法和传递 Endpoint
返回的对象 createEndpoint
方法。
另请参阅
您可以使用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端点:
包括项目文件。
在Java项目的类路径中包含客户端JAR文件,例如adobe-livecycle-client.jar。
创建EndpointRegistry客户端对象。
ServiceClientFactory
包含连接属性的对象。EndpointRegistryClient
对象,使用它的构造函数传递 ServiceClientFactory
对象。设置SOAP端点属性。
CreateEndpointInfo
对象。CreateEndpointInfo
对象的 setConnectorId
方法和传递字符串值 SOAP
.CreateEndpointInfo
对象的 setDescription
方法和传递描述端点的字符串值。CreateEndpointInfo
对象的 setName
方法,并传递一个指定名称的字符串值。CreateEndpointInfo
对象的 setServiceId
方法,并传递一个指定服务名称的字符串值。CreateEndpointInfo
对象的 setOperationName
方法,并传递一个指定操作名称的字符串值。 对于SOAP和EJB端点,请指定通配符( *
),这表示所有操作。创建SOAP端点。
通过调用 EndpointRegistryClient
对象的 createEndpoint
方法和传递 CreateEndpointInfo
对象。 此方法会返回 Endpoint
表示新SOAP端点的对象。
启用端点。
通过调用 EndpointRegistryClient
对象的enable方法并传递 Endpoint
返回的对象 createEndpoint
方法。
另请参阅
您可以使用AEM Forms Java API以编程方式将Watched Folder端点添加到服务。 通过添加Watched Folder端点,您可以使用户能够将文件(如PDF文件)放置在文件夹中。 将文件放在文件夹中后,将调用配置的服务并操作文件。 服务执行指定的操作后,会将修改的文件保存在指定的输出文件夹中。 观察文件夹配置为按固定速率间隔或按cron时间表进行扫描,例如每个星期一、星期三和星期五中午。
为了以编程方式将Watched Folder端点添加到服务,请考虑以下命名的短暂过程 EncryDocument. (请参阅 了解AEM Forms流程.)
此流程接受不安全的PDF文档作为输入值,然后将不安全的PDF文档传递到加密服务的 EncryptPDFUsingPassword
操作。 PDF文档使用密码进行加密,密码加密的PDF文档是此过程的输出值。 输入值(无保护PDF文档)的名称为 InDoc
并且数据类型是 com.adobe.idp.Document
. 输出值(口令加密的PDF文档)的名称为 SecuredDoc
并且数据类型是 com.adobe.idp.Document
.
无法使用Web服务添加Watched Folder端点。
要向服务添加Watched Folder端点,请执行以下任务:
EndpointRegistryClient
对象。包括项目文件
在开发项目中包含必要的文件。 如果要使用Java创建客户端应用程序,请包含必要的JAR文件。 如果使用Web服务,请确保包含代理文件。
必须将以下JAR文件添加到项目的类路径中:
有关这些JAR文件位置的信息,请参见 包括AEM Forms Java库文件.
创建EndpointRegistry客户端对象
要以编程方式添加观察文件夹端点,您必须创建 EndpointRegistryClient
对象。
设置Watched文件夹端点属性
要为服务创建Watched Folder端点,请指定以下值:
WatchedFolder
.EncryptDocument
.invoke
.指定配置值
以编程方式将Watched文件夹端点添加到服务时,必须指定Watched文件夹端点的配置值。 如果使用管理控制台添加了Watched文件夹端点,则这些配置值由管理员指定。
以下列表指定以编程方式将Watched文件夹端点添加到服务时设置的配置值:
data*
,所有匹配的文件和文件夹 data*
不会被接听。 这包括名为的文件和文件夹 data1
, data2
,等等。 此外,还可以使用通配符模式对模式进行补充,以指定文件模式。 观察文件夹修改正则表达式以支持通配符模式,例如 *.*
和 *.pdf
. 正则表达式不支持这些通配符模式。*
,所有匹配的文件和文件夹 input*
被捡起来了。 这包括名为的文件和文件夹 input1
, input2
,等等。 默认值为 *
。此值表示所有文件和文件夹。 此外,还可以使用通配符模式对模式进行补充,以指定文件模式。 观察文件夹修改正则表达式以支持通配符模式,例如 *.*
和 *.pdf
. 正则表达式不支持这些通配符模式。 此值是必需的。result/%Y/%M/%D/
。这是watched文件夹中的结果文件夹。preserve/%Y/%M/%D/
。failure/%Y/%M/%D/
。定义输入参数值
创建Watched文件夹端点时,必须定义输入参数值。 也就是说,必须描述传递给watched文件夹调用的操作的输入值。 例如,请考虑本主题中引入的过程。 它具有一个名为的输入值 InDoc
并且它的数据类型为 com.adobe.idp.Document
. 为此进程创建Watched文件夹端点时(激活进程后,该进程将成为服务),必须定义输入参数值。
要定义Watched Folder端点所需的输入参数值,请指定以下值:
输入参数名称:输入参数的名称。 在Workbench中为进程指定输入值的名称。 如果输入值属于服务操作(不是在Workbench中创建的进程的服务),则在component.xml文件中指定输入名称。 例如,本节介绍的进程的输入参数的名称为 InDoc
.
映射类型:用于配置调用服务操作所需的输入值。 有两种类型的映射类型:
Literal
:观察文件夹端点使用在显示的字段中输入的值。 支持所有基本Java类型。 例如,如果API使用字符串、long、int和Boolean等输入,则字符串将转换为正确类型并调用服务。Variable
:输入的值是watched文件夹用来选取输入的文件模式。 例如,如果为映射类型选择“变量”,并且输入文档必须是PDF文件,则可以指定 *.pdf
作为映射值。映射值:指定映射类型的值。 例如,如果您选择 Variable
映射类型,您可以指定 *.pdf
作为文件模式。
数据类型:指定输入值的数据类型。 例如,本节介绍的进程的输入值的数据类型为 com.adobe.idp.Document
.
定义输出参数值
创建Watched文件夹端点时,必须定义一个输出参数值。 也就是说,必须描述由Watched Folder端点调用的服务返回的输出值。 例如,请考虑本主题中引入的过程。 它有一个输出值,名为 SecuredDoc
并且它的数据类型为 com.adobe.idp.Document
. 为此进程创建Watched文件夹端点时(激活进程后,该进程将成为服务),必须定义输出参数值。
要定义Watched Folder端点所需的输出参数值,请指定以下值:
输出参数名称:输出参数的名称。 进程输出值的名称在Workbench中指定。 如果输出值属于服务操作(不是在Workbench中创建的流程的服务),则输出名称在component.xml文件中指定。 例如,本节介绍的进程的输出参数的名称为 SecuredDoc
.
映射类型:用于配置服务和操作的输出。 以下选项可供选择:
%F.pdf
源目标是sourcefilename.pdf。 例如,本节介绍的流程会返回单个文档。 因此,映射类型可以定义为 %F.pdf
( %F
表示使用给定的文件名)。 模式 %E
指定输入文档的扩展名。Result\%F\
,源目标是Result\sourcefilename\source1 (输出1)和Result\sourcefilename\source2 (输出2)。Result\%F\
,源目标是Result\sourcefilename\file1和Result\sourcefilename\file2。 如果地图有多个对象,则模式为 Result\%F.pdf
源目标为Result\sourcefilename1.pdf (输出1)、Result\sourcefilenam2.pdf (输出2)等。数据类型:指定返回值的数据类型。 例如,本节介绍的进程的返回值的数据类型为 com.adobe.idp.Document
.
创建Watched文件夹端点
在设置端点的属性、配置值以及定义输入和输出参数值后,必须创建Watched Folder端点。
启用端点
创建Watched Folder端点后,必须启用它。 启用端点后,可用于调用服务。 启用该端点后,您可以在管理控制台中查看它。
另请参阅
使用AEM Forms Java API添加Watched文件夹端点:
包括项目文件。
在Java项目的类路径中包含客户端JAR文件,例如adobe-livecycle-client.jar。
创建EndpointRegistry客户端对象。
ServiceClientFactory
包含连接属性的对象。EndpointRegistryClient
对象,使用它的构造函数传递 ServiceClientFactory
对象。设置Watched Folder端点属性。
CreateEndpointInfo
对象。CreateEndpointInfo
对象的 setConnectorId
方法和传递字符串值 WatchedFolder
.CreateEndpointInfo
对象的 setDescription
方法和传递描述端点的字符串值。CreateEndpointInfo
对象的 setName
方法,并传递一个指定名称的字符串值。CreateEndpointInfo
对象的 setServiceId
方法,并传递一个指定服务名称的字符串值。CreateEndpointInfo
对象的 setOperationName
方法,并传递一个指定操作名称的字符串值。 通常,在为源自于Workbench中创建的进程的服务创建Watched文件夹端点时,会调用操作的名称。指定配置值。
对于要为Watched文件夹端点设置的每个配置值,您必须调用 CreateEndpointInfo
对象的 setConfigParameterAsText
方法。 例如,要设置 url
配置值,调用 CreateEndpointInfo
对象的 setConfigParameterAsText
方法,并传递以下字符串值:
url
配置值,指定 url
.url
配置值,指定watched文件夹位置。要查看EncryptDocument服务设置的所有配置值,请参阅位于以下位置的Java代码示例: 快速启动:使用Java API添加Watched文件夹端点.
定义输入参数值。
通过调用 CreateEndpointInfo
对象的 setInputParameterMapping
方法,并传递以下值:
InDoc
.InDoc
输入参数为 com.adobe.idp.Document
.variable
.调用 setInputParameterMapping
用于定义每个输入参数值的方法。 由于EncryptDocument进程只有一个输入参数,因此您需要调用此方法一次。
定义输出参数值。
通过调用 CreateEndpointInfo
对象的 setOutputParameterMapping
方法,并传递以下值:
SecuredDoc
.SecuredDoc
输出参数为 com.adobe.idp.Document
.%F.pdf
.创建Watched文件夹端点。
通过调用 EndpointRegistryClient
对象的 createEndpoint
方法和传递 CreateEndpointInfo
对象。 此方法会返回 Endpoint
表示Watched文件夹端点的对象。
启用端点。
通过调用 EndpointRegistryClient
对象的 enable
方法和传递 Endpoint
返回的对象 createEndpoint
方法。
另请参阅
此 快速启动:使用Java API添加Watched文件夹端点 使用一个必须是Java项目一部分的常量文件来编译快速入门。 此常量文件表示添加Watched文件夹端点时必须设置的配置值。 以下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\EncryDocument. 有关短暂进程的信息,请参见 了解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使用字符串、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 (输出1)和Result\sourcefilename\source2 (输出2)。Result\%F\
,源目标是Result\sourcefilename\file1和Result\sourcefilename\file2。 如果地图有多个对象,则模式为 Result\%F.pdf
源目标为Result\sourcefilename1.pdf (输出1)、Result\sourcefilenam2.pdf (输出2)等。数据类型:指定返回值的数据类型。 例如,本节介绍的进程的返回值的数据类型为 com.adobe.idp.Document
.
创建电子邮件端点
在设置电子邮件端点属性和配置值并定义输入和输出参数值后,必须创建电子邮件端点。
启用端点
创建电子邮件端点后,必须启用它。 启用端点后,可用于调用服务。 启用该端点后,您可以在管理控制台中查看它。
另请参阅
使用Java API添加电子邮件端点:
包括项目文件。
在Java项目的类路径中包含客户端JAR文件,例如adobe-livecycle-client.jar。
创建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服务的所有配置值集,请参阅位于以下位置的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
方法和传递 Endpoint
返回的对象 createEndpoint
方法。
另请参阅
此 快速入门:使用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";
}
JEE上的AEM表单弃用LiveCycle RemotingAPI。
您可以使用AEM Forms Java API以编程方式将远程端点添加到服务。 通过添加远程处理端点,您可以使Flex应用程序能够使用远程处理来调用服务。 (请参阅 使用AEM Forms调用(已为AEM表单弃用) AEM Forms远程处理.)
为了以编程方式将远程处理端点添加到服务,请考虑以下命名的短暂过程 EncryDocument.
此流程接受不安全的PDF文档作为输入值,然后将不安全的PDF文档传递到加密服务的 EncryptPDFUsingPassword
操作。 PDF文档使用密码进行加密,密码加密的PDF文档是此过程的输出值。 输入值(无保护PDF文档)的名称为 InDoc
并且数据类型是 com.adobe.idp.Document
. 输出值(口令加密的PDF文档)的名称为 SecuredDoc
并且数据类型是 com.adobe.idp.Document
.
为了演示如何将Remoting端点添加到服务,本节将Remoting端点添加到名为EncryptDocument的服务。
无法使用Web服务添加远程端点。
要从服务中删除端点,请执行以下任务:
EndpointRegistryClient
对象。包括项目文件
在开发项目中包含必要的文件。 如果要使用Java创建客户端应用程序,请包含必要的JAR文件。 如果使用Web服务,请确保包含代理文件。
必须将以下JAR文件添加到项目的类路径中:
有关这些JAR文件位置的信息,请参见 包括AEM Forms Java库文件.
创建EndpointRegistry客户端对象
要以编程方式添加远程端点,您必须创建 EndpointRegistryClient
对象。
设置远程端点属性
要为服务创建远程端点,请指定以下值:
Remoting
.EncryptDocument
.创建远程端点
设置远程端点属性后,可以为服务创建远程端点。
启用端点
创建新端点后,必须启用它。 启用远程处理端点后,Flex客户端将能够调用该服务。
另请参阅
使用Java API添加远程端点:
包括项目文件。
在Java项目的类路径中包含客户端JAR文件,例如adobe-livecycle-client.jar。
创建EndpointRegistry客户端对象。
ServiceClientFactory
包含连接属性的对象。EndpointRegistryClient
对象,使用它的构造函数传递 ServiceClientFactory
对象。设置远程端点属性。
CreateEndpointInfo
对象。CreateEndpointInfo
对象的 setConnectorId
方法和传递字符串值 Remoting
.CreateEndpointInfo
对象的 setDescription
方法和传递描述端点的字符串值。CreateEndpointInfo
对象的 setName
方法,并传递一个指定名称的字符串值。CreateEndpointInfo
对象的 setServiceId
方法,并传递一个指定服务名称的字符串值。CreateEndpointInfo
对象的 setOperationName
方法,并传递一个指定操作名称的字符串值。 对于远程处理端点,请指定通配符(*)。创建远程端点。
通过调用 EndpointRegistryClient
对象的 createEndpoint
方法和传递 CreateEndpointInfo
对象。 此方法会返回 Endpoint
表示新远程处理端点的对象。
启用端点。
通过调用 EndpointRegistryClient
对象的 enable
方法和传递 Endpoint
返回的对象 createEndpoint
方法。
另请参阅
您可以使用AEM Forms Java API以编程方式将TaskManager端点添加到服务。 通过将TaskManager端点添加到服务,可以使Workspace用户能够调用该服务。 也就是说,在Workspace中工作的用户可以调用具有相应TaskManager端点的进程。
无法使用Web服务添加TaskManager端点。
要向服务添加TaskManager端点,请执行以下任务:
EndpointRegistryClient
对象。包括项目文件
在开发项目中包含必要的文件。 如果要使用Java创建客户端应用程序,请包含必要的JAR文件。 如果使用Web服务,请确保包含代理文件。
必须将以下JAR文件添加到项目的类路径中:
有关这些JAR文件位置的信息,请参见 包括AEM Forms Java库文件.
创建EndpointRegistry客户端对象
您必须先创建 EndpointRegistryClient
对象。
为端点创建类别
类别用于在工作区中组织服务。 也就是说,Workspace用户可以通过在Workspace中选择类别来调用具有TaskManager端点的服务。 创建TaskManager端点时,您可以引用现有类别或以编程方式创建新类别。
此部分在将TaskManager端点添加到服务时创建新类别。
设置TaskManager端点属性
要为服务创建TaskManager端点,请指定以下值:
TaskManagerConnector
.invoke
.创建TaskManager端点
设置TaskManager端点属性后,可以为服务创建TaskManager端点。
启用端点
创建新端点后,必须启用它。 启用该端点后,可用于从Workspace中调用服务。 启用该端点后,您可以在管理控制台中查看它。
另请参阅
使用Java API添加TaskManager端点:
包括项目文件。
在Java项目的类路径中包含客户端JAR文件,例如adobe-livecycle-client.jar。
创建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
方法,并传递一个指定操作名称的字符串值。 通常,在创建 TaskManager
源自在Workbench中创建的进程的服务的端点,该操作的名称为 invoke
.创建TaskManager端点。
通过调用 EndpointRegistryClient
对象的 createEndpoint
方法和传递 CreateEndpointInfo
对象。 此方法会返回 Endpoint
表示新TaskManager端点的对象。
启用端点。
通过调用 EndpointRegistryClient
对象的 enable
方法和传递 Endpoint
返回的对象 createEndpoint
方法。
另请参阅
快速入门:使用Java API添加TaskManager端点
您可以使用AEM Forms Java API以编程方式修改现有端点。 通过修改端点,可以更改端点的行为。 例如,假定一个Watched文件夹端点,它指定用作Watched文件夹的文件夹。 您可以通过编程方式修改属于Watched文件夹端点的配置值,从而让另一个文件夹充当Watched文件夹。 有关属于观察文件夹端点的配置值的信息,请参见 添加观察文件夹端点.
为了演示如何修改端点,本节通过更改作为Watched文件夹的文件夹来修改Watched文件夹端点。
无法使用Web服务修改端点。
要修改端点,请执行以下任务:
EndpointRegistryClient
对象。包括项目文件
在开发项目中包含必要的文件。 如果要使用Java创建客户端应用程序,请包含必要的JAR文件。 如果使用Web服务,请确保包含代理文件。
必须将以下JAR文件添加到项目的类路径中:
有关这些JAR文件位置的信息,请参见 包括AEM Forms Java库文件.
创建EndpointRegistry客户端对象
要以编程方式修改端点,您必须创建 EndpointRegistryClient
对象。
检索要修改的端点
必须先检索端点,然后才能修改端点。 要检索端点,您必须以能够访问端点的用户身份连接。 建议您以管理员身份连接。 (请参阅 设置连接属性)。
您可以通过检索端点列表来检索端点。 然后,您可以遍历列表,搜索要删除的特定端点。 例如,您可以通过确定与端点对应的服务和端点类型来定位端点。 找到端点后,可以对其进行修改。
指定新的配置值
修改端点时,请指定新的配置值。 例如,要修改Watched Folder端点,请重置所有Watched Folder端点配置值,而不仅仅是要修改的值。 有关属于观察文件夹端点的配置值的信息,请参见 添加观察文件夹端点.
有关属于电子邮件端点的配置值的信息,请参阅 添加电子邮件端点.
您无法修改终结点调用的服务。 如果尝试修改服务,则会引发异常。 要修改与给定端点关联的服务,请删除端点并创建新端点。 (请参阅 删除端点.)
另请参阅
使用Java API修改端点:
包括项目文件。
在Java项目的类路径中包含客户端JAR文件,例如adobe-livecycle-client.jar。
创建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
方法。 此方法返回一个指定终结点类型的字符串值。 例如,如果端点是Watched Folder端点,则此方法将返回 WatchedFolder
.指定新的配置值。
创建 ModifyEndpointInfo
对象。
对于要设置的每个配置值,调用 ModifyEndpointInfo
对象的 setConfigParameterAsText
方法。 例如,要设置url配置值,请调用 ModifyEndpointInfo
对象的 setConfigParameterAsText
方法,并传递以下值:
url
配置值,指定 url
.url
配置值,指定watched文件夹位置。调用 EndpointRegistryClient
对象的 modifyEndpoint
方法并传递 ModifyEndpointInfo
对象。
另请参阅
您可以使用AEM Forms Java API以编程方式从服务中删除端点。 删除终结点后,无法使用终结点启用的调用方法调用该服务。 例如,如果从服务中删除SOAP端点,则无法使用SOAP模式调用该服务。
要演示如何从服务中删除端点,本节从名为的服务中删除EJB端点 EncryDocument.
无法使用Web服务删除端点。
要从服务中删除端点,请执行以下任务:
EndpointRegistryClient
对象。包括项目文件
将必要的文件包含到开发项目中。 如果要使用Java创建客户端应用程序,请包含必要的JAR文件。 如果使用Web服务,请确保包含代理文件。
必须将以下JAR文件添加到项目的类路径中:
有关这些JAR文件位置的信息,请参见 包括AEM Forms Java库文件.
创建EndpointRegistry客户端对象
要以编程方式删除端点,您必须创建 EndpointRegistryClient
对象。
检索要删除的端点
必须先检索端点,然后才能删除端点。 要检索端点,您必须以能够访问端点的用户身份连接。 建议您以管理员身份连接。 (请参阅 设置连接属性)。
您可以通过检索端点列表来检索端点。 然后,您可以遍历列表,搜索要删除的特定端点。 例如,您可以通过确定与端点对应的服务和端点类型来定位端点。 找到端点后,可以将其删除。
删除端点
创建新端点后,必须启用它。 启用端点后,可用于调用服务。 启用该端点后,您可以在管理控制台中查看它。
另请参阅
使用Java API删除端点:
包括项目文件。
在Java项目的类路径中包含客户端JAR文件,例如adobe-livecycle-client.jar。
创建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以编程方式检索有关端点连接器的信息。 连接器使端点能够使用各种调用方法调用服务。 例如,Watched文件夹连接器允许端点使用watched文件夹调用服务。 通过以编程方式检索有关端点连接器的信息,可以检索与连接器关联的配置值,例如哪些配置值是必需的以及哪些是可选的。
要演示如何检索有关端点连接器的信息,本节将检索有关Watched Folder连接器的信息。 (请参阅 添加观察文件夹端点.)
无法使用Web服务检索有关终结点的信息。
本主题使用 ConnectorRegistryClient
用于检索有关端点连接器信息的API。 (请参阅 AEM Forms API参考.)
要检索终结点连接器信息,请执行以下任务:
ConnectorRegistryClient
对象。包括项目文件
将必要的文件包含到开发项目中。 如果要使用Java创建客户端应用程序,请包含必要的JAR文件。 如果使用Web服务,请确保包含代理文件。
必须将以下JAR文件添加到项目的类路径中:
如果AEM Forms部署在支持的J2EE应用程序服务器(不是JBoss)上,请将adobe-utilities.jar和jbossall-client.jar替换为特定于部署AEM Forms的J2EE应用程序服务器的JAR文件。 有关所有AEM Forms JAR文件位置的信息,请参见 包括AEM Forms Java库文件.
创建ConnectorRegistry客户端对象
要以编程方式检索端点连接器信息,请创建 ConnectorRegistryClient
对象。
指定连接器类型
指定要从中检索信息的连接器的类型。 存在以下类型的连接器:
检索配置值
指定连接器类型后,可以检索有关连接器的信息,如支持的配置值。 例如,对于任何连接器,您可以确定哪些配置值是必需的,哪些是可选的。
另请参阅
使用Java API检索端点连接器信息:
包括项目文件。.
在Java项目的类路径中包含客户端JAR文件,例如adobe-livecycle-client.jar。
创建ConnectorRegistry客户端对象。
ServiceClientFactory
包含连接属性的对象。ConnectorRegistryClient
对象,使用它的构造函数传递 ServiceClientFactory
对象。指定连接器类型。
通过调用 ConnectorRegistryClient
对象的 getEndpointDefinition
方法,并传递一个指定连接器类型的字符串值。 例如,要指定Watched Folder连接器类型,请传递字符串值 WatchedFolder
. 此方法会返回 Endpoint
对应于连接器类型的对象。
检索配置值。
Endpoint
对象的 getConfigParameters
方法。 此方法返回一个数组 ConfigParameter
对象。ConfigParameter
对象。 例如,您可以通过调用 ConfigParameter
对象的 isRequired
方法。 如果需要配置值,则此方法将返回 true
.另请参阅