パッケージ jakarta.servlet.http
インターフェース Part
public interface Part
このクラスは、
multipart/form-data
POST リクエスト内で受信されたパーツまたはフォームアイテムを表します。- 導入:
- Servlet 3.0
メソッドのサマリー
すべてのメソッド インスタンスメソッド 抽象メソッド 修飾子と型 メソッド 説明 void
delete()
関連する一時ディスクファイルの削除など、ファイルアイテムの基になるストレージを削除します。StringSE
getContentType()
このパーツのコンテンツ型を取得します。StringSE
getHeader(StringSE name)
指定された MIME ヘッダーの値をString
として返します。CollectionSE<StringSE>
getHeaderNames()
この Part のヘッダー名を取得します。CollectionSE<StringSE>
getHeaders(StringSE name)
指定された名前の Part ヘッダーの値を取得します。InputStreamSE
getInputStream()
このパーツのコンテンツを InputStream として取得しますStringSE
getName()
このパートの名前を取得しますlong
getSize()
このファイルのサイズを返します。StringSE
getSubmittedFileName()
クライアントによって指定されたファイル名を取得しますvoid
write(StringSE fileName)
このアップロードされたアイテムをディスクに書き込む便利なメソッド。
メソッドの詳細
getInputStream
InputStreamSE getInputStream() throws IOExceptionSE
このパーツのコンテンツを InputStream として取得します- 戻り値:
- InputStream としてのこのパートのコンテンツ
- 例外:
IOExceptionSE
- コンテンツを InputStream として取得する際にエラーが発生した場合
getContentType
StringSE getContentType()
このパーツのコンテンツ型を取得します。- 戻り値:
- このパートのコンテンツ型。
getName
StringSE getName()
このパートの名前を取得します- 戻り値:
- String としてのこのパートの名前
getSubmittedFileName
StringSE getSubmittedFileName()
クライアントによって指定されたファイル名を取得します- 戻り値:
- 提出されたファイル名
- 導入:
- Servlet 3.1
getSize
long getSize()
このファイルのサイズを返します。- 戻り値:
- このパートのサイズをバイト単位で指定する
long
write
void write(StringSE fileName) throws IOExceptionSE
このアップロードされたアイテムをディスクに書き込む便利なメソッド。このメソッドは、同じパーツに対して複数回呼び出された場合に成功するとは限りません。これにより、特定の実装では、基礎となるすべてのデータをコピーするのではなく、可能な場合、たとえばファイル名の変更を使用できるため、パフォーマンスが大幅に向上します。
- パラメーター:
fileName
- アップロードされたパーツを保存する場所。相対パスはMultipartConfigElement.getLocation()
を基準にしています。提供されているとおりに絶対パスが使用されます。注: これはシステムに依存する文字列であり、URI 表記がすべてのシステムで受け入れられるとは限らないことに注意してください。移植性のために、この文字列はファイルまたはパス API を使用して生成する必要があります。- 例外:
IOExceptionSE
- エラーが発生した場合。
delete
void delete() throws IOExceptionSE
関連する一時ディスクファイルの削除など、ファイルアイテムの基になるストレージを削除します。- 例外:
IOExceptionSE
- エラーが発生した場合。
getHeader
StringSE getHeader(StringSE name)
指定された MIME ヘッダーの値をString
として返します。指定された名前のヘッダーが Part に含まれていない場合、このメソッドはnull
を返します。同じ名前のヘッダーが複数ある場合、このメソッドはパーツの最初のヘッダーを返します。ヘッダー名では大文字と小文字が区別されません。このメソッドは、任意のリクエストヘッダーで使用できます。- パラメーター:
name
- ヘッダー名を指定するString
- 戻り値:
- リクエストされたヘッダーの値を含む
String
、またはパーツにその名前のヘッダーがない場合はnull
getHeaders
CollectionSE<StringSE> getHeaders(StringSE name)
指定された名前の Part ヘッダーの値を取得します。返された
Collection
に対する変更は、このPart
に影響してはなりません。パーツヘッダー名では大文字と小文字が区別されません。
- パラメーター:
name
- 値を返すヘッダー名- 戻り値:
- 指定された名前のヘッダーの値の(空の場合もある)
Collection
getHeaderNames
CollectionSE<StringSE> getHeaderNames()
この Part のヘッダー名を取得します。一部のサーブレットコンテナーでは、サーブレットがこのメソッドを使用してヘッダーにアクセスすることを許可しません。この場合、このメソッドは
null
を返します返された
Collection
に対する変更は、このPart
に影響してはなりません。- 戻り値:
- このパートのヘッダー名の(空の場合もある)
Collection