Publicar um Serviço de Web com 4D

A publicação de um Serviço de Web em 4D se realiza geralmente em três etapas:

1. Criação do método a se publicar,
2. Configuração da publicação (WSDL),
3. Publicação.

É possível definir etapas adicionais de personalização, porém não são obrigatórias.

É possível criar qualquer tipo de sistema de projeto destinado a uma publicação como um Serviço Web. O sistema deve aceitar os parâmetros e retornar um resultado. É indispensável que estes parâmetros sejam declarados no cabeçalho do sistema utilizando os comandos do tema Compilador.

Por padrão, 4D formata os parâmetros necessários para a operação de sistemas publicados como Serviços Web. Contudo, você pode modificar estes parâmetros utilizando o comando SOAP DECLARATION.

4D se encarrega automaticamente de codificar e decodificar os dados recebidos e enviados através do SOAP.

Atenção: os nomes dos sistemas são utilizados como etiquetas XML nas solicitações SOAP. Conforme a norma XML, estes nomes não devem ter espaços ou números. Além disso, para evitar qualquer risco de incompatibilidade, recomenda-se não utilizar caracteres extensos (tais como os caracteres acentuados).

Para definir e controlar o desenvolvimento de um sistema publicado como um Serviço Web, deve-se utilizar os comandos do tema “Serviços Web” - consulte a seção Web Services (Servidor) no Manual de Linguagem 4D.

Para poder publicar um ou mais sistemas de sua base de dados como Serviços Web, devem-se cumprir as seguintes condições:

• A máquina utilizada como servidor SOAP (aplicação 4D monousuário ou 4D Server) tem uma licença SOAP 4D..
• O servidor Web de 4D deve se iniciar.
• Deve estar selecionada a opção Permitir solicitações de Serviços Web na página Web Services na caixa de diálogo Propriedades do banco. Se essa opção não estiver selecionada, 4D recusa as solicitações SOAP e não gera um WSDL.
  
  Quando esta opção estiver selecionada, 4D cria o arquivo WSDL (ver Geração de WSDL).
• Cada método a ser publicado deve ser Oferecido como Serviço Web. Esta configuração é realizada utilizando uma opção da janela Propriedades do método:
  
  Nota: Para maiores informações sobre esta janela, consulte Definir as propriedades dos métodos de projeto.
  Quando a opção Oferecido como Serviço Web está selecionada, o método correspondente pode ser chamado como Serviço Web através de uma solicitação SOAP.
  Nota: Se a opção Publicado em WSDL também estiver selecionada, o sistema aparecerá no WSDL do servidor (ver o parágrafo seguinte).

Na Página Métodos do Explorador de 4D, os ícones específicos indicam os métodos oferecidos como serviços web e os publicados no arquivo WSDL .

O WSDL descreve, em linguagem XML, a sintaxe e a informação necessária para chamar o sistema 4D (Nome do sistema, URL, parâmetros, etc.).

Em 4D, o WSDL corresponde a um único Serviço Web e define os sistemas e seus parâmetros e pode ser consultado em um lugar específico. Em 4D, o WSDL não é um “arquivo” real (só existe na memória e não está escrito no disco); este é um URL chamado 4DWSDL para Serviços Web publicados em modo RPC ou 4DWSDL/DOC para os Serviços Web publicados em modo DOC. Sempre está localizado na raiz do servidor Web.

Por exemplo, se o endereço de seu servidor Web é http://www.miservidor.com, você poderia consultar o WSDL na seguinte URL:

• http://www.myserver.com/4DWSDL (modo RPC)
• http://www.myserver.com/4DWSDL/DOC (modo DOC).

Para adicionar ou suprimir um método no WSDL, simplesmente selecione ou desmarque a opção correspondente na janela Propriedades do sistema. 4D atualizará imediatamente os conteúdos WSDL.

Nota: No Explorador de 4D, um ícone específico identifica os sistemas publicados no WSDL

Quando as solicitações de Serviços Web estão autorizadas, 4D gera automaticamente e dinamicamente o WSDL do servidor 4D Web, se ao menos um método tiver a opção Publicado em WSDL selecionada na janela Propriedades do método. Por padrão, esta opção não está selecionada.

Cada Serviço Web publicado na Internet tem um nome. Este nome é utilizado para diferenciar os serviços a nível de servidor SOAP (quando o servidor publica vários Serviços Web), bem como nos diretórios dos Serviços Web.
 
Por padrão, 4D utiliza o nome A_WebService. Este parâmetro pode ser modificado na página  “Serviços Web” das Preferências do banco:

Atenção: conforme a norma XML para nomes de etiquetas, a cadeia de caracteres utilizada não deve começar com um número nem ter espaços. Além disso, para evitar todo risco de incompatibilidade, se recomenda não utilizar caracteres estendidos (tais como os caracteres acentuados).

Cada Serviço Web publicado na Internet deve ser único. A singularidade dos nomes de Serviços Web é assegurada utilizando espaços de nomes XML. Um espaço de nomes é uma cadeia de caracteres arbitrária que permite identificar de maneira única um conjunto de etiquetas XML. Geralmente, o espaço de nomes começa com o URL da empresa (http://miempresa.com/miespaciodenombre). Neste caso, não é indispensável ter algo em particular no URL definido; o que importa é que a cadeia de caracteres utilizada seja única.

Por padrão, 4D utiliza o seguinte namespace: http://www.4d.com/namespace/default. Este parâmetro pode ser modificado na página SOAP do tema “Serviços Web” das preferências da base:

Os comentários associados aos sistemas oferecidos como Serviços Web e publicados no WSDL aparecem automaticamente no arquivo como um campo “documentação”.

Esses comentários devem ser introduzidos na Página Métodos do Explorador (ver Usar os comentários).

Este mecanismo permite descrever ou documentar os sistemas publicados. A interpretação e o manejo deste campo depende da implementação do cliente de Serviço Web.

Uma vez que seu Serviço Web é publicado por 4D, toda aplicação cliente que suporte Serviços Web pode se conectar a ele. O modo de acesso ao servidor e o processo da troca de informação com o servidor Serviço Web dependerá da aplicação cliente utilizada para a operação.

Toda a informação necessária para o uso de um Serviço Web (tal como o URL do serviço, os parâmetros a se utilizar, etc.) é publicada no WSDL de 4D. A princípio, o uso de um Serviço Web deveria começar com a leitura do WSDL do servidor SOAP a fim de recuperar esta informação. Em 4D, o URL do WSDL é http://DireccionServidor/4DWSDL (modo RPC) ou http://DireccionServidor/4DWSDL/DOC (modo DOC).

Entretanto, este passo não é obrigatório. A conexão com o servidor SOAP pode se efetuar diretamente.

Esta é uma lista dos valores necessários para estabelecer solicitações SOAP, assim como seu sistema de definição:

• URL de acesso a um Serviço Web publicado por 4D
  http://ServerAddress/4DSOAP/ (modo RPC) ou
  http://ServerAddress/4DSOAP/DOC (modo DOC)
  (não personalizáveis).

• Nome do Serviço Web
  Por padrão: A_WebService.
  Valor personalizável (ver Personalizar o nome do serviço Web).

• Nome do método publicado
  Nome do sistema de projeto 4D definido pelo desenvolvedor (ver Criar um sistema de Serviço Web).

• Parâmetros do método
  Os parâmetros devem ser declarados no sistema (definido pelo desenvolvedor).
  Nomes SOAP por padrão: FourD_arg0, FourD_arg1... FourD_argn.
  Nomes personalizáveis utilizando o comando SOAP DECLARATION.

• Espaço de nomes
  Por padrão: http://www.4d.com/namespace/default.
  Valor personalizável (ver Personalizar um espaço de nomes ).

• Conteúdo do campo SOAP Action
  ServiceName#MethodName (não personalizável).