Anotações de metadados de serviços da web (JSR 181)

Usando as anotações da especificação JSR 181, você pode anotar uma classe de implementação de serviço da web ou uma interface de serviço da Web. Em seguida, você pode gerar um serviço da web com um assistente ou publicando o aplicativo em um servidor.

Nota: A classe Java™ que contém cada anotação no padrão JSR 181 é denominada javax.jws.xxx, em que xxx é o nome da anotação após o caractere '@'. Por exemplo, o nome de classe Java que corresponde a @WebService é javax.jws.webservice.
Nome: Descrição: Propriedades: Definições:
@WebService Essa anotação marca uma classe Java ou uma interface de terminal em serviço (SEI) como implementação de uma interface de serviço da web.

Três das propriedades da anotação podem ser usadas somente com uma classe de implementação de terminal em serviço para um terminal de JavaBeans. Essas propriedades são serviceName, portName e endpointInterface.

Se a anotação referenciar uma SEI por meio do atributo endpointInterface, a SEI também deverá ter a anotação @WebService.

Por padrão, todos os métodos públicos em uma classe que especifica a anotação @WebService são expostos no serviço da web.

  • Destino da anotação: Tipo
  • Propriedades:
    name
    O nome de wsdl:portType. A propriedade name é mapeado para uma SEI ou uma classe de implementação de Java. O valor padrão é o nome não qualificado da interface ou classe Java. (Sequência de Caracteres)
    targetNamespace
    Especifica o namespace XML dos elementos WSDL e XML que são gerados a partir do serviço da web.
    • Se a anotação @WebService.targetNamespace está em uma interface de terminal em serviço. O targetNamespace é usado para o namespace para o wsdl:portType (e elementos XML associados).
    • Se a anotação @WebService.targetNamespace estiver em um bean de implementação de serviço que não faz referência a uma interface de terminal em serviço (por meio do elemento de anotação endpointInterface), o targetNamespace será usado para o wsdl:portType e o wsdl:service (e elementos XML associados).
    • Se a anotação @WebService.targetNamespace estiver em um bean de implementação de serviço que faz referência a uma interface de terminal em serviço (por meio do elemento de anotação endpointInterface), o targetNamespace será usado apenas para o wsdl:service (e elementos XML associados).

    O valor padrão é o namespace que é mapeado a partir do nome do pacote que contém o serviço da web. (Sequência de Caracteres)

    serviceName
    Especifica o nome do serviço do serviço da Web: wsdl:service. Esta propriedade não é permitida em interfaces de terminal. O valor padrão é o nome simples da classe Java + Serviço. (Sequência de Caracteres)
    endpointInterface
    Especifica o nome qualificado da interface de terminal de serviço que define o contrato do serviço da Web abstrato do serviço. Se especificada, a interface de terminal em serviço será utilizada para determinar o contrato de WSDL abstrato. (Sequência de Caracteres)
    portName
    O wsdl:portName. A propriedade portName é o nome da porta do terminal. O valor padrão é WebService.name +Port . (Sequência de Caracteres)
    wsdlLocation
    Especifica o endereço da web do documento WSDL que define o serviço da web. O endereço da Web é relativo ou absoluto. (Sequência de Caracteres)
@Retention(value = RetentionPolicy.RUNTIME)
@Target({TYPE})
public @interface WebService{
	String name() default “”;
	String targetNamespace() default “”;
	String serviceName() default “”';
	String wsdlLocation() default “”;
	String endpointInterface() default “”;
	String portName() default “”;
};
@WebMethod Essa anotação denota um método que é uma operação de serviço da web.

É possível aplicar essa anotação a métodos públicos em uma Interface de Terminal em Serviço (SEI) de cliente ou servidor, ou em uma classe de implementação de terminal em serviço para um terminal de JavaBeans.

A anotação @WebMethod é suportada somente em classes que possuem a anotação @WebService.

  • Destino da anotação: Método
  • Propriedades:
    operationName
    Especifica o nome do wsdl:operation que corresponde a este método. O valor padrão é o nome do método Java. (Sequência de Caracteres)
    action
    Define a ação para essa operação. Para ligações SOAP, esse valor determina o valor do cabeçalho SOAPAction. (Sequência de Caracteres)
    exclude
    Especifica se um método deve ser excluído do serviço da Web. Esta propriedade pode ser usada apenas com uma classe de implementação. Usada para parar a exposição de um método herdado como parte deste serviço da web. Se este elemento for especificado, outros elementos não deverão ser especificados para @WebMethod. Esta propriedade não é permitida em interfaces de terminal.

    O valor padrão é false. (Boolean)

@Retention(value = RetentionPolicy.RUNTIME)
@Target({TYPE})
public @interface WebMethod{
	String operationName() default “”;
	String action() default “”;
	boolean exclude() default false;
};
@Oneway Essa anotação denota um método como uma operação unidirecional para um serviço da web. Ela possui uma mensagem de entrada, mas nenhuma mensagem de saída. Essa anotação pode ser usada somente em métodos que não possuem valor de retorno.

É possível aplicar essa anotação a métodos públicos em uma Interface de Terminal em Serviço (SEI) de cliente ou servidor, ou em uma classe de implementação de terminal em serviço para um terminal de JavaBeans.

  • Destino da anotação: Método
  • Não há propriedades na anotação OneWay.
@Retention(value = RetentionPolicy.RUNTIME)
@Target({TYPE})
public @interface OneWay{
};
@WebParam Essa anotação customiza o mapeamento de um parâmetro individual para uma parte da mensagem de serviço da web e um elemento XML.

É possível aplicar essa anotação a métodos públicos em uma Interface de Terminal em Serviço (SEI) de cliente ou servidor, ou em uma classe de implementação de terminal em serviço para um terminal de JavaBeans.

  • Destino da anotação: Parameter
  • Propriedades:
    name
    Se a operação for no estilo de chamada de procedimento remoto (RPC) e o atributo partName não for especificado, este será o nome do atributo wsdl:part que representa o parâmetro. Se a operação for no estilo de documento ou o parâmetro mapear para um cabeçalho, name será o nome local do elemento XML que representa o parâmetro. Esse atributo será obrigatório se a operação for estilo documento, o estilo do parâmetro for BARE e o modo for OUT ou INOUT. Se o atributo partName for especificado, o atributo name será ignorado. (Sequência de Caracteres)
    partName
    Define o nome do atributo wsdl:part que representa esse parâmetro. Use isso somente se a operação for no estilo RPC ou se a operação for no estilo de documento e o estilo de parâmetro for BARE. (Sequência de Caracteres)
    targetNamespace
    Especifica o espaço de nomes XML do elemento XML referente ao parâmetro. Aplica-se somente às ligações de documentos quando o atributo é mapeado para um elemento XML. O valor padrão é o targetNamespace para o serviço da Web. (Sequência de Caracteres)
    de suporte
    O valor representa a direção que o parâmetro flui para esse método. Os valores válidos são IN, INOUT e OUT. (Sequência de Caracteres)
    cabeçalho
    Especifica se o parâmetro está em um cabeçalho da mensagem, em vez de em um corpo da mensagem. O valor padrão é false. (Boolean)
@Retention(value = RetentionPolicy.RUNTIME)
@Target({PARAMETER})
public @interface WebParam{
	public enum Mode{
		IN,
		OUT,
		INOUT
	};
	String name() default “”;
	String partName() default "";
	String targetNamespace() default “”;
	Mode mode() default Mode.IN
	boolean header() default false;
};
@WebResult Essa anotação customiza como um valor de retorno é mapeado para uma parte WSDL ou elemento XML.

É possível aplicar essa anotação a métodos públicos em uma Interface de Terminal em Serviço (SEI) de cliente ou servidor, ou em uma classe de implementação de terminal em serviço para um terminal de JavaBeans.

  • Destino da anotação: Método
  • Propriedades:
    name
    Especifica o nome do valor de retorno como ele está listado no arquivo WSDL e como é encontrado nas mensagens da conexão. Para ligações RPC, esse é o nome do atributo wsdl:part que representa o valor de retorno. Para ligações de documento, o parâmetro name é o nome local do elemento XML que representa o valor de retorno. O valor padrão é return para ligações RPC e DOCUMENT/WRAPPED. O valor padrão é o nome do método + Response para ligações DOCUMENT/BARE. (Sequência de Caracteres)
    targetNamespace
    Especifica o namespace XML para o valor de retorno. Use esta anotação somente para ligações de documento quando o valor de retorno é mapeado para um elemento XML. O valor padrão é o targetNamespace para o serviço da web. (Sequência de Caracteres)
    cabeçalho
    Especifica se o resultado está contido em um cabeçalho. O valor padrão é false. (Sequência de Caracteres)
    partName
    Especifica o nome da parte para o resultado com operações RPC ou DOCUMENT/BARE. O valor padrão é @WebResult.name. (Boolean)
@Retention(value = RetentionPolicy.RUNTIME)
@Target({METHOD})
public @interface WebResult{
	String name() default “return”;
	String targetNamespace default() “”;
	boolean header() default false;	
	String partName() default "";
};
@HandlerChain Esta anotação associa o serviço da web a uma cadeia de manipuladores definida externamente. É possível usar essa anotação se a configuração do manipulador precisar ser compartilhada entre vários serviços da web, e a configuração do manipulador de integração na origem do aplicativo é ineficiente.

Aplique essa anotação a uma Interface de Terminal em Serviço (SEI) de cliente ou servidor, ou a uma classe de implementação de terminal em serviço para um terminal de JavaBeans.

  • Destino da anotação: Tipo
  • Propriedades:
    file
    Especifica o local do arquivo da cadeia de manipuladores. O local do arquivo é um java.net.URL absoluto em formato externo ou um caminho relativo do arquivo de origem ou classe. (Sequência de Caracteres)
    name
    Especifica o nome da cadeia de manipuladores no arquivo de configuração. (Sequência de Caracteres)
@Retention(value = RetentionPolicy.RUNTIME)
@Target({TYPE})
public @interface HandlerChain{
	String file();
	String name();
};
@SOAPBinding Essa anotação especifica o mapeamento do serviço da web para o protocolo de mensagem SOAP.

É possível aplicar essa anotação a um tipo ou métodos públicos em uma Interface de Terminal em Serviço (SEI) de cliente ou servidor, ou em uma classe de implementação de terminal em serviço para um terminal de Java beans.

A anotação no nível do método é limitada pelo que ela pode especificar. Use a anotação somente se a propriedade style possuir o valor DOCUMENT. Se a anotação no nível de método não for especificada, o comportamento de @SOAPBinding a partir do tipo será usado.

  • Destino da anotação: Tipo ou Método
  • Propriedades:
    style
    Define o estilo de codificação para as mensagens que são enviadas para e a partir do serviço da web. Os valores válidos são DOCUMENT e RPC. O valor-padrão é DOCUMENT. (Sequência de Caracteres)
    utilização
    Define a codificação que é usada para mensagens que são enviadas para e a partir do serviço da web. O valor padrão é LITERAL. ENCODED não é um valor suportado. (Sequência de Caracteres)
    parameterStyle
    Determina se os parâmetros do método representam todo o corpo da mensagem, ou se os parâmetros são elementos que são agrupados dentro de um elemento de nível superior que é denominado após a operação. Os valores válidos são WRAPPED ou BARE. É possível usar o valor BARE com ligações de estilo DOCUMENT. O valor padrão é WRAPPED. (Sequência de Caracteres)
@Retention(value = RetentionPolicy.RUNTIME)
@Target({TYPE})
public @interface SOAPBinding{
	public enum Style{
		DOCUMENT,
		RPC
	};
	public enum Use{
		LITERAL,
	};
	public enum ParameterStyle{
		BARE,
		WRAPPED
	};
	Style style() default Style.DOCUMENT
	Use use() default Use.LITERAL
	ParameterStyle parameterStyle() default ParameterStyle.WRAPPED;
};
Icon that indicates the type of topic Reference topic
Timestamp icon Last updated: last_date

File name: rwsandoc003.html