CommonsMultipartResolver (Spring Framework API)

java.lang.ObjectSE
- org.springframework.web.multipart.commons.CommonsFileUploadSupport
- - org.springframework.web.multipart.commons.CommonsMultipartResolver

実装されているすべてのインターフェース:
Aware, ServletContextAware, MultipartResolver
```
public class CommonsMultipartResolver
extends CommonsFileUploadSupport
implements MultipartResolver, ServletContextAware
```
Apache Commons FileUpload 1.2 以降のサーブレットベースの MultipartResolver 実装。このリゾルバーバリアントは、アプリケーション内のローカル FileUpload ライブラリに委譲し、サーブレットコンテナー間で最大の移植性を提供します。
Commons FileUpload は、従来、任意の "multipart/" 型の POST リクエストを解析します。サポートされている HTTP メソッドは、setSupportedMethods(java.lang.String...) を介してカスタマイズできます。
Bean プロパティとして "maxUploadSize"、"maxInMemorySize"、"defaultEncoding" 設定を提供します (CommonsFileUploadSupport から継承)。デフォルト値と許容値の詳細については、対応する ServletFileUpload/DiskFileItemFactory プロパティ ( "sizeMax"、"sizeThreshold"、"headerEncoding" ) を参照してください。
一時ファイルをサーブレットコンテナーの一時ディレクトリに保存します。アプリケーションコンテキストによって、 または ServletContext を取得するコンストラクターによって（スタンドアロンで使用するために）初期化する必要があります。
メモ: 一般的な代替手段は StandardServletMultipartResolver であり、サーブレットコンテナー自体のマルチパートパーサーに委譲します。設定はコンテナーレベルで行われ、コンテナー固有の制限がある可能性があります。
導入:
29.09.2003
作成者:
Trevor D. Cook, Juergen Hoeller
関連事項:
CommonsMultipartResolver(ServletContext), setResolveLazily(boolean), setSupportedMethods(java.lang.String...), ServletFileUpload, DiskFileItemFactory, StandardServletMultipartResolver

ネストされたクラスの要約
- クラス org.springframework.web.multipart.commons.CommonsFileUploadSupport から継承されたネストクラス / インターフェース
  CommonsFileUploadSupport.MultipartParsingResult

フィールドのサマリー
- クラス org.springframework.web.multipart.commons.CommonsFileUploadSupport から継承されたフィールド
  logger

コンストラクターの概要

コンストラクター
コンストラクターと説明
`CommonsMultipartResolver()` Bean として使用するコンストラクター。
`CommonsMultipartResolver(ServletContextEE servletContext)` スタンドアロンで使用するためのコンストラクター。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`void`	`cleanupMultipart(MultipartHttpServletRequest request)` アップロードされたファイルのストレージなど、マルチパート処理に使用されるリソースをクリーンアップします。
`protected StringSE`	`determineEncoding(HttpServletRequestEE request)` 指定されたリクエストのエンコーディングを決定します。
`boolean`	`isMultipart(HttpServletRequestEE request)` 指定されたリクエストにマルチパートコンテンツが含まれているかどうかを判断します。
`protected org.apache.commons.fileupload.FileUpload`	`newFileUpload(org.apache.commons.fileupload.FileItemFactory fileItemFactory)` 基礎となる `org.apache.commons.fileupload.servlet.ServletFileUpload` インスタンスを初期化します。
`protected CommonsFileUploadSupport.MultipartParsingResult`	`parseRequest(HttpServletRequestEE request)` 指定されたサーブレットリクエストを解析し、そのマルチパート要素を解決します。
`MultipartHttpServletRequest`	`resolveMultipart(HttpServletRequestEE request)` 指定された HTTP リクエストをマルチパートファイルとパラメーターに解析し、リクエストをファイル記述子へのアクセスを提供する `MultipartHttpServletRequest` オブジェクト内にラップし、標準の ServletRequest メソッドを介して含まれるパラメーターにアクセスできるようにします。
`void`	`setResolveLazily(boolean resolveLazily)` ファイルまたはパラメーターのアクセス時にマルチパートリクエストを遅延解決するかどうかを設定します。
`void`	`setServletContext(ServletContextEE servletContext)` このオブジェクトが実行される `ServletContext`EE を設定します。
`void`	`setSupportedMethods(StringSE... supportedMethods)` サポートされているメソッドを HTTP メソッド名の配列として指定します。

クラス org.springframework.web.multipart.commons.CommonsFileUploadSupport から継承されたメソッド
cleanupFileItems, createMultipartFile, getDefaultEncoding, getFileItemFactory, getFileUpload, isUploadTempDirSpecified, newFileItemFactory, parseFileItems, prepareFileUpload, setDefaultEncoding, setMaxInMemorySize, setMaxUploadSize, setMaxUploadSizePerFile, setPreserveFilename, setUploadTempDir

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE

- コンストラクターの詳細
  - CommonsMultipartResolver
```
public CommonsMultipartResolver()
```
    Bean として使用するコンストラクター。ServletContextAware インターフェース経由で渡される ServletContext を介して（通常 WebApplicationContext によって）サーブレットコンテナーの一時ディレクトリを決定します。
    関連事項:
    setServletContext(javax.servlet.ServletContext), ServletContextAware, WebApplicationContext
  - CommonsMultipartResolver
```
public CommonsMultipartResolver(ServletContextEE servletContext)
```
    スタンドアロンで使用するためのコンストラクター。指定された ServletContext を介して、サーブレットコンテナーの一時ディレクトリを決定します。
    パラメーター:
    servletContext - 使用する ServletContext
- メソッドの詳細
  - setResolveLazily
```
public void setResolveLazily(boolean resolveLazily)
```
    ファイルまたはパラメーターのアクセス時にマルチパートリクエストを遅延解決するかどうかを設定します。
    デフォルトは "false" で、マルチパート要素をすぐに解決し、resolveMultipart(javax.servlet.http.HttpServletRequest) 呼び出し時に対応する例外をスローします。遅延マルチパート解析の場合はこれを "true" に切り替え、アプリケーションがマルチパートファイルまたはパラメーターを取得しようとすると解析例外をスローします。
  - setSupportedMethods
```
public void setSupportedMethods(StringSE... supportedMethods)
```
    サポートされているメソッドを HTTP メソッド名の配列として指定します。従来の Commons FileUpload のデフォルトは "POST" のみです。
    Spring プロパティ値として構成されている場合、これはコンマ区切りの文字列にすることができます。「POST、PUT」。
    導入:
    5.3.9
  - newFileUpload
```
protected org.apache.commons.fileupload.FileUpload newFileUpload(org.apache.commons.fileupload.FileItemFactory fileItemFactory)
```
    基礎となる org.apache.commons.fileupload.servlet.ServletFileUpload インスタンスを初期化します。テスト目的などでカスタムサブクラスを使用するためにオーバーライドすることができます。
    次で指定:
    クラス CommonsFileUploadSupport の newFileUpload
    パラメーター:
    fileItemFactory - 使用するコモンズ FileItemFactory
    戻り値:
    新しい ServletFileUpload インスタンス
  - setServletContext
```
public void setServletContext(ServletContextEE servletContext)
```
    インターフェースからコピーされた説明: ServletContextAware
    このオブジェクトが実行される ServletContextEE を設定します。
    通常の Bean プロパティの設定後、InitializingBean の afterPropertiesSet またはカスタム init メソッドのような初期コールバックの前に呼び出されます。ApplicationContextAware の setApplicationContext の後に呼び出されます。
    次で指定:
    インターフェース ServletContextAware の setServletContext
    パラメーター:
    servletContext - このオブジェクトによって使用される ServletContext オブジェクト
    関連事項:
    InitializingBean.afterPropertiesSet(), ApplicationContextAware.setApplicationContext(org.springframework.context.ApplicationContext)
  - isMultipart
```
public boolean isMultipart(HttpServletRequestEE request)
```
    インターフェースからコピーされた説明: MultipartResolver
    指定されたリクエストにマルチパートコンテンツが含まれているかどうかを判断します。
    通常、コンテンツ型 "multipart/form-data" をチェックしますが、実際に受け入れられるリクエストは、リゾルバー実装の機能によって異なる場合があります。
    次で指定:
    インターフェース MultipartResolver の isMultipart
    パラメーター:
    request - 評価されるサーブレットリクエスト
    戻り値:
    リクエストにマルチパートコンテンツが含まれているかどうか
  - resolveMultipart
```
public MultipartHttpServletRequest resolveMultipart(HttpServletRequestEE request)
                                             throws MultipartException
```
    インターフェースからコピーされた説明: MultipartResolver
    指定された HTTP リクエストをマルチパートファイルとパラメーターに解析し、リクエストをファイル記述子へのアクセスを提供する MultipartHttpServletRequest オブジェクト内にラップし、標準の ServletRequest メソッドを介して含まれるパラメーターにアクセスできるようにします。
    次で指定:
    インターフェース MultipartResolver の resolveMultipart
    パラメーター:
    request - ラップするサーブレットリクエスト (マルチパートコンテンツ型である必要があります)
    戻り値:
    ラップされたサーブレットリクエスト
    例外:
    MultipartException - サーブレットリクエストがマルチパートでない場合、または実装固有の問題が発生した場合 (ファイルサイズの制限を超えるなど)
    関連事項:
    MultipartRequest.getFile(java.lang.String), MultipartRequest.getFileNames(), MultipartRequest.getFileMap(), ServletRequest.getParameter(java.lang.String)EE, ServletRequest.getParameterNames()EE, ServletRequest.getParameterMap()EE
  - parseRequest
```
protected CommonsFileUploadSupport.MultipartParsingResult parseRequest(HttpServletRequestEE request)
                                                                throws MultipartException
```
    指定されたサーブレットリクエストを解析し、そのマルチパート要素を解決します。
    パラメーター:
    request - 解析するリクエスト
    戻り値:
    解析結果
    例外:
    MultipartException - マルチパート解決が失敗した場合。
  - determineEncoding
```
protected StringSE determineEncoding(HttpServletRequestEE request)
```
    指定されたリクエストのエンコーディングを決定します。サブクラスでオーバーライドできます。
    デフォルトの実装では、リクエストのエンコーディングをチェックし、このリゾルバーに指定されているデフォルトのエンコーディングにフォールバックします。
    パラメーター:
    request - 現在の HTTP リクエスト
    戻り値:
    リクエストのエンコーディング (非 null)
    関連事項:
    ServletRequest.getCharacterEncoding()EE, CommonsFileUploadSupport.setDefaultEncoding(java.lang.String)
  - cleanupMultipart
```
public void cleanupMultipart(MultipartHttpServletRequest request)
```
    インターフェースからコピーされた説明: MultipartResolver
    アップロードされたファイルのストレージなど、マルチパート処理に使用されるリソースをクリーンアップします。
    次で指定:
    インターフェース MultipartResolver の cleanupMultipart
    パラメーター:
    request - リソースをクリーンアップするリクエスト

クラス CommonsMultipartResolver

ネストされたクラスの要約

クラス org.springframework.web.multipart.commons.CommonsFileUploadSupport から継承されたネストクラス / インターフェース

フィールドのサマリー

クラス org.springframework.web.multipart.commons.CommonsFileUploadSupport から継承されたフィールド

コンストラクターの概要

メソッドのサマリー

クラス org.springframework.web.multipart.commons.CommonsFileUploadSupport から継承されたメソッド

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

コンストラクターの詳細

CommonsMultipartResolver

CommonsMultipartResolver

メソッドの詳細

setResolveLazily

setSupportedMethods

newFileUpload

setServletContext

isMultipart

resolveMultipart

parseRequest

determineEncoding

cleanupMultipart