intra-mart 6.1.14

jp.co.intra_mart.common.aid.javaee.http
インタフェース MultipartFormData.Entity

含まれているインタフェース:
MultipartFormData

public static interface MultipartFormData.Entity

フォームデータのエンティティです。

フォームから送信された情報を解析した結果の各エンティティは、 ヘッダ情報とデータで構成されます。


メソッドの概要
 boolean containsHeader(String name)
          指定された文字列がヘッダの名称かどうかを判定します。
 byte[] getBytes()
          データ部をバイト配列として取得します。
 String getContent()
          データ部を文字列表現として取得します。
 String getContent(String enc)
          データ部を指定された文字コードで変換した結果を文字列表現として 取得します。
 int getContentLength()
          データ部をバイト長を取得します。
 String getFileName()
          アップロードされたファイルのファイル名を取得します。
 String getHeader(String name)
          ヘッダの取得。
 String[] getHeaderNames()
          ヘッダ名称一覧の取得。
 InputStream getInputStream()
          データ部を入力ストリームとして取得します。
 String getName()
          フォームのコントロール名称の取得。
 Reader getReader()
          推奨されていません。 getReader(String) に置き換えられました。
 Reader getReader(String encoding)
          データ部を Reader として取得します。
 

メソッドの詳細

getName

public String getName()
フォームのコントロール名称の取得。

フォームから送信された情報のうち、このエンティティが表す情報の もととなったフォーム中に定義されたコントロールの名称を返します。

戻り値:
コントロール名称

getFileName

public String getFileName()
アップロードされたファイルのファイル名を取得します。

ファイルアップロードをしたリクエストではない場合は、null を返します。
Content-Disposition: form-data; name="ctrl_name"; filename="file_path"
ヘッダは、上記のような形式で受け取れる
ctrl_name: <INPUT type="file"> の name 属性
file_path: クライアントでのファイル名
ヘッダ情報は他にもあるが、上記の行のみを対象に解析を行う

戻り値:
String ファイル名

getHeaderNames

public String[] getHeaderNames()
ヘッダ名称一覧の取得。

このエンティティのもつヘッダ情報の名称一覧を返します。

戻り値:
ヘッダ名称の取得

getHeader

public String getHeader(String name)
ヘッダの取得。

返却値は、文字エンコーディングの変換が行われていない状態の文字列を返却します。 具体的には、javax.servlet.ServletRequest#getInputStream()を利用して リクエストの内容をバイト配列で取得し、それを「ISO-8859-1」で文字列化した内容が返却されます。

別のエンコーディングに変換する場合、以下のようなコードで変換する必要があります。

 byte[] rawData = entity.getHeader(headerName).getBytes("ISO-8859-1");
 String encodedValue = new String(rawData, request.getCharacterEncoding());
 

パラメータ:
name - ヘッダ名称
戻り値:
ヘッダ名称にマップされている値

containsHeader

public boolean containsHeader(String name)
指定された文字列がヘッダの名称かどうかを判定します。

パラメータ:
name - ヘッダ名称
戻り値:
ヘッダ名称が値にマップされている場合 true

getContentLength

public int getContentLength()
データ部をバイト長を取得します。

戻り値:
データのサイズ

getContent

public String getContent()
データ部を文字列表現として取得します。

入力されたバイトデータから文字列への変換には、Application Runtimeが稼動しているJavaVMの デフォルト文字エンコーディングを使います。

戻り値:
データ

getContent

public String getContent(String enc)
                  throws UnsupportedEncodingException
データ部を指定された文字コードで変換した結果を文字列表現として 取得します。

指定のエンコード名がサポートされていない場合 UnsupportedEncodingException がスローされます。

パラメータ:
enc - エンコード名
戻り値:
データ
例外:
UnsupportedEncodingException
関連項目:
UnsupportedEncodingException

getBytes

public byte[] getBytes()
データ部をバイト配列として取得します。

戻り値:
データ

getReader

public Reader getReader()
推奨されていません。 getReader(String) に置き換えられました。

データ部を Reader として取得します。

このReaderが文字に変換する際に使用する文字エンコーディングは、Application Runtimeが稼動している JavaVMのデフォルト文字エンコーディングです。

戻り値:
データ

getReader

public Reader getReader(String encoding)
データ部を Reader として取得します。

このReaderが文字に変換する際に使用する文字エンコーディングは、指定した文字エンコーディングです。

戻り値:
データ。エラーが発生した場合nullを返します。
導入されたバージョン:
6.1.12

getInputStream

public InputStream getInputStream()
データ部を入力ストリームとして取得します。

戻り値:
データ

intra-mart 6.1.14

Copyright © 2000-2010 NTT DATA INTRAMART CO.,LTD.. All Rights Reserved.