Os exemplos e amostras neste documento são somente para AEM Forms no ambiente JEE.
Sobre o Serviço de Registro de Ponto de Extremidade
O serviço Registro de Ponto de Extremidade fornece a capacidade de gerenciar pontos de extremidade de forma programática. Você pode, por exemplo, adicionar os seguintes tipos de endpoints a um serviço:
SOAP, EJB e (obsoleto para formulários AEM no JEE) Os endpoints de comunicação remota são criados automaticamente para cada serviço ativado. Os endpoints SOAP e EJB ativam SOAP e EJB para todas as operações de serviço.
Um endpoint de Comunicação Remota permite que os clientes Flex chamem operações no serviço AEM Forms ao qual o endpoint é adicionado. Um destino do Flex com o mesmo nome do ponto de extremidade é criado, e os clientes do Flex podem criar RemoteObjects que apontem para esse destino para chamar operações no serviço relevante.
Os pontos de acesso de Email, Gerenciador de tarefas e Pasta monitorada expõem apenas uma operação específica do serviço. A adição desses endpoints requer uma segunda etapa de configuração para selecionar um método a ser chamado, definir parâmetros de configuração e especificar mapeamentos de parâmetros de entrada e saída.
Você pode organizar os pontos de extremidade do TaskManager em grupos chamados categorias. Essas categorias são expostas ao Espaço de trabalho por meio do TaskManager, com os usuários finais vendo os pontos de extremidade do TaskManager à medida que são categorizados. No Workspace, os usuários finais veem essas categorias no painel de navegação. Os endpoints dentro de cada categoria são exibidos como cartões de processo na página Iniciar processos no Workspace.
Você pode realizar essas tarefas usando o serviço Registro de Ponto de Extremidade:
Você pode adicionar programaticamente um endpoint EJB a um serviço usando a API Java do AEM Forms. Adicionando um ponto final EJB a um serviço, você está permitindo que uma aplicação cliente chame o serviço usando o modo EJB. Ou seja, ao definir as propriedades de conexão necessárias para chamar o AEM Forms, você pode selecionar o modo EJB. (Consulte Definindo propriedades de conexão.)
Não é possível adicionar um ponto final EJB usando serviços Web.
Normalmente, um ponto final EJB é adicionado a um serviço por padrão. No entanto, um ponto final EJB pode ser adicionado a um processo que é implantado programaticamente ou quando um ponto final EJB foi removido e deve ser adicionado novamente.
Para adicionar um ponto final EJB a um serviço, execute as seguintes tarefas:
EndpointRegistry Client
objeto.Incluir arquivos de projeto
Inclua os arquivos necessários no projeto de desenvolvimento. Os seguintes arquivos JAR devem ser adicionados ao caminho de classe do projeto:
Para obter informações sobre a localização desses arquivos JAR, consulte Inclusão de arquivos da biblioteca Java do AEM Forms.
Criar um objeto Cliente EndpointRegistry
Antes de adicionar programaticamente um endpoint EJB, você deve criar um EndpointRegistryClient
objeto.
Definir atributos de ponto final EJB
Para criar um endpoint EJB para um serviço, especifique os seguintes valores:
EJB
.*
). No entanto, se você quiser especificar uma operação específica em vez de chamar todas as operações de serviço, especifique o nome da operação em vez de usar o caractere curinga ( *
).Criar um ponto final EJB
Após definir atributos de endpoint EJB, você pode criar um endpoint EJB para um serviço.
Habilitar o endpoint
Depois de criar um novo endpoint, você deve habilitá-lo. Depois de habilitar o endpoint, ele poderá ser usado para chamar o serviço. Após habilitar o endpoint, é possível visualizá-lo no console de administração.
Consulte também
Adicionando um ponto final EJB usando a API Java
Inclusão de arquivos da biblioteca Java do AEM Forms
Definindo propriedades de conexão
Adicionar um ponto final EJB usando a API Java:
Incluir arquivos de projeto.
Inclua arquivos JAR do cliente, como adobe-livecycle-client.jar, no caminho de classe do projeto Java. (
Crie um objeto Cliente EndpointRegistry.
ServiceClientFactory
objeto que contém propriedades de conexão.EndpointRegistryClient
usando seu construtor e transmitindo o ServiceClientFactory
objeto.Definir atributos de ponto final EJB.
CreateEndpointInfo
usando seu construtor.CreateEndpointInfo
do objeto setConnectorId
e transmitindo o valor da string EJB
.CreateEndpointInfo
do objeto setDescription
e transmitindo um valor de string que descreve o endpoint.CreateEndpointInfo
do objeto setName
e transmitindo um valor de string que especifica o nome.CreateEndpointInfo
do objeto setServiceId
e transmitindo um valor de string que especifica o nome do serviço.CreateEndpointInfo
do objeto setOperationName
e passe um valor de string que especifique o nome da operação. Para pontos de extremidade SOAP e EJB, especifique um caractere curinga ( *
), o que implica todas as operações.Criar um ponto final EJB.
Crie o endpoint chamando o EndpointRegistryClient
do objeto createEndpoint
e transmitindo o CreateEndpointInfo
objeto. Este método retorna um valor de Endpoint
objeto que representa o novo ponto final EJB.
Ative o endpoint.
Ative o endpoint chamando o botão EndpointRegistryClient
método enable do objeto e transmitindo o Endpoint
objeto que foi retornado pelo createEndpoint
método.
Consulte também
QuickStart: adicionando um endpoint EJB usando a API Java
Inclusão de arquivos da biblioteca Java do AEM Forms
Definindo propriedades de conexão
Você pode adicionar programaticamente um endpoint SOAP a um serviço usando a API Java do AEM Forms. Adicionando um ponto de extremidade SOAP, você habilita um aplicativo cliente a chamar o serviço usando o modo SOAP. Ou seja, ao definir as propriedades de conexão necessárias para chamar o AEM Forms, você pode selecionar o modo SOAP.
Não é possível adicionar um ponto de extremidade SOAP usando serviços da Web.
Normalmente, um ponto de extremidade SOAP é adicionado a um serviço por padrão. No entanto, um ponto de extremidade SOAP pode ser adicionado a um processo que é implantado programaticamente ou quando um ponto de extremidade SOAP foi removido e precisa ser adicionado novamente.
Para adicionar um ponto de extremidade SOAP a um serviço, execute as seguintes tarefas:
EndpointRegistryClient
objeto.Incluir arquivos de projeto
Inclua os arquivos necessários no projeto de desenvolvimento. Se você estiver criando uma aplicação cliente usando Java, inclua os arquivos JAR necessários. Se você estiver usando serviços da Web, certifique-se de incluir os arquivos proxy.
Os seguintes arquivos JAR devem ser adicionados ao caminho de classe do projeto:
Esses arquivos JAR são necessários para criar um endpoint SOAP. No entanto, você precisará adicionar arquivos JAR se usar o endpoint SOAP para chamar o serviço. Para obter informações sobre arquivos JAR do AEM Forms, consulte Inclusão de arquivos da biblioteca Java do AEM Forms.
Criar um objeto Cliente EndpointRegistry
Para adicionar programaticamente um ponto de extremidade SOAP a um serviço, você deve criar um EndpointRegistryClient
objeto.
Definir atributos de ponto de extremidade SOAP
Para adicionar um ponto de extremidade SOAP a um serviço, especifique os seguintes valores:
SOAP
.*
). No entanto, se você quiser especificar uma operação específica em vez de chamar todas as operações de serviço, especifique o nome da operação em vez de usar o caractere curinga ( *
).Criar um ponto de extremidade SOAP
Após definir os atributos do ponto de extremidade SOAP, você pode criar um ponto de extremidade SOAP.
Habilitar o endpoint
Depois de criar um novo endpoint, você deve habilitá-lo. Quando o endpoint está habilitado, ele pode ser usado para chamar o serviço. Depois de habilitar o endpoint, você pode visualizá-lo no console de administração.
Consulte também
Adicionar um endpoint SOAP usando a API Java
Inclusão de arquivos da biblioteca Java do AEM Forms
Definindo propriedades de conexão
Adicionar um ponto de extremidade SOAP a um serviço usando a API Java:
Incluir arquivos de projeto.
Inclua arquivos JAR do cliente, como adobe-livecycle-client.jar, no caminho de classe do projeto Java.
Crie um objeto Cliente EndpointRegistry.
ServiceClientFactory
objeto que contém propriedades de conexão.EndpointRegistryClient
usando seu construtor e transmitindo o ServiceClientFactory
objeto.Definir atributos de ponto de extremidade SOAP.
CreateEndpointInfo
usando seu construtor.CreateEndpointInfo
do objeto setConnectorId
e transmitindo o valor da string SOAP
.CreateEndpointInfo
do objeto setDescription
e transmitindo um valor de string que descreve o endpoint.CreateEndpointInfo
do objeto setName
e transmitindo um valor de string que especifica o nome.CreateEndpointInfo
do objeto setServiceId
e transmitindo um valor de string que especifica o nome do serviço.CreateEndpointInfo
do objeto setOperationName
e transmitindo um valor de string que especifica o nome da operação. Para pontos de extremidade SOAP e EJB, especifique um caractere curinga ( *
), o que implica todas as operações.Crie um ponto de extremidade SOAP.
Crie o endpoint chamando o EndpointRegistryClient
do objeto createEndpoint
e transmitindo o CreateEndpointInfo
objeto. Este método retorna um valor de Endpoint
objeto que representa o novo ponto de extremidade SOAP.
Ative o endpoint.
Ative o endpoint chamando o botão EndpointRegistryClient
método enable do objeto e transmitem o Endpoint
objeto que foi retornado pelo createEndpoint
método.
Consulte também
QuickStart: adicionando um endpoint SOAP usando a API Java
Inclusão de arquivos da biblioteca Java do AEM Forms
Definindo propriedades de conexão
Você pode adicionar programaticamente um endpoint de Pasta monitorada a um serviço usando a API Java do AEM Forms. Ao adicionar um endpoint de Pasta monitorada, você permite que os usuários coloquem um arquivo (como um arquivo de PDF) em uma pasta. Quando o arquivo é colocado na pasta, o serviço configurado é chamado e manipula o arquivo. Depois que o serviço executa a operação especificada, ele salva o arquivo modificado em uma pasta de saída especificada. Uma pasta monitorada é configurada para ser digitalizada em um intervalo de taxa fixa ou com uma programação cron, como toda segunda, quarta e sexta ao meio-dia.
Para fins de adicionar programaticamente um endpoint de Pasta monitorada a um serviço, considere o seguinte processo de vida curta chamado EncryptDocument. (Consulte Noções básicas sobre processos do AEM Forms.)
Esse processo aceita um documento de PDF não seguro como valor de entrada e, em seguida, passa o documento de PDF não seguro para o do serviço de criptografia EncryptPDFUsingPassword
operação. O documento PDF é criptografado com uma senha e o documento PDF criptografado com senha é o valor de saída desse processo. O nome do valor de entrada (o documento PDF não seguro) é InDoc
e o tipo de dados for com.adobe.idp.Document
. O nome do valor de saída (o documento PDF criptografado por senha) é SecuredDoc
e o tipo de dados for com.adobe.idp.Document
.
Não é possível adicionar um ponto de extremidade de Pasta monitorada usando serviços da Web.
Para adicionar um ponto de extremidade de Pasta monitorada a um serviço, execute as seguintes tarefas:
EndpointRegistryClient
objeto.Incluir arquivos de projeto
Inclua os arquivos necessários no projeto de desenvolvimento. Se você estiver criando uma aplicação cliente usando Java, inclua os arquivos JAR necessários. Se você estiver usando serviços da Web, certifique-se de incluir os arquivos proxy.
Os seguintes arquivos JAR devem ser adicionados ao caminho de classe do projeto:
Para obter informações sobre a localização desses arquivos JAR, consulte Inclusão de arquivos da biblioteca Java do AEM Forms.
Criar um objeto Cliente EndpointRegistry
Para adicionar programaticamente um endpoint de Pasta monitorada, você deve criar um EndpointRegistryClient
objeto.
Definir atributos de ponto de extremidade da pasta monitorada
Para criar um ponto final de Pasta monitorada para um serviço, especifique os seguintes valores:
WatchedFolder
.EncryptDocument
.invoke
.Especificar valores de configuração
Você deve especificar valores de configuração para um ponto de extremidade de Pasta monitorada ao adicionar programaticamente um ponto de extremidade de Pasta monitorada a um serviço. Esses valores de configuração são especificados por um administrador se um endpoint de Pasta monitorada for adicionado usando o console de administração.
A lista a seguir especifica os valores de configuração que são definidos quando você adiciona programaticamente um ponto de extremidade de Pasta monitorada a um serviço:
data*
, todos os arquivos e pastas que corresponderem data*
não são coletadas. Isso inclui arquivos e pastas chamados data1
, data2
e assim por diante. Além disso, o padrão pode ser complementado com padrões curingas para especificar padrões de arquivo. A pasta monitorada modifica a expressão regular para suportar padrões curingas, como *.*
e *.pdf
. Esses padrões curingas não são suportados por expressões regulares.*
, todos os arquivos e pastas que corresponderem input*
são coletadas. Isso inclui arquivos e pastas chamados input1
, input2
e assim por diante. O valor padrão é *
. Esse valor indica todos os arquivos e pastas. Além disso, o padrão pode ser complementado com padrões curingas para especificar padrões de arquivo. A pasta monitorada modifica a expressão regular para suportar padrões curingas, como *.*
e *.pdf
. Esses padrões curingas não são suportados por expressões regulares. Esse valor é obrigatório.result/%Y/%M/%D/
. Esta é a pasta de resultados dentro da pasta monitorada.preserve/%Y/%M/%D/
.failure/%Y/%M/%D/
.Definir valores de parâmetro de entrada
Ao criar um endpoint de Pasta monitorada, você deve definir valores de parâmetro de entrada. Ou seja, você deve descrever os valores de entrada transmitidos para a operação chamada pela pasta monitorada. Por exemplo, considere o processo introduzido neste tópico. Ele tem um valor de entrada chamado InDoc
e seu tipo de dados é com.adobe.idp.Document
. Ao criar um endpoint de Pasta monitorada para esse processo (depois que um processo é ativado, ele se torna um serviço), você deve definir o valor do parâmetro de entrada.
Para definir valores de parâmetro de entrada necessários para um endpoint de Pasta monitorada, especifique os seguintes valores:
Nome do parâmetro de entrada: o nome do parâmetro de entrada. O nome de um valor de entrada é especificado na Bancada para um processo. Se o valor de entrada pertencer a uma operação de serviço (um serviço que não é um processo criado no Workbench), o nome de entrada será especificado no arquivo component.xml. Por exemplo, o nome do parâmetro de entrada para o processo introduzido nesta seção é InDoc
.
Tipo de mapeamento: usado para configurar os valores de entrada necessários para chamar a operação de serviço. Há dois tipos de mapeamento:
Literal
: o endpoint da Pasta monitorada usa o valor inserido no campo como ele é exibido. Todos os tipos básicos de Java são compatíveis. Por exemplo, se uma API usar entradas como String, long, int e Boolean, a cadeia de caracteres será convertida no tipo adequado e o serviço será chamado.Variable
: o valor inserido é um padrão de arquivo que a pasta monitorada usa para escolher a entrada. Por exemplo, se você selecionar Variável para o tipo de mapeamento e o documento de entrada precisar ser um arquivo PDF, será possível especificar *.pdf
como o valor de mapeamento.Mapeamento de valor: especifica o valor do tipo de mapeamento. Por exemplo, se você selecionar um Variable
tipo de mapeamento, é possível especificar *.pdf
como o padrão do arquivo.
Tipo de dados: especifica o tipo de dados do(s) valor(es) de entrada. Por exemplo, o tipo de dados do valor de entrada do processo introduzido nesta seção é com.adobe.idp.Document
.
Definir um valor de parâmetro de saída
Ao criar um endpoint de Pasta monitorada, você deve definir um valor de parâmetro de saída. Ou seja, você deve descrever o valor de saída retornado pelo serviço chamado pelo endpoint da Pasta monitorada. Por exemplo, considere o processo introduzido neste tópico. Ele tem um valor de saída chamado SecuredDoc
e seu tipo de dados é com.adobe.idp.Document
. Ao criar um endpoint de Pasta monitorada para esse processo (depois que um processo é ativado, ele se torna um serviço), você deve definir o valor do parâmetro de saída.
Para definir um valor de parâmetro de saída necessário para um endpoint de Pasta monitorada, especifique os seguintes valores:
Nome do parâmetro de saída: o nome do parâmetro de saída. O nome de um valor de saída de processo é especificado no Workbench. Se o valor de saída pertencer a uma operação de serviço (um serviço que não é um processo criado no Workbench), o nome da saída será especificado no arquivo component.xml. Por exemplo, o nome do parâmetro de saída para o processo introduzido nesta seção é SecuredDoc
.
Tipo de mapeamento: usado para configurar a saída do serviço e da operação. As opções disponíveis são as seguintes:
%F.pdf
e o destino de origem é sourcefilename.pdf. Por exemplo, o processo introduzido nesta seção retorna um único documento. Como resultado, o tipo de mapeamento pode ser definido como %F.pdf
( %F
significa usar o nome de arquivo fornecido). O padrão %E
especifica a extensão do documento de entrada.Result\%F\
, e o destino de origem é Result\sourcefilename\source1 (saída 1) e Result\sourcefilename\source2 (saída 2).Result\%F\
e o destino de origem é Result\sourcefilename\file1 e Result\sourcefilename\file2. Se o mapa tiver mais de um objeto, o padrão será Result\%F.pdf
e o destino de origem é Result\sourcefilename1.pdf (saída 1), Result\sourcefilenam2.pdf (saída 2) e assim por diante.Tipo de dados: especifica o tipo de dados do valor de retorno. Por exemplo, o tipo de dados do valor de retorno do processo introduzido nesta seção é com.adobe.idp.Document
.
Criar um ponto de extremidade de Pasta monitorada
Depois de definir os atributos do ponto de extremidade, os valores de configuração e os valores dos parâmetros de entrada e saída, você deve criar o ponto de extremidade da Pasta monitorada.
Habilitar o endpoint
Depois de criar um endpoint de Pasta monitorada, você deve ativá-lo. Quando o endpoint está habilitado, ele pode ser usado para chamar o serviço. Após habilitar o endpoint, é possível visualizá-lo no console de administração.
Consulte também
Adicionar um endpoint de pasta monitorada usando a API Java
Inclusão de arquivos da biblioteca Java do AEM Forms
Definindo propriedades de conexão
Adicione um endpoint de Pasta monitorada usando a API Java do AEM Forms:
Incluir arquivos de projeto.
Inclua arquivos JAR do cliente, como adobe-livecycle-client.jar, no caminho de classe do projeto Java.
Crie um objeto Cliente EndpointRegistry.
ServiceClientFactory
objeto que contém propriedades de conexão.EndpointRegistryClient
usando seu construtor e transmitindo o ServiceClientFactory
objeto.Defina atributos de ponto de extremidade da Pasta monitorada.
CreateEndpointInfo
usando seu construtor.CreateEndpointInfo
do objeto setConnectorId
e transmitindo o valor da string WatchedFolder
.CreateEndpointInfo
do objeto setDescription
e transmitindo um valor de string que descreve o endpoint.CreateEndpointInfo
do objeto setName
e transmitindo um valor de string que especifica o nome.CreateEndpointInfo
do objeto setServiceId
e transmitindo um valor de string que especifica o nome do serviço.CreateEndpointInfo
do objeto setOperationName
e transmitindo um valor de string que especifica o nome da operação. Normalmente, ao criar um endpoint de Pasta monitorada para um serviço que se originou de um processo criado no Workbench, o nome da operação é chamado.Especifique os valores de configuração.
Para cada valor de configuração a ser definido para o endpoint da Pasta monitorada, você deve chamar o CreateEndpointInfo
do objeto setConfigParameterAsText
método. Por exemplo, para definir a variável url
valor de configuração, chame o CreateEndpointInfo
do objeto setConfigParameterAsText
e passe os seguintes valores de string:
url
valor de configuração, especifique url
.url
valor de configuração, especifique o local da pasta monitorada.Para ver todos os valores de configuração definidos para o serviço EncryptDocument, consulte o exemplo de código Java localizado em QuickStart: adicionando um endpoint de pasta monitorada usando a API Java.
Defina os valores do parâmetro de entrada.
Defina um valor de parâmetro de entrada chamando o CreateEndpointInfo
do objeto setInputParameterMapping
e passe os seguintes valores:
InDoc
.InDoc
o parâmetro de entrada é com.adobe.idp.Document
.variable
.Chame o setInputParameterMapping
para cada valor de parâmetro de entrada a ser definido. Como o processo EncryptDocument tem apenas um parâmetro de entrada, é necessário chamar esse método uma vez.
Defina um valor de parâmetro de saída.
Defina um valor de parâmetro de saída chamando o CreateEndpointInfo
do objeto setOutputParameterMapping
e passe os seguintes valores:
SecuredDoc
.SecuredDoc
o parâmetro de saída é com.adobe.idp.Document
.%F.pdf
.Crie um ponto de extremidade de Pasta monitorada.
Crie o endpoint chamando o EndpointRegistryClient
do objeto createEndpoint
e transmitindo o CreateEndpointInfo
objeto. Este método retorna um valor de Endpoint
objeto que representa o ponto de extremidade da Pasta monitorada.
Ative o endpoint.
Ative o endpoint chamando o botão EndpointRegistryClient
do objeto enable
e transmitindo o Endpoint
objeto que foi retornado pelo createEndpoint
método.
Consulte também
QuickStart: adicionando um endpoint de pasta monitorada usando a API Java
Inclusão de arquivos da biblioteca Java do AEM Forms
Definindo propriedades de conexão
A variável QuickStart: adicionando um endpoint de pasta monitorada usando a API Java O usa um arquivo constante que deve fazer parte do projeto Java para compilar o início rápido. Esse arquivo constante representa valores de configuração que devem ser definidos ao adicionar um ponto de extremidade de Pasta monitorada. O código Java a seguir representa o arquivo de constante.
/**
* 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";
}
Você pode adicionar programaticamente um endpoint de email a um serviço usando a API Java do AEM Forms. Ao adicionar um endpoint de email, você permite que os usuários enviem uma mensagem de email com um ou mais anexos de arquivo para uma conta de email especificada. Em seguida, a operação de configuração do serviço é chamada e manipula os arquivos. Depois que o serviço executa a operação especificada, ele envia uma mensagem de email para o remetente com os arquivos modificados como anexos de arquivo.
Para fins de adição programática de um endpoint de email a um serviço, considere o seguinte processo de vida curta chamado MyApplication\EncryptDocument. Para obter informações sobre processos de vida curta, consulte Noções básicas sobre processos do AEM Forms.
Esse processo aceita um documento de PDF não seguro como valor de entrada e, em seguida, passa o documento de PDF não seguro para o do serviço de criptografia EncryptPDFUsingPassword
operação. Esse processo criptografa o documento PDF com uma senha e retorna o documento PDF criptografado por senha como o valor de saída. O nome do valor de entrada (o documento PDF não seguro) é InDoc
e o tipo de dados for com.adobe.idp.Document
. O nome do valor de saída (o documento PDF criptografado por senha) é SecuredDoc
e o tipo de dados for com.adobe.idp.Document
.
Não é possível adicionar um terminal de email usando serviços da Web.
Para adicionar um terminal de email a um serviço, execute as seguintes tarefas:
EndpointRegistryClient
objeto.Incluir arquivos de projeto
Inclua os arquivos necessários no projeto de desenvolvimento. Se você estiver criando uma aplicação cliente usando Java, inclua os arquivos JAR necessários. Se você estiver usando serviços da Web, certifique-se de incluir os arquivos proxy.
Os seguintes arquivos JAR devem ser adicionados ao caminho de classe do projeto:
Para obter informações sobre a localização desses arquivos JAR, consulte Inclusão de arquivos da biblioteca Java do AEM Forms.
Criar um objeto Cliente EndpointRegistry
Antes de adicionar programaticamente um endpoint de email, você deve criar um EndpointRegistryClient
objeto.
Definir atributos de ponto de extremidade de email
Para criar um terminal de email para um serviço, especifique os seguintes valores:
Email
.EncryptDocument
.invoke
.Especificar valores de configuração
Você deve especificar valores de configuração para um endpoint de email ao adicionar programaticamente um endpoint de email a um serviço. Esses valores de configuração são especificados por um administrador se um endpoint de email for adicionado usando o console de administração.
A conta de email monitorada é uma conta especial usada somente para o endpoint de email. Esta conta não é uma conta de email de usuário comum. A conta de email de um usuário comum não deve ser configurada como a conta usada pelo provedor de email, pois o provedor exclui mensagens de email da caixa de entrada após concluir a configuração das mensagens.
Os seguintes valores de configuração são definidos ao adicionar programaticamente um endpoint de email a um serviço:
SuperAdmin
.DefaultDom
.adobe.com
for usado, somente o email do adobe.com for processado, o email de outros domínios será ignorado.*
.sender
, os resultados de email são enviados ao remetente. Até 100 recipients são suportados. Especifique recipients adicionais com endereços de email, cada um separado por vírgula. Para desativar essa opção, deixe esse valor em branco. Em alguns casos, você pode acionar um processo e não quiser uma notificação por email sobre o resultado. O valor padrão é sender
.sender
, os resultados de email são enviados ao remetente. Até 100 recipients são suportados. Especifique recipients adicionais com endereços de email, cada um separado por vírgula. Para desativar essa opção, deixe esse valor em branco. O valor padrão é sender
.IMAP
ou POP3
. O servidor de e-mail do host da caixa de entrada deve suportar esses protocolos.UTF-8
.Definir valores de parâmetro de entrada
Ao criar um endpoint de email, você deve definir valores de parâmetro de entrada. Ou seja, você deve descrever os valores de entrada transmitidos para a operação chamada pelo endpoint de email. Por exemplo, considere o processo introduzido neste tópico. Ele tem um valor de entrada chamado InDoc
e seu tipo de dados é com.adobe.idp.Document
. Ao criar um endpoint de email para esse processo (depois que um processo é ativado, ele se torna um serviço), você deve definir o valor do parâmetro de entrada.
Para definir valores de parâmetro de entrada necessários para um endpoint de Email, especifique os seguintes valores:
Nome do parâmetro de entrada: o nome do parâmetro de entrada. O nome de um valor de entrada é especificado na Bancada para um processo. Se o valor de entrada pertencer a uma operação de serviço (um serviço Forms que não é um processo criado no Workbench), o nome de entrada será especificado no arquivo component.xml. Por exemplo, o nome do parâmetro de entrada para o processo introduzido nesta seção é InDoc
.
Tipo de mapeamento: usado para configurar os valores de entrada necessários para chamar a operação de serviço. Dois tipos de mapeamento são os seguintes:
Literal
: O endpoint de Email usa o valor inserido no campo como ele é exibido. Todos os tipos básicos de Java são compatíveis. Por exemplo, se uma API usar entradas como String, long, int e Boolean, a cadeia de caracteres será convertida no tipo adequado e o serviço será chamado.Variable
: o valor inserido é um padrão de arquivo que o endpoint de email usa para escolher a entrada. Por exemplo, se você selecionar Variável para o tipo de mapeamento e o documento de entrada precisar ser um arquivo PDF, será possível especificar *.pdf
como o valor de mapeamento.Mapeamento de valor: especifica o valor do tipo de mapeamento. Por exemplo, se você selecionar um tipo de mapeamento Variável, será possível especificar *.pdf
como o padrão do arquivo.
Tipo de dados: especifica o tipo de dados dos valores de entrada. Por exemplo, o tipo de dados do valor de entrada do processo introduzido nesta seção é com.adobe.idp.Document.
Definir um valor de parâmetro de saída
Ao criar um endpoint de email, você deve definir um valor de parâmetro de saída. Ou seja, você deve descrever o valor de saída retornado pelo serviço chamado pelo endpoint de email. Por exemplo, considere o processo introduzido neste tópico. Ele tem um valor de saída chamado SecuredDoc
e seu tipo de dados é com.adobe.idp.Document
. Ao criar um endpoint de email para esse processo (depois que um processo é ativado, ele se torna um serviço), você deve definir o valor do parâmetro de saída.
Para definir um valor de parâmetro de saída necessário para um endpoint de email, especifique os seguintes valores:
Nome do parâmetro de saída: o nome do parâmetro de saída. O nome de um valor de saída de processo é especificado no Workbench. Se o valor de saída pertencer a uma operação de serviço (um serviço que não é um processo criado no Workbench), o nome da saída será especificado no arquivo component.xml. Por exemplo, o nome do parâmetro de saída para o processo introduzido nesta seção é SecuredDoc
.
Tipo de mapeamento: usado para configurar a saída do serviço e da operação. As opções disponíveis são as seguintes:
%F.pdf
e o destino de origem é sourcefilename.pdf. Por exemplo, o processo introduzido nesta seção retorna um único documento. Como resultado, o tipo de mapeamento pode ser definido como %F.pdf
( %F
significa usar o nome de arquivo fornecido). O padrão %E
especifica a extensão do documento de entrada.Result\%F\
, e o destino de origem é Result\sourcefilename\source1 (saída 1) e Result\sourcefilename\source2 (saída 2).Result\%F\
e o destino de origem é Result\sourcefilename\file1 e Result\sourcefilename\file2. Se o mapa tiver mais de um objeto, o padrão será Result\%F.pdf
e o destino de origem é Result\sourcefilename1.pdf (saída 1), Result\sourcefilenam2.pdf (saída 2) e assim por diante.Tipo de dados: especifica o tipo de dados do valor de retorno. Por exemplo, o tipo de dados do valor de retorno do processo introduzido nesta seção é com.adobe.idp.Document
.
Criar o endpoint de email
Depois de definir os atributos do endpoint de email e os valores de configuração, e definir valores de parâmetro de entrada e saída, você deve criar o endpoint de email.
Habilitar o endpoint
Depois de criar um endpoint de email, você deve habilitá-lo. Quando o endpoint está habilitado, ele pode ser usado para chamar o serviço. Após habilitar o endpoint, é possível visualizá-lo no console de administração.
Consulte também
Adicionar um terminal de email usando a API Java
Inclusão de arquivos da biblioteca Java do AEM Forms
Definindo propriedades de conexão
Adicionar um endpoint de email usando a API Java:
Incluir arquivos de projeto.
Inclua arquivos JAR do cliente, como adobe-livecycle-client.jar, no caminho de classe do projeto Java.
Crie um objeto Cliente EndpointRegistry.
ServiceClientFactory
objeto que contém propriedades de conexão.EndpointRegistryClient
usando seu construtor e transmitindo o ServiceClientFactory
objeto.Defina atributos de endpoint de email.
CreateEndpointInfo
usando seu construtor.CreateEndpointInfo
do objeto setConnectorId
e transmitindo o valor da string Email
.CreateEndpointInfo
do objeto setDescription
e transmitindo um valor de string que descreve o endpoint.CreateEndpointInfo
do objeto setName
e transmitindo um valor de string que especifica o nome.CreateEndpointInfo
do objeto setServiceId
e transmitindo um valor de string que especifica o nome do serviço.CreateEndpointInfo
do objeto setOperationName
e transmitindo um valor de string que especifica o nome da operação. Normalmente, ao criar um endpoint de email para um serviço que se originou de um processo criado no Workbench, o nome da operação é chamado.Especifique os valores de configuração.
Para cada valor de configuração a ser definido para o endpoint de email, chame o CreateEndpointInfo
do objeto setConfigParameterAsText
método. Por exemplo, para definir a variável smtpHost
valor de configuração, chame o CreateEndpointInfo
do objeto setConfigParameterAsText
e passe os seguintes valores:
smtpHost
valor de configuração, especifique smtpHost
.smtpHost
valor de configuração, especifique um valor de string que especifique o nome do servidor SMTP.Para ver todos os valores de configuração definidos para o serviço EncryptDocument introduzidos nesta seção, consulte o exemplo de código Java localizado em QuickStart: adicionando um endpoint de email usando a API Java.
Defina os valores do parâmetro de entrada.
Defina um valor de parâmetro de entrada chamando o CreateEndpointInfo
do objeto setInputParameterMapping
e passe os seguintes valores:
InDoc
.InDoc
o parâmetro de entrada é com.adobe.idp.Document
.variable
.Chame o setInputParameterMapping
para cada valor de parâmetro de entrada a ser definido. Como o processo EncryptDocument tem apenas um parâmetro de entrada, é necessário chamar esse método uma vez.
Defina um valor de parâmetro de saída.
Defina um valor de parâmetro de saída chamando o CreateEndpointInfo
do objeto setOutputParameterMapping
e transmitindo os seguintes valores:
SecuredDoc
.SecuredDoc
o parâmetro de saída é com.adobe.idp.Document
.%F.pdf
.Crie o endpoint de email.
Crie o endpoint chamando o EndpointRegistryClient
do objeto createEndpoint
e transmitindo o CreateEndpointInfo
objeto. Este método retorna um valor de Endpoint
objeto que representa o endpoint de email.
Ative o endpoint.
Ative o endpoint chamando o botão EndpointRegistryClient
do objeto enable
e transmitindo o Endpoint
objeto que foi retornado pelo createEndpoint
método.
Consulte também
QuickStart: adicionando um endpoint de pasta monitorada usando a API Java
Inclusão de arquivos da biblioteca Java do AEM Forms
Definindo propriedades de conexão
A variável QuickStart: adicionando um endpoint de email usando a API Java O usa um arquivo constante que deve fazer parte do projeto Java para compilar o início rápido. Esse arquivo de constante representa valores de configuração que devem ser definidos ao adicionar um terminal de email. O código Java a seguir representa o arquivo de constante.
/**
* 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";
}
APIs do LiveCycle Remoting descontinuadas para formulários AEM no JEE.
Você pode adicionar programaticamente um endpoint de comunicação remota a um serviço usando a API Java do AEM Forms. Ao adicionar um endpoint de Comunicação Remota, você está habilitando um aplicativo do Flex a chamar o serviço usando comunicação remota. (Consulte Chamada do AEM Forms usando (obsoleto para o AEM formulários) AEM Forms Remoting.)
Para adicionar programaticamente um terminal de Comunicação Remota a um serviço, considere o seguinte processo de vida curta chamado EncryptDocument.
Esse processo aceita um documento de PDF não seguro como valor de entrada e, em seguida, passa o documento de PDF não seguro para o do serviço de criptografia EncryptPDFUsingPassword
operação. O documento PDF é criptografado com uma senha e o documento PDF criptografado com senha é o valor de saída desse processo. O nome do valor de entrada (o documento PDF não seguro) é InDoc
e o tipo de dados for com.adobe.idp.Document
. O nome do valor de saída (o documento PDF criptografado por senha) é SecuredDoc
e o tipo de dados for com.adobe.idp.Document
.
Para demonstrar como adicionar um ponto de extremidade de Comunicação Remota a um serviço, esta seção adiciona um ponto de extremidade de Comunicação Remota a um serviço chamado EncryptDocument.
Não é possível adicionar um ponto de extremidade de Comunicação Remota usando serviços da Web.
Para remover um ponto de extremidade de um serviço, execute as seguintes tarefas:
EndpointRegistryClient
objeto.Incluir arquivos de projeto
Inclua os arquivos necessários no projeto de desenvolvimento. Se você estiver criando uma aplicação cliente usando Java, inclua os arquivos JAR necessários. Se você estiver usando serviços da Web, certifique-se de incluir os arquivos proxy.
Os seguintes arquivos JAR devem ser adicionados ao caminho de classe do projeto:
Para obter informações sobre a localização desses arquivos JAR, consulte Inclusão de arquivos da biblioteca Java do AEM Forms.
Criar um objeto Cliente EndpointRegistry
Para adicionar programaticamente um ponto de extremidade de Comunicação Remota, você deve criar um EndpointRegistryClient
objeto.
Definir atributos de ponto de extremidade de Comunicação Remota
Para criar um ponto de extremidade de Comunicação Remota para um serviço, especifique os seguintes valores:
Remoting
.EncryptDocument
.Criar um ponto de extremidade de Comunicação Remota
Após definir os atributos do ponto de extremidade Remoting, você pode criar um ponto de extremidade Remoting para um serviço.
Habilitar o endpoint
Depois de criar um novo endpoint, você deve habilitá-lo. Quando um endpoint de Comunicação Remota está habilitado, ele permite que um cliente Flex chame o serviço.
Consulte também
Adicionar um terminal de comunicação remota usando a API Java
Inclusão de arquivos da biblioteca Java do AEM Forms
Definindo propriedades de conexão
Adicionar um endpoint de Comunicação Remota usando a API Java:
Incluir arquivos de projeto.
Inclua arquivos JAR do cliente, como adobe-livecycle-client.jar, no caminho de classe do projeto Java.
Crie um objeto Cliente EndpointRegistry.
ServiceClientFactory
objeto que contém propriedades de conexão.EndpointRegistryClient
usando seu construtor e transmitindo o ServiceClientFactory
objeto.Defina atributos de ponto de extremidade de Comunicação Remota.
CreateEndpointInfo
usando seu construtor.CreateEndpointInfo
do objeto setConnectorId
e transmitindo o valor da string Remoting
.CreateEndpointInfo
do objeto setDescription
e transmitindo um valor de string que descreve o endpoint.CreateEndpointInfo
do objeto setName
e transmitindo um valor de string que especifica o nome.CreateEndpointInfo
do objeto setServiceId
e transmitindo um valor de string que especifica o nome do serviço.CreateEndpointInfo
do objeto setOperationName
e transmitindo um valor de string que especifica o nome da operação. Para um ponto de extremidade de Comunicação Remota, especifique um caractere curinga (*).Criar um ponto de extremidade de Comunicação Remota.
Crie o endpoint chamando o EndpointRegistryClient
do objeto createEndpoint
e transmitindo o CreateEndpointInfo
objeto. Este método retorna um valor de Endpoint
objeto que representa o novo ponto de extremidade Remoting.
Ative o endpoint.
Ative o endpoint chamando o botão EndpointRegistryClient
do objeto enable
e transmitindo o Endpoint
objeto que foi retornado pelo createEndpoint
método.
Consulte também
QuickStart: adicionando um endpoint de comunicação remota usando a API Java
Inclusão de arquivos da biblioteca Java do AEM Forms
Definindo propriedades de conexão
Você pode adicionar programaticamente um endpoint TaskManager a um serviço usando a API Java do AEM Forms. Ao adicionar um terminal TaskManager a um serviço, você permite que um usuário do Workspace chame o serviço. Ou seja, um usuário que trabalha no Espaço de trabalho pode chamar um processo que tenha um endpoint do TaskManager correspondente.
Não é possível adicionar um ponto de extremidade TaskManager usando serviços da Web.
Para adicionar um ponto de extremidade TaskManager a um serviço, execute as seguintes tarefas:
EndpointRegistryClient
objeto.Incluir arquivos de projeto
Inclua os arquivos necessários no projeto de desenvolvimento. Se você estiver criando uma aplicação cliente usando Java, inclua os arquivos JAR necessários. Se você estiver usando serviços da Web, certifique-se de incluir os arquivos proxy.
Os seguintes arquivos JAR devem ser adicionados ao caminho de classe do projeto:
Para obter informações sobre a localização desses arquivos JAR, consulte Inclusão de arquivos da biblioteca Java do AEM Forms.
Criar um objeto Cliente EndpointRegistry
Antes de adicionar programaticamente um ponto de extremidade TaskManager, você deve criar um EndpointRegistryClient
objeto.
Criar uma categoria para o ponto de extremidade
As categorias são usadas para organizar serviços no Espaço de trabalho. Ou seja, um usuário do Workspace pode chamar um serviço que tenha um terminal TaskManager selecionando uma categoria no Workspace. Ao criar um endpoint do TaskManager, você pode fazer referência a uma categoria existente ou criar programaticamente uma nova categoria.
Esta seção cria uma nova categoria como parte da adição de um ponto de extremidade TaskManager a um serviço.
Definir atributos de ponto de extremidade do TaskManager
Para criar um ponto de extremidade TaskManager para um serviço, especifique os seguintes valores:
TaskManagerConnector
.invoke
.Criar um ponto de extremidade TaskManager
Após definir os atributos de um ponto de extremidade do TaskManager, você pode criar um ponto de extremidade do TaskManager para um serviço.
Habilitar o endpoint
Depois de criar um novo endpoint, você deve habilitá-lo. Quando o endpoint está habilitado, ele pode ser usado para chamar o serviço no Espaço de trabalho. Após habilitar o endpoint, é possível visualizá-lo no console de administração.
Consulte também
Adicionar um terminal TaskManager usando a API Java
Inclusão de arquivos da biblioteca Java do AEM Forms
Definindo propriedades de conexão
Adicione um endpoint TaskManager usando a API Java:
Incluir arquivos de projeto.
Inclua arquivos JAR do cliente, como adobe-livecycle-client.jar, no caminho de classe do projeto Java.
Crie um objeto Cliente EndpointRegistry.
ServiceClientFactory
objeto que contém propriedades de conexão.EndpointRegistryClient
usando seu construtor e transmitindo o ServiceClientFactory
objeto.Crie uma categoria para o endpoint.
Criar um CreateEndpointCategoryInfo
usando seu construtor e transmitindo os seguintes valores:
Crie a categoria chamando o EndpointRegistryClient
do objeto createEndpointCategory
e transmitindo o CreateEndpointCategoryInfo
objeto. Este método retorna um valor de EndpointCategory
objeto que representa a nova categoria.
Defina os atributos do ponto de extremidade do TaskManager.
CreateEndpointInfo
usando seu construtor.CreateEndpointInfo
do objeto setConnectorId
e transmitindo o valor da string TaskManagerConnector
.CreateEndpointInfo
do objeto setDescription
e transmitindo um valor de string que descreve o endpoint.CreateEndpointInfo
do objeto setName
e transmitindo um valor de string que especifica o nome.CreateEndpointInfo
do objeto setServiceId
e transmitindo um valor de string que especifica o nome do serviço.CreateEndpointInfo
do objeto setCategoryId
e transmitindo um valor de string que especifica o valor do identificador de categoria. Você pode chamar a variável EndpointCategory
do objeto getId
para obter o valor identificador desta categoria.CreateEndpointInfo
do objeto setOperationName
e transmitindo um valor de string que especifica o nome da operação. Normalmente, ao criar uma TaskManager
endpoint para um serviço originado de um processo criado no Workbench, o nome da operação é invoke
.Crie um ponto de extremidade TaskManager.
Crie o endpoint chamando o EndpointRegistryClient
do objeto createEndpoint
e transmitindo o CreateEndpointInfo
objeto. Este método retorna um valor de Endpoint
objeto que representa o novo ponto de extremidade do TaskManager.
Ative o endpoint.
Ative o endpoint chamando o botão EndpointRegistryClient
do objeto enable
e transmitindo o Endpoint
objeto que foi retornado pelo createEndpoint
método.
Consulte também
QuickStart: adicionando um endpoint TaskManager usando a API Java
Inclusão de arquivos da biblioteca Java do AEM Forms
Definindo propriedades de conexão
Você pode modificar programaticamente um endpoint existente usando a API Java do AEM Forms. Ao modificar um endpoint, é possível alterar o comportamento dele. Considere, por exemplo, um endpoint de Pasta monitorada que especifica uma pasta usada como a pasta monitorada. Você pode modificar programaticamente os valores de configuração que pertencem ao endpoint da Pasta monitorada, resultando em outra pasta funcionando como a pasta monitorada. Para obter informações sobre valores de configuração que pertencem a um endpoint de Pasta monitorada, consulte Adicionar pontos de extremidade da pasta monitorada.
Para demonstrar como modificar um endpoint, esta seção modifica um endpoint de Pasta monitorada alterando a pasta que se comporta como a pasta monitorada.
Não é possível modificar um ponto de extremidade usando serviços da Web.
Para modificar um endpoint, execute as seguintes tarefas:
EndpointRegistryClient
objeto.Incluir arquivos de projeto
Inclua os arquivos necessários no projeto de desenvolvimento. Se você estiver criando uma aplicação cliente usando Java, inclua os arquivos JAR necessários. Se você estiver usando serviços da Web, certifique-se de incluir os arquivos proxy.
Os seguintes arquivos JAR devem ser adicionados ao caminho de classe do projeto:
Para obter informações sobre a localização desses arquivos JAR, consulte Inclusão de arquivos da biblioteca Java do AEM Forms.
Criar um objeto Cliente EndpointRegistry
Para modificar programaticamente um endpoint, você deve criar um EndpointRegistryClient
objeto.
Recuperar o ponto de extremidade a ser modificado
Antes de modificar um endpoint, você deve recuperá-lo. Para recuperar um endpoint, você deve se conectar como um usuário que pode acessar um endpoint. É recomendável conectar-se como administrador. (Consulte Definindo propriedades de conexão).
Você pode recuperar um ponto de extremidade recuperando uma lista de pontos de extremidade. É possível percorrer a lista, procurando o endpoint específico a ser removido. Por exemplo, você pode localizar um endpoint determinando o serviço que corresponde ao endpoint e o tipo de endpoint. Ao localizar o endpoint, você pode modificá-lo.
Especificar novos valores de configuração
Ao modificar um endpoint, especifique novos valores de configuração. Por exemplo, para modificar um endpoint de Pasta monitorada, redefina todos os valores de configuração de endpoint de Pasta monitorada, não apenas aqueles que você deseja modificar. Para obter informações sobre valores de configuração que pertencem a um endpoint de Pasta monitorada, consulte Adicionar pontos de extremidade da pasta monitorada.
Para obter informações sobre valores de configuração que pertencem a um endpoint de email, consulte Adicionar pontos de extremidade de email.
Não é possível modificar o serviço chamado pelo ponto de extremidade. Se você tentar modificar o serviço, uma exceção será lançada. Para modificar o serviço associado a um determinado ponto de extremidade, remova o ponto de extremidade e crie um novo. (Consulte Removendo Pontos de Extremidade.)
Consulte também
Modificação de um endpoint usando a API Java
Inclusão de arquivos da biblioteca Java do AEM Forms
Definindo propriedades de conexão
Modifique um endpoint usando a API Java:
Incluir arquivos de projeto.
Inclua arquivos JAR do cliente, como adobe-livecycle-client.jar, no caminho de classe do projeto Java.
Crie um objeto Cliente EndpointRegistry.
ServiceClientFactory
objeto que contém propriedades de conexão.EndpointRegistryClient
usando seu construtor e transmitindo o ServiceClientFactory
objeto.Recupere o ponto de extremidade a ser modificado.
EndpointRegistryClient
do objeto getEndpoints
e passar um PagingFilter
objeto que atua como filtro. Você pode passar um (PagingFilter)null
para retornar todos os pontos de extremidade. Este método retorna um valor de java.util.List
objeto no qual cada elemento é um Endpoint
objeto. Para obter informações sobre uma PagingFilter
objeto, consulte Referência da API do AEM Forms.java.util.List
para determinar se tem pontos de extremidade. Se existirem endpoints, cada elemento será um EndPoint
instância.EndPoint
do objeto getServiceId
método. Este método retorna um valor de string que especifica o nome do serviço.EndPoint
do objeto getConnectorId
método. Esse método retorna um valor de string que especifica o tipo de endpoint. Por exemplo, se o endpoint for um endpoint de Pasta monitorada, esse método retornará WatchedFolder
.Especifique novos valores de configuração.
Criar um ModifyEndpointInfo
invocando seu construtor.
Para cada valor de configuração a ser definido, chame o ModifyEndpointInfo
do objeto setConfigParameterAsText
método. Por exemplo, para definir o valor de configuração do url, chame o ModifyEndpointInfo
do objeto setConfigParameterAsText
e passe os seguintes valores:
url
valor de configuração, especifique url
.url
valor de configuração, especifique o local da pasta monitorada.Chame o EndpointRegistryClient
do objeto modifyEndpoint
e transmita o ModifyEndpointInfo
objeto.
Consulte também
QuickStart: modificando um endpoint usando a API Java
Inclusão de arquivos da biblioteca Java do AEM Forms
Definindo propriedades de conexão
Você pode remover programaticamente um endpoint de um serviço usando a API Java do AEM Forms. Depois que você remove um ponto de extremidade, o serviço não pode ser chamado usando o método de invocação que o ponto de extremidade habilitou. Por exemplo, se você remover um ponto de extremidade SOAP de um serviço, não poderá chamar o serviço usando o modo SOAP.
Para demonstrar como remover um endpoint de um serviço, esta seção remove um endpoint EJB de um serviço chamado EncryptDocument.
Não é possível remover um ponto de extremidade usando serviços da Web.
Para remover um ponto de extremidade de um serviço, execute as seguintes tarefas:
EndpointRegistryClient
objeto.Incluir arquivos de projeto
Inclua os arquivos necessários no projeto de desenvolvimento. Se você estiver criando uma aplicação cliente usando Java, inclua os arquivos JAR necessários. Se você estiver usando serviços da Web, certifique-se de incluir os arquivos proxy.
Os seguintes arquivos JAR devem ser adicionados ao caminho de classe do projeto:
Para obter informações sobre a localização desses arquivos JAR, consulte Inclusão de arquivos da biblioteca Java do AEM Forms.
Criar um objeto Cliente EndpointRegistry
Para remover programaticamente um endpoint, você deve criar um EndpointRegistryClient
objeto.
Recuperar o ponto de extremidade a ser removido
Antes de remover um endpoint, é necessário recuperá-lo. Para recuperar um endpoint, você deve se conectar como um usuário que pode acessar um endpoint. É recomendável conectar-se como administrador. (Consulte Definindo propriedades de conexão).
Você pode recuperar um ponto de extremidade recuperando uma lista de pontos de extremidade. É possível percorrer a lista, procurando o endpoint específico a ser removido. Por exemplo, você pode localizar um endpoint determinando o serviço que corresponde ao endpoint e o tipo de endpoint. Ao localizar o endpoint, você pode removê-lo.
Remover o ponto de extremidade
Depois de criar um novo endpoint, você deve habilitá-lo. Quando o endpoint está habilitado, ele pode ser usado para chamar o serviço. Após habilitar o endpoint, é possível visualizá-lo no console de administração.
Consulte também
Remoção de um endpoint usando a API Java
Inclusão de arquivos da biblioteca Java do AEM Forms
Definindo propriedades de conexão
Remova um endpoint usando a API Java:
Incluir arquivos de projeto.
Inclua arquivos JAR do cliente, como adobe-livecycle-client.jar, no caminho de classe do projeto Java.
Crie um objeto Cliente EndpointRegistry.
ServiceClientFactory
objeto que contém propriedades de conexão.EndpointRegistryClient
usando seu construtor e transmitindo o ServiceClientFactory
objeto.Recupere o ponto de extremidade a ser removido.
EndpointRegistryClient
do objeto getEndpoints
e passar um PagingFilter
objeto que atua como filtro. Você pode passar (PagingFilter)null
para retornar todos os pontos de extremidade. Este método retorna um valor de java.util.List
objeto no qual cada elemento é um Endpoint
objeto.java.util.List
para determinar se tem pontos de extremidade. Se existirem endpoints, cada elemento será um EndPoint
instância.EndPoint
do objeto getServiceId
método. Este método retorna um valor de string que especifica o nome do serviço.EndPoint
do objeto getConnectorId
método. Esse método retorna um valor de string que especifica o tipo de endpoint. Por exemplo, se o ponto final for um ponto final EJB, este método retornará EJB
.Remova o endpoint.
Remova o endpoint chamando o EndpointRegistryClient
do objeto remove
e transmitindo o EndPoint
objeto que representa o ponto de extremidade a ser removido.
Consulte também
QuickStart: removendo um endpoint usando a API Java
Inclusão de arquivos da biblioteca Java do AEM Forms
Definindo propriedades de conexão
Você pode recuperar programaticamente informações sobre conectores de endpoint usando a API do AEM Forms. Um conector permite que um endpoint chame um serviço usando vários métodos de invocação. Por exemplo, um conector de Pasta monitorada permite que um terminal chame um serviço usando pastas monitoradas. Ao recuperar programaticamente informações sobre conectores de endpoint, é possível recuperar valores de configuração associados a um conector, como quais valores de configuração são necessários e quais são opcionais.
Para demonstrar como recuperar informações sobre conectores de endpoint, esta seção recupera informações sobre um conector de Pasta monitorada. (Consulte Adicionar pontos de extremidade da pasta monitorada.)
Não é possível recuperar informações sobre pontos de extremidade usando serviços da Web.
Este tópico usa a variável ConnectorRegistryClient
API para recuperar informações sobre conectores de endpoint. (Consulte Referência da API do AEM Forms.)
Para recuperar informações do conector do ponto de extremidade, execute as seguintes tarefas:
ConnectorRegistryClient
objeto.Incluir arquivos de projeto
Inclua os arquivos necessários no projeto de desenvolvimento. Se você estiver criando uma aplicação cliente usando Java, inclua os arquivos JAR necessários. Se você estiver usando serviços da Web, certifique-se de incluir os arquivos proxy.
Os seguintes arquivos JAR devem ser adicionados ao caminho de classe do projeto:
Se o AEM Forms for implantado em um servidor de aplicativos J2EE compatível que não seja JBoss, substitua adobe-utilities.jar e jbossall-client.jar por arquivos JAR específicos para o servidor de aplicativos J2EE no qual o AEM Forms é implantado. Para obter informações sobre a localização de todos os arquivos JAR do AEM Forms, consulte Inclusão de arquivos da biblioteca Java do AEM Forms.
Criar um objeto Cliente ConnectorRegistry
Para recuperar programaticamente as informações do conector do ponto de extremidade, crie um ConnectorRegistryClient
objeto.
Especificar o tipo de conector
Especifique o tipo de conector do qual recuperar informações. Existem os seguintes tipos de conectores:
Recuperar valores de configuração
Após especificar o tipo de conector, você pode recuperar informações sobre o conector, como o valor de configuração suportado. Por exemplo, para qualquer conector, é possível determinar quais valores de configuração são necessários e quais são opcionais.
Consulte também
Recuperar informações do conector de ponto de extremidade usando a API Java
Inclusão de arquivos da biblioteca Java do AEM Forms
Definindo propriedades de conexão
Recupere informações do conector de ponto de extremidade usando a API Java:
Incluir arquivos de projeto. .
Inclua arquivos JAR do cliente, como adobe-livecycle-client.jar, no caminho de classe do projeto Java.
Crie um objeto Cliente ConnectorRegistry.
ServiceClientFactory
objeto que contém propriedades de conexão.ConnectorRegistryClient
usando seu construtor e transmitindo o ServiceClientFactory
objeto.Especifique o tipo de conector.
Especifique o tipo de conector chamando o ConnectorRegistryClient
do objeto getEndpointDefinition
e transmitindo um valor de string que especifica o tipo de conector. Por exemplo, para especificar o tipo de conector Pasta monitorada, passe o valor da string WatchedFolder
. Este método retorna um valor de Endpoint
objeto que corresponde ao tipo de conector.
Recupere valores de configuração.
Endpoint
do objeto getConfigParameters
método. Este método retorna uma matriz de ConfigParameter
objetos.ConfigParameter
objeto. Você pode, por exemplo, determinar se o valor de configuração é obrigatório ou opcional, chamando o ConfigParameter
do objeto isRequired
método. Se o valor de configuração for necessário, esse método retornará true
.Consulte também
QuickStart: recuperando informações do conector de ponto de extremidade usando a API Java
Inclusão de arquivos da biblioteca Java do AEM Forms
Definindo propriedades de conexão