Como fazer para criar e publicar WebServices?

Data de postagem: Mar 31, 2011 7:52:55 PM

A partir da versão 9.1.0.3 do iEngine já é possível criar e publicar WebServices. A publicação é toda feita em java, enquanto que a implementação da regra de negócio é feita em iJavaScript no iEngine. A comunição entre o ambiente Java e o ambiente iJavaScript é feita através do protocolo HTTP. Antes de iniciar a leitura do passo-à-passo, recomendamos a leitura do artigo Como fazer para executar codigo Java no iEngine?. Segue abaixo o passo-à-passo que demonstra uma construção de um serviço:

Requisitos

Java SE Development Kit (JDK) 6 (http://java.sun.com/javase/downloads/index.jsp)

Eclipse Web Tools Platform - WTP (http://download.eclipse.org/webtools/downloads/)

Apache CXF 2.1.3 (Libs disponíveis na iVFS) (http://cxf.apache.org/download.html)

JSON-Lib 2.2.2-jdk15 (Libs disponíveis na iVFS) (http://json-lib.sourceforge.net/)

Passo-à-Passo

Iremos implementar um serviço de consulta por CPF, ao informar o CPF para o serviço será retornado um JSON com os dados da pessoa consultada.

• 1. Primeiramente criaremos a regra de negócio do WebService em um script iJavaScript:

  2. /**

  3. * Realiza um pesquisa por Entidade através do CPF e retorna os dados da Entidade Encontrada

  4. */

  5. //Tratamento para transformar o tipo Date em JSON deserializável pela JSON-Lib

  6. Date.prototype.toJson = function Date_toJson() {

  7. var json = '{

  8. "date": ' + this.getDate() + ',

  9. "day": ' + this.getDay() + ',

  10. "hours": ' + this.getHours() + ',

  11. "minutes": ' + this.getMinutes() + ',

  12. "month": ' + this.getMonth() + ',

  13. "seconds": ' + this.getSeconds() + ',

  14. "time": ' + this.getTime() + ',

  15. "timezoneOffset" : ' + this.getTimezoneOffset() + ',

  16. "year" : ' + this.getYear() + '

  17. }'

  18. return json

  19. }

  20. function execute() {

  21. var cpf = javaRequest.getParameter( "cpf" )

  22. var ds = connection.getDataSet(

  23. "Select

  24. NOME,

  25. NASCIMENTO,

  26. FONE,

  27. ENDERECO

  28. from

  29. ENTIDADE

  30. Where CGCCPF = '"+ cpf +"'"

  31. )

  32. var nascimento = !!ds.nascimento?ds.nascimento.toJson():"{}"

  33. var jsonEntidade = '{

  34. "nome" : "' + ds.nome + '",

  35. "nascimento": ' + nascimento + ',

  36. "fone": "' + ds.fone + '",

  37. "endereco": "' + ds.endereco + '"

  38. }'

  39. return jsonEntidade

  40. }

  41. execute()

  42. Note que foi adicionado um método chamado toJson() no protótipo Date(). Este método gera um JSON compatível com a classe java.lang.Date.

  43. Agora teremos que publicar o WebService, a publicação é feita em Java. Vamos lá: Crie um novo projeto do Eclipse(detalhes em: Como fazer para executar codigo Java no iEngine?) chamado MyService e adicione as seguintes javalibs no build path:

      1. commons-logging-1.1.1.jar

      2. cxf-2.1.3.jar

      3. geronimo-activation_1.1_spec-1.0.2.jar

      4. geronimo-annotation_1.0_spec-1.1.1.jar

      5. geronimo-javamail_1.4_spec-1.3.jar

      6. geronimo-servlet_2.5_spec-1.2.jar

      7. geronimo-ws-metadata_2.0_spec-1.1.2.jar

      8. jaxb-api-2.1.jar

      9. jaxb-impl-2.1.7.jar

      10. jaxws-api-2.1.jar

      11. jetty-6.1.9.jar

      12. jetty-util-6.1.9.jar

      13. neethi-2.0.4.jar

      14. saaj-api-1.3.jar

      15. saaj-impl-1.3.2.jar

      16. wsdl4j-1.6.2.jar

      17. wstx-asl-3.2.6.jar

      18. stax-api-1.0.1.jar

      19. xml-resolver-1.2.jar

      20. XmlSchema-1.4.2.jar

      21. enginelet-2.0.jar

      22. commons-beanutils.jar

      23. commons-beanutils-bean-collections.jar

      24. commons-beanutils-core.jar

      25. commons-collections-3.2.jar

      26. commons-lang-2.3.jar

      27. commons-logging-adapters-1.1.1.jar

      28. commons-logging-api-1.1.1.jar

      29. ezmorph-1.0.4.jar

      30. json-lib-2.2.2-jdk15.jar

      31. PS: As javalibs poderam ser obtidas a partir da iVFS. O artigo Como fazer para executar codigo Java no iEngine? mostra como obter elas no primeiro item do passo-à-passo.

  44. Selecione a pasta de src do projeto e crie um novo pacote. Vá em File/New/Package..., informe o nome "br.com.unum.engine.webservice.teste" para o pacote e clique no botão Finish.

  45. Selecione o pacote criado e cria um crie um classe chamada Entidade.

  46. Implemente a classe Entidade da seguinte forma:

  47. package br.com.unum.engine.webservice.teste;

  48. import java.util.Date;

  49. public class Entidade {

  50. private String nome;

  51. private Date nascimento;

  52. private String fone;

  53. private String endereco;

  55. public void setNome(String nome) {

  56. this.nome = nome;

  57. }

  59. public String getNome() {

  60. return nome;

  61. }

  63. public void setNascimento(Date nascimento) {

  64. this.nascimento = nascimento;

  65. }

  67. public Date getNascimento() {

  68. return nascimento;

  69. }

  71. public void setFone(String fone) {

  72. this.fone = fone;

  73. }

  75. public String getFone() {

  76. return fone;

  77. }

  79. public void setEndereco(String endereco) {

  80. this.endereco = endereco;

  81. }

  83. public String getEndereco() {

  84. return endereco;

  85. }

  86. }

  87. DICA: O Eclipse ajuda a implementar os métodos get's e set's. Basta digitar get e teclar CTRL+Espaço para auto-completar.

  88. Este JavaBean será utilizada na deserialização do JSON retornado pelo script da regra de negócio.

  89. Crie uma interface chamada MyService. Vá em File/New/Interface..., informe o nome MyService para a interface e clique no botão Finish.

  90. Codifique a interface da seguinte maneira:

  91. package br.com.unum.engine.webservice.teste;

  92. import javax.jws.WebParam;

  93. import javax.jws.WebService;

  94. @WebService

  95. public interface MyService {

  96. public String obterEntidadePorCPF( @WebParam(name="cpf") String cpf );

  97. }

  98. As anotações @WebServie e @WebParam são fundamentais para a publicação do WebService. A anotação @WebService indica que a interface é um WebService e a anotação @WebParam serve para informar o nome do parametro para o gerador do WSDL.

  99. Crie um classe chamada MyServiceImpl que implemente a interface MyService.

1. Codifique a classe MyServiceImpl da seguite forma:

   1. package br.com.unum.engine.webservice.teste;

   2. import java.util.HashMap;

   3. import javax.jws.WebService;

   4. import br.com.inteq.engine.ieji.IEngineJavaInterface;

   5. import net.sf.json.JSONObject;

   6. @WebService(endpointInterface="br.com.unum.engine.webservice.teste.MyService", serviceName="MyService")

   7. public class MyServiceImpl implements MyService {

   8. public Entidade obterEntidadePorCPF(String cpf) {

   9. try {

   10. Entidade entidade;

   11. HashMap<String, String> parametes = new HashMap<String, String>();

   12. parametes.put("cpf", cpf);

   13. String entidadeJson = IEngineJavaInterface.runScript(<Chave do script javascript do passo 1>, parametes);

   14. JSONObject entidadeJsonObj = JSONObject.fromObject(entidadeJson);

   15. entidade = (Entidade)JSONObject.toBean(entidadeJsonObj, Entidade.class);

   16. return entidade;

   17. } catch (RunScriptException e) {

   18. e.printStackTrace();

   19. return null;

   20. }

   21. }

   22. }

   23. Tudo que o método obterEntidadePorCPF faz é executar o script que contém a regra de negócio no iEngine, e o JSON retornado pelo script é deserializado pelo biblioteca json-lib na JavaBean Entidade.

   24. A anotação @WebService, serve para indicar qual a interface do serviço e o nome do serviço que irá ser publicado no WSDL.

   25. Gere o JAR do WebService. O artigo Como fazer para executar codigo Java no iEngine? mostra com gerar arquivos JAR usando o ANT no Eclipse;

   26. Agora copie o JAR gerado para a pasta <Diretório do iEngine>\javalibs, se você não importou o JAR para a iVFS você deve usar criar o arquivo .ignoresync;

2. Agora você deve publicar o serviço no JavaServer. JavaServer e o servidor HTTP Java integrado ao iEngine que publica Web Services. Há três formas de publicar Web Services:

   2. 1. Atráves do processo Ir Para\Desenvolvimento\Web Services\Web Services Publicados: Sigua as instruções de ajuda do processo.

      2. Através do código javascript usando a API JavaServer(recomendavél usar durante o desenvolvimento):

         1. • Use javaServer.publishService( serviceUrl, serviceJavaClass ) para publicar um Web Service. Ex: javaServer.publishService( "http://127.0.0.1:8081/myservice", "br.com.unum.engine.webservice.teste.MyServiceImpl" ). Note que a classe java que deve ser usada é a classe que implementa a interface do serviço.

            • Use javaServer.unpublishService( serviceUrl ) para despublicar um Web Service. Ex.: javaServer.unpublishService( "http://127.0.0.1:8081/myservice" )

            • Use javaServer.listServices() para listar os Web Services publicados.

• 1. Através da auto-inicialização de Web Services Ir Para\Desenvolvimento\Web Services\Auto inicialização de Web Services: O processo de auto-inicialização serve para cadastrar Web Services que seram inicializados a automaticamente por uma determinada instância do iEngine. Sigua as instruções de ajuda do processo.

  2. Você poderá conferir o WSDL de publicação do Web Service acessando a URL: http://127.0.0.1:8081/myservice?wsdl;

  3. Em anexo o código da parte desenvolvida em java do exemplo desenvolvido neste artigo;

  4. Tela demonstrando a consumação do Web Service deste artigo na plataforma .NET: