Web Services

Um serviço é uma funcionalidade de um sistema de informação que pode ser invocada remotamente através da rede.
Um Web Service é um serviço que usa os protocolos de comunicação da World Wide Web - HTTP sobre TCP sobre IP - e protocolos adicionais para descrever mensagens e dados - SOAP sobre XML.

Para permitir uma definição rigorosa das operações e dos tipos de dados dos Web Services são usadas as linguagens WSDL (Web Services Description Language) e XSD (XML Schema Definition), respetivamente.

Para a publicação e pesquisa de Web Services usa-se um servidor de nomes que implementa a norma UDDI (Universal Description, Discovery and Integration). No Sun RPC usa-se o rpcbind, no Java RMI usa-se o rmiregistry, nos Web Services usa-se o jUDDI (Java UDDI).

Para uma explicação mais detalhada destas tecnologias, ver:

• Livro de Couloris, Capítulo 9
• UDDI

 

JAX

As bibliotecas JAX (Java API for XML) são a família de bibliotecas da plataforma Java que lidam com tecnologias baseadas em XML, como é o caso dos Web Services.

A JAX-WS (Java API for XML Web Services) é uma biblioteca para Java que permite implementar Web Services, usando as normas: HTTP/TCP/IP para mensagens, SOAP/XML para mensagens, WSDL e XSD para descrição.

Para comunicar com servidores UDDI, existe a biblioteca JAX-R (Java API for XML Registries), que permite publicar, pesquisar e eliminar registos de Web Services.

Para uma explicação mais detalhada destas tecnologias, ver:

• JAX-WS
• JAX-R

O esquema de dados do UDDI é consideravelmente mais rico do que o habitual num servidor de nomes, com diversas entidades e relações, que permitem guardar informação de negócio sobre a organização e os seus serviços. Como consequência, o JAX-R é uma biblioteca verbosa, que obriga a escrever muitas linhas de código para realizar as tarefas mais habituais de registo e de pesquisa.

Para tornar a utilização do UDDI mais simples foi criada a biblioteca UDDINaming que simplifica o esquema de dados para suportar apenas:
1 organização, 1 serviço e 1 implementação.
Esta biblioteca, cujo código está disponível para consulta e modificação, torna o registo e pesquisa de serviços mais sucinto.

 

---

Exemplo

Vamos então ver um exemplo de um Web Service feito em Java, que usa a biblioteca UDDINaming para comunicar com o servidor de nomes.

Nota: As pastas que contêm o código não devem ter espaços no seu caminho.

1. jUDDI
• O servidor de nomes a utilizar é o jUDDI (Java UDDI), que faz parte do software que se pediu para instalar.
• Para lançar o servidor, basta executar o seguinte comando na pasta juddi-.../bin:
• startup.sh (Linux e Mac)
• startup.bat (Windows)
• Para confirmar funcionamento, aceder à página de índice do jUDDI, que dá também acesso à interface de administração
  http://localhost:9090/juddiv3/
• utilizador:senha uddiadmin:da_password1
2. UDDINaming
• Obter o código da biblioteca UDDINaming: [atualizado em 2016-04-26]
  (versão 1.1 corrige bug em unbind quando se usava com wild-card (%) e
  acrescenta operação listRecords que permite obter vários registos e saber o par (nome,URL) obtido em cada resultado)
• Biblioteca uddi-naming
• Consultar javadoc
• Instalar o módulo no repositório Maven local:
  • cd uddi-naming
  • mvn install
• A biblioteca inclui um teste de integração (IT - Integration Test)
  que verifica o funcionamento correto do jUDDI antes de instalar o módulo.
• Uma vez instalado o módulo no repositório Maven local, a biblioteca pode ser usada como dependência num pom.xml:

      ...
      <!-- UDDI Naming -->
      <dependency>
          <groupId>pt.ulisboa.tecnico.sdis</groupId>
          <artifactId>uddi-naming</artifactId>
          <version>1.1.1</version>
      </dependency>
      ...
  

3. Servidor JAX-WS

É possível implementar Web Services partindo de código Java já existente. Esta abordagem de desenvolvimento designa-se por implementation-first. Para transformar um tipo Java num Web Service, basta usar a anotação @WebService. As descrições em WSDL e XSD são geradas automaticamente quando o servidor se executa.

• Obter o código do servidor:
• Hello World Web Service (Implementation-First)
• Construir o servidor:
• cd hello-ws_juddi
• mvn compile
• Executar o servidor:
• mvn exec:java
  O nome da classe a executar e os argumentos estão definidos no pom.xml
  O servidor deve executar sem erros, disponibilizando o endpoint address e registando-se no UDDI.
• Confirmar que o servidor está à espera de pedidos e consultar o contrato que é gerado automaticamente:
  • http://localhost:8080/hello-ws/endpoint?wsdl
  • http://localhost:8080/hello-ws/endpoint?xsd=1
4. Cliente JAX-WS
• Obter o código do cliente:
• Web Service client
• Construir o cliente:
• cd hello-ws-cli_juddi
• mvn compile
  Executa previamente generate-sources onde o cliente obtém o contrato WSDL a partir do servidor e
  usa a ferramenta wsimport para gerar as classes de invocação do serviço (em target/)
  
• Executar o cliente:
• mvn exec:java
  O cliente deve executar sem erros, consultando o UDDI para descobrir o endereço do servidor,
  e fazendo uma invocação remota.

Resumo

Primeiro foi lançado o servidor de nomes jUDDI.
Depois foi instalada a biblioteca UDDINaming no repositório Maven local, que testa também o funcionamento do servidor jUDDI.
Em seguida, foi construído e iniciado o servidor, que se regista no jUDDI e fica à espera de pedidos no endpoint address.
Finalmente, o cliente obtém o WSDL a partir do servidor e gera o código de invocação que permite depois fazer invocações remotas.

Depois de testado o Exemplo, passar ao Exercício.

 

---

Exercício

Partindo do exemplo acima, foi construído um novo Web Service Tic Tac Toe (jogo do galo).

• O ponto de partida foi o programa ttt-local
• O ponto de chegada consiste em dois programas: servidor ttt-ws_juddi e cliente ttt-ws-cli_juddi.

• A estrutura dos projetos está montada mas, atenção,
  faltam ainda alterações importantes assinaladas com "...",
  quer no pom.xml, quer no código Java!

• O objetivo do exercício é acrescentar o que falta e colocar o servidor e cliente a funcionar.

 

1. No servidor (ttt-ws_juddi):
• Configurar no ficheiro pom.xml:
• A dependência para a biblioteca UDDINaming (em falta dentro da tag <dependencies>).
• A localização do UDDI (uddi.url)
  Por omissão, o valor é http://localhost:9090.
• O nome do serviço a registar (ws.name)
• O endereço do serviço a disponibilizar (ws.url)
  Por exemplo, http://localhost:8080/ttt-ws/endpoint
• Consultar a interface TTT e respectiva implementação TTTImpl
• Completar as anotações javax.jws.WebService, indicando a interface implementada: ttt.TTT

    @WebService(endpointInterface="...")
    public class TTTImpl implements TTT {

• Depois de efectuadas as alterações:
  mvn compile exec:java
  (a classe a executar e os argumentos estão definidos no pom.xml)
  
• Consultar o WSDL gerado dinamicamente, que deverá estar disponível no endereço
  http://localhost:8080/ttt-ws/endpoint?WSDL.

 

2. No cliente (ttt-ws-cli_juddi):
• Configurar no ficheiro pom.xml:
• A dependência para a biblioteca UDDINaming (em falta dentro da tag <dependencies>).
• A localização do UDDI (uddi.url)
  
• O nome do serviço a pesquisar (ws.name)
• Gerar o código necessário às invocações remotas a partir do WSDL:
  mvn generate-sources
  O WSDL é necessário para a compilação do cliente, pelo que o servidor deverá estar a correr.
  Caso se pretenda gerar novamente as classes, deve fazer-se:
  mvn clean generate-sources
  
• Consultar ./target/generated-sources/wsimport ou faça refresh no package explorer do Eclipse.
  
• Verificar que alterações ocorreram nas pastas do projeto em resultado da geração de código a partir do WSDL.
  Inspeccione o conteúdo dos novos ficheiros gerados e tente compreender a função de cada um.
• Abrir e analisar o ficheiro cujo nome termina em ...Service.java.
  A classe ...Service estende a classe javax.xml.ws.Service, que é a classe que o JAX-WS fornece para acesso ao serviço remoto.
  A classe gerada já está configurada para o Web Service em causa, logo é mais fácil de usar que usando a classe Service diretamente.
• No método main() do cliente, criar uma instância de ...Service e chamar o método get...Port(), que retorna uma instância da interface (remota) do seu Web Service. A partir daí, pode invocar qualquer operação chamando métodos dessa interface.

    public Game() {
        ...

        ...Service service = new ...Service();
        ... port = service.get...Port();

• Agora já deverá ser possível compilar a aplicação sem erros:
  mvn compile
• E jogar:
  mvn exec:java

Perguntas

1. Estude o WSDL gerado. Consegue mapear o código Java para as definições WSDL e XSD?
2. Onde, no WSDL, é especificado o tipo de argumentos do Web Service?
3. Compare o WSDL gerado com o ficheiro ttt.x do servidor SUN RPC do ttt.
1. Que informação é comum a ambos os ficheiros?
2. Que informação existe no WSDL mas não existe no .x?
4. Identifique a função de cada ficheiro gerado no cliente (ignore os ficheiros ObjectFactory.java e package-info.java na sua resposta).

O resto do enunciado será entregue na aula.
O objetivo será estender ou modificar as funcionalidades disponíveis.