AEM 6.4 chegou ao fim do suporte estendido e esta documentação não é mais atualizada. Para obter mais detalhes, consulte nossa períodos de assistência técnica. Encontre as versões compatíveis here.
Sobre o serviço de registro do Endpoint
O serviço Endpoint Registry fornece a capacidade de gerenciar programaticamente os endpoints. Você pode, por exemplo, adicionar os seguintes tipos de endpoints a um serviço:
EJB
SOAP
Pasta assistida
(Obsoleto para formulários AEM) Remoção
Gerenciador de tarefas
SOAP, EJB e (obsoleto para formulários AEM no JEE) Os pontos finais remotos são criados automaticamente para cada serviço ativado. Os endpoints SOAP e EJB habilitam SOAP e EJB para todas as operações de serviço.
Um terminal Remoting permite que os clientes Flex chamem operações no serviço AEM Forms ao qual o terminal foi adicionado. Um destino Flex com o mesmo nome do ponto de extremidade é criado e os clientes Flex podem criar RemoteObjects que apontam para esse destino para chamar operações no serviço relevante.
Os endpoints Email, Gerenciador de tarefas e Pasta assistida 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 para chamar, definir parâmetros de configuração e especificar mapeamentos de parâmetros de entrada e saída.
Você pode organizar endpoints do TaskManager em grupos chamados categorias. Essas categorias são então expostas ao Workspace 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 visualizam essas categorias no painel de navegação. Os endpoints em 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 Endpoint Registry:
Adicione pontos de extremidade EJB. (Consulte Adicionar Endpoints EJB.)
Adicione pontos de extremidade SOAP. (Consulte Adicionar endpoints SOAP.)
Adicionar pontos de extremidade de pasta assistida (consulte Adicionar pontos de extremidade de pasta monitorada.)
Adicionar endpoints de email. (Consulte Adicionar pontos de extremidade de email.)
Adicione pontos de extremidade remotos. (Consulte Adicionar pontos finais remotos.)
Adicionar endpoints do TaskManager (Consulte Adicionar pontos de extremidade do Gerenciador de Tarefas.)
Modificar endpoints (Consulte Modificação de Endpoints.)
Remover endpoints (Consulte Remoção de pontos finais.)
Recuperar informações do conector do ponto de extremidade (Consulte Recuperando informações do conector de ponto de extremidade.)
Você pode adicionar um ponto de extremidade EJB a um serviço por programação usando a API Java do AEM Forms. Ao adicionar um ponto de extremidade EJB a um serviço, você está permitindo que um aplicativo cliente chame o serviço usando o modo EJB. Ou seja, ao definir propriedades de conexão necessárias para chamar o AEM Forms, você pode selecionar o modo EJB. (Consulte Configuração das propriedades de conexão.)
Não é possível adicionar um ponto de extremidade EJB usando serviços da Web.
Normalmente, um ponto de extremidade EJB é adicionado a um serviço por padrão. No entanto, um ponto de extremidade EJB pode ser adicionado a um processo que é programaticamente implantado ou quando um ponto de extremidade EJB foi removido e deve ser adicionado novamente.
Para adicionar um ponto de extremidade EJB a um serviço, execute as seguintes tarefas:
EndpointRegistry Client
objeto.Incluir arquivos de projeto
Inclua os arquivos necessários no seu projeto de desenvolvimento. Os seguintes arquivos JAR devem ser adicionados ao caminho de classe do seu 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 de cliente EndpointRegistry
Antes de poder adicionar programaticamente um ponto de extremidade EJB, você deve criar um EndpointRegistryClient
objeto.
Definir atributos de ponto de extremidade EJB
Para criar um ponto de extremidade EJB para um serviço, especifique os seguintes valores:
EJB
.*
). No entanto, se 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 EJB
Depois de definir atributos de ponto de extremidade EJB, você pode criar um ponto de extremidade EJB para um serviço.
Ativar o ponto de extremidade
Depois de criar um novo terminal, você deve habilitá-lo. Após habilitar o endpoint, ele poderá ser usado para chamar o serviço. Depois de ativar o endpoint, você pode visualizá-lo no console de administração.
Consulte também
Adicionar um ponto de extremidade EJB usando a API Java
Inclusão de arquivos da biblioteca Java do AEM Forms
Configuração das propriedades de conexão
Adicione um ponto de extremidade EJB usando a API do Java:
Inclua arquivos de projeto.
Inclua arquivos JAR do cliente, como adobe-livecycle-client.jar, no caminho da classe do seu projeto Java. (
Crie um objeto Cliente EndpointRegistry.
ServiceClientFactory
objeto que contém propriedades de conexão.EndpointRegistryClient
usando seu construtor e passando o ServiceClientFactory
objeto.Defina os atributos do ponto de extremidade 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 ponto de extremidade.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 transmita 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 EJB.
Crie o ponto de extremidade chamando a variável EndpointRegistryClient
do objeto createEndpoint
e a aprovação do CreateEndpointInfo
objeto. Esse método retorna um Endpoint
objeto que representa o novo ponto de extremidade EJB.
Habilite o endpoint .
Ative o endpoint chamando a função EndpointRegistryClient
método enable do objeto e transmitindo o Endpoint
objeto retornado pelo createEndpoint
método .
Consulte também
Início rápido: Adicionar um ponto de extremidade EJB usando a API Java
Inclusão de arquivos da biblioteca Java do AEM Forms
Configuração das propriedades de conexão
Você pode adicionar um terminal SOAP a um serviço por programação usando a API do AEM Forms Java. Ao adicionar um ponto de extremidade SOAP, você permite que um aplicativo cliente chame 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 terminal 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 é removido e deve ser adicionado novamente.
Para adicionar um terminal 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 um aplicativo 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 seu projeto:
Esses arquivos JAR são necessários para criar um terminal SOAP. No entanto, é necessário adicionar arquivos JAR se você usar o terminal SOAP para chamar o serviço. Para obter informações sobre arquivos AEM Forms JAR, consulte Inclusão de arquivos da biblioteca Java do AEM Forms.
Criar um objeto de cliente EndpointRegistry
Para adicionar programaticamente um terminal SOAP a um serviço, é necessário criar um EndpointRegistryClient
objeto.
Definir atributos de ponto de extremidade SOAP
Para adicionar um terminal SOAP a um serviço, especifique os seguintes valores:
SOAP
.*
). No entanto, se 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 terminal SOAP
Depois de definir atributos de ponto de extremidade SOAP, você pode criar um ponto de extremidade SOAP.
Ativar o ponto de extremidade
Depois de criar um novo terminal, você deve habilitá-lo. Quando o endpoint está ativado, ele pode ser usado para chamar o serviço. Depois de ativar o endpoint, você pode visualizá-lo no console de administração.
Consulte também
Adicionar um terminal SOAP usando a API Java
Inclusão de arquivos da biblioteca Java do AEM Forms
Configuração das propriedades de conexão
Adicione um terminal SOAP a um serviço usando a API do Java:
Inclua arquivos de projeto.
Inclua arquivos JAR do cliente, como adobe-livecycle-client.jar, no caminho da classe do seu projeto Java.
Crie um objeto Cliente EndpointRegistry.
ServiceClientFactory
objeto que contém propriedades de conexão.EndpointRegistryClient
usando seu construtor e passando o ServiceClientFactory
objeto.Defina 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 ponto de extremidade.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 terminal SOAP.
Crie o ponto de extremidade chamando a variável EndpointRegistryClient
do objeto createEndpoint
e a aprovação do CreateEndpointInfo
objeto. Esse método retorna um Endpoint
que representa o novo ponto de extremidade SOAP.
Habilite o endpoint .
Ative o endpoint chamando a função EndpointRegistryClient
habilite o método do objeto e passe o Endpoint
objeto retornado pelo createEndpoint
método .
Consulte também
Início rápido: Adicionar um terminal SOAP usando a API Java
Inclusão de arquivos da biblioteca Java do AEM Forms
Configuração das propriedades de conexão
Você pode adicionar programaticamente um endpoint de Pasta assistida a um serviço usando a API Java do AEM Forms. Ao adicionar um ponto de extremidade de Pasta assistida, os usuários podem colocar 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 assistida é configurada para ser digitalizada em um intervalo de taxa fixa ou com um cronograma de medição, como todas as segundas, quartas e sextas-feiras ao meio-dia.
Para adicionar programaticamente um endpoint de Pasta assistida a um serviço, considere o seguinte processo de curta duração chamado EncryptDocument. (Consulte Noções básicas sobre os processos do AEM Forms.)
Esse processo aceita um documento PDF não seguro como um valor de entrada e, em seguida, passa o documento 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 por 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 é com.adobe.idp.Document
. O nome do valor de saída (o documento PDF criptografado por senha) é SecuredDoc
e o tipo de dados é com.adobe.idp.Document
.
Não é possível adicionar um endpoint de Pasta assistida usando serviços da Web.
Para adicionar um endpoint de Pasta assistida 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 um aplicativo 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 seu 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 de cliente EndpointRegistry
Para adicionar programaticamente um endpoint de Pasta assistida, é necessário criar um EndpointRegistryClient
objeto.
Definir atributos de ponto de extremidade de pasta assistida
Para criar um endpoint de Pasta assistida 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 endpoint de Pasta assistida ao adicionar programaticamente um endpoint de Pasta assistida a um serviço. Esses valores de configuração são especificados por um administrador se um endpoint Pasta assistida for adicionado usando o console de administração.
A lista a seguir especifica os valores de configuração que são definidos ao adicionar programaticamente um ponto de extremidade de Pasta assistida a um serviço:
data*
, todos os arquivos e pastas que correspondem data*
não são selecionadas. Isso inclui arquivos e pastas nomeados 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 assistida modifica a expressão regular para suportar padrões curingas, como *.*
e *.pdf
. Esses padrões curingas não são compatíveis com expressões regulares.*
, todos os arquivos e pastas que correspondem input*
são selecionadas. Isso inclui arquivos e pastas nomeados 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 assistida modifica a expressão regular para suportar padrões curingas, como *.*
e *.pdf
. Esses padrões curingas não são compatíveis com expressões regulares. Esse valor é obrigatório.result/%Y/%M/%D/
. Esta é a pasta de resultados dentro da pasta observada.preserve/%Y/%M/%D/
.failure/%Y/%M/%D/
.Definir valores de parâmetros de entrada
Ao criar um ponto de extremidade de Pasta assistida, é necessário definir valores de parâmetro de entrada. Ou seja, você deve descrever os valores de entrada passados para a operação que é invocada pela pasta assistida. 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 assistida para esse processo (depois que um processo é ativado, ele se torna um serviço), é necessário definir o valor do parâmetro de entrada.
Para definir os valores de parâmetro de entrada necessários para um endpoint de Pasta assistida, 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 no Workbench 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. Existem dois tipos de mapeamento:
Literal
: O endpoint Pasta assistida usa o valor inserido no campo como ele é exibido. Todos os tipos básicos de Java são suportados. Por exemplo, se uma API usar entrada, 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 assistida 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.Valor do mapeamento: Especifica o valor do tipo de mapeamento. Por exemplo, se você selecionar uma Variable
tipo de mapeamento, é possível especificar *.pdf
como padrão de 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 Pasta assistida, é necessário definir um valor de parâmetro de saída. Ou seja, você deve descrever o valor de saída que é retornado pelo serviço chamado pelo endpoint Pasta assistida . 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 assistida para esse processo (depois que um processo é ativado, ele se torna um serviço), é necessário 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 assistida, 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 do 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 de 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 especificado). O padrão %E
especifica a extensão do documento de entrada.Result\%F\
e o destino de origem é Result\sourcefilename\source1 (output 1) e Result\sourcefilename\source2 (output 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 endpoint de pasta monitorada
Depois de definir os atributos do ponto de extremidade, os valores de configuração e os valores de parâmetro de entrada e saída, é necessário criar o ponto de extremidade Pasta assistida.
Ativar o ponto de extremidade
Depois de criar um endpoint de Pasta assistida, você deve ativá-lo. Quando o endpoint está ativado, ele pode ser usado para chamar o serviço. Depois de ativar o endpoint, você pode visualizá-lo no console de administração.
Consulte também
Adicionar um endpoint de pasta assistida usando a API Java
Inclusão de arquivos da biblioteca Java do AEM Forms
Configuração das propriedades de conexão
Adicione um endpoint de Pasta assistida usando a API do Java do AEM Forms:
Inclua arquivos de projeto.
Inclua arquivos JAR do cliente, como adobe-livecycle-client.jar, no caminho da classe do seu projeto Java.
Crie um objeto Cliente EndpointRegistry.
ServiceClientFactory
objeto que contém propriedades de conexão.EndpointRegistryClient
usando seu construtor e passando o ServiceClientFactory
objeto.Defina os atributos do ponto de extremidade da pasta assistida.
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 ponto de extremidade.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 assistida para um serviço originado 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 Pasta assistida, você deve chamar a variável 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 transmita os seguintes valores da 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 Início rápido: Adicionar um endpoint de pasta assistida usando a API Java.
Defina os valores dos parâmetros de entrada.
Defina um valor de parâmetro de entrada chamando a função CreateEndpointInfo
do objeto setInputParameterMapping
e transmita os seguintes valores:
InDoc
.InDoc
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 a função CreateEndpointInfo
do objeto setOutputParameterMapping
e transmita os seguintes valores:
SecuredDoc
.SecuredDoc
parâmetro de saída é com.adobe.idp.Document
.%F.pdf
.Crie um ponto de extremidade de Pasta assistida.
Crie o ponto de extremidade chamando a variável EndpointRegistryClient
do objeto createEndpoint
e a aprovação do CreateEndpointInfo
objeto. Esse método retorna um Endpoint
objeto que representa o ponto de extremidade da pasta assistida.
Habilite o endpoint .
Ative o endpoint chamando a função EndpointRegistryClient
do objeto enable
e a aprovação do Endpoint
objeto retornado pelo createEndpoint
método .
Consulte também
Início rápido: Adicionar um endpoint de pasta assistida usando a API Java
Inclusão de arquivos da biblioteca Java do AEM Forms
Configuração das propriedades de conexão
O Início rápido: Adicionar um endpoint de pasta assistida 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 assistida. O código Java a seguir representa o arquivo 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 um endpoint de email a um serviço de maneira programática usando a API do AEM Forms Java. Ao adicionar um ponto de extremidade de email, os usuários podem enviar 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 de serviço é invocada 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 adicionar um ponto de extremidade de email a um serviço de maneira programática, considere o seguinte processo de duração curta chamado MyApplication\EncryptDocument. Para obter informações sobre processos de duração curta, consulte Noções básicas sobre os processos do AEM Forms.
Esse processo aceita um documento PDF não seguro como um valor de entrada e, em seguida, passa o documento 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 é com.adobe.idp.Document
. O nome do valor de saída (o documento PDF criptografado por senha) é SecuredDoc
e o tipo de dados é com.adobe.idp.Document
.
Não é possível adicionar um ponto de extremidade de email usando serviços da Web.
Para adicionar um terminal 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 um aplicativo 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 seu 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 de cliente EndpointRegistry
Antes de poder adicionar um endpoint de email programaticamente, você deve criar um EndpointRegistryClient
objeto.
Definir atributos de ponto de extremidade de email
Para criar um ponto de extremidade 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 normal do usuário. A conta de email de um usuário comum não deve ser configurada como a conta que o Provedor de email usa, pois o Provedor de email exclui mensagens de email da caixa de entrada após sua conclusão com as mensagens.
Os seguintes valores de configuração são definidos ao adicionar programaticamente um ponto de extremidade de email a um serviço:
SuperAdmin
.DefaultDom
.adobe.com
for usado, somente o email do adobe.com será processado, o email de outros domínios será ignorado.*
.sender
, os resultados do email são enviados ao remetente. Há suporte para até 100 recipients. 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, talvez você queira acionar um processo e não desejar uma notificação por email do resultado. O valor padrão é sender
.sender
, os resultados do email são enviados ao remetente. Há suporte para até 100 recipients. 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 correio do host da caixa de entrada deve oferecer suporte a esses protocolos.UTF-8
.Definir valores de parâmetros de entrada
Ao criar um ponto de extremidade de email, você deve definir os valores do parâmetro de entrada. Ou seja, você deve descrever os valores de entrada passados para a operação que é invocada 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), é necessário definir o valor do parâmetro de entrada.
Para definir valores de parâmetros de entrada necessários para um ponto de extremidade 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 no Workbench 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, conforme ele é exibido. Todos os tipos básicos de Java são suportados. Por exemplo, se uma API usar entrada, como String, long, int e Boolean, a cadeia de caracteres será convertida para o tipo adequado e o serviço será chamado.Variable
: O valor inserido é um padrão de arquivo que o ponto de extremidade 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.Valor do mapeamento: Especifica o valor do tipo de mapeamento. Por exemplo, se você selecionar um tipo de mapeamento de variável, será possível especificar *.pdf
como padrão de 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 ponto de extremidade 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), é necessário definir o valor do parâmetro de saída.
Para definir um valor de parâmetro de saída necessário para um ponto de extremidade 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 do 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 de 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 especificado). O padrão %E
especifica a extensão do documento de entrada.Result\%F\
e o destino de origem é Result\sourcefilename\source1 (output 1) e Result\sourcefilename\source2 (output 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 e os valores de configuração do ponto de extremidade de email e os valores de parâmetro de entrada e saída, é necessário criar o ponto de extremidade de email.
Ativar o ponto de extremidade
Depois de criar um ponto de extremidade de email, você deve habilitá-lo. Quando o endpoint está ativado, ele pode ser usado para chamar o serviço. Depois de ativar o endpoint, você pode visualizá-lo no console de administração.
Consulte também
Adicionar um endpoint de email usando a API do Java
Inclusão de arquivos da biblioteca Java do AEM Forms
Configuração das propriedades de conexão
Adicione um endpoint de email usando a API do Java:
Inclua arquivos de projeto.
Inclua arquivos JAR do cliente, como adobe-livecycle-client.jar, no caminho da classe do seu projeto Java.
Crie um objeto Cliente EndpointRegistry.
ServiceClientFactory
objeto que contém propriedades de conexão.EndpointRegistryClient
usando seu construtor e passando o ServiceClientFactory
objeto.Defina os atributos do ponto de extremidade 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 ponto de extremidade.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 originado 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, você deve chamar a variável 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 transmita 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 introduzido nesta seção, consulte o exemplo de código Java localizado em Início rápido: Adicionar um endpoint de email usando a API do Java.
Defina os valores dos parâmetros de entrada.
Defina um valor de parâmetro de entrada chamando a função CreateEndpointInfo
do objeto setInputParameterMapping
e transmita os seguintes valores:
InDoc
.InDoc
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 a função CreateEndpointInfo
do objeto setOutputParameterMapping
e transmitindo os seguintes valores:
SecuredDoc
.SecuredDoc
parâmetro de saída é com.adobe.idp.Document
.%F.pdf
.Crie o endpoint de email .
Crie o ponto de extremidade chamando a variável EndpointRegistryClient
do objeto createEndpoint
e a aprovação do CreateEndpointInfo
objeto. Esse método retorna um Endpoint
objeto que representa o ponto de extremidade de email.
Habilite o endpoint .
Ative o endpoint chamando a função EndpointRegistryClient
do objeto enable
e a aprovação do Endpoint
objeto retornado pelo createEndpoint
método .
Consulte também
Início rápido: Adicionar um endpoint de pasta assistida usando a API Java
Inclusão de arquivos da biblioteca Java do AEM Forms
Configuração das propriedades de conexão
O Início rápido: Adicionar um endpoint de email usando a API do 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 email. O código Java a seguir representa o arquivo 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 obsoletas para formulários AEM no JEE.
Você pode adicionar um terminal Remoting programaticamente a um serviço usando a API Java do AEM Forms. Ao adicionar um terminal Remoting, você está permitindo que um aplicativo Flex chame o serviço usando o remoting. (Consulte Invocar o AEM Forms usando (obsoleto para formulários AEM) AEM Forms Remoting.)
Para fins de adicionar programaticamente um terminal Remoting a um serviço, considere o seguinte processo de curta duração chamado EncryptDocument.
Esse processo aceita um documento PDF não seguro como um valor de entrada e, em seguida, passa o documento 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 por 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 é com.adobe.idp.Document
. O nome do valor de saída (o documento PDF criptografado por senha) é SecuredDoc
e o tipo de dados é com.adobe.idp.Document
.
Para demonstrar como adicionar um terminal Remoting a um serviço, esta seção adiciona um terminal Remoting a um serviço chamado EncryptDocument.
Não é possível adicionar um terminal Remoting usando os serviços da Web.
Para remover um terminal 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 um aplicativo 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 seu 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 de cliente EndpointRegistry
Para adicionar um terminal Remoting programaticamente, você deve criar um EndpointRegistryClient
objeto.
Definir atributos de ponto de extremidade remoto
Para criar um terminal Remoting para um serviço, especifique os seguintes valores:
Remoting
.EncryptDocument
.Criar um terminal Remoting
Depois de definir os atributos de ponto de extremidade Remota, você pode criar um ponto de extremidade Remota para um serviço.
Ativar o ponto de extremidade
Depois de criar um novo terminal, você deve habilitá-lo. Quando um terminal Remoting é ativado, ele permite que um cliente Flex chame o serviço.
Consulte também
Adicionar um terminal Remoting usando a API Java
Inclusão de arquivos da biblioteca Java do AEM Forms
Configuração das propriedades de conexão
Adicione um terminal Remoting usando a API Java:
Inclua arquivos de projeto.
Inclua arquivos JAR do cliente, como adobe-livecycle-client.jar, no caminho da classe do seu projeto Java.
Crie um objeto Cliente EndpointRegistry.
ServiceClientFactory
objeto que contém propriedades de conexão.EndpointRegistryClient
usando seu construtor e passando o ServiceClientFactory
objeto.Defina os atributos do ponto de extremidade remoto.
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 ponto de extremidade.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 terminal Remoting, especifique um caractere curinga (*).Crie um terminal Remoting .
Crie o ponto de extremidade chamando a variável EndpointRegistryClient
do objeto createEndpoint
e a aprovação do CreateEndpointInfo
objeto. Esse método retorna um Endpoint
que representa o novo ponto de extremidade Remoto.
Habilite o endpoint .
Ative o endpoint chamando a função EndpointRegistryClient
do objeto enable
e a aprovação do Endpoint
objeto retornado pelo createEndpoint
método .
Consulte também
Início rápido: Adicionar um terminal Remoting usando a API Java
Inclusão de arquivos da biblioteca Java do AEM Forms
Configuração das propriedades de conexão
Você pode adicionar programaticamente um terminal TaskManager a um serviço usando a API Java do AEM Forms. Ao adicionar um ponto de extremidade do 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 Workspace pode chamar um processo que tem um ponto de extremidade do TaskManager correspondente.
Não é possível adicionar um ponto de extremidade do TaskManager usando serviços da Web.
Para adicionar um ponto de extremidade do 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 um aplicativo 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 seu 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 de cliente EndpointRegistry
Antes de poder adicionar programaticamente um ponto de extremidade do TaskManager, você deve criar um EndpointRegistryClient
objeto.
Criar uma categoria para o endpoint
As categorias são usadas para organizar serviços no Workspace. Ou seja, um usuário do Workspace pode chamar um serviço que tem um terminal TaskManager selecionando uma categoria no Workspace. Ao criar um ponto de extremidade 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 do TaskManager a um serviço.
Definir atributos de ponto de extremidade do TaskManager
Para criar um ponto de extremidade do TaskManager para um serviço, especifique os seguintes valores:
TaskManagerConnector
.invoke
.Criar um ponto de extremidade do Gerenciador de Tarefas
Depois de definir atributos de ponto de extremidade do TaskManager, você pode criar um ponto de extremidade do TaskManager para um serviço.
Ativar o ponto de extremidade
Depois de criar um novo terminal, você deve habilitá-lo. Quando o endpoint está ativado, ele pode ser usado para chamar o serviço de dentro do Workspace. Depois de ativar o endpoint, você pode visualizá-lo no console de administração.
Consulte também
Adicionar um ponto de extremidade do TaskManager usando a API do Java
Inclusão de arquivos da biblioteca Java do AEM Forms
Configuração das propriedades de conexão
Adicione um ponto de extremidade do TaskManager usando a API do Java:
Inclua arquivos de projeto.
Inclua arquivos JAR do cliente, como adobe-livecycle-client.jar, no caminho da classe do seu projeto Java.
Crie um objeto Cliente EndpointRegistry.
ServiceClientFactory
objeto que contém propriedades de conexão.EndpointRegistryClient
usando seu construtor e passando o ServiceClientFactory
objeto.Crie uma categoria para o endpoint .
Crie um CreateEndpointCategoryInfo
usando seu construtor e transmitindo os seguintes valores:
Crie a categoria chamando a variável EndpointRegistryClient
do objeto createEndpointCategory
e a aprovação do CreateEndpointCategoryInfo
objeto. Esse método retorna um EndpointCategory
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 ponto de extremidade.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 invocar o 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 do TaskManager.
Crie o ponto de extremidade chamando a variável EndpointRegistryClient
do objeto createEndpoint
e a aprovação do CreateEndpointInfo
objeto. Esse método retorna um Endpoint
objeto que representa o novo ponto de extremidade do TaskManager.
Habilite o endpoint .
Ative o endpoint chamando a função EndpointRegistryClient
do objeto enable
e a aprovação do Endpoint
objeto retornado pelo createEndpoint
método .
Consulte também
Início rápido: Adicionar um ponto de extremidade do TaskManager usando a API do Java
Inclusão de arquivos da biblioteca Java do AEM Forms
Configuração das propriedades de conexão
Você pode modificar programaticamente um terminal existente usando a API do AEM Forms Java. Ao modificar um endpoint, é possível alterar o comportamento do endpoint. Considere, por exemplo, um endpoint de Pasta assistida que especifica uma pasta que é usada como a pasta assistida. Você pode modificar programaticamente os valores de configuração que pertencem ao endpoint Pasta assistida, resultando em outra pasta funcionando como a pasta assistida. Para obter informações sobre os valores de configuração que pertencem a um endpoint de Pasta assistida, consulte Adicionar pontos de extremidade de pasta monitorada.
Para demonstrar como modificar um endpoint, esta seção modifica um endpoint de Pasta assistida alterando a pasta que se comporta como a pasta assistida.
Não é possível modificar um terminal 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 um aplicativo 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 seu 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 de cliente EndpointRegistry
Para modificar programaticamente um endpoint, você deve criar um EndpointRegistryClient
objeto.
Recuperar o ponto de extremidade para modificar
Antes de poder modificar um endpoint, você deve recuperá-lo. Para recuperar um terminal, você deve se conectar como um usuário que pode acessar um terminal. É recomendável conectar-se como um administrador. (Consulte Configuração das propriedades de conexão).
Você pode recuperar um ponto de extremidade recuperando uma lista de pontos de extremidade. Em seguida, você pode iterar pela lista, procurando pelo endpoint específico a ser removido. Por exemplo, você pode localizar um ponto de extremidade determinando o serviço que corresponde ao ponto de extremidade e o tipo de ponto de extremidade. Ao localizar o ponto de extremidade, você pode modificá-lo.
Especificar novos valores de configuração
Ao modificar um ponto de extremidade, especifique novos valores de configuração. Por exemplo, para modificar um endpoint de Pasta assistida, redefina todos os valores de configuração do endpoint de Pasta assistida, não apenas os que você deseja modificar. Para obter informações sobre os valores de configuração que pertencem a um endpoint de Pasta assistida, consulte Adicionar pontos de extremidade de pasta monitorada.
Para obter informações sobre os valores de configuração que pertencem a um ponto de extremidade de email, consulte Adicionar pontos de extremidade de email.
Não é possível modificar o serviço chamado pelo endpoint. Se você tentar modificar o serviço, uma exceção será lançada. Para modificar o serviço associado a um determinado terminal, remova o terminal e crie um novo. (Consulte Remoção de pontos finais.)
Consulte também
Modificação de um terminal usando a API do Java
Inclusão de arquivos da biblioteca Java do AEM Forms
Configuração das propriedades de conexão
Modifique um terminal usando a API do Java:
Inclua arquivos de projeto.
Inclua arquivos JAR do cliente, como adobe-livecycle-client.jar, no caminho da classe do seu projeto Java.
Crie um objeto Cliente EndpointRegistry.
ServiceClientFactory
objeto que contém propriedades de conexão.EndpointRegistryClient
usando seu construtor e passando o ServiceClientFactory
objeto.Recupere o terminal para modificar.
EndpointRegistryClient
do objeto getEndpoints
e a transmissão de um PagingFilter
que atua como filtro. Você pode passar uma (PagingFilter)null
para retornar todos os pontos finais. Esse método retorna um java.util.List
objeto no qual cada elemento é um Endpoint
objeto. Para obter informações sobre um PagingFilter
objeto, consulte Referência da API do AEM Forms.java.util.List
para determinar se há endpoints. Se houver pontos de extremidade, cada elemento é um EndPoint
instância.EndPoint
do objeto getServiceId
método . Esse 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 de extremidade for um ponto de extremidade de Pasta assistida, esse método retornará WatchedFolder
.Especifique novos valores de configuração.
Crie um ModifyEndpointInfo
chamando 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 de url, chame a função ModifyEndpointInfo
do objeto setConfigParameterAsText
e transmita 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 passe o ModifyEndpointInfo
objeto.
Consulte também
Início rápido: Modificação de um terminal usando a API do Java
Inclusão de arquivos da biblioteca Java do AEM Forms
Configuração das propriedades de conexão
Você pode remover programaticamente um terminal de um serviço usando a API Java do AEM Forms. Após remover um ponto de extremidade, o serviço não poderá ser chamado usando o método de invocação que o ponto de extremidade ativou. Por exemplo, se você remover um terminal SOAP de um serviço, não poderá chamar o serviço usando o modo SOAP.
Para demonstrar como remover um ponto de extremidade de um serviço, esta seção remove um ponto de extremidade EJB de um serviço chamado EncryptDocument.
Não é possível remover um terminal usando serviços da Web.
Para remover um terminal 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 um aplicativo 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 seu 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 de cliente EndpointRegistry
Para remover programaticamente um terminal, você deve criar um EndpointRegistryClient
objeto.
Recuperar o ponto de extremidade para remover
Antes de remover um terminal, é necessário recuperá-lo. Para recuperar um terminal, você deve se conectar como um usuário que pode acessar um terminal. É recomendável conectar-se como um administrador. (Consulte Configuração das propriedades de conexão).
Você pode recuperar um ponto de extremidade recuperando uma lista de pontos de extremidade. Em seguida, você pode iterar pela lista, procurando pelo endpoint específico a ser removido. Por exemplo, você pode localizar um ponto de extremidade determinando o serviço que corresponde ao ponto de extremidade e o tipo de ponto de extremidade. Ao localizar o ponto de extremidade, você pode removê-lo.
Remover o ponto de extremidade
Depois de criar um novo terminal, você deve habilitá-lo. Quando o endpoint está ativado, ele pode ser usado para chamar o serviço. Depois de ativar o endpoint, você pode visualizá-lo no console de administração.
Consulte também
Remoção de um terminal usando a API do Java
Inclusão de arquivos da biblioteca Java do AEM Forms
Configuração das propriedades de conexão
Remova um terminal usando a API do Java:
Inclua arquivos de projeto.
Inclua arquivos JAR do cliente, como adobe-livecycle-client.jar, no caminho da classe do seu projeto Java.
Crie um objeto Cliente EndpointRegistry.
ServiceClientFactory
objeto que contém propriedades de conexão.EndpointRegistryClient
usando seu construtor e passando o ServiceClientFactory
objeto.Recupere o ponto de extremidade a ser removido.
EndpointRegistryClient
do objeto getEndpoints
e a transmissão de um PagingFilter
que atua como filtro. Você pode passar (PagingFilter)null
para retornar todos os pontos finais. Esse método retorna um java.util.List
objeto no qual cada elemento é um Endpoint
objeto.java.util.List
para determinar se há endpoints. Se houver pontos de extremidade, cada elemento é um EndPoint
instância.EndPoint
do objeto getServiceId
método . Esse 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 de extremidade for um ponto de extremidade EJB, esse método retornará EJB
.Remova o ponto de extremidade.
Remova o ponto de extremidade chamando o EndpointRegistryClient
do objeto remove
e a aprovação do EndPoint
objeto que representa o ponto de extremidade a ser removido.
Consulte também
Início rápido: Remoção de um terminal usando a API do Java
Inclusão de arquivos da biblioteca Java do AEM Forms
Configuração das propriedades de conexão
Você pode recuperar programaticamente informações sobre conectores de ponto de extremidade 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 assistida permite que um terminal chame um serviço usando pastas assistidas. Ao recuperar programaticamente informações sobre conectores de ponto de extremidade, é 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 assistida. (Consulte Adicionar pontos de extremidade de pasta monitorada.)
Não é possível recuperar informações sobre endpoints usando serviços da Web.
Este tópico usa a variável ConnectorRegistryClient
API para recuperar informações sobre conectores de ponto de extremidade. (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 um aplicativo 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 seu 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 do servidor de aplicativos J2EE no qual o AEM Forms é implantado. Para obter informações sobre a localização de todos os arquivos AEM Forms JAR, consulte Inclusão de arquivos da biblioteca Java do AEM Forms.
Criar um objeto de 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. Os seguintes tipos de conectores existem:
Recuperar valores de configuração
Depois de especificar o tipo de conector, é possível recuperar informações sobre o conector, como o valor de configuração suportado. Por exemplo, para qualquer conector, você pode determinar quais valores de configuração são necessários e quais são opcionais.
Consulte também
Recuperar informações do conector do ponto de extremidade usando a API Java
Inclusão de arquivos da biblioteca Java do AEM Forms
Configuração das propriedades de conexão
Recupere informações do conector do ponto de extremidade usando a API Java:
Inclua arquivos de projeto. .
Inclua arquivos JAR do cliente, como adobe-livecycle-client.jar, no caminho da classe do seu projeto Java.
Crie um objeto Cliente ConnectorRegistry.
ServiceClientFactory
objeto que contém propriedades de conexão.ConnectorRegistryClient
usando seu construtor e passando o ServiceClientFactory
objeto.Especifique o tipo de conector.
Especifique o tipo de conector chamando a funçã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 de Pasta assistida, passe o valor da string WatchedFolder
. Esse método retorna um Endpoint
que corresponde ao tipo de conector.
Recupere os valores de configuração.
Endpoint
do objeto getConfigParameters
método . Esse 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 a variável ConfigParameter
do objeto isRequired
método . Se o valor de configuração for necessário, esse método retornará true
.Consulte também
Início rápido: Recuperação de informações do conector do ponto de extremidade usando a API Java
Inclusão de arquivos da biblioteca Java do AEM Forms
Configuração das propriedades de conexão