javax.xml.bind.attachment

クラスAttachmentMarshaller

java.lang.Object

javax.xml.bind.attachment.AttachmentMarshaller

public abstract class AttachmentMarshaller
extends Object

JAXB整列化プロセスがバイナリ・データのストレージを最適化できるようにします。

このAPIは、JAXB整列化プロセスとMIMEベース・パッケージ・プロセッサ間における、最適化されたバイナリ・データ形式の効率的かつ協調的な作成を可能にします。JAXB実装はMIMEベース・パッケージのルート本体を整列化し、参照可能なMIMEパートの作成をこの抽象化オブジェクトを実装するMIMEベース・パッケージ・プロセッサに委任します。

isXOPPackage()がtrueの場合、XOP処理は有効になります。詳細は、addMtomAttachment(DataHandler, String, String)を参照してください。

WS-I Attachment Profile 1.0は、{http://ws-i.org/profiles/basic/1.1/xsd}swaRefに関係する各JAXBプロパティに対するmarshallerによって呼び出されるaddSwaRefAttachment(DataHandler)によってサポートされています。

導入されたバージョン:

JAXB 2.0

関連項目:

Marshaller.setAttachmentMarshaller(AttachmentMarshaller), XML-binary Optimized Packaging, WS-I Attachments Profile Version 1.0

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

コンストラクタ

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

メソッドのサマリー

修飾子と型	メソッドと説明
abstract String	addMtomAttachment(byte[] data, int offset, int length, String mimeType, String elementNamespace, String elementLocalName) バイナリdataを、添付として最適化されたバイナリ・ストレージにすることを考慮します。
abstract String	addMtomAttachment(DataHandler data, String elementNamespace, String elementLocalName) MIMEコンテンツdataを、添付として最適化されたバイナリ・ストレージにすることを考慮します。
abstract String	addSwaRefAttachment(DataHandler data) 添付としてMIME dataを追加し、添付のコンテンツID、cidを返します。
boolean	isXOPPackage() JAXB marshallerがXOP作成を有効にすべき場合、trueを返す読取り専用プロパティ。

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

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

コンストラクタの詳細

AttachmentMarshaller

public AttachmentMarshaller()

メソッドの詳細

addMtomAttachment

public abstract String addMtomAttachment(DataHandler data,
                                         String elementNamespace,
                                         String elementLocalName)

MIMEコンテンツdataを、添付として最適化されたバイナリ・ストレージにすることを考慮します。

isXOPPackage()がtrueの場合、「Creating XOP Packages」のステップ3に記載されているとおり、データ型が「base64Binary」である各要素に対し、JAXB整列化プロセスによってこのメソッドは呼び出されます。

このメソッドの実装者は、dataを独立して添付するか、base64Binaryデータ形式にインライン化するかを決定します。実装がMIMEパートとしてバイナリ・データのストレージを最適化することを選択した場合、dataをMIMEベース・パッケージに添付した後、MIMEメッセージ内のMIMEパートを識別する一意のコンテンツID、cidを割り当てることが必要です。このメソッドはcidを返します。これにより、JAXBマーシャラは、バイナリ・データを整列化するかわりに、そのcidを参照するXOP要素を整列化できます。メソッドがnullを返す場合、JAXBマーシャラはbase64binaryデータとしてdataをインラインにします。

このメソッドの呼出し側は、次の制約を満たす必要があります。dataを含む要素情報セット項目にxmime:contentType属性がある場合、または、dataを表現するJAXBプロパティまたはフィールドが既知のMIME型で注釈されている場合、data.getContentType()がそのMIME型に設定される必要があります。

elementNamespaceおよびelementLocalNameパラメータは、バイナリ・データを含むコンテキストを提供します。この情報は、バイナリ・データをインラインにするか、添付として最適化するかを決定するために、MIMEベース・パッケージ・プロセッサによって使用される場合があります。

パラメータ:

data - 添付するデータを表現する。null以外。

elementNamespace - base64Binaryデータを包含する要素の名前空間URI。nullは不可、空は可。

elementLocalName - 要素のローカル名。常にnull以外の有効な文字列。

戻り値:

dataを含む添付を識別する有効なコンテンツID URI (RFC 2387を参照)。それ以外の場合、添付が追加されておらず、代わりにメッセージ内にインライン化するべきなら、null。

関連項目:

XML-binary Optimized Packaging, Describing Media Content of Binary Data in XML

addMtomAttachment

public abstract String addMtomAttachment(byte[] data,
                                         int offset,
                                         int length,
                                         String mimeType,
                                         String elementNamespace,
                                         String elementLocalName)

バイナリdataを、添付として最適化されたバイナリ・ストレージにすることを考慮します。

コンテンツ型が不明であるため、添付のMIMEコンテンツ型を「application/octet-stream」に設定する必要があります。

elementNamespaceおよびelementLocalNameパラメータは、バイナリ・データを含むコンテキストを提供します。この情報は、バイナリ・データをインラインにするか、添付として最適化するかを決定するために、MIMEベース・パッケージ・プロセッサによって使用される場合があります。

パラメータ:

data - 添付するデータを表現する。null以外。実際のデータ領域は(data,offset,length)タプルによって指定される。

offset - 最初のバイトの読込み先となる配列内のオフセット。array.length以下の負でない値にする必要がある

length - 指定された配列から読み込むバイト数。array.length以下の負でない値にする必要がある

mimeType - データにJAXBが認識しているMIME型が関連付けられている場合、それがこのパラメータとして渡される。認識しているMIME型がない場合、「application/octet-stream」。このパラメータはnullは不可。

elementNamespace - base64Binaryデータを包含する要素の名前空間URI。nullは不可、空は可。

elementLocalName - 要素のローカル名。常にnull以外の有効な文字列。

戻り値:

dataを含む添付に対するコンテンツID URI、cid。データをインライン化するべき場合はnull。

関連項目:

addMtomAttachment(DataHandler, String, String)

isXOPPackage

public boolean isXOPPackage()

JAXB marshallerがXOP作成を有効にすべき場合、trueを返す読取り専用プロパティ。

整列化プロセス中に、この値を変更しないでください。この値がtrueの場合、整列化プロセスで適切なバイナリ・データ型が現れたとき、addMtomAttachment(...)メソッドが呼び出されます。

この値がtrueであり、整列化されたXMLコンテンツが「Creating XOP Pacakges」(http://www.w3.org/TR/2005/REC-xop10-20050125/#creating_xop_packages)のステップ1に違反した場合、Marshaller.marshal()はIllegalStateExceptionをスローします。「Ensure the Original XML Infoset contains no element information item with a [namespace name] of "http://www.w3.org/2004/08/xop/include" and a [local name] of Include (元のXML情報セットに、[namespace name]が「http://www.w3.org/2004/08/xop/include」で、[local name]がIncludeである要素情報項目が含まれないようにすること)」

このメソッドがtrueを返し、整列化プロセス中、最低1回のaddMtomAttachment(...)呼出しがコンテンツIDを返した場合、MIMEベース・パッケージ・プロセッサは、「Creating XOP Pacakges」のステップ5に記載されているとおり、application/xop+xmlメディア・タイプをルート部分にラベル付けする必要があります。

戻り値:

MIMEコンテキストがXOPパッケージの場合、true。

addSwaRefAttachment

public abstract String addSwaRefAttachment(DataHandler data)

添付としてMIME dataを追加し、添付のコンテンツID、cidを返します。

このメソッドは、{http://ws-i.org/profiles/basic/1.1/xsd}swaRef型であるそれぞれの要素/属性に対するJAXB整列化プロセスによって呼び出されます。このメソッドを実装するMIMEベース・パッケージ・プロセッサは、指定されたデータをMIME添付に添付し、MIMEベース・パッケージ内でその添付を一意に識別するコンテンツID、cidを生成します。

呼出し側は、返されたコンテンツID、cidを、整列化されたXMLコンテンツに挿入します。

パラメータ:

data - 添付するデータを表現する。null以外。

戻り値:

cidとして使用される有効なURI。WS-I Attachments Profile Version 1.0の準拠要件R2928を満たすこと。