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。