javax.servlet.http

インタフェース Part

public interface Part

このクラスはPOSTリクエストのmultipart/form-data内で受け取られたパートまたはフォームのアイテムを表します。

導入されたバージョン:

Servlet 3.0

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	delete() 関連する一時ファイルなど、ストレージ上に存在するファイルアイテムを削除します。
String	getContentType() このパートのコンテンツタイプを取得します。
String	getHeader(String name) MIMEヘッダーから指定された値をStringとして返します。
Collection<String>	getHeaderNames() このパートのヘッダーの名前を取得します。
Collection<String>	getHeaders(String name) 指定された名前でパートのヘッダーの値を取得します。
InputStream	getInputStream() パートのコンテンツを InputStream として取得します。
String	getName() パートの名前を取得します。
long	getSize() このファイルのサイズを返します。
String	getSubmittedFileName() クライアントから示されたファイルの名前を取得します。
void	write(String fileName) このアップロードされたアイテムをディスクに書き込むための便利メソッドです。

メソッドの詳細

getInputStream

InputStream getInputStream()
                    throws IOException

パートのコンテンツを InputStream として取得します。

戻り値:

パートのコンテンツの InputStream

例外:

IOException - コンテンツをInputStream として取得する際にエラーが発生した場合

getContentType

String getContentType()

このパートのコンテンツタイプを取得します。

戻り値:

このパートのコンテンツタイプ

getName

String getName()

パートの名前を取得します。

戻り値:

パートの名前の String

getSubmittedFileName

String getSubmittedFileName()

クライアントから示されたファイルの名前を取得します。

戻り値:

サブミットされたファイル名

導入されたバージョン:

Servlet 3.1

getSize

long getSize()

このファイルのサイズを返します。

戻り値:

このパートのバイト長を示すlong

write

void write(String fileName)
    throws IOException

このアップロードされたアイテムをディスクに書き込むための便利メソッドです。

このメソッドは同じパートに対して複数回呼び出された場合の成功は保証されません。 これにより特定の実装では、例えば可能であれば元のすべてのデータをコピーするのではなくファイルの名前変更を使用することでパフォーマンス上のメリットが得られます。

パラメータ:

fileName - アップロードされたパーツを格納する必要のある場所。 値はファイル名もしくはパスのどちらかでよいです。 ファイルシステム内のファイルの実際の位置は、 MultipartConfigElement.getLocation()からの相対パスです。 絶対パスは指定されたとおりに使用され、 getLocation()からの相対パスです。(訳注：JavaDocが間違っている？相対パスではありませんというのが正しそうな気がする) 注意：これはシステムに依存する文字列であり、URI表記はすべてのシステムで受け入れられなくてもよいです。 移植性のためにはこの文字列はFileもしくはPath APIを使用して生成する必要があります。

例外:

IOException - エラーが起きた場合

delete

void delete()
     throws IOException

関連する一時ファイルなど、ストレージ上に存在するファイルアイテムを削除します。

例外:

IOException - エラーが起きた場合

getHeader

String getHeader(String name)

MIMEヘッダーから指定された値をStringとして返します。 パートが指定された名前をヘッダーに持たない場合、このメソッドはnullを返します。 パートが同じ名前で重複したヘッダーを持っていた場合、このメソッドは最初のヘッダーを返します。 ヘッダー名は大文字と小文字を区別しません。 任意のリクエストのヘッダーでこのメソッドを使用できます。

パラメータ:

name - ヘッダー名を指定する String

戻り値:

要求されたヘッダーの値を含むString、 パートにその名前のヘッダーがない場合はnull

getHeaders

Collection<String> getHeaders(String name)

指定された名前でパートのヘッダーの値を取得します。

返されたCollectionに対するいかなる変更もこのPartに影響を与えてはいけません。

パートのヘッダー名は大文字小文字を区別しません。

パラメータ:

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

戻り値:

ヘッダーの指定された名前の値の(空の可能性のある) Collection

getHeaderNames

Collection<String> getHeaderNames()

このパートのヘッダーの名前を取得します。

いくつかのサーブレットコンテナはこのメソッドを使用してヘッダーにアクセスする許可しません。 その場合このメソッドはnullを返します。

返されたCollectionに対するいかなる変更もこのPartに影響を与えてはいけません。

戻り値:

このパートのヘッダー名の(空の可能性のある) Collection