JAX-WS 2.2規約解析--Annotations Defined by JSR-181

JAX-WS 2.0中使用了一些在JSR-181中定義的註釋。

 

1. javax.jws.WebService

@Target({TYPE})

public @interface WebService {

String name() default "";

String targetNamespace() default "";

String serviceName() default "";

String wsdlLocation() default "";

String endpointInterface() default "";

String portName() default "";

};

 

說明:

當實現 Web Service 時,@WebService 註釋標記 Java 類。實現Web Service 接口時,標記服務端點接口(SEI)。

要點:

• 實現 Web Service 的 Java 類必須指定 @WebService 或 @WebServiceProvider 註釋。不能同時提供這兩種註釋。此註釋適用於客戶機/服務器 SEI 或 JavaBeans 端點的服務器端點實現類。

• 如果註釋通過 endpointInterface 屬性引用了某個 SEI,那麼還必須使用 @WebService註釋來註釋該 SEI

屬性:

名稱

說明

數據類型

name 

wsdl:portType 的名稱。缺省值爲 Java 類或接口的非限定名稱。

String

targetNamespace 

指定從 Web Service 生成的 WSDL 和 XML 元素的 XML 命名空間。缺省值爲從包含該 Web Service 的包名映射的命名空間。

String

serviceName 

指定 Web Service 的服務名稱:wsdl:service。缺省值爲 Java 類的簡單名稱 + Service

String

serviceName 

指定 Web Service 的服務名稱:wsdl:service。缺省值爲 Java 類的簡單名稱 + Service

String

endpointInterface 

指定用於定義服務的抽象 Web Service 約定的服務端點接口的限定名。如果指定了此限定名,那麼會使用該服務端點接口來確定抽象 WSDL 約定。

String

portName 

wsdl:portName。缺省值爲 WebService.name+Port

String

wsdlLocation 

指定用於定義 Web Service 的 WSDL 文檔的 Web 地址。Web 地址可以是相對路徑或絕對路徑。

String

 

2.javax.jws.WebMethod

@Target({METHOD})

public @interface WebMethod {

String operationName() default "";

String action() default "" ;

boolean exclude() default false;

};

 

 

說明:

@WebMethod 註釋表示此爲一個Web Service的操作方法。將此註釋應用於客戶機或服務器服務端點接口(SEI)上的方法,或者應用於JavaBeans 端點的服務器端點實現類。

要點:

• 僅支持在使用 @WebService 註釋來註釋的類上使用 @WebMethod 註釋。

屬性:

名稱

說明

數據類型

operationName 

指定與此方法相匹配的 wsdl:operation 的名稱。缺省值爲 Java 方法的名稱。

String

action 

定義此操作的行爲。對於 SOAP 綁定,此值將確定 SOAPAction 頭的值。缺省值爲 Java 方法的名稱。

String

exclude 

指定是否從 Web Service 中排除某一方法。缺省值爲 false

Boolean

 

 

3.javax.jws.OneWay

@Target({METHOD})

public @interface Oneway {

};

 

說明

@Oneway 註釋將一個方法表示爲只有輸入消息而沒有輸出消息的 Web Service單向操作。將此註釋應用於客戶機或服務器服務端點接口(SEI)上的方法,或者應用於 JavaBeans 端點的服務器端點實現類。

4.javax.jws.WebParam

@Target({PARAMETER})

public @interface WebParam {

public enum Mode { IN, OUT, INOUT };

String name() default "";

String targetNamespace() default "";

Mode mode() default Mode.IN;

boolean header() default false;

String partName() default "";

 };

 

說明:

@WebParam 註釋用於定製從單個參數至 Web Service 消息部件和 XML 

元素的映射。將此註釋應用於客戶機或服務器服務端點接口(SEI)上的方法,

或者應用於 JavaBeans 端點的服務器端點實現類。

屬性:

名稱

說明

數據類型

name 

參數的名稱。如果操作是遠程過程調用(RPC)類型並且未指定 partName 屬性,那麼這是用於表示參數的 wsdl:part 屬性的名稱。如果操作是文檔類型或者參數映射至某個頭,那麼 -name 是用於表示該參數的 XML 元素的局部名稱。如果操作是文檔類型、參數類型爲 BARE 並且方式爲 OUT 或 INOUT,那麼必須指定此屬性。

String

partName 

定義用於表示此參數的 wsdl:part 屬性的名稱。僅當操作類型爲 RPC 或者操作是文檔類型並且參數類型爲 BARE 時才使用此參數。

String

targetNamespace 

指定參數的 XML 元素的 XML 名稱空間。當屬性映射至 XML 元素時,僅應用於文檔綁定。缺省值爲 StringWeb Service 的 targetNamespace

mode 

此值表示此方法的參數流的方向。有效值爲 ININOUT 和 OUT

String

header 

指定參數是在消息頭還是消息體中。缺省值爲 false

Booealn

 

 

5.javax.jws.WebResult

@Target({METHOD})

public @interface WebResult {

String name() default "return";

String targetNamespace() default "";

boolean header() default false;

String partName() default "";

};

 

說明

@WebResult 註釋用於定製從返回值至 WSDL 部件或 XML 元素的映射。將此註釋應用於客戶機或服務器服務端點接口(SEI)上的方法,或者應用於JavaBeans 端點的服務器端點實現類。

屬性:

名稱

說明

數據類型

name 

當返回值列示在 WSDL 文件中並且在連接上的消息中找到該返回值時,指定該返回值的名稱。對於 RPC 綁定,這是用於表示返回值的 wsdl:part 屬性的名稱。對於文檔綁定,-name 參數是用於表示返回值的 XML 元素的局部名。對於 RPC 和 DOCUMENT/WRAPPED 綁定,缺省值爲 return。對於 DOCUMENT/BARE 綁定,缺省值爲方法名 + Response

String

targetNamespace 

指定返回值的 XML 名稱空間。僅當操作類型爲 RPC 或者操作是文檔類型並且參數類型爲 BARE 時才使用此參數。

String

header 

指定頭中是否附帶結果。缺省值爲 false

Boolean

partName 

指定 RPC 或 DOCUMENT/BARE 操作的結果的部件名稱。缺省值爲 @WebResult.name

String

 

6.javax.jws.SOAPBinding

@Target({TYPE, METHOD})

public @interface SOAPBinding {

public enum Style { DOCUMENT, RPC }

public enum Use { LITERAL, ENCODED }

public enum ParameterStyle { BARE, WRAPPED }

Style style() default Style.DOCUMENT;

Use use() default Use.LITERAL;

ParameterStyle parameterStyle() default ParameterStyle.WRAPPED;

}

 

說明:

   @SOAPBinding 註釋指定 Web Service 與 SOAP 消息協議之間的映射。將此註釋應用於客戶機或服務器服務端點接口(SEI)上的類型或方法,或者應用於JavaBeans 端點的服務器端點實現類。

    方法級別的註釋僅限於它可以指定的對象,僅當 style 屬性爲 DOCUMENT 時才使用該註釋。如果未指定方法級別的註釋,那麼將使用類型的 @SOAPBinding行爲。

屬性:

名稱

說明

數據類型

style 

定義發送至 Web Service 和來自 Web Service 的消息的編碼樣式。有效值爲 DOCUMENT 和 RPC。缺省值爲 DOCUMENT

String

use 

定義用於發送至 Web Service 和來自 Web Service 的消息的格式。缺省值爲 LITERALENCODED 在 Feature Pack for Web Services 中不受支持。

String

parameterStyle 

確定方法的參數是否表示整個消息體,或者參數是否是封裝在執行操作之後命名的頂級元素中的元素。有效值爲 WRAPPED 或 BARE。對於 DOCUMENT 類型的綁定只能使用 BARE 值。缺省值爲 WRAPPED

String

 

 

7.javax.jws.HandlerChain

@Target({TYPE})

public @interface HandlerChain {

String file();

String name() default "";

}

 

說明:

@HandlerChain 註釋用於使 Web Service 與外部定義的處理程序鏈相關聯。只能通過對 SEI 或實現類使用 @HandlerChain 註釋來配置服務器端的處理程序。但是可以使用多種方法來配置客戶端的處理程序。可以通過對生成的服務類或者SEI 使用 @HandlerChain 註釋來配置客戶端的處理程序。此外,可以按程序在服務上註冊您自己的 HandlerResolver 接口實現,或者按程序在綁定對象上設置處理程序鏈。

屬性:

名稱

說明

數據類型

file  

指定處理程序鏈文件所在的位置。文件位置可以是採用外部格式的絕對 java.net.URL,也可以是類文件中的相對路徑。

String

name 

指定配置文件中處理程序鏈的名稱。

String

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章