19.2.4　コアAPI

1

−

StreamingAttachmentFeature()

×

2

−

StreamingAttachmentFeature(String dir,boolean parseEagerly,long memoryThreshold)

○

説明

StreamingAttachmentFeatureを作成します。

引数

dir：

一時ファイルの出力先ディレクトリパスです。存在しないディレクトリ，アクセス権のないディレクトリ，または存在するファイル名を指定した場合，メッセージを出力し，受信した添付ファイルを含むSOAPメッセージに含まれるMIMEボディをメモリ上に展開します（KDJW10026-W）。

parseEagerly：

受信した添付ファイルを含むSOAPメッセージを詳細に解析するかどうかを設定します。trueの場合，添付ファイルを含むSOAPメッセージを詳細に解析します。

memoryThreshold：

添付ファイルを含むSOAPメッセージを受信する際に，SOAPメッセージに含まれるMIMEボディをメモリ上に展開するかどうかを判定するためのしきい値(単位：バイト)です。16KB（16384L）より大きい値または-1を指定します。これら以外の値を指定した場合，動作は保証されません。-1を指定した場合，常にMIMEボディをメモリ上に展開します。

3

java.lang.String

getID()

○

説明

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

4

org.jvnet.mimepull.MIMEConfig

getConfig()

○

説明

ストリーミングの設定情報を表すMIMEConfigインスタンスを取得します。一度このメソッドを呼び出した場合，次のsetterメソッドを用いてストリーミングの設定情報を変更することはできません。

• setDir(String dir)

• setParseEagerly(boolean parseEagerly)

• setMemoryThreshold(int memoryThreshold)

5

void

setDir(String dir)

○

説明

ストリーミングが有効の場合に，受信した添付ファイルを含むSOAPメッセージに含まれるMIMEボディを一時ファイルとして出力するときに使用するディレクトリを設定します。このメソッドを複数回呼び出した場合，最後に指定した値が有効になります。getConfig()メソッドを呼び出した場合，このメソッドによる再設定はできません。

引数

dir：

一時ファイルの出力先ディレクトリパスです。存在しないディレクトリ，アクセス権のないディレクトリ，または存在するファイル名を指定した場合，メッセージを出力し，受信した添付ファイルを含むSOAPメッセージに含まれるMIMEボディをメモリ上に展開します（KDJW10026-W）。

6

void

setParseEagerly(boolean parseEagerly)

○

説明

ストリーミングが有効の場合に，受信した添付ファイルを含むSOAPメッセージを詳細に解析するかどうかを設定します。このメソッドを複数回呼び出した場合，最後に指定した値が有効になります。getConfig()メソッドを呼び出した場合，このメソッドによる再設定はできません。

引数

parseEagerly：

受信した添付ファイルを含むSOAPメッセージを詳細に解析するかどうかを設定します。trueの場合，添付ファイルを含むSOAPメッセージを詳細に解析します。

7

void

setMemoryThreshold(int memoryThreshold)

○

説明

ストリーミングが有効の場合に，添付ファイルを含むSOAPメッセージを受信するときにSOAPメッセージに含まれるMIMEボディをメモリ上に展開するかどうかを判定するためのしきい値を設定します。このメソッドを複数回呼び出した場合，最後に指定した値が有効になります。getConfig()メソッドを呼び出した場合，このメソッドによる再設定はできません。

引数

memoryThreshold：

添付ファイルを含むSOAPメッセージを受信する際に，SOAPメッセージに含まれるMIMEボディをメモリ上に展開するかどうかを判定するためのしきい値(単位：バイト)です。16KB（16384L）より大きい値または-1を指定します。これら以外の値を指定した場合，動作は保証されません。-1を指定した場合，常にMIMEボディをメモリ上に展開します。

1

−

StreamingDataHandler(Object o, String s)

×

2

−

StreamingDataHandler(URL url)

×

3

−

StreamingDataHandler(DataSource dataSource)

×

4

java.io.InputStream

readOnce()

○

説明

このオブジェクトのjava.io.InputStreamを取得します。

例外

IOException：

このオブジェクトに対応するInputStreamが取得できなかった場合に発生します。

5

void

moveTo(File file)

○

説明

このオブジェクトが示す添付ファイルを指定されたファイルに移動します。

• 引数fileにnullを指定した場合，java.io.IOExceptionが発生します（KDJW10023-E）。

• 引数fileに存在するファイルまたはディレクトリのパス，存在しない親ディレクトリを含むファイルパスを指定した場合，IOExceptionが発生します（KDJW10027-E）。

引数

file：

出力先ファイルパスです。

例外

IOException：

次の場合に発生します。

• nullをfileに指定。

• 存在するファイルまたはディレクトリのパス，または存在しない親ディレクトリを含むファイルパスをfileに指定。

• 入出力エラーが発生。

6

void

close()

○

説明

このオブジェクトが示す添付ファイルのリソースを解放します。

例外

IOException：

入出力エラーが発生した場合に発生します。

1

−

MIMEConfig()

×

2

void

setParseEagerly(boolean parseEagerly)

○

説明

ストリーミングが有効の場合に，受信した添付ファイルを含むSOAPメッセージを詳細に解析するかどうかを設定します。このメソッドを複数回呼び出した場合，最後に指定した値が有効になります。

引数

parseEagerly：

受信した添付ファイルを含むSOAPメッセージを詳細に解析するかどうかを設定します。trueの場合，添付ファイルを含むSOAPメッセージを詳細に解析します。

3

void

setMemoryThreshold(long memoryThreshold)

○

説明

ストリーミングが有効の場合に，添付ファイルを含むSOAPメッセージを受信するときに，SOAPメッセージに含まれるMIMEボディをメモリ上に展開するかどうかを判定するためのしきい値を設定します。このメソッドを複数回呼び出した場合，最後に指定した値が有効になります。

引数

memoryThreshold：

添付ファイルを含むSOAPメッセージを受信する際に，SOAPメッセージに含まれるMIMEボディをメモリ上に展開するかどうかを判定するためのしきい値(単位：バイト)です。16KB（16384L）より大きい値または-1を指定します。これら以外の値を指定した場合，動作は保証されません。-1を指定した場合，常にMIMEボディをメモリ上に展開します。

4

void

setDir(String dir)

○

説明

ストリーミングが有効の場合に，受信した添付ファイルを含むSOAPメッセージに含まれるMIMEボディを一時ファイルとして出力するときに使用するディレクトリを設定します。このメソッドを複数回呼び出した場合，nullまたは空文字（""）以外の値で最初に指定したものが有効になります。

引数

dir：

一時ファイルの出力先ディレクトリパスです。

5

void

validate()

○

説明

一時ファイルを作成できるかを検証します。作成できない場合，添付ファイルをメモリ上に展開するように設定します。

存在しないディレクトリ，アクセス権のないディレクトリ，存在するファイル名をsetDir(String dir)メソッドで設定し，このメソッドで検証しない場合，ストリーミングが一時ファイルを出力するときにorg.jvnet.mimepull.MIMEParsingExceptionが発生します。

1

java.lang.String

getBindingID()

×

2

java.util.List<Handler>

getHandlerChain()

○

説明

プロトコルバインディングインスタンスのハンドラチェインのコピーを取得します。

3

void

setHandlerChain (java.util.List<Handler> chain)

○

説明

プロトコルバインディングインスタンスのハンドラチェインを設定します。

引数

chain：

ハンドラチェインを構成するハンドラのリストです。

例外

javax.xml.ws.WebServiceException：

ハンドラチェインの設定でエラーが起きた場合，またはchainにnullを指定した場合に発生します。

1

MessageContext.Scope

close(MessageContext context)

○

説明

メッセージ交換を完了するとき，JAX-WSのランタイムがメッセージ，フォルト，または例外をディスパッチする直前に呼び出されます。

2

boolean

handleFault(C context)

○

説明

フォルトメッセージを処理するために呼び出されます。

3

boolean

handleMessage(C context)

○

説明

インバウンドおよびアウトバウンドのメッセージで通常の処理をするために呼び出されます。

1

java.util.List<Handler>

getHandlerChain(PortInfo portInfo)

○

説明

指定されたポートのハンドラチェインを取得します。このメソッドではnullを返さないでください。

引数

portInfo：

アクセス対象のポートの情報です。

1

LogicalMessage

getMessage()

○

説明

このメッセージコンテキストからメッセージを取得します。

1

MessageContext.Scope

getScope(java.lang.String name)

○^※1

説明

プロパティのスコープを取得します。

例外

java.lang.IllegalArgumentException：

nameにnull，空の文字列，およびこのメッセージコンテキストに関連づけられていないプロパティ名を指定した場合に発生します。

標準のメッセージコンテキストのプロパティと，ユーザ定義メッセージコンテキストプロパティは，メッセージコンテキストに関連づけられているものと見なされます。

メッセージコンテキストのプロパティについては，「19.2.5(1)　メッセージコンテキストのプロパティのサポート範囲」を参照してください。

2

void

setScope(java.lang.String name, MessageContext.Scope scope)

○^※2

説明

プロパティのスコープを設定します。

例外

java.lang.IllegalArgumentException

nameにnull，空の文字列，およびこのメッセージコンテキストに関連づけられていないプロパティ名を指定した場合に発生します。標準のメッセージコンテキストのプロパティと，ユーザ定義メッセージコンテキストプロパティは，メッセージコンテキストに関連づけられているものと見なされます。

メッセージコンテキストのプロパティについては，「19.2.5(1)　メッセージコンテキストのプロパティのサポート範囲」を参照してください。

1

java.lang.String

getBindingID()

○

説明

アクセス対象のポートが使用する，バインディングを識別するURIを取得します。

2

javax.xml.namespace.QName

getPortName()

○

説明

アクセス対象のWSDLのポートからQNameを取得します。

3

javax.xml.namespace.QName

getServiceName()

○

説明

アクセス対象のポートを含む，WSDLのサービスのQNameを取得します。

1

java.util.Set<javax.xml.namespace.QName>

getHeaders()

○

説明

このハンドラインスタンスで処理できるヘッダを取得します。

1

java.lang.Object[]

getHeaders(javax.xml.namespace.QName header, javax.xml.bind.JAXBContext context, boolean allRoles)

○

説明

このメッセージコンテキストが持つメッセージから特定のQNameを持つヘッダを取得します。このメッセージコンテキストがメッセージを持っていない場合，またはheaderで指定したQNameに一致するヘッダが存在しない場合は，空の配列を返します。

例外

javax.xml.ws.WebServiceException：

次の場合に発生します。

• headerにnullを指定した場合

• contextにnullを指定した場合

2

javax.xml.soap.SOAPMessage

getMessage()

○

説明

このメッセージコンテキストからSOAPメッセージを取得します。

3

java.util.Set<java.lang.String>

getRoles()

○

説明

ハンドラチェインの実行に関連づけられたSOAPアクタおよびロールを取得します。

4

void

setMessage(javax.xml.soap.SOAPMessage message)

×

1

−

Holder()

○

説明

null値を含む新しいホルダを作成します。

2

−

Holder(T value)

○

説明

指定した値を含む新しいホルダを作成します。

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)

×

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)

○

説明

指定された原因と詳細メッセージを持つ新規例外を構築します。

1

−

AddressingFeature()

○

説明

AddressingFeatureを作成します。

2

−

AddressingFeature(boolean enabled)

○

説明

AddressingFeatureを作成します。

引数

enabled：

WS-Addressingを有効にするか無効にするかを指定します。

3

−

AddressingFeature(boolean enabled, boolean required)

○

説明

AddressingFeatureを作成します。

引数

enabled：

WS-Addressingを有効にするか無効にするかを指定します。

required：

WS-Addressingの使用を要求する場合に指定します。

4

−

AddressingFeature(boolean enabled, boolean required,

AddressingFeature.Responses responses)

○

説明

AddressingFeatureを作成します。

引数

enabled：

WS-Addressingを有効にするか無効にするかを指定します。

required：

WS-Addressingの使用を要求する場合に指定します。

responses：

要求する応答エンドポイントの種別を指定します。応答エンドポイントの種別は，次のどれかを指定できます。^※

• すべてのURI

  javax.xml.ws.soap.AddressingFeature.Responses.ALL

• 匿名URIだけ

  javax.xml.ws.soap.AddressingFeature.Responses.ANONYMOUS

• 非匿名URIだけ

  javax.xml.ws.soap.AddressingFeature.Responses.NON_ANONYMOUS

5

java.lang.String

getID()

○

説明

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

6

AddressingFeature.Responses

getResponses()

○

説明

要求する応答エンドポイントの種別を取得します。

7

Boolean

isRequired()

○

説明

AdderssingFeatureの使用を要求するかどうかの情報を取得します。

1

−

MTOMFeature()

○

説明

MTOMFeatureを作成します。

2

−

MTOMFeature(boolean enabled)

○

説明

MTOMFeatureを作成します。

引数

enabled：

MTOM/XOP仕様形式の添付ファイルを使用するかどうかを指定します。

3

−

MTOMFeature(boolean enabled, int threshold)

○

説明

MTOMFeatureを作成します。

引数

enabled：

MTOM/XOP仕様形式の添付ファイルを使用するかどうかを指定します。

threshold：

MTOM/XOP仕様形式の添付ファイルとして送信するバイナリデータのサイズ（単位：バイト）です。thresholdの指定値≦バイナリデータのサイズのとき，バイナリデータをMTOM/XOP仕様形式の添付ファイルとして送信します。

4

−

MTOMFeature(int threshold)

○

説明

MTOMFeatureを作成します。

引数

threshold：

MTOM/XOP仕様形式の添付ファイルとして送信するバイナリデータのサイズ（単位：バイト）です。thresholdの指定値≦バイナリデータのサイズのとき，バイナリデータをMTOM/XOP仕様形式の添付ファイルとして送信します。

5

java.lang.String

getID()

○

説明

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

6

int

getThreshold()

○

説明

バイナリデータをMTOM/XOP仕様形式の添付ファイルとして送信するかどうかを判定するためのしきい値を取得します。

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仕様形式の添付ファイルの有効または無効が設定されている場合，このメソッドによる再設定はできません。

引数

flag：

MTOM/XOP仕様形式の添付ファイルを有効にするか無効にするかを指定します。

6

void

setRoles(java.util.Set<java.lang.String> roles)

×

1

−

SOAPFaultException (javax.xml.soap.SOAPFault fault)

○

説明

SOAPFaultExceptionの新規例外を構築します。

2

javax.xml.soap.SOAPFault

getFault()

○

説明

埋め込まれたSOAPFaultインスタンスを取得します。

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)

○

説明

指定された原因および詳細メッセージを持つ新規例外を構築します。