devpia.dextuploadnj.support.spring
Class DEXTUploadNJFilesToZipDownloadView

サポートされる最小バージョン

1.3.0

最小サポート環境

JRE 1.6, Spring Framework

説明

指定されたファイルを1つのzipファイルで囲み、ダウンロードを実行するビュークラスである。

@RequestMapping(value = "マッピングURL", method = RequestMethod.GET)
public ModelAndView メソッド(...) {
    List<File> files = new ArrayList<File>();
    files.add(new File("/src/test/resources/compress/....txt"));
    files.add(new File("/src/test/resources/compress/....pdf"));
    files.add(new File("/src/test/resources/compress/subA/subB/....txt"));
    files.add(new File("/src/test/resources/compress/....jpg"));
    files.add(new File("/src/test/resources/compress/....docx"));
		
    DEXTUploadNJFilesToZipDownloadView view = new DEXTUploadNJFilesToZipDownloadView();
			
    view.setEntries(files);
    view.setCharsetName("UTF-8");
			
    return new ModelAndView(view);
}

DEXTUploadNJFilesToZipDownloadViewビューを使用すると、リンク先のファイルを圧縮した後、すぐにダウンロードを実行する。

ダウンロードが完了すると、内部的に圧縮ファイルを直接削除し、圧縮ダウンロードはpartial contentダウンロードをサポートしていない。

もし圧縮されたファイルを削除せずに再するには、DEXTUploadNJFilesToZipDownloadViewビュークラスではなく、CompressUtilクラスを直接使用して圧縮ファイルを作成した後、 DEXTUploadNJFileDownloadViewビュークラスを使用してダウンロードする必要がある。

@RequestMapping(value = "マッピングURL", method = RequestMethod.GET)
public ModelAndView メソッド(...) {
    List<File> files = new ArrayList<File>();
    files.add(new File("/src/test/resources/compress/....txt"));
    files.add(new File("/src/test/resources/compress/....pdf"));
    files.add(new File("/src/test/resources/compress/subA/subB/....txt"));
    files.add(new File("/src/test/resources/compress/....jpg"));
    files.add(new File("/src/test/resources/compress/....docx"));
    // CompressUtilを使用して圧縮ファイルを生成する。
    CompressUtil zipper = new CompressUtil();
    File zipped = zipper.zip(entries, "/tmp", "UTF-8", false, true);
		
    // ファイルをダウンロードするためにDEXTUploadNJFileDownloadViewオブジェクトを生成する。
    DEXTUploadNJFileDownloadView view = new DEXTUploadNJFileDownloadView();
    
    view.setFile(zipped);
    view.setFilename("ダウンロードするファイル名.zip");
    view.setMime("application/x-zip-compressed");
    view.setUseClientCache(false);
    view.setCharsetName("UTF-8");
    
    // ダウンロードが開始される。
    return new ModelAndView(view);
}

コンストラクタ

DEXTUploadNJFilesToZipDownloadView

DEXTUploadNJFilesToZipDownloadViewオブジェクトを生成する。

形式

public DEXTUploadNJFilesToZipDownloadView()
public DEXTUploadNJFilesToZipDownloadView(List<File> entries)
public DEXTUploadNJFilesToZipDownloadView(List<File> entries, String filename)
public DEXTUploadNJFilesToZipDownloadView(List<File> entries, List<String> entryNames, String filename)

パラメータ

名前

形式

説明

entries

java.util.List<java.io.File>

圧縮するファイルのリストを指すオブジェクト

filename

java.lang.String

クライアントがダウンロードファイル名

entryNames

java.util.List<java.lang.String>

（2.4.0バージョンからサポート）

圧縮するファイルの名前のリスト。「entryNames」パラメータのサイズは「entries」パラメータのサイズと同じです。

メソッド

getEntries

圧縮するファイルのリストを指すjava.util.Listオブジェクトを返します。
形式
```
public List<File> getEntries()
```
リターン

圧縮するファイルのリストを指すjava.util.Listオブジェクト

setEntries

圧縮するファイルのリストを指すjava.util.Listオブジェクトを設定する。

形式

public void setEntries(List<File> entries)

パラメータ

名前	形式	説明
entries	java.util.List<java.io.File>	圧縮するファイルのリストを指すオブジェクト

getTempZipRepositoryPath

zipファイルが作成される一時ディレクトリを表すパスを返します。

形式

public String getTempZipRepositoryPath()

リターン

zipファイルが作成される一時ディレクトリを示すパス

setTempZipRepositoryPath

zipファイルが作成される一時ディレクトリを表すパスを設定する。

形式

public void setTempZipRepositoryPath(String tempZipRepositoryPath)

パラメータ

名前	形式	説明
tempZipRepositoryPath	java.lang.String	一時ディレクトリを示すパス

getZipCharsetName

多言語を使用するファイル名をエンコードする過程で使用する文字セット名前を返します。
形式
```
public String getZipCharsetName()
```
リターン

多言語を使用するファイル名をエンコードする過程で使用する文字セット名前

setZipCharsetName

多言語を使用するファイル名をエンコードする過程で使用する文字セット名前を設定する。

形式

public void setZipCharsetName(String zipCharsetName)

パラメータ

名前	形式	説明
zipCharsetName	java.lang.String	多言語を使用するファイル名をエンコードする過程で使用する文字セット名前

isIncludeHiddenFile

圧縮するとき、隠しファイルも圧縮するかどうかを返します。
形式
```
public boolean isIncludeHiddenFile()
```
リターン

true, false

setIncludeHiddenFile

圧縮するとき、隠しファイルも圧縮するかどうかを設定する。

形式

public void setIncludeHiddenFile(boolean includeHiddenFile)

パラメータ

名前	形式	説明
includeHiddenFile	boolean	パラメータの値がtrueの場合、隠しファイルも圧縮対象となる。

getEntryNames (バージョン2.4.0からサポート)

圧縮するファイルの名前のリストを返します。
形式
```
public List<String> getEntryNames()
```
リターン

圧縮するファイルの名前のリスト

setEntryNames (バージョン2.4.0からサポート)

圧縮するファイルの名前のリストを設定します。

形式

public void setEntryNames(List<String> entryNames)

パラメータ

名前	形式	説明
entryNames	List<String>	圧縮するファイルの名前のリスト

getFile

DEXTUploadNJFileDownloadViewクラスのgetFileメソッドを参照すること。

setFile

DEXTUploadNJFileDownloadViewクラスのsetFileメソッドを参照すること。

isAllowingWeakRange

DEXTUploadNJFileDownloadViewクラスのisAllowingWeakRangeメソッドを参照すること。

setAllowingWeakRange

DEXTUploadNJFileDownloadViewクラスのsetAllowingWeakRangeメソッドを参照すること。

isUseClientCache

DEXTUploadNJFileDownloadViewクラスのisUseClientCacheメソッドを参照すること。

setUseClientCache

DEXTUploadNJFileDownloadViewクラスのsetUseClientCacheメソッドを参照すること。

isRemoveAfterDownloading

DEXTUploadNJFileDownloadViewクラスのisRemoveAfterDownloadingメソッドを参照すること。

setRemoveAfterDownloading

DEXTUploadNJFileDownloadViewクラスのsetRemoveAfterDownloadingメソッドを参照すること。

setUseTomcatSendFile

DEXTUploadNJFileDownloadViewクラスのsetUseTomcatSendFileメソッドを参照すること。

doRenderImpl

DEXTUploadNJAbstractDownloadableView抽象クラスのdoRenderImplメソッドを参照すること。

getFilename

DEXTUploadNJAbstractDownloadableView抽象クラスのgetFilenameメソッドを参照すること。

setFilename

DEXTUploadNJAbstractDownloadableView抽象クラスのsetFilenameメソッドを参照すること。

getMime

DEXTUploadNJAbstractDownloadableView抽象クラスのgetMimeメソッドを参照すること。

setMime

DEXTUploadNJAbstractDownloadableView抽象クラスのsetMimeメソッドを参照すること。

isInline

DEXTUploadNJAbstractDownloadableView抽象クラスのisInlineメソッドを参照すること。

setInline

DEXTUploadNJAbstractDownloadableView抽象クラスのsetInlineメソッドを参照すること。

getCharsetName

DEXTUploadNJAbstractDownloadableView抽象クラスのgetCharsetNameメソッドを参照すること。

setCharsetName

DEXTUploadNJAbstractDownloadableView抽象クラスのsetCharsetNameメソッドを参照すること。

getDownloadStreamBufferSize

DEXTUploadNJAbstractDownloadableView抽象クラスのgetDownloadStreamBufferSizeメソッドを参照すること。

setDownloadStreamBufferSize

DEXTUploadNJAbstractDownloadableView抽象クラスのsetDownloadStreamBufferSizeメソッドを参照すること。

getContentDisposition

See the getContentDisposition method of the DEXTUploadNJAbstractDownloadableView class.

setContentDisposition

See the setContentDisposition method of the DEXTUploadNJAbstractDownloadableView class

devpia.dextuploadnj.support.springClass DEXTUploadNJFilesToZipDownloadView

devpia.dextuploadnj.support.spring
Class DEXTUploadNJFilesToZipDownloadView