クラス AttachmentUnmarshaller
- java.lang.ObjectSE
-
- jakarta.xml.bind.attachment.AttachmentUnmarshaller
public abstract class AttachmentUnmarshaller extends ObjectSE
最適化されたバイナリデータ形式を含むルートドキュメントの Jakarta XML Binding アンマーシャリングを有効にします。
この API により、Jakarta XML Binding 実装と MIME ベースのパッケージプロセッサー (MTOM/XOP および WS-I AP 1.0) の間で、最適化されたバイナリデータ形式の効率的な協調処理が可能になります。Jakarta XML Binding はパッケージの本体をアンマーシャリングし、使用されているパッケージ形式の理解を、この抽象クラスを実装する MIME ベースのパッケージプロセッサーに委譲します。
この抽象クラスは、パッケージが XOP 処理
isXOPPackage()
を必要とするかどうかを識別し、content-id によって接続ファイルとして保存されているバイナリコンテンツの取得を提供します。getAttachment*(String cid)
に渡すコンテンツ ID cid の識別- XOP 処理の場合、cid の infoset 表現はセクション 3.2 XOP パッケージの解釈のステップ 2a に記述されています。
- WS-I AP 1.0 の場合、cid は、セクション 4.4 SOAP エンベロープからの添付ファイルの参照で指定された型
ref:swaRef
の要素または属性として識別されます。
- 導入:
- 1.6、JAXB 2.0
- 作成者:
- Marc Hadley, Kohsuke Kawaguchi, Joseph Fialli
- 関連事項:
Unmarshaller.setAttachmentUnmarshaller(AttachmentUnmarshaller)
, XML バイナリ最適化パッケージ , WS-I 接続ファイルプロファイルバージョン 1.0 ., XML でのバイナリデータのメディアコンテンツの記述
コンストラクターのサマリー
コンストラクター 修飾子 コンストラクター 説明 protected
AttachmentUnmarshaller()
派生クラスの何もしないコンストラクター。
メソッドのサマリー
すべてのメソッド インスタンスメソッド 抽象メソッド 具象メソッド 修飾子と型 メソッド 説明 abstract byte[]
getAttachmentAsByteArray(StringSE cid)
content-idcid
で識別される添付ファイルをbyte[]
として取得します。abstract DataHandler
getAttachmentAsDataHandler(StringSE cid)
content-id、cid
で MIME コンテンツを検索し、DataHandler
として返します。boolean
isXOPPackage()
Jakarta XML Binding アンマーシャラーが XOP 処理を実行する必要がある場合に true を返す読み取り専用プロパティ。
メソッドの詳細
getAttachmentAsDataHandler
public abstract DataHandler getAttachmentAsDataHandler(StringSE cid)
content-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
。 - 例外:
IllegalArgumentExceptionSE
- 指定された cid の添付ファイルが見つからない場合。
getAttachmentAsByteArray
public abstract byte[] getAttachmentAsByteArray(StringSE cid)
content-id
cid
で識別される添付ファイルをbyte[]
として取得します。- パラメーター:
cid
- これは、XML スキーマxs:anyURI
データ型の有効な字句形式であることが期待されます。isXOPPackage()
==true
の場合、cid:
URI スキームごとの有効な URI である必要があります (RFC 2387 を参照)- 戻り値:
- cid によって識別される添付ファイルの byte[] 表現。
- 例外:
IllegalArgumentExceptionSE
- 指定された cid の添付ファイルが見つからない場合。
isXOPPackage
public boolean isXOPPackage()
Jakarta XML Binding アンマーシャラーが XOP 処理を実行する必要がある場合に true を返す読み取り専用プロパティ。
このメソッドは、XOP ドキュメントの識別で指定された制約が満たされると、
true
を返します。この値は、非整列化プロセス中に変更してはなりません。- 戻り値:
- MIME コンテキストが XOP ドキュメントの場合は true。