![[目次]](FIGURE/CONTENT.GIF)
Cosminexus V9 アプリケーションサーバ Webサービス開発ガイド
![[用語]](FIGURE/GLOSS.GIF)
![[索引]](FIGURE/INDEX.GIF)
![[前へ]](FIGURE/FRONT.GIF)
![[次へ]](FIGURE/AFTER.GIF)
ここでは，コアAPIのサポート範囲について説明します。
com.sun.xml.ws.developer.StreamingAttachmentFeatureクラスのサポート範囲を次の表に示します。
表19-13 com.sun.xml.ws.developer.StreamingAttachmentFeatureクラスのサポート範囲
| 項番 | 戻り値の型 | メソッド名 | サポート | |
|---|---|---|---|---|
| 1 | − | StreamingAttachmentFeature() | × | |
| 2 | − | StreamingAttachmentFeature(String dir,boolean parseEagerly,long memoryThreshold) | ○ | |
| 説明 | StreamingAttachmentFeatureを作成します。 | |||
| 引数 |
|
|||
| 3 | java.lang.String | getID() | ○ | |
| 説明 | StreamingAttachmentFeatureの一意の識別子を取得します。 | |||
| 4 | org.jvnet.mimepull.MIMEConfig | getConfig() | ○ | |
| 説明 | ストリーミングの設定情報を表すMIMEConfigインスタンスを取得します。一度このメソッドを呼び出した場合，次のsetterメソッドを用いてストリーミングの設定情報を変更することはできません。
|
|||
| 5 | void | setDir(String dir) | ○ | |
| 説明 | ストリーミングが有効の場合に，受信した添付ファイルを含むSOAPメッセージに含まれるMIMEボディを一時ファイルとして出力するときに使用するディレクトリを設定します。このメソッドを複数回呼び出した場合，最後に指定した値が有効になります。getConfig()メソッドを呼び出した場合，このメソッドによる再設定はできません。 | |||
| 引数 |
|
|||
| 6 | void | setParseEagerly(boolean parseEagerly) | ○ | |
| 説明 | ストリーミングが有効の場合に，受信した添付ファイルを含むSOAPメッセージを詳細に解析するかどうかを設定します。このメソッドを複数回呼び出した場合，最後に指定した値が有効になります。getConfig()メソッドを呼び出した場合，このメソッドによる再設定はできません。 | |||
| 引数 |
|
|||
| 7 | void | setMemoryThreshold(int memoryThreshold) | ○ | |
| 説明 | ストリーミングが有効の場合に，添付ファイルを含むSOAPメッセージを受信するときにSOAPメッセージに含まれるMIMEボディをメモリ上に展開するかどうかを判定するためのしきい値を設定します。このメソッドを複数回呼び出した場合，最後に指定した値が有効になります。getConfig()メソッドを呼び出した場合，このメソッドによる再設定はできません。 | |||
| 引数 |
|
|||
com.sun.xml.ws.developer.StreamingDataHandlerクラスのサポート範囲を次の表に示します。
表19-14 com.sun.xml.ws.developer.StreamingDataHandlerクラスのサポート範囲
| 項番 | 戻り値の型 | メソッド名 | サポート | |
|---|---|---|---|---|
| 1 | − | StreamingDataHandler(Object o, String s) | × | |
| 2 | − | StreamingDataHandler(URL url) | × | |
| 3 | − | StreamingDataHandler(DataSource dataSource) | × | |
| 4 | java.io.InputStream | readOnce() | ○ | |
| 説明 | このオブジェクトのjava.io.InputStreamを取得します。 | |||
| 例外 |
|
|||
| 5 | void | moveTo(File file) | ○ | |
| 説明 | このオブジェクトが示す添付ファイルを指定されたファイルに移動します。
|
|||
| 引数 |
|
|||
| 例外 |
|
|||
| 6 | void | close() | ○ | |
| 説明 | このオブジェクトが示す添付ファイルのリソースを解放します。 | |||
| 例外 |
|
|||
org.jvnet.mimepull.MIMEConfigクラスのサポート範囲を次の表に示します。
表19-15 org.jvnet.mimepull.MIMEConfigクラスのサポート範囲
| 項番 | 戻り値の型 | メソッド名 | サポート | |
|---|---|---|---|---|
| 1 | − | MIMEConfig() | × | |
| 2 | void | setParseEagerly(boolean parseEagerly) | ○ | |
| 説明 | ストリーミングが有効の場合に，受信した添付ファイルを含むSOAPメッセージを詳細に解析するかどうかを設定します。このメソッドを複数回呼び出した場合，最後に指定した値が有効になります。 | |||
| 引数 |
|
|||
| 3 | void | setMemoryThreshold(long memoryThreshold) | ○ | |
| 説明 | ストリーミングが有効の場合に，添付ファイルを含むSOAPメッセージを受信するときに，SOAPメッセージに含まれるMIMEボディをメモリ上に展開するかどうかを判定するためのしきい値を設定します。このメソッドを複数回呼び出した場合，最後に指定した値が有効になります。 | |||
| 引数 |
|
|||
| 4 | void | setDir(String dir) | ○ | |
| 説明 | ストリーミングが有効の場合に，受信した添付ファイルを含むSOAPメッセージに含まれるMIMEボディを一時ファイルとして出力するときに使用するディレクトリを設定します。このメソッドを複数回呼び出した場合，nullまたは空文字（""）以外の値で最初に指定したものが有効になります。 | |||
| 引数 |
|
|||
| 5 | void | validate() | ○ | |
| 説明 | 一時ファイルを作成できるかを検証します。作成できない場合，添付ファイルをメモリ上に展開するように設定します。 存在しないディレクトリ，アクセス権のないディレクトリ，存在するファイル名をsetDir(String dir)メソッドで設定し，このメソッドで検証しない場合，ストリーミングが一時ファイルを出力するときにorg.jvnet.mimepull.MIMEParsingExceptionが発生します。 |
|||
javax.xml.ws.Bindingインタフェースのサポート範囲を次の表に示します。詳細はJAX-WS 2.2仕様を参照してください。
表19-16 javax.xml.ws.Bindingインタフェースのサポート範囲
| 項番 | 戻り値の型 | メソッド名／説明 | サポート | |
|---|---|---|---|---|
| 1 | java.lang.String | getBindingID() | × | |
| 2 | java.util.List<Handler> | getHandlerChain() | ○ | |
| 説明 | プロトコルバインディングインスタンスのハンドラチェインのコピーを取得します。 | |||
| 3 | void | setHandlerChain (java.util.List<Handler> chain) | ○ | |
| 説明 | プロトコルバインディングインスタンスのハンドラチェインを設定します。 | |||
| 引数 |
|
|||
| 例外 |
|
|||
javax.xml.ws.handler.Handler<C extends MessageContext>インタフェースのサポート範囲を次の表に示します。詳細はJAX-WS 2.2仕様を参照してください。
表19-17 javax.xml.ws.handler.Handler<C extends MessageContext>インタフェースのサポート範囲
| 項番 | 戻り値の型 | メソッド名／説明 | サポート | |
|---|---|---|---|---|
| 1 | MessageContext.Scope | close(MessageContext context) | ○ | |
| 説明 | メッセージ交換を完了するとき，JAX-WSのランタイムがメッセージ，フォルト，または例外をディスパッチする直前に呼び出されます。 | |||
| 2 | boolean | handleFault(C context) | ○ | |
| 説明 | フォルトメッセージを処理するために呼び出されます。 | |||
| 3 | boolean | handleMessage(C context) | ○ | |
| 説明 | インバウンドおよびアウトバウンドのメッセージで通常の処理をするために呼び出されます。 | |||
javax.xml.ws.handler.HandlerResolverインタフェースのサポート範囲を次の表に示します。詳細はJAX-WS 2.2仕様を参照してください。
表19-18 javax.xml.ws.handler.HandlerResolverインタフェースのサポート範囲
| 項番 | 戻り値の型 | メソッド名／説明 | サポート | |
|---|---|---|---|---|
| 1 | java.util.List<Handler> | getHandlerChain(PortInfo portInfo) | ○ | |
| 説明 | 指定されたポートのハンドラチェインを取得します。このメソッドではnullを返さないでください。 | |||
| 引数 |
|
|||
javax.xml.ws.handler.LogicalMessageContextインタフェースのサポート範囲を次の表に示します。詳細はJAX-WS 2.2仕様を参照してください。
表19-19 javax.xml.ws.handler.LogicalMessageContextインタフェースのサポート範囲
| 項番 | 戻り値の型 | メソッド名／説明 | サポート | |
|---|---|---|---|---|
| 1 | LogicalMessage | getMessage() | ○ | |
| 説明 | このメッセージコンテキストからメッセージを取得します。 | |||
javax.xml.ws.handler.MessageContextインタフェースのサポート範囲を次の表に示します。詳細はJAX-WS 2.2仕様を参照してください。
表19-20 javax.xml.ws.handler.MessageContextインタフェースのサポート範囲
| 項番 | 戻り値の型 | メソッド名／説明 | サポート | |
|---|---|---|---|---|
| 1 | MessageContext.Scope | getScope(java.lang.String name) | ○※1 | |
| 説明 | プロパティのスコープを取得します。 | |||
| 例外 |
|
|||
| 2 | void | setScope(java.lang.String name, MessageContext.Scope scope) | ○※2 | |
| 説明 | プロパティのスコープを設定します。 | |||
| 例外 |
|
|||
javax.xml.ws.handler.PortInfoインタフェースのサポート範囲を次の表に示します。詳細はJAX-WS 2.2仕様を参照してください。
表19-21 javax.xml.ws.handler.PortInfoインタフェースのサポート範囲
| 項番 | 戻り値の型 | メソッド名／説明 | サポート | |
|---|---|---|---|---|
| 1 | java.lang.String | getBindingID() | ○ | |
| 説明 | アクセス対象のポートが使用する，バインディングを識別するURIを取得します。 | |||
| 2 | javax.xml.namespace.QName | getPortName() | ○ | |
| 説明 | アクセス対象のWSDLのポートからQNameを取得します。 | |||
| 3 | javax.xml.namespace.QName | getServiceName() | ○ | |
| 説明 | アクセス対象のポートを含む，WSDLのサービスのQNameを取得します。 | |||
javax.xml.ws.handler.soap.SOAPHandler<T extends SOAPMessageContext>インタフェースのサポート範囲を次の表に示します。詳細はJAX-WS 2.2仕様を参照してください。
表19-22 javax.xml.ws.handler.soap.SOAPHandler<T extends SOAPMessageContext>インタフェースのサポート範囲
| 項番 | 戻り値の型 | メソッド名／説明 | サポート | |
|---|---|---|---|---|
| 1 | java.util.Set<javax.xml.namespace.QName> | getHeaders() | ○ | |
| 説明 | このハンドラインスタンスで処理できるヘッダを取得します。 | |||
javax.xml.ws.handler.soap.SOAPMessageContextインタフェースのサポート範囲を次の表に示します。詳細はJAX-WS 2.2仕様を参照してください。
表19-23 javax.xml.ws.handler.soap.SOAPMessageContextインタフェースのサポート範囲
| 項番 | 戻り値の型 | メソッド名／説明 | サポート | |
|---|---|---|---|---|
| 1 | java.lang.Object[] | getHeaders(javax.xml.namespace.QName header, javax.xml.bind.JAXBContext context, boolean allRoles) | ○ | |
| 説明 | このメッセージコンテキストが持つメッセージから特定のQNameを持つヘッダを取得します。このメッセージコンテキストがメッセージを持っていない場合，またはheaderで指定したQNameに一致するヘッダが存在しない場合は，空の配列を返します。 | |||
| 例外 |
|
|||
| 2 | javax.xml.soap.SOAPMessage | getMessage() | ○ | |
| 説明 | このメッセージコンテキストからSOAPメッセージを取得します。 | |||
| 3 | java.util.Set<java.lang.String> | getRoles() | ○ | |
| 説明 | ハンドラチェインの実行に関連づけられたSOAPアクタおよびロールを取得します。 | |||
| 4 | void | setMessage(javax.xml.soap.SOAPMessage message) | × | |
javax.xml.ws.Holder<T>クラスのサポート範囲を次の表に示します。詳細はJAX-WS 2.2仕様を参照してください。
表19-24 javax.xml.ws.Holder<T>クラスのサポート範囲
| 項番 | 戻り値の型 | メソッド名／説明 | サポート | |
|---|---|---|---|---|
| 1 | − | Holder() | ○ | |
| 説明 | null値を含む新しいホルダを作成します。 | |||
| 2 | − | Holder(T value) | ○ | |
| 説明 | 指定した値を含む新しいホルダを作成します。 | |||
javax.xml.ws.LogicalMessageインタフェースのサポート範囲を次の表に示します。
表19-25 javax.xml.ws.LogicalMessageインタフェースのサポート範囲
| 項番 | 戻り値の型 | メソッド名／説明 | サポート | |
|---|---|---|---|---|
| 1 | javax.xml.transform.Source | getPayload() | ○ | |
| 説明 | XMLソースとしてメッセージのペイロードを取得します。 | |||
| 2 | java.lang.Object | getPayload(javax.xml.bind.JAXBContext context) | ○ | |
| 説明 | JAXBオブジェクトとしてメッセージのペイロードを取得します | |||
| 3 | void | setPayload(java.lang.Object payload, javax.xml.bind.JAXBContext context) | × | |
| 4 | void | setPayload(javax.xml.transform.Source payload) | × | |
javax.xml.ws.ProtocolExceptionクラスのサポート範囲を次の表に示します。詳細はJAX-WS 2.2仕様を参照してください。
表19-26 javax.xml.ws.ProtocolExceptionクラスのサポート範囲
| 項番 | 戻り値の型 | メソッド名／説明 | サポート | |
|---|---|---|---|---|
| 1 | − | ProtocolException() | ○ | |
| 説明 | 詳細メッセージがnullである新規例外を構築します。 | |||
| 2 | − | ProtocolException(java.lang.String message) | ○ | |
| 説明 | 指定された詳細メッセージを持つ新規例外を構築します。 | |||
| 3 | − | ProtocolException(java.lang.String message, java.lang.Throwable cause) | ○ | |
| 説明 | 指定された詳細メッセージおよび原因を使用して新規例外を構築します。 | |||
| 4 | − | ProtocolException(java.lang.Throwable cause) | ○ | |
| 説明 | 指定された原因と詳細メッセージを持つ新規例外を構築します。 | |||
javax.xml.ws.soap.AddressingFeatureクラスのサポート範囲を次の表に示します。詳細はJAX-WS 2.2仕様を参照してください。
表19-27 javax.xml.ws.soap.AddressingFeatureクラスのサポート範囲
| 項番 | 戻り値の型 | メソッド名 | サポート | |
|---|---|---|---|---|
| 1 | − | AddressingFeature() | ○ | |
| 説明 | AddressingFeatureを作成します。 | |||
| 2 | − | AddressingFeature(boolean enabled) | ○ | |
| 説明 | AddressingFeatureを作成します。 | |||
| 引数 |
|
|||
| 3 | − | AddressingFeature(boolean enabled, boolean required) | ○ | |
| 説明 | AddressingFeatureを作成します。 | |||
| 引数 |
|
|||
| 4 | − | AddressingFeature(boolean enabled, boolean required, AddressingFeature.Responses responses) |
○ | |
| 説明 | AddressingFeatureを作成します。 | |||
| 引数 |
|
|||
| 5 | java.lang.String | getID() | ○ | |
| 説明 | AdderssingFeatureの一意の識別子を取得します。 | |||
| 6 | AddressingFeature.Responses | getResponses() | ○ | |
| 説明 | 要求する応答エンドポイントの種別を取得します。 | |||
| 7 | Boolean | isRequired() | ○ | |
| 説明 | AdderssingFeatureの使用を要求するかどうかの情報を取得します。 | |||
javax.xml.ws.soap.MTOMFeatureクラスのサポート範囲を次の表に示します。詳細はJAX-WS 2.2仕様を参照してください。
表19-28 javax.xml.ws.soap.MTOMFeatureクラスのサポート範囲
| 項番 | 戻り値の型 | メソッド名 | サポート | |
|---|---|---|---|---|
| 1 | − | MTOMFeature() | ○ | |
| 説明 | MTOMFeatureを作成します。 | |||
| 2 | − | MTOMFeature(boolean enabled) | ○ | |
| 説明 | MTOMFeatureを作成します。 | |||
| 引数 |
|
|||
| 3 | − | MTOMFeature(boolean enabled, int threshold) | ○ | |
| 説明 | MTOMFeatureを作成します。 | |||
| 引数 |
|
|||
| 4 | − | MTOMFeature(int threshold) | ○ | |
| 説明 | MTOMFeatureを作成します。 | |||
| 引数 |
|
|||
| 5 | java.lang.String | getID() | ○ | |
| 説明 | MTOMFeatureの一意の識別子を取得します。 | |||
| 6 | int | getThreshold() | ○ | |
| 説明 | バイナリデータをMTOM/XOP仕様形式の添付ファイルとして送信するかどうかを判定するためのしきい値を取得します。 | |||
javax.xml.ws.soap.SOAPBindingインタフェースのサポート範囲を次の表に示します。詳細はJAX-WS 2.2仕様を参照してください。
表19-29 javax.xml.ws.soap.SOAPBindingインタフェースのサポート範囲
| 項番 | 戻り値の型 | メソッド名 | サポート | |
|---|---|---|---|---|
| 1 | javax.xml.soap.MessageFactory | getMessageFactory() | × | |
| 2 | java.util.Set<java.lang.String> | getRoles() | × | |
| 3 | javax.xml.soap.SOAPFactory | getSOAPFactory() | × | |
| 4 | boolean | isMTOMEnabled() | ○ | |
| 説明 | MTOM/XOP仕様形式の添付ファイルが有効化されている場合，trueを返します。 | |||
| 5 | void | setMTOMEnabled(boolean flag) | ○ | |
| 説明 | MTOM/XOP仕様形式の添付ファイルを有効または無効にします。 MTOMFeatureやこのメソッドを使用してMTOM/XOP仕様形式の添付ファイルの有効または無効が設定されていない場合に，このメソッドで設定できます。すでにMTOM/XOP仕様形式の添付ファイルの有効または無効が設定されている場合，このメソッドによる再設定はできません。 |
|||
| 引数 |
|
|||
| 6 | void | setRoles(java.util.Set<java.lang.String> roles) | × | |
javax.xml.ws.soap.SOAPFaultExceptionクラスのサポート範囲を次の表に示します。詳細はJAX-WS 2.2仕様を参照してください。
表19-30 javax.xml.ws.soap.SOAPFaultExceptionクラスのサポート範囲
| 項番 | 戻り値の型 | メソッド名／説明 | サポート | |
|---|---|---|---|---|
| 1 | − | SOAPFaultException (javax.xml.soap.SOAPFault fault) | ○ | |
| 説明 | SOAPFaultExceptionの新規例外を構築します。 | |||
| 2 | javax.xml.soap.SOAPFault | getFault() | ○ | |
| 説明 | 埋め込まれたSOAPFaultインスタンスを取得します。 | |||
javax.xml.ws.WebServiceExceptionクラスのサポート範囲を次の表に示します。詳細はJAX-WS 2.2仕様を参照してください。
表19-31 javax.xml.ws.WebServiceExceptionクラスのサポート範囲
| 項番 | 戻り値の型 | メソッド名／説明 | サポート | |
|---|---|---|---|---|
| 1 | − | WebServiceException() | ○ | |
| 説明 | 詳細メッセージがnullである新規例外を構築します。 | |||
| 2 | − | WebServiceException (java.lang.String message) | ○ | |
| 説明 | 指定された詳細メッセージを持つ新規例外を構築します。 | |||
| 3 | − | WebServiceException(java.lang.String message, java.lang.Throwable cause) | ○ | |
| 説明 | 指定された詳細メッセージおよび原因を持つ新規例外を構築します。 | |||
| 4 | − | WebServiceException (java.lang.Throwable cause) | ○ | |
| 説明 | 指定された原因および詳細メッセージを持つ新規例外を構築します。 | |||
All Rights Reserved. Copyright (C) 2012, 2015, Hitachi, Ltd.