Gerando o código do cliente de amostra para um recurso JAX-RS 2.0

É possível gerar o código do cliente de amostra para um recurso Java™ API for RESTful Web Services (JAX-RS) a partir de um endereço do projeto REST.

Antes de Iniciar

Importante: Aplicável ao Liberty
Execute a configuração a seguir para o WebSphere Application Server Developer Tools for Eclipse:
  • Inclua o tempo de execução do Liberty nas preferências.
  • Crie um servidor Liberty na visualização Servidores.
  • Crie um projeto da web com um ou mais serviços REST que são definidos no projeto. Caso contrário, caso não sejam definidos serviços, o nó REST não terá filhos.

Procedimento

  1. Expanda your_REST_project > Serviços > REST.
  2. Clique com o botão direito no endereço ou em um de seus filhos e selecione Gerar > Cliente JAX-RS. O diálogo Cliente JAX-RS 2.0 é exibido.
    1. No campo Pasta de Origem, aceite o padrão ou especifique a pasta de destino do cliente gerado.
    2. No campo Nome, aceite o padrão ou especifique o nome da classe Java do cliente.
    3. No campo Pacote, aceite o padrão ou especifique o nome do pacote Java do cliente.
    4. Selecione os recursos que você deseja utilizar para gerar o código do cliente.
    5. Gere uma nova classe de filtro.
      1. Selecione Gerar Filtro do Cliente JAX-RS.
      2. Aceite o padrão ou especifique o nome da classe de filtro.

      Esta opção cria uma classe básica que implementa as interfaces ClientRequestFilter e ClientResponseFilter a partir do pacote javax.ws.rs.client do JAX-RS 2.0. É possível preencher os detalhes de implementação dos métodos de interface após a geração da nova classe de filtro.

  3. Opcional: Para gerar classes JAXB e o cliente no mesmo projeto, selecione Usar esquema XML para a geração de JAXB.

    O método de recurso do serviço JAX-RS pode ter classes JAXB como argumentos de método ou tipos de retorno. Se você não tiver a origem JAXB, mas tiver o esquema XML, é possível gerar as classes JAXB para que o código do cliente possa acessá-las.

    1. Clique em Next.

      O diálogo Cliente JAX-RS com JAXB é exibido.

    2. Opcional: No campo Pacote Java do destino JAXB, forneça o pacote Java a ser utilizado para as classes JAXB geradas.

      Esse valor é transmitido para o compilador de ligação ou para a ferramenta Java Architecture for XML Binding Compiler (XJC), com a opção -p.

    3. Clique em Procurar... para procurar o arquivo XSD a partir do qual você deseja gerar a classe JAXB.

      Também é possível inserir o arquivo XSD no Esquema XML. Esse valor é transmitido para o compilador de ligação ou para a ferramenta XJC, com a opção -b.

    4. Opcional: Para fornecer arquivos de ligação JAXB definidos pelo usuário, selecione Especificar arquivos de ligação JAXB.

      Ao selecionar essa opção, é possível clicar em Incluir para incluir arquivos de declaração de ligação customizados. Também é possível remover arquivos, destacando-os e, em seguida, selecionando Remover.

    5. Opcional: Para permitir extensões do fornecedor, selecione Permitir extensões do fornecedor.

      Essa seleção pode ser necessária para o processamento de alguns documentos de Esquema XML. Esse valor é transmitido para o compilador de ligação ou para a ferramenta XJC, com a opção -extension.

  4. Clique em Concluir.

Resultados

Você gerou o código do cliente de amostra para um recurso JAX-RS.

Caso tenha concluído a etapa adicional para gerar classes JAXB, você também gerou classes JAXB no mesmo projeto que seu cliente JAX-RS.

Você também gerou um novo arquivo de classe Java, utilizando a API do Cliente JAX-RS 2.0, que pode ser usado para acessar o serviço JAX-RS. Cada método anotado do serviço JAX-RS possui um método do cliente JAX-RS correspondente, que é gerado a partir das anotações nos métodos do serviço JAX-RS. Os métodos do serviço JAX-RS incluem @PathParam; @QueryParam; @Consumes; @Produces; @Path e métodos de recurso, como @GET, @PUT ou @POST.

Restrição: Todas as classes que são afetadas pelo algoritmo de geração do cliente JAX-RS devem respeitar as seguintes restrições:
  • Essas classes devem ser uma sequência, uma primitiva, uma classe de API do JAX-RS ou uma classe do cliente anotada por Java Architecture for XML Binding (JAXB). Essas classes não podem ser binárias.
  • Todas as classes devem estar no formato de origem, para que o algoritmo possa localizá-las. Se as classes não estiverem no mesmo projeto que o serviço JAX-RS, o cliente JAX-RS não poderá ser gerado.

O que Fazer Depois

Inclua o código na amostra, para que o código do cliente funcione e atenda às necessidades do código do cliente JAX-RS 2.0. Para testar a amostra, inclua o código do cliente em um JSP ou um servlet. O código do cliente deve estar em um contêiner do servlet, porque não há suporte para aplicativos Java independentes. Quando o código do cliente JAX-RS 2.0 estiver em funcionamento, use o código do cliente para iniciar o serviço do JAX-RS 2.0.
Icon that indicates the type of topic Task topic
Timestamp icon Last updated: last_date

File name: t_jaxrs_scc_jaxrs.html