javax.xml.bind.attachment

クラス AttachmentUnmarshaller

java.lang.Object

javax.xml.bind.attachment.AttachmentUnmarshaller

public abstract class AttachmentUnmarshaller
extends Object

最適化されたバイナリデータ形式を含むルート文書の JAXB 非整列化を可能にします。

この API は、JAXB 2.0 実装と MIME ベースパッケージプロセッサ (MTOM/XOP および WS-I AP 1.0) 間における、最適化されたバイナリデータ形式の効率的かつ協調的な処理を可能にします。JAXB は、パッケージの本体を非整列化し、使用されるパッケージング形式についての理解をこの abstract クラスを実装する MIME ベースパッケージプロセッサに委任します。

この abstract クラスは、パッケージが XOP 処理を必要とするかどうかを識別し (isXOPPackage())、添付として保存されているバイナリコンテンツをコンテンツ ID によって取得できるようにします。

getAttachment*(String cid) に渡すコンテンツ ID、cid の識別

• XOP 処理における cid の情報セット表現は、セクション 3.2「Interpreting XOP Packages」のステップ 2a に記載されています。
• WS-I AP 1.0 における cid は、セクション 4.4「Referencing Attachments from the SOAP Envelope」に記載されている ref:swaRef 型の要素または属性として識別されます。

導入されたバージョン:

JAXB 2.0

関連項目:

Unmarshaller.setAttachmentUnmarshaller(AttachmentUnmarshaller), XML-binary Optimized Packaging, WS-I Attachments Profile Version 1.0., Describing Media Content of Binary Data in XML

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

コンストラクタ

コンストラクタと説明
AttachmentUnmarshaller()

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
abstract byte[]	getAttachmentAsByteArray(String cid) コンテンツ ID cid によって識別された添付を、byte[] として取得します。
abstract DataHandler	getAttachmentAsDataHandler(String cid) コンテンツ ID cid に基づいて MIME コンテンツを検索し、DataHandler として返します。
boolean	isXOPPackage() JAXB unmarshaller が XOP 処理を実行する必要がある場合、true を返す読み取り専用プロパティーです。

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

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

コンストラクタの詳細

AttachmentUnmarshaller

public AttachmentUnmarshaller()

メソッドの詳細

getAttachmentAsDataHandler

public abstract DataHandler getAttachmentAsDataHandler(String cid)

コンテンツ ID cid に基づいて MIME コンテンツを検索し、DataHandler として返します。

戻り値の DataHandler インスタンスは、次の必要とされるマッピング制約を満たすように設定される必要があります。

MIME および Java 型の間で必要とされるマッピング
MIME タイプ	Java 型
DataHandler.getContentType()	instanceof DataHandler.getContent()
image/gif	java.awt.Image
image/jpeg	java.awt.Image
text/xml または application/xml	javax.xml.transform.Source

追加のマッピングをサポートすることもできます。

パラメータ:

cid - XML スキーマ xs:anyURI データ型の有効な字句表現であることが期待される。isXOPPackage() ==true の場合、各 cid: URI スキームに対する有効な URI にする必要がある (RFC 2387 を参照)

戻り値:

MIME 添付を表す DataHandler。

例外:

IllegalArgumentException - 指定した cid の添付が見つからない場合。

getAttachmentAsByteArray

public abstract byte[] getAttachmentAsByteArray(String cid)

コンテンツ ID cid によって識別された添付を、byte[] として取得します。

.

パラメータ:

cid - XML スキーマ xs:anyURI データ型の有効な字句表現であることが期待される。isXOPPackage() ==true の場合、各 cid: URI スキームに対する有効な URI にする必要がある (RFC 2387 を参照)

戻り値:

cid によって識別された添付の byte [] 表現。

例外:

IllegalArgumentException - 指定した cid の添付が見つからない場合。

isXOPPackage

public boolean isXOPPackage()

JAXB unmarshaller が XOP 処理を実行する必要がある場合、true を返す読み取り専用プロパティーです。

「Identifying XOP Documents」で指定された制約を満たす場合、このメソッドは true を返します。非整列化プロセス中に、この値を変更しないでください。

戻り値:

MIME コンテキストが XOP 文書の場合、true。