Anotações para criar visão geral de serviços da web

É possível usar anotações de seu código Java™ para criar serviços da web. As anotações especificam os metadados que estão associados às implementações de serviço da web.

O padrão de programação Java API for XML-Based Web Services (JAX-WS) depende de anotações para simplificar o desenvolvimento de serviços da Web. As anotações descrevem dois aspectos de serviços da web: como uma implementação de serviço do lado do servidor é acessada como um serviço da web e como uma classe Java do lado do cliente acessa serviços da web.

O padrão de programação JAX-WS suporta a anotação de classes Java com metadados que são usados para definir um aplicativo de terminal em serviço como um serviço da web e para especificar como um cliente pode acessar o serviço. O padrão JAX-WS suporta o uso de anotações que são baseadas em várias Java Specification Requests (JSRs):
  • Um Recurso de Metadados para a Linguagem de Programação Java (JSR 175).
  • Metadados de Serviços da Web para a Plataforma Java (JSR 181).
  • Java API for XML-Based Web Services (JAX-WS) 2.0 (JSR 224).
  • Anotações comuns para a Plataforma Java (JSR 250).
Usando as anotações a partir do padrão JSR 181, você pode anotar uma classe de implementação de serviço ou uma interface de serviço. Em seguida, você pode gerar um serviço da web com um assistente ou publicando o aplicativo em um servidor. O uso de anotações com código-fonte Java e classes Java simplifica o desenvolvimento de serviço da web. Se você utilizar anotações desta maneira, definirá mais informações que geralmente são obtidas de arquivos do descritor de implementação, arquivos Web Services Description Language (WSDL) ou metadados de mapeamento de XML e WSDL para os artefatos de origem.

É possível usar anotações para configurar ligações e cadeias de manipulador; e para configurar nomes de portType, serviço e outros parâmetros WSDL. Também é possível usar anotações no momento da criação para mapear Java para WSDL e esquema, e no tempo de execução para controlar como o tempo de execução de JAX-WS processa e responde às chamadas de serviço da web.

O produto usa as anotações nos clientes que você cria por meio do assistente de cliente de serviço da web. O assistente gera um proxy de cliente e uma classe de serviço estático com anotações. Essas anotações especificam como o cliente acessa o serviço da web.

Para obter informações detalhadas sobre as anotações que você pode usar, consulte a referência relacionada.

Cenários de serviço da web baseados em anotação suportados

Os cenários de serviço da web a seguir são suportados pelas ferramentas e ambientes de tempo de execução do WebSphere:

Tabela 1. Ambientes de Tempo de Execução Suportados. Tempos de execução suportados por cenários de serviço da web baseados em anotação.
Cenário Ambiente de tempo de execução Comments
Java bean ascendente WebSphere Application Server v7.0 e posterior Pode ser feito usando anotações sozinhas ou em combinação com os assistentes de serviço da web. Se o bean já possui uma anotação @javax.jws.WebService, muitos campos no assistente ficam desativados, porque o assistente não precisa gerar um bean delegado para você. Você está apto apenas a selecionar para gerar um arquivo WSDL. Se você tiver incluído somente o @javax.jws.WebService em seu Java bean e desejar ativar outras opções, tais como ligação SOAP 1.2 ou MTOM, saia do assistente e remova a anotação ou continue criando o serviço da web usando a documentação de anotações. O assistente não permite que você anexe novas anotações em um bean parcialmente anotado pré-existente.
EJB 2.x ascendente Nenhuma. Não suportado pelo uso de anotações
EJB 3.0 ascendente WebSphere Application Server v7.0 e posterior Não é possível usar uma mistura de anotações e o assistente de serviços da web. Você deve usar anotações e implementar o bean EJB no servidor de aplicativos.
Java bean Meet-in-the-middle WebSphere Application Server v7.0 e posterior Este cenário permite mapear um Java bean anotado de serviço da web para um documento WSDL usando o atributo wsdlLocation.
Nota: Se você desejar usar SOAP 1.2:
@javax.xml.ws.BindingType (value=javax.xml.ws.soap.SOAPBinding.SOAP12HTTP_BINDING) 
deverá especificar o atributo wsdlLocation da anotação @WebService, tal como no exemplo a seguir:
@javax.jws.WebService (targetNamespace="http://p/", ..., wsdlLocation="WEB-INF/wsdl/EchoService.wsdl")
Não é possível usar o arquivo WSDL gerado dinamicamente pelo WebSphere Application Server, mas deverá ter um arquivo WSDL criado com antecedência. Como alternativa, você pode usar os assistentes de serviços da web, que geram um arquivo WSDL para você se você selecionar para usar SOAP 1.2 ao gerar um serviço da web a partir de um Java bean.

Para maiores informações, consulte: Criando um serviço da web a partir de um Java bean e um arquivo WSDL.

EJB 3.0 Meet-in-the-middle WebSphere Application Server v7.0 e posterior Este cenário permite mapear um bean EJB anotado de serviço da web para um documento WSDL usando o atributo wsdlLocation.

Para maiores informações, consulte: Criando um serviço da web a partir de um bean EJB e um arquivo WSDL.

Exemplo

Por exemplo, é possível integrar uma tag @WebService na origem Java para expor um bean como um serviço da web.
@WebService 

public class QuoteBean implements StockQuote {

       public float getQuote(String sym) { ... }

}

A anotação @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. Você pode controlar mais níveis de granularidade, incluindo outras anotações em 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, à medida que você cria artefatos usando algumas das ferramentas de mapeamento descendente que 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.

Icon that indicates the type of topic Concept topic
Timestamp icon Last updated: last_date

File name: cwsandoc001.html