javax.xml.soap

クラス MimeHeaders

java.lang.Object

javax.xml.soap.MimeHeaders

public class MimeHeaders
extends Object

MimeHeader オブジェクトのコンテナで、メッセージの MIME 部分にある MIME ヘッダーを表します。

このクラスは、主に MIME ヘッダーと値に基づいてアプリケーションに特定の添付を取得させようとするときに使用します。また、このクラスは AttachmentPart や、SAAJ API のほかの MIME 依存部分の実装に多く使用されます。

関連項目:

SOAPMessage.getAttachments(), AttachmentPart

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

コンストラクタ

コンストラクタと説明
MimeHeaders() 空の Vector オブジェクトによって初期化されるデフォルトの MimeHeaders オブジェクトを構築します。

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
void	addHeader(String name, String value) 指定の名前と値の MimeHeader オブジェクトを、この MimeHeaders オブジェクトのヘッダーリストに追加します。
Iterator	getAllHeaders() この MimeHeaders オブジェクトのすべての MimeHeader を返します。
String[]	getHeader(String name) 指定のヘッダーのすべての値を String オブジェクトの配列として返します。
Iterator	getMatchingHeaders(String[] names) 指定の名前配列にある名前と一致する名前を持つ MimeHeader オブジェクトをすべて返します。
Iterator	getNonMatchingHeaders(String[] names) 指定の名前配列にある名前と一致しない名前を持つ MimeHeader オブジェクトをすべて返します。
void	removeAllHeaders() この MimeHeaders オブジェクトからすべてのヘッダーエントリを削除します。
void	removeHeader(String name) 指定の名前に一致する名前を持つ MimeHeader オブジェクトをすべて削除します。
void	setHeader(String name, String value) 指定の値に対し、指定の名前が一致する最初のヘッダーエントリの現在の値を置き換えます。既存のヘッダーで一致するものがない場合、新たにヘッダーを追加します。

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

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

コンストラクタの詳細

MimeHeaders

public MimeHeaders()

空の Vector オブジェクトによって初期化されるデフォルトの MimeHeaders オブジェクトを構築します。

メソッドの詳細

getHeader

public String[] getHeader(String name)

指定のヘッダーのすべての値を String オブジェクトの配列として返します。

パラメータ:

name - 返される値のヘッダー名

戻り値:

指定のヘッダーのすべての値を持つ String 配列

関連項目:

setHeader(java.lang.String, java.lang.String)

setHeader

public void setHeader(String name,
             String value)

指定の値に対し、指定の名前が一致する最初のヘッダーエントリの現在の値を置き換えます。既存のヘッダーで一致するものがない場合、新たにヘッダーを追加します。このメソッドは、最初の 1 つの後、一致するヘッダーをすべて削除します。

RFC822 ヘッダーは US-ASCII 文字だけを含むことが可能である点に注意してください。

パラメータ:

name - 検索するヘッダー名を持つ String

value - 指定のヘッダーの現在の値と置き換える値を持つ String

例外:

IllegalArgumentException - 設定する MIME ヘッダー名または値に問題があった場合

関連項目:

getHeader(java.lang.String)

addHeader

public void addHeader(String name,
             String value)

指定の名前と値の MimeHeader オブジェクトを、この MimeHeaders オブジェクトのヘッダーリストに追加します。

RFC822 ヘッダーは US-ASCII 文字だけを含むことが可能である点に注意してください。

パラメータ:

name - 追加するヘッダーの名前を持つ String

value - 追加するヘッダーの値を持つ String

例外:

IllegalArgumentException - 追加する MIME ヘッダー名または値に問題があった場合

removeHeader

public void removeHeader(String name)

指定の名前に一致する名前を持つ MimeHeader オブジェクトをすべて削除します。

パラメータ:

name - 検索するヘッダー名を持つ String

removeAllHeaders

public void removeAllHeaders()

この MimeHeaders オブジェクトからすべてのヘッダーエントリを削除します。

getAllHeaders

public Iterator getAllHeaders()

この MimeHeaders オブジェクトのすべての MimeHeader を返します。

戻り値:

MimeHeader オブジェクトの MimeHeaders オブジェクトリストの Iterator オブジェクト

getMatchingHeaders

public Iterator getMatchingHeaders(String[] names)

指定の名前配列にある名前と一致する名前を持つ MimeHeader オブジェクトをすべて返します。

パラメータ:

names - 検索する名前を持つ String オブジェクトの配列

戻り値:

指定のリストにある名前の 1 つと一致する MimeHeader オブジェクトの Iterator オブジェクト

getNonMatchingHeaders

public Iterator getNonMatchingHeaders(String[] names)

指定の名前配列にある名前と一致しない名前を持つ MimeHeader オブジェクトをすべて返します。

パラメータ:

names - 検索する名前を持つ String オブジェクトの配列

戻り値:

指定のリストにある名前のいずれにも一致しない MimeHeader オブジェクトの Iterator オブジェクト