Serviços da web baseados em Java API for XML
Serviços da web baseados em Java™ API for XML (JAX-WS), que também é conhecido como JSR-224, é a última geração de modelo de programação de serviços da web que estende a base fornecida pelo modelo de programação Java API para RPC baseado em XML (JAX-RPC). Usando o JAX-WS, o desenvolvimento de serviços e clientes da web é simplificado com maior independência da plataforma para aplicativos Java pelo uso de proxies dinâmicos e anotações Java. As ferramentas de serviços da web incluídas neste produto suportam JAX-WS 2.0, 2.1 e 2.2.
O JAX-WS é um novo modelo de programação que simplifica o desenvolvimento de aplicativo por meio de suporte de um modelo padrão baseado em anotação para desenvolver aplicativos e clientes de serviço da web. O padrão de programação JAX-WS alinha-se estrategicamente com a tendência atual do setor rumo a um modelo de sistema de mensagens mais centrado em documentos e substitui o modelo de programação de chamada de procedimento remoto conforme definido por JAX-RPC. Embora este produto ainda suporte o modelo de programação e aplicativos JAX-RPC, o JAX-RPC tem limitações e não suporta muitos serviços atuais centrados em documento. O JAX-WS é o modelo de programação estratégico para desenvolvimento de serviços da web e é uma parte necessária da plataforma Java EE 5.
- Melhor independência de plataforma para aplicativos Java
- Usando as APIs de JAX-WS, o desenvolvimento de serviços e clientes da web é simplificado com melhor independência da plataforma para aplicativos Java. O JAX-WS obtém vantagem de proxies dinâmicos, enquanto que JAX-RPC usa os stubs gerados. O cliente proxy dinâmico chama um serviço da web com base em uma Interface de Terminal em Serviço (SEI) que é gerada ou fornecida. O cliente de proxy dinâmico é semelhante ao cliente stub no modelo de programação JAX-RPC. Embora o cliente proxy dinâmico JAX-WS e o cliente stub JAX-RPC sejam ambos baseados em Interface de Terminal em Serviço (SEI) que é gerada a partir de um arquivo WSDL, há uma diferença importante. O cliente proxy dinâmico é gerado dinamicamente no tempo de execução usando a funcionalidade de proxy dinâmico Java 5, enquanto o cliente stub baseado em JAX-RPC é um arquivo Java não portável que é gerado pelo conjunto de ferramentas. Diferentemente dos clientes stub JAX-RPC, o cliente de proxy dinâmico não requer que você gere novamente um stub antes de executar o cliente em um servidor de aplicativos para um fornecedor diferente, porque a interface gerada não requer as informações do fornecedor específico. Consulte o Capítulo 4 da especificação JAX-WS 2.0 para obter mais informações sobre o uso de clientes proxy dinâmicos.
- Anotações
O JAX-WS introduz suporte para anotação de classes Java com metadados para indicar que a classe Java é um serviço da web. O JAX-WS suporta o uso de anotações com base no Recurso de Metadados para a especificação Java Programming Language (JSR 175), e os Metadados de serviços da web para a especificação Java Platform (JSR 181) e anotações que são definidas pela especificação JAX-WS 2.0. O uso de anotações na origem Java e na classe Java simplifica o desenvolvimento de serviços da web, definindo algumas das informações adicionais que geralmente são obtidas de arquivos do descritor de implementação, arquivos WSDL ou metadados de mapeamento de arquivos XML e WSDL para os artefatos de origem.
Por exemplo, é possível incorporar uma tag @WebService simples na origem Java para expor o bean como um serviço da Web.
@WebService public class QuoteBean implements StockQuote { public float getQuote(String sym) { ... } }A anotação do @WebService informa ao ambiente de tempo de execução do servidor para expor todos os métodos públicos nesse bean como um serviço da web. Os níveis adicionais de granularidade podem ser controlados incluindo-se anotações adicionais sobre os métodos ou parâmetros individuais. O uso de anotações facilita muito mais a exposição de artefatos Java como serviços da Web. Além disso, como os artefatos são criados a partir do uso de algumas ferramentas de mapeamento descendente que se iniciam a partir de um arquivo WSDL, as anotações são incluídas dentro da origem e classes Java como uma maneira de capturar metadados juntamente com os arquivos de origem.
- Chamando serviços da web de forma assíncrona
Com o JAX-WS, os serviços da web podem ser chamados tanto de maneira síncrona como de maneira assíncrona. O JAX-WS inclui suporte para um mecanismo de pesquisa e um mecanismo de retorno de chamada ao chamar os serviços da web de maneira assíncrona. Usando um modelo de pesquisa, um cliente pode emitir uma solicitação e obter de volta um objeto de resposta, que é pesquisado para determinar se o servidor respondeu. Quando o servidor responde, a resposta real é recuperada. Usando o modelo de pesquisa, o cliente pode continuar processando outro trabalho sem aguardar que uma resposta seja retornada. Usando o modelo de retorno de chamada, o cliente fornece um manipulador de retorno de chamada para aceitar e processar o objeto de resposta de entrada. Ambos os modelos, de sondagem e de retorno de chamada, permitem que o cliente se concentre em continuar processando o trabalho enquanto fornece um modelo mais dinâmico e eficiente para chamar os serviços da web.
Por exemplo, uma interface de serviço da web possui métodos para solicitações síncronas e assíncronas.
@WebService public interface CreditRatingService { // operação síncrona Score getCreditScore(Customer customer); // operação assíncrona com sondagem Response<Score> getCreditScoreAsync(Customer customer); // operação assíncrona com retorno de chamada Future<?> getCreditScoreAsync(Customer customer, AsyncHandler<Score> handler); }A chamada assíncrona que usa o mecanismo de retorno de chamada requer uma entrada adicional pelo programador do cliente. O manipulador de retorno de chamada é um objeto que contém o código do aplicativo que será executado quando uma resposta assíncrona for recebida. A seguir está um exemplo de código para um manipulador de retorno de chamada assíncrono:
CreditRatingService svc = ...; Future<?> invocation = svc.getCreditScoreAsync(customerFred, new AsyncHandler<Score>() { public void handleResponse ( Response<Score> response) { Score score = response.get(); // trabalho aqui... } } );A seguir está um exemplo de código para um cliente de sondagem assíncrona:
CreditRatingService svc = ...; Response<Score> response = svc.getCreditScoreAsync(customerFred); while (!response.isDone()) { // do something while we wait } // no cast needed, thanks to generics Score score = response.get(); </Score>- Usando a injeção do recurso
O JAX-WS suporta a injeção de recurso para simplificar ainda mais o desenvolvimento de serviços da Web. O JAX-WS usa esse recurso-chave do Java EE 5 para deslocar a carga de criação e inicialização de serviços comuns em um ambiente de tempo de execução do Java de seu aplicativo de serviço da Web para o próprio ambiente do contêiner do aplicativo. O JAX-WS fornece suporte para um subconjunto de anotações definidas em JSR-250 para injeção de recurso e ciclo de vida do aplicativo em seu ambiente tempo de execução.
O servidor de aplicativos também suporta o uso da anotação @Resource ou @WebServiceRef para declarar clientes gerenciados pelo JAX-WS e para solicitar injeção de serviços e portas do JAX-WS. Quando qualquer uma dessas anotações é utilizada em um campo ou um método, ela resulta na injeção de uma instância de serviço ou de porta do JAX-WS. O uso dessas anotações também resulta no tipo especificado pela anotação que está sendo ligada ao espaço de nomes do JNDI.
A anotação do @Resource é definida pela especificação JSR-250, Common Annotations incluída no Java Platform, Enterprise Edition 5 (Java EE 5). Ao colocar a anotação @Resource em uma variável do tipo javax.xml.ws.WebServiceContext em uma classe de implementação de terminal em serviço, você pode solicitar a injeção de um recurso e coletar a interface javax.xml.ws.WebServiceContext relacionada a essa chamada de terminal específica. A partir da interface WebServiceContext, é possível coletar o MessageContext para a solicitação associada à chamada de método específica usando o método getMessageContext().
O exemplo a seguir ilustra o uso das anotações @Resource e @WebServiceRef para a injeção de recurso:@WebService public class MyService { @Resource private WebServiceContext ctx; @Resource private SampleService svc; @WebServiceRef private SamplePort port; public String echo (String input) { … } }Consulte as seções 5.2.1 e 5.3 da especificação JAX-WS para obter informações adicionais sobre a injeção de recurso.
- Ligação de dados com JAXB 2.2
- O JAX-WS potencializa a API
JAXB e as ferramentas como tecnologia de ligação para mapeamentos entre os objetos Java e os documentos XML. As ferramentas JAX-WS dependem
das ferramentas JAXB para a ligação de dados padrão para mapeamentos bidirecionais entre os objetos Java e os documentos XML. A ligação de dados do JAXB substitui a ligação de dados descrita pela especificação do JAX-RPC.
O WebSphere Application Server Versão 7.0 suporta a especificação JAXB 2.1. O JAX-WS 2.1 requer o JAXB 2.1 para a ligação de dados. O JAXB 2.1 fornece aprimoramentos tais como melhor suporte de compilação e suporte para a anotação @XMLSeeAlso e suporte a 1.0 de esquema completo.
O WebSphere Application Server Versão 8.0 ou posterior e o WebSphere Application Server Liberty V8.5.5 suportam a especificação JAXB 2.2. JAX-WS 2.2 requer JAXB 2.2 para ligação de dados. O JAXB 2.2 fornece aprimoramentos menores em suas anotações para a geração de esquema aprimorado e melhor integração com o JAX-WS.
- Clientes dinâmicos e estáticos
- A API de programação de cliente dinâmico para JAX-WS é chamada de cliente
de despacho (javax.xml.ws.Dispatch). O cliente dispatch é um cliente orientado
ao sistema de mensagens XML. Os dados são enviados no modo PAYLOAD ou MESSAGE.
Ao usar o modo PAYLOAD, o cliente de despacho é responsável apenas
por fornecer o conteúdo do elemento <soap:Body> e o JAX-WS
inclui os elementos <soap:Envelope> e <soap:Header>. Ao usar
o modo MESSAGE, o cliente de despacho é responsável por fornecer
todo o envelope SOAP, incluindo os elementos <soap:Envelope>,
<soap:Header> e <soap:Body> e o JAX-WS não inclui nada de adicional
na mensagem. O cliente dispatch suporta chamadas assíncronas usando um mecanismo de retorno de chamada ou de sondagem. </soap:Body></soap:Header></soap:Envelope></soap:Header></soap:Envelope></soap:Body>
O modelo de programação de cliente estático para JAX-WS é chamado de cliente de proxy. O cliente proxy chama um serviço da web baseado em uma Interface de Terminal em Serviço (SEI) que é gerada ou fornecida.
- Suporte ao MTOM
- Usando o JAX-WS, é possível enviar anexos binários, como imagens ou arquivos, junto com solicitações de serviços da Web. O JAX-WS inclui suporte para transmissão otimizada de dados binários conforme especificado pelo MTOM (Message Transmission Optimization Mechanism).
- Várias estruturas de carga útil
- O JAX-WS expõe as seguintes tecnologias de ligação ao usuário: XML Source, SOAP Attachments API for Java (SAAJ) 1.3 e Java Architecture for XML Binding (JAXB) 2.0. O XML Source permite que um usuário transmita um javax.xml.transform.Source para o tempo de execução que representa os dados em um objeto de Origem a ser transmitido para o tempo de execução. A SAAJ 1.3 agora tem a capacidade de transmitir um documento SOAP inteiro pela interface, e não apenas a carga útil. Isso é feito pelo cliente que transmite o objeto SAAJ SOAPMessage pela interface. O JAX-WS potencializa o suporte ao JAXB 2.0 como tecnologia de ligação de dados de escolha entre Java e XML.
- Suporte ao SOAP 1.2
- Suporte para SOAP 1.2 foi incluído no JAX-WS 2.0. O JAX-WS suporta SOAP 1.1 e SOAP 1.2. O SOAP 1.2 fornece uma definição mais específica do modelo de processamento de SOAP, que elimina muitas das ambiguidades que ocasionalmente levam a problemas de interoperabilidade na ausência dos perfis de interoperabilidade de serviços da web (WS-I). A SOAP 1.2 deve reduzir as chances de problemas de interoperabilidade com implementações de SOAP 1.2 entre diferentes fornecedores. Ele não é interoperável com versões anteriores.
- Suporte para parâmetros de método e tipos de retorno
- O JAX-WS 2.2 suporta parâmetros
de métodos e tipos de retornos. Em uma operação de serviços da Web JAX-WS, é possível definir uma operação de serviços da Web com um
parâmetro de operação e um tipo de retorno opcional. Se o parâmetro de
operação e o tipo de retorno definirem uma propriedade targetNamespace vazia
especificando um valor "" para a propriedade targetNamespace com a anotação
@WebParam ou @WebResult, o ambiente de tempo de execução JAX-WS
se comportará da seguinte maneira:
- Se a operação for estilo de documento, o estilo de parâmetro será WRAPPED e o parâmetro não mapeará para um cabeçalho. Um namespace vazio é mapeado com os parâmetros de operações e tipos de retornos.
- Se o estilo de parâmetro não for WRAPPED, o valor do parâmetro targetNamespace especificado usando a anotação @WebParam ou @WebResult será usado.
JAX-WS 2.1.6
- O método é anotado com @WebMethod ou @WebMethod(exclude=false) e a classe contida nele possui uma anotação @WebService
- O método não tem nenhuma anotação @WebMethod mas a classe contida nele possui uma anotação @WebService e nenhum outro método é anotado com @WebMethod ou @WebMethod(exclude=false)
- O método possui uma anotação @WebMethod ou @WebMethod(exclude=false).
- O método não tem nenhuma anotação @WebMethod, mas a classe contida nele possui uma anotação @WebService.
public class Base
{
@WebMethod(exclude=false)
public void superExposed(String s) {}
public String supernoanno(String s) {}
}
@WebService
public class BeanImpl extends Base
{
@WebMethod(exclude=false)
public void exposed(String s) {}
public String nonpublic(String s) {}
}
Antes do JAX-WS 2.1.6, o único método exposto seria public
void exposto(String s). No JAX-WS 2.1.6 e mais recente, os métodos
a seguir são expostos:public void exposed(String s)
public String nonpublic(String s)
public void superExposed(String s)
O WebSphere Application Server Versão 7.0.0.7 e posterior inclui essas mudanças por meio do IBM® JDK 6 SR6. Para ativar o ambiente de trabalho para fornecer orientação sobre o uso de JAX-WS 2.1.6, acesse e defina a configuração de orientação de exposição do método JAX-WS 2.1.6 como true.
JAX-WS 2.2
- WebSphere Application Server Liberty V8.5.5
- WebSphere Application Server V8.5
- WebSphere Application Server V8.0
A especificação JAX-WS 2.2 substitui e inclui funções na especificação JAX-WS 2.1. O JAX-WS 2.2 inclui suporte do lado do cliente para uso de anotações relacionadas ao WebServiceFeature, como anotações @MTOM, @Addressing e @RespectBinding. O JAX-WS 2.1 tinha suporte incluído anteriormente para essas anotações no servidor. Além disso, os serviços da web para especificação Java EE 1.3 apresentam suporte para essas anotações relacionadas ao WebServiceFeature, bem como suporte para usar elementos do descritor de implementação para configurar esses recursos no cliente e no servidor. O JAX-WS 2.2 requer o Java Architecture for XML Binding (JAXB) Versão 2.2 para ligação de dados.
Para obter mais informações sobre o JAX-WS, consulte a especificação JSR-224 oficial: JSR 224: Serviços da web baseados em Java API for XML (JAX-WS) 2.0
