Utilizando Objetos de Integração

Este capítulo apresenta os Objetos de Integração, que são Java™ beans que encapsulam interações com um aplicativo do host. Os Objetos de Integração são suportados apenas pelos aplicativos da Web do HATS, incluindo os portlets do HATS.

Nota:
Variáveis globais e modelos não são suportados para Objetos de Integração utilizados nos portlets padrão do HATS.

Se você já utilizou o IBM® WebSphere Host Publisher, já está familiarizado com a maioria dos aspectos dos Objetos de Integração, mas terá que aprender sobre como são utilizados no HATS. Não precisa ser um desenvolvedor experiente do Host Publisher para criar e utilizar Objetos de Integração no HATS.

Se seu aplicativo HATS transformar um simples aplicativo do host, sem conexões secundárias, você não precisará utilizar os Objetos de Integração. Você pode precisar utilizar Objetos de Integração se qualquer dessas instruções forem verdadeiras:

Depois que você criou um Objeto de Integração, pode utilizá-lo de muitas maneiras:

Consulte o HATS Web Application Programmer's Guide para obter informações sobre outras tarefas avançadas que podem ser executadas com Objetos de Integração. Algumas das tarefas discutidas são:

Criando um Objeto de Integração

Um Objeto de Integração é criado a partir de uma macro. Siga as etapas descritas em Macros e Terminal Host para gravar uma macro.

Clique com o botão direito na macro na visualização Projetos HATS e selecione Criar Objeto de Integração. O Objeto de Integração terá o mesmo nome que a macro. Você também pode definir uma preferência no HATS para gerar automaticamente um Objeto de Integração quando uma macro for gravada. Clique em Janela > Preferências, expanda HATS na árvore à esquerda e clique em Objeto de Integração. Selecione a caixa rotulada Gerar Objeto de Integração Automaticamente ao Salvar Macro, em seguida, clique em Aplicar.

Ao nomear uma macro utilizada para criar um Objeto de Integração, certifique-se de seguir estes requisitos:

Notas:
  1. Os Objetos de Integração gerados automaticamente são sempre não encadeados.
  2. Para obter informações sobre a criação de Objetos de Integração ao utilizar o suporte a DBCS, consulte Criando um Objeto de Integração.

Os Objetos de Integração não podem ser criados a partir de macros encadeadas. O encadeamento de Objetos de Integração é bem diferente do encadeamento de macros, no qual cada Objeto de Integração em uma cadeia deve ser executado até a conclusão antes que o próximo Objeto de Integração na cadeia assuma o controle. O encadeamento de macros, utilizando a ação executar macro do HATS, encerra a macro atual (aquela na qual a ação executar macro ocorre) e inicia o processo da tela da macro especificada da macro de destino. Se você importar uma macro do Host On-Demand que contém a tag <playmacro name="chainedMacroName"/>, poderá utilizar apenas esta macro nas ações executar macro e desempenhar transação da macro do HATS. Consulte HATS Advanced Macro Guide para obter informações adicionais sobre o encadeamento de macros.

Se uma macro for alterada utilizando o editor de macro, após a criação de um Objeto de Integração para essa macro específica, o Objeto de Integração precisará ser gerado novamente para refletir a alteração com exatidão. Se a preferência Gerar Automaticamente o Objeto de Integração ao Salvar a Macro for selecionada, o Objeto de Integração será atualizado automaticamente.

Para ver uma lista de Objetos de Integração que você criou, clique na guia da visualização Projetos HATS do HATS Toolkit e expanda o nome do projeto, em seguida, acesse Origem > IntegrationObject e clique duas vezes na pasta para visualizar os conteúdos.

Nota:
A pasta IntegrationObject em Origem fica visível apenas após a criação de seu primeiro Objeto de Integração.

Encadeamento do Objeto de Integração

O encadeamento do Objeto de Integração permite que você crie vários Objetos de Integração, que podem ser agrupados numa única tarefa principal no seu aplicativo Host Access Transformation Services. Cada Objeto de Integração executa uma subtarefa, e a tarefa principal é executada por uma cadeia do Objeto de Integração. Quando o aplicativo é executado, os Objetos de Integração são executados na seqüência, todos utilizando a mesma conexão.

Quando você clica na macro para criar o Objeto de Integração, selecione Criar Objeto de Integração em Cadeia. Então especifique se o Objeto de Integração é o primeiro, do meio ou último na cadeia. Deve haver mais de um Objeto de Integração do meio em uma cadeia. Digite as etiquetas que identificam os estados de início e parada para este Objeto de Integração. Não há etiqueta de estado de início para o Objeto de Integração que esteja em primeiro em sua cadeia, e não há etiqueta de estado de parada para um Objeto de Integração que esteja em último em sua cadeia. As etiquetas de estado são necessários para garantir que os Objetos de Integração em uma cadeia sejam processados na ordem correta, com os dados corretos transmitidos de cada vez.

Esta seção descreve o encadeamento do Objeto de Integração em detalhes e mostra como utilizá-lo em seus aplicativos do HATS.

Decidindo Quando Utilizar o Encadeamento de Objetos de Integração

Para determinar quantos Objetos de Integração são necessários na cadeia, comece listando todas as subtarefas que precisam ser executadas. Por exemplo, imagine um aplicativo do host chamado fileview que, quando invocado, exibe uma lista de arquivos. Na lista de arquivos, um usuário pode selecionar qualquer arquivo digitando 1 ao lado do nome desse arquivo, pressionando Enter, e visualizando seu conteúdo. Existem duas tarefas a serem desempenhadas:

  1. Obter a lista de arquivos a ser apresentada ao usuário.
  2. Obter detalhes de um arquivo selecionado.

São necessárias duas macros pois o usuário deve decidir-se antes da segunda macro poder ser executada. A segunda macro deve aguardar pela entrada do usuário. A primeira etapa na separação das tarefas em Objetos de Integração individuais é definir onde será necessária a entrada do usuário.

Se o usuário tiver várias opções e cada uma causar ações diferentes do host, então cada opção deverá ser um Objeto de Integração separado. Em seguida, é possível reunir dinamicamente os Objetos de Integração, dependendo das seleções do usuário. Um exemplo disso é um menu com cinco itens. Se o usuário tiver permissão para selecionar uma das cinco opções, cada seleção deverá ser criada como um Objeto de Integração independente.

Depois de inteirar-se sobre o número de tarefas distintas, você poderá decidir como o encadeamento afetará seu aplicativo. Se houver mais de duas tarefas, o encadeamento poderá ajudar a melhorar o tempo de resposta do aplicativo ou diminuir a quantidade de registro de macro a ser executada, reduzindo, assim, a complexidade geral dos Objetos de Integração.

Utilizando o Encadeamento de Objetos de Integração

O Objeto de Integração em uma cadeia deixa a conexão em um estado (em uma determinada tela). Finalizada a execução do Objeto de Integração, outro Objeto de Integração que comece nesse estado (ou seja, nessa tela) pode ser executado.

Você pode utilizar o encadeamento para dividir o aplicativo complexo em várias tarefas, cada uma representada por um Objeto de Integração. Você deve assegurar que a ordem dos Objetos de Integração esteja correta.

Por exemplo, se houver três Objetos de Integração em uma cadeia (A, B e C), utilize primeiro A, depois B e por último C. Se o Objeto de Integração C for invocado antes do Objeto de Integração B, quando C solicitar conexão, ela não estará disponível no estado correto, provocando falha no Objeto de Integração.

Figura 64. Duração da Conexão com Encadeamento
duração da conexão com encadeamento

A Figura 64 representa a duração de uma conexão na execução de três Objetos de Integração. O Objeto de Integração A está configurado como primeiro, o B como o intermediário e o C como o último. Os dados de estado da conexão representam a conexão e a etiqueta do estado do último Objeto de Integração executado.

  1. Quando o Objeto de Integração A começa a executar, ele recupera a conexão especificada na macro. Se a tela de registro de entrada estiver ativada e uma conexão estiver disponível, a conexão já estará estabelecida e pronta. Se a tela de registro de entrada estiver ativada, mas uma conexão não estiver disponível, a conexão será criada e a macro de conexão (se especificada) será executada. Se a tela de registro de entrada estiver desativada, uma conexão será criada e a macro de conexão (se especificada) será executada.
  2. O Objeto de Integração A executa a macro associada e depois salva a conexão e seu estado atual para a próxima invocação. (Você definiu esse estado como a etiqueta de estado parado durante o encadeamento do Objeto de Integração).
  3. Quando o Objeto de Integração B começa a ser executado, ele recupera uma conexão e seu estado a partir dos dados de estado da conexão pois ele é o Objeto de Integração intermediário. Você deve ter definido a etiqueta de estado inicial do Objeto de Integração B como a etiqueta de estado final do Objeto de Integração A, o que permite o encadeamento desses Objetos de Integração.
  4. Quando a execução do Objeto de Integração B é concluída, a conexão e seu estado são salvos nos dados de estado de conexão.
  5. O Objeto de Integração C também recupera a conexão dos dados de estado da conexão. Quando o Objeto de Integração C começa a ser executado, ele recupera uma conexão e seu estado a partir dos dados de estado da conexão pois ele é o último Objeto de Integração. Você deve ter definido a etiqueta de estado inicial do Objeto de Integração C como a etiqueta de estado final do Objeto de Integração B, o que permite o encadeamento desses Objetos de Integração. Os Objetos de Integração com a última posição na cadeia não possuem etiquetas finais porque a conexão é sempre retornada.
  6. Quando a tela de registro de entrada é ativada, a conexão retorna ao conjunto; caso contrário, a macro de desconexão (se especificada) é executada e a conexão é encerrada.
Nota:
As configurações para a tela de registro de entrada são feitas acessando a guia Macro das configurações da sua conexão. É necessário ativar o pooling para que a definição da tela de registro de entrada fique disponível. Para obter informações adicionais, consulte Editor de Conexão.

Para construir um aplicativo utilizando o encadeamento do Objeto de Integração com o HATS, você precisa primeiro construir os Objetos de Integração e então criar suas páginas da Web a partir dos Objetos de Integração.

Siga estas etapas para criar seu aplicativo.

  1. Registrar macros.
  2. Criar Objetos de Integração encadeados a partir de cada macro.
  3. Criar Páginas da Web para cada Objeto de Integração.
Registrar uma Macro

Você pode registrar macros em HATS Toolkit utilizando o terminal do host do HATS. Na tela do terminal do host do HATS, clique no ícone Registrar Macro. Para obter informações sobre a gravação de macros, consulte Ícones Relacionados a Macro.

Repita essas etapas para cada Objeto de Integração que deseja criar.

Criar Objetos de Integração a partir de Cada Macro
Depois de criadas todas as suas macros, você pode ir para a guia Visualização Proj. HATS do HATS Toolkit e expandir o nome do projeto e abrir a pasta Macros.

Clique com o botão direito em cada macro individual e selecione Criar o Objeto de Integração Encadeado. Você terá a opção de selecionar a posição na cadeia de objeto para Primeiro, Meio ou Último. Se selecionar Primeiro, o estado será parado durante a configuração do encadeamento do Objeto de Integração. Se você selecionar Meio, o estado pode ser de início, ou de parada. A posição Último da cadeia do objeto utiliza o estado de início.

Isso precisa ser feito para todos os Objetos de Integração que são parte da cadeia.

Criar Páginas da Web a partir de Cada Objeto de Integração.
Depois de ter criado seus Objetos de Integração, você pode então criar suas páginas da Web. Para obter informações sobre a criação de páginas da Web a partir de Objetos de Integração, consulte Criando Páginas da Web a partir de um Objeto de Integração.

Depurando Aplicativos que Utilizam o Encadeamento de Objetos de Integração

Enquanto o encadeamento de Objetos de Integração é uma ferramenta poderosa para modelar a maioria dos aplicativos complexos do host, cuidado ao montar os aplicativos. Há o risco de criar um aplicativo Java EE com Objetos de Integração chamados fora de ordem; portanto, você deve estar ciente dos erros que são obtidos no servidor quando isso acontece.

Se os Objetos de Integração forem encadeados inadequadamente, você terá problemas ao executar seu Objeto de Integração. A seguir estão as mensagens de erro que poderão ser exibidas no servidor e como depurá-las.

HPS5075 Recebido STATE_PLAY_ERROR durante a reprodução da macro no arquivo zzz.macro
Esse erro ocorre quando a macro falha ao ser reproduzida por não corresponder à tela atual. Isso poderá acontecer se um Objeto de Integração de uma cadeia for invocado na ordem correta (foi encontrada uma conexão em uma cadeia específica para seu uso), mas a própria macro falhar durante a reprodução. Poderá ser um problema se as etiquetas de estado inicial e final forem as mesmas, até mesmo para dois Objetos de Integração, e você invocar os objetos fora da ordem lógica.
HPS5035 Não há objeto de fonte de dados {0} na HttpSession. Uma causa possível é o uso de vários navegadores a partir de uma única máquina para um aplicativo encadeado. Consulte a documentação para obter informações adicionais.
Esse erro ocorre quando um Objeto de Integração com uma etiqueta de estado inicial do último estado do Objeto de Integração falha ao obter a conexão e seu estado porque sua etiqueta de estado inicial não corresponde à etiqueta de estado final do Objeto de Integração precedente.

Quando isso acontecer, verifique porque seu Objeto de Integração está sendo invocado fora de ordem.

Criando Páginas da Web a partir de um Objeto de Integração

Você pode criar um JSP a partir de qualquer Objeto de Integração. Existem três abordagens para a construção destas páginas; elas são chamadas de Modelo 1, JSF e Struts. As seções a seguir descrevem estas três abordagens e como criar páginas utilizando-as.

Criar Páginas da Web do Modelo 1

A abordagem tradicional do HATS para construir uma JSP é chamada Modelo 1.

Nota:
Esta é a única abordagem suportada para portlets padrão do HATS.

Nesse modelo, uma JSP única contém:

Na visualização Projetos HATS, clique com o botão direito no nome de um Objeto de Integração e selecione Criar Páginas da Web do Modelo 1. Especifique os nomes de página de entrada e saída junto com o destino ou aceite os nomes padrão criados a partir do nome do Objeto de Integração. Também é possível especificar Opções de Geração de Páginas, selecionando Anexar a Arquivos Existentes ou Sobrescrever Arquivos Existentes. Clique em Avançar após concluir sua seleções.

Ao criar páginas da Web do Modelo 1, você define duas páginas: uma página de entrada, que reúne os dados requeridos pelo Objeto de Integração, e uma página de saída, que apresenta os resultados após a execução do Objeto de Integração.

Na página Definir Entradas, é possível definir um controle de entrada para cada propriedade de controle. Para alterar um controle, selecione uma propriedade de entrada e clique em Editar. É possível incluir um texto inicial para o controle e, onde necessário, configure o controle selecionado. Ao invés de utilizar um controle de entrada, você pode escolher configurar a propriedade de entrada com o valor de uma variável global. Você também tem a opção de armazenar o valor da propriedade de entrada como uma variável global (as variáveis globais utilizadas pelos Objetos de Integração são compartilhadas). Quando a página de entrada é executada, ela não transmite o controle diretamente à página de saída; ela retorna o controle ao aplicativo do HATS permitindo que as variáveis globais sejam configuradas e outras ações sejam realizadas conforme necessário.

Nota:
Se sua macro não contiver prompts, não haverá nenhuma página de entrada.

Na página Definir Saídas, você seleciona as propriedades de saída do Objeto de Integração que deseja exibir. Para alterar um controle, selecione uma propriedade de saída e clique em Editar. É possível incluir o texto inicial para o controle. A JSP de saída contem o código para inicializar o Objeto de Integração, para configurar as propriedades do Objeto de Integração a partir das variáveis globais, para executar o Objeto de Integração e exibir a saída do Objeto de Integração.

As páginas criadas vão para a pasta Conteúdo da Web/Páginas do Modelo 1 na visualização Projetos HATS. Para editar uma página da Web e chamar o Designer de Páginas, dê um clique duplo no nome da página. Para testar suas páginas, clique com o botão direito do mouse na página de entrada (ou página de saída se não houver entradas) e selecione Depurar no Servidor ou Executar no Servidor.

Nota:
Ao utilizar páginas da Web do Modelo 1 para Objetos de Integração nos projetos de portlet padrão do HATS, observe as seguintes considerações:

Criar Páginas da Web do Struts

Se tiver instalado o recurso Struts Tools do Rational SDP, o HATS permite que você utilize Struts para construir páginas da Web com base nos Objetos de Integração.

Nota:
Esta abordagem não é suportada para portlets padrão do HATS.

Na visualização Projetos HATS, clique com o botão direito no nome de um Objeto de Integração e selecione Criar Páginas da Web de Struts. Especifique o nomes para páginas de entrada e saída, ou aceite os nomes padrão criados a partir do nome do Objeto de Integração. Clique em Concluir.

Quando criar páginas da Web no Struts, o HATS gera cinco arquivos:

Classe Struts Action
Esta classe é a classe principal. Ela instancia o Objeto de Integração, configura as propriedades de Objetos de Integração utilizando valores na classe ActionForm, configura o nome do grupo do Objeto de Integração e executa o Objeto de Integração. Então encaminha o JSP de saída, ou se houver um erro, o retorna ao tempo de execução do HATS e permite que o tempo de execução do HATS identifique o erro. O desenvolvedor não deve modificar esta classe.
Classe ActionForm
Esta classe contém setters e getters de cada entrada no JSP. O JSP de entrada envia ao Struts Servlet, que instancia a classe ActionForm e define todas as suas propriedades baseada em entradas enviadas do formulário JSP. Essa classe é utilizada pela classe Ação para definir todas as propriedades de Objetos de Integração. Se você incluir ou remover as propriedades de entrada do JSP de entrada, deverá incluir ou remover os setters e getters correspondentes deste arquivo.
JSP de Entrada
O JSP de entrada contém formulário HTML de Struts que será utilizado para enviar o pedido ao Struts Controller, que cria um ActionForm e encaminha o pedido à classe Ação apropriada. Se o Objeto de Integração não precisar de nenhuma entrada, ou se as entradas vierem com fontes diferentes, como de variáveis globais, um JSP de entrada vazio será criado contendo apenas o formulário HTML. A página de entrada será criada na pasta Páginas do Struts. Para testar suas páginas, abra a pasta e localize a página que criou. Clique com o botão direito na página e selecione Executar no Servidor.
JSP de Saída
O JSP de saída exibe as propriedades de saída do Objeto de Integração. Esta página é similar ao Modelo 1 do JSP de saída.
WebDiagram
Este arquivo exibe o fluxo e a lógica do Struts baseado em páginas da Web. Consulte a documentação da ferramenta do Struts no Rational SDP para obter informações adicionais sobre a modificação do Diagrama da Web.

O HATS também adiciona um mapeamento de ação para o arquivo struts-config.xml associar a classe Ação à classe ActionForm.

O Struts foi desenvolvido como parte do projeto Jakarta do Apache Software Foundation. Para obter informações detalhadas sobre Struts, consulte http://jakarta.apache.org/struts bem como o conteúdo da ajuda do Rational SDP.

Criar Páginas da Web JSF

JSF (JavaServer Faces) é uma estrutura para o desenvolvimento de UIs (Interfaces com o Usuário) para aplicativos da Web executados em um servidor Java. É possível construir rapidamente aplicativos da Web montando componentes de UI reutilizáveis em uma página. Depois de criar páginas da Web JSF, é possível utilizar ferramentas como o Designer de Páginas e a paleta para modificações e edição.

Nota:
Esta abordagem não é suportada para portlets padrão HATS ou portlets IBM do HATS.

Na visualização Projetos HATS, clique com o botão direito no nome de um Objeto de Integração e selecione Criar Páginas da Web JSF. Especifique nomes para páginas de entrada e de saída e também o destino ou aceite os nomes padrão criados a partir do nome do Objeto de Integração. Você também pode Sobrescrever Arquivos Existentes selecionando a caixa de opções. Clique em Avançar após concluir sua seleções.

Ao criar páginas da Web JSF, você define duas páginas: uma página de entrada, que reúne dados requeridos pelo Objeto de Integração, e uma página de saída, que apresenta os resultados após a execução do Objeto de Integração.

Para a página de entrada, é possível definir um controle de entrada para cada propriedade de entrada. Para alterar um controle, selecione uma propriedade de entrada e clique em Editar. É possível incluir um texto inicial para o controle e, onde necessário, configure o controle selecionado. Clique em Avançar.

Para a página de saída, você seleciona as propriedades de saída do Objeto de Integração que deseja exibir. Para alterar um controle, selecione uma propriedade de saída e clique em Editar. É possível incluir o texto inicial para o controle. Clique em Concluir.

As páginas criada vão para a pasta Conteúdo da Web/Páginas JSF na visualização Projetos HATS. Para editar uma página da Web e chamar o Designer de Páginas, dê um clique duplo no nome da página. Para testar suas páginas, clique com o botão direito do mouse na página de entrada (ou página de saída se não houver entradas) e selecione Depurar no Servidor ou Executar no Servidor.

BasicIOErrorPage.jsp e AdvancedIOErrorPage.jsp

O BasicIOErrorPage é a página de erro padrão utilizada pelos JSPs que conduz os Objetos de Integração. Se ocorrer um erro, ele retornará informações básicas ao navegador sobre a natureza do erro. A conexão de backend é descartada automaticamente neste processo.

O AdvancedIOErrorPage.jsp permite que a conexão seja transmitida ao servlet de entrada do HATS para uma transformação padrão se a conexão tiver sido criada a partir da definição de conexão padrão. Esse processo permite que você interaja com a conexão backend e determine possivelmente porque ocorreu o erro. A transformação padrão também oferece a você a capacidade de desconectar a conexão. Basicamente, o AdvancedIOErrorPage.jsp oferece mais controle sobre o processo quando um Objeto de Integração encontra um erro.

Você pode localizar estas páginas de erro na visualização Navegador, na pasta Conteúdo da Web de seu projeto.

Trabalhando com Objetos de Integração em JSPs

Estas funções de ferramentas do HATS são aplicáveis durante o trabalho com Objetos de Integração em JSPs. Você pode selecionar os itens listados abaixo utilizando o menu Ferramentas do HATS na barra de menus do HATS Toolkit.

Inserir Propriedades do Objeto de Integração

É possível incluir a entrada e a saída do Objeto de Integração em sua JSP de transformação.

Entrada

Selecione Inserir Propriedades do Objeto de Integração > Entrada quando desejar incluir uma entrada do Objeto de Integração em um JSP. Na página Selecionar Classe de Objeto de Integração, insira o nome da classe do Objeto de Integração que deseja utilizar e a página de destino que é exibida quando o usuário envia o formulário de entrada. Clique em Avançar. Na página Definir Entradas, para alterar um controle, selecione uma propriedade de entrada e clique em Editar. Aqui você pode definir a introdução, selecionar um controle de entrada apropriado e configurá-lo, se necessário, e pode armazenar o valor como uma variável global.

Saída

Selecione Inserir Propriedades do Objeto de Integração > Saída quando desejar incluir uma saída do Objeto de Integração em um JSP. Na página Selecionar Classe do Objeto de Integração, insira o nome da classe do Objeto de Integração que deseja utilizar e clique na caixa de opção Inserir Métodos de Transação do Objeto de Integração para incluir os métodos de transação que executam Objetos de Integração. Clique em Avançar. Na página Definir Saída, para alterar um controle, selecione uma propriedade de saída e clique em Editar. Aqui, é possível definir o texto inicial e selecionar um controle de saída apropriado.

Uma variável global do HATS contém um valor que pode ser utilizado para transmitir informações de um objeto do HATS para outro. Se desejar transmitir dados de saída do Objeto de Integração para outro objeto do HATS, é necessário incluir código no JSP de saída utilizado para conduzir o Objeto de Integração. É necessário incluir o código após a execução bem-sucedida do Objeto de Integração, por exemplo:

<%
IOGV.setGlobalVariableString(session, "exampleGV", 
exampleIO.getOutputData());
%>

Neste exemplo, à variável global compartilhada denominada exampleGV é designado o valor da propriedade OutputData do Objeto de Integração exampleIO.

A variável global utilizada em um ambiente do Objeto de Integração deve ser definida como uma variável global compartilhada. O código no exemplo cria a variável global compartilhada se ela ainda não existir.

Inserir Redirecionar para Aplicativo do HATS

Selecione Inserir Redirecionamento para o Aplicativo HATS para incluir um botão em sua transformação que encaminha informações de controle JSP de volta para o aplicativo HATS, seja um aplicativo da Web ou um portlet padrão, que seu usuário iniciou. Por exemplo, você pode querer devolver o controle para o aplicativo do HATS depois que uma JSP aciona um Objeto de integração e desempenha uma tarefa designada. Você pode editar os atributos deste botão na exibição Design realçando o botão, clicando com o botão direito do mouse e selecionando Atributos.