Embora o ambiente de tempo de execução Java API for RESTful Web Services (JAX-RS)
inclua vários provedores de entidade para manipular a serialização e a
desserialização de tipos Java, ele não suporta todos os tipos possíveis
de mídia. É possível desenvolver um provedor de entidade customizado
para manipular tipos de ligação Java para corpos de mensagens.
Sobre Esta Tarefa
Se o seu aplicativo da Web JAX-RS necessitar que tipos Java ou tipos de mídia adicionais sejam suportados além do que as APIs do JAX-RS suportam, é possível incluir um provedor de entidade customizado no aplicativo.
Qualquer provedor de entidade definido e customizado tem precedência sobre os provedores
de entidade que forem incluídos no ambiente de tempo de execução JAX-RS. Diferente dos
recursos, os provedores são sempre beans singleton.
Procedimento
- Configure o ambiente de desenvolvimento.
- Antes de iniciar o desenvolvimento de aplicativos
JAX-RS, é necessário configurar o ambiente de desenvolvimento ao incluir
as bibliotecas JAX-RS no caminho de classe.
- Definir os recursos nos aplicativos da Web JAX-RS.
- Os recursos são o bloco de construção básico de um serviço RESTful. Os recursos podem conter dados estáticos
ou atualizados dinamicamente.
Os exemplos de recursos a partir de um aplicativo de armazenamento de manual online incluem um manual, uma ordem de um armazenamento e uma coleta de usuários. Ao identificar os recursos no seu aplicativo, poderá tornar seu serviço mais
útil e fácil de desenvolver.
- Configure o aplicativo JAX-RS.
É possível configurar aplicativos JAX-RS de várias formas dependendo de suas necessidades.
Para aproveitar a funcionalidade Java™ Platform, Enterprise Edition (Java EE) 6, é possível usar os recursos de varredura de anotação.
Ao usar a varredura de anotação, é possível omitir uma subclasse JAX-RS javax.ws.rs.core.Application ou ter uma subclasse javax.ws.rs.core.Application minimamente definida. Como alternativa, é possível especificar o servlet ou filtro do IBM® JAX-RS se quiser usar a funcionalidade disponível no servlet e filtro do IBM JAX-RS.
Usando um dos métodos de configuração do JAX-RS Versão 1.1, é possível omitir uma subclasse javax.ws.rs.core.Application
em seu aplicativo ou ter uma subclasse javax.ws.rs.core.Application que retorne um conjunto vazio de classes para informar o ambiente de tempo de execução do JAX-RS para localizar e usar todas as classes JAX-RS no aplicativo. É possível que você queira usar este método quando não quiser ter que incluir manualmente cada classe JAX-RS relevante em uma subclasse javax.ws.rs.core.Application conforme desenvolve o aplicativo.
Ao especificar o servlet e filtro IBM JAX-RS específicos, é possível aproveitar e garantir o comportamento do IBM JAX-RS específico. Por exemplo, usar o filtroIBM JAX-RS pode ser útil
no desenvolvimento de um aplicativo da Web com uma combinação de recursos JAX-RS e arquivos
JavaServer Pages (JSP) com os mesmos padrões de URL.
Embora haja um método de configuração de JAX-RS V1.1 que suporte o uso de um arquivo web.xml opcional, se quiser especificar restrições de segurança ou funções, ou, se quiser aproveitar os outros recursos ativados usando um arquivo web.xml, você deverá especificar as informações em um arquivo web.xml.
Escolha um dos três métodos a seguir para configurar seu aplicativo JAX-RS:
- Configurar aplicativos JAX-RS usando métodos JAX-RS 1.1
Use este método se quiser usar os recursos de varredura de anotação ou usar os métodos de configuração do JAX-RS 1.1. É possível usar os recursos de varredura de anotação para promover a portabilidade do aplicativo, para minimizar a quantidade de código de configuração ou para modificar o aplicativo de forma dinâmica sem mudanças no código do aplicativo.
- Configurar
o arquivo web.xml para servlets JAX-RS
Use este método se quiser especificar os recursos que estão ativados usando os parâmetros de inicialização de servlet para alterar o comportamento e garantir que se obtém o servlet IBM JAX-RS. Ao usar os servlets, é possível definir um caminho de servlet no arquivo web.xml que é anexado à URL
de base.
- Configurar
o arquivo web.xml para filtros JAX-RS
Use este método se quiser usar o filtro quando tiver JSPs, outros servlets e filtros e recursos JAX-RS com uma combinação de padrões URL. É possível configurar o arquivo web.xml para definir filtros que indicam as possíveis URLs nas quais o filtro pode ser chamado.
- Implemente formatos de entidade customizados.
- Se o seu aplicativo da Web JAX-RS necessitar que tipos Java ou tipos de mídia adicionais que não são suportados pelas APIs do JAX-RS, é possível incluir um provedor de entidade customizado no aplicativo.
- Montar aplicativos da Web JAX-RS.
- Após
desenvolver os arquivos de classe Java
para o seu aplicativo da Web JAX-RS e editar o arquivo web.xml para ativar
o servlet JAX-RS, você está pronto para montar o aplicativo.
Montar
o aplicativo da Web em um pacote archive aplicativo da Web (WAR). É possível montar o pacote
WAR em um pacote archive corporativo (EAR), se necessário.
- Implementar aplicativos da Web JAX-RS.
- Após ter
montado o seu aplicativo da Web JAX-RS, é necessário implementar o seu pacote
archive Web (WAR) ou o pacote archive corporativo (EAR) no
servidor de aplicativos.
Resultados
Você desenvolveu e implementou um aplicativo da Web JAX-RS que contém um provedor de entidade customizado.