javax.xml.ws.soap

クラス MTOMFeature

java.lang.Object

javax.xml.ws.WebServiceFeature

javax.xml.ws.soap.MTOMFeature

public final class MTOMFeature
extends WebServiceFeature

この機能は、Web サービスでの MTOM の使用を表します。 この機能は、SEI プロキシ、クライアント側の Dispatch インスタンスおよびサーバー側の Endpoint インスタンスの作成時に使用できます。この機能はクライアント側の Service インスタンスの作成には使用できません。

この機能を有効または無効にした場合の影響は次のとおりです。

• 有効:このモードでは、MTOM が有効になります。受信側は、最適化されていないメッセージも最適化されたメッセージも受け入れる必要があり、送信側は最適化されたメッセージも、最適化されていないメッセージも送信できます。最適化するかどうかを決定するため、送信側が使用するヒューリスティックは、実装に固有です。
• 無効:このモードでは、MTOM が無効になります

threshold プロパティーを使用して、いつバイナリデータを XOP でエンコードすべきかどうかを判定するためのしきい値を設定できます。

導入されたバージョン:

JAX-WS 2.1

フィールドのサマリー

フィールド

修飾子と型	フィールドと説明
static String	ID MTOMFeature を識別する定数です
protected int	threshold MTOM しきい値のプロパティーです。

クラス javax.xml.ws.WebServiceFeature から継承されたフィールド

enabled

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
MTOMFeature() MTOMFeature を作成します。
MTOMFeature(boolean enabled) MTOMFeature を作成します。
MTOMFeature(boolean enabled, int threshold) MTOMFeature を作成します。
MTOMFeature(int threshold) MTOMFeature を作成します。

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
String	getID() この WebServiceFeature の一意の識別子を取得します。
int	getThreshold() バイナリデータを添付として送信すべきかどうかを判定するためのしきい値を取得します。

クラス javax.xml.ws.WebServiceFeature から継承されたメソッド

isEnabled

クラス java.lang.Object から継承されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

ID

public static final String ID

MTOMFeature を識別する定数です

関連項目:

定数フィールド値

threshold

protected int threshold

MTOM しきい値のプロパティーです。このプロパティーは、MTOM が有効になっている場合にヒントとして機能します。このサイズ (バイト単位) を超えるバイナリデータは、添付として送信されるべきです。このプロパティーの値は常に 0 以上でなければいけません。デフォルト値は 0 です。

コンストラクタの詳細

MTOMFeature

public MTOMFeature()

MTOMFeature を作成します。作成されたインスタンスは有効になります。

MTOMFeature

public MTOMFeature(boolean enabled)

MTOMFeature を作成します。

パラメータ:

enabled - この機能を有効にするかどうかを指定する

MTOMFeature

public MTOMFeature(int threshold)

MTOMFeature を作成します。作成されたインスタンスは有効になります。

パラメータ:

threshold - 添付として送信すべきバイナリデータのサイズ (バイト単位)。

例外:

WebServiceException - threshold が 0 より小さい場合

MTOMFeature

public MTOMFeature(boolean enabled,
           int threshold)

MTOMFeature を作成します。

パラメータ:

enabled - この機能を有効にするかどうかを指定する

threshold - 添付として送信すべきバイナリデータのサイズ (バイト単位)。

例外:

WebServiceException - threshold が 0 より小さい場合

メソッドの詳細

getID

public String getID()

この WebServiceFeature の一意の識別子を取得します。

定義:

getID、クラス: WebServiceFeature

戻り値:

この機能の一意の識別子。

getThreshold

public int getThreshold()

バイナリデータを添付として送信すべきかどうかを判定するためのしきい値を取得します。

戻り値:

現在のしきい値サイズ (バイト単位)